mix/vega

Mix Vega is a HTTP web framework written in PHP support Swoole, WorkerMan

Installs: 2 686

Dependents: 5

Suggesters: 0

Security: 0

Stars: 46

Watchers: 2

Forks: 3

Open Issues: 0

Type:framework

v3.0.28 2022-06-21 03:52 UTC

README

OpenMix 出品:https://openmix.org

Mix Vega

中文 | English

Vega is a CLI mode HTTP web framework written in PHP support Swoole, WorkerMan, FPM, CLI-Server

Vega 是一个用 PHP 编写的 CLI 模式 HTTP 网络框架,支持 Swoole、WorkerMan、FPM、CLI-Server

概述

Vega 是 MixPHP V3+ 内置的最核心的组件 (可独立使用),参考 golang gin mux 开发,它包含 Web 应用处理的大量功能 (数据库处理除外) ,包括:路由、渲染、参数获取、中间件、文件上传、静态文件处理等;具有 CLI 模式下强大的兼容性,同时支持 Swoole、WorkerMan、FPM、CLI-Server, 并且支持 Swoole 的多种进程模型与协程。

推荐搭配以下数据库使用:

推荐文章:

技术交流

知乎:https://www.zhihu.com/people/onanying
官方QQ群:284806582 , 825122875 敲门暗号:vega

安装

需先安装 Swoole 或者 WorkerMan

composer require mix/vega

快速开始

  • Swoole 多进程 (异步) 中使用
<?php
require __DIR__ . '/vendor/autoload.php';

$vega = new Mix\Vega\Engine();
$vega->handle('/hello', function (Mix\Vega\Context $ctx) {
    $ctx->string(200, 'hello, world!');
})->methods('GET');

$http = new Swoole\Http\Server('0.0.0.0', 9501);
$http->on('Request', $vega->handler());
$http->set([
    'worker_num' => 4,
]);
$http->start();

开启多进程协程

$http->on('Request', $vega->handler());
$http->on('WorkerStart', function ($server, $workerId) {
    // 协程初始化
    // 比如:启动 mix/database mix/redis 的连接池
});
$http->set([
    'enable_coroutine' => true,
    'worker_num' => 4,
]);
php swoole.php
  • Swoole 单进程 (协程) 中使用
<?php
require __DIR__ . '/vendor/autoload.php';

Swoole\Coroutine\run(function () {
    $vega = new Mix\Vega\Engine();
    $vega->handle('/hello', function (Mix\Vega\Context $ctx) {
        $ctx->string(200, 'hello, world!');
    })->methods('GET');
    
    $server = new Swoole\Coroutine\Http\Server('0.0.0.0', 9502, false);
    $server->handle('/', $vega->handler());
    $server->start();
});
php swooleco.php
  • WorkerMan 中使用
<?php
require __DIR__ . '/vendor/autoload.php';

$vega = new Mix\Vega\Engine();
$vega->handle('/hello', function (Mix\Vega\Context $ctx) {
    $ctx->string(200, 'hello, world!');
})->methods('GET');

$http_worker = new Workerman\Worker("http://0.0.0.0:2345");
$http_worker->onMessage = $vega->handler();
$http_worker->count = 4;
Workerman\Worker::runAll();
php wokerman.php start
  • PHP-FPM 中使用

nginx 配置 rewrite 重写到 index.php

<?php
require __DIR__ . '/vendor/autoload.php';

$vega = new Mix\Vega\Engine();
$vega->handle('/hello', function (Mix\Vega\Context $ctx) {
    $ctx->string(200, 'hello, world!');
})->methods('GET');
return $vega->run();

这个内置的Web服务器主要用于本地开发使用,不可用于线上产品环境。

<?php
require __DIR__ . '/vendor/autoload.php';

$vega = new Mix\Vega\Engine();
$vega->handle('/hello', function (Mix\Vega\Context $ctx) {
    $ctx->string(200, 'hello, world!');
})->methods('GET');
return $vega->run();
php -S localhost:8000 router.php
  • 访问测试
% curl http://127.0.0.1:9501/hello
hello, world!

路由配置

配置 Closure 闭包路由

$vega = new Mix\Vega\Engine();
$vega->handle('/hello', function (Mix\Vega\Context $ctx) {
    $ctx->string(200, 'hello, world!');
})->methods('GET');

配置 callable 路由

class Hello {
    public function index(Mix\Vega\Context $ctx) {
        $ctx->string(200, 'hello, world!');
    }
}
$vega = new Mix\Vega\Engine();
$vega->handle('/hello', [new Hello(), 'index'])->methods('GET');

配置路由变量

$vega = new Mix\Vega\Engine();
$vega->handle('/users/{id:\d+}', function (Mix\Vega\Context $ctx) {
    $id = $ctx->param('id');
    $ctx->string(200, 'hello, world!');
})->methods('GET');

配置多个 method

$vega = new Mix\Vega\Engine();
$vega->handle('/hello', function (Mix\Vega\Context $ctx) {
    $ctx->string(200, 'hello, world!');
})->methods('GET', 'POST');

路由前缀 (分组)

$vega = new Mix\Vega\Engine();
$sub = $vega->pathPrefix('/foo');
$sub->handle('/bar1', function (Mix\Vega\Context $ctx) {
    $ctx->string(200, 'hello, world!');
})->methods('GET');
$sub->handle('/bar2', function (Mix\Vega\Context $ctx) {
    $ctx->string(200, 'hello1, world!');
})->methods('GET');

参数获取

请求参数

方法名称 描述
$ctx->request: ServerRequestInterface 符合PSR的请求对象
$ctx->response: ResponseInterface 符合PSR的响应对象
$ctx->param(string $key): string 获取路由参数
$ctx->query(string $key): string 获取url参数,包含路由参数
$ctx->defaultQuery(string $key, string $default): string 获取url参数,可配置默认值
$ctx->getQuery(string $key): string or null 获取url参数, 可判断是否存在
$ctx->postForm(string $key): string 获取post参数
$ctx->defaultPostForm(string $key, string $default): string 获取post参数,可配置默认值
$ctx->getPostForm(string $key): string or null 获取post参数,可判断是否存在

Headers, Cookies, Uri ...

方法名称 描述
$ctx->method(): string 请求类型
$ctx->contentType(): string 文档类型
$ctx->header(string $key): string 请求头
$ctx->cookie(string $name): string cookies
$ctx->uri(): UriInterface 完整uri
$ctx->rawData(): string 原始包数据

客户端IP

方法名称 描述
$ctx->clientIP(): string 从反向代理获取用户真实IP
$ctx->remoteIP(): string 获取远程IP

上传文件处理

方法名称 描述
$ctx->formFile(string $name): UploadedFileInterface 获取上传的第一个文件
$ctx->multipartForm(): UploadedFileInterface[] 获取上传的全部文件

文件保存

$file = $ctx->formFile('img');
$targetPath = '/data/project/public/uploads/' . $file->getClientFilename();
$file->moveTo($targetPath);

请求上下文

请求当中需要保存一些信息,比如:会话、JWT载荷等。

方法名称 描述
$ctx->set(string $key, $value): void 设置值
$ctx->get(string $key): mixed or null 获取值
$ctx->mustGet(string $key): mixed or throws 获取值或抛出异常

中断执行

abort 执行后,会停止执行后面的全部代码,包括中间件。

方法名称 描述
$ctx->abort(): void 中断,需自行处理响应
$ctx->abortWithStatus(int $code): void 中断并响应状态码
$ctx->abortWithStatusJSON(int $code, $data): void 中断并响应JSON
$vega = new Mix\Vega\Engine();
$vega->handle('/users/{id}', function (Mix\Vega\Context $ctx) {
    if (true) {
        $ctx->string(401, 'Unauthorized');
        $ctx->abort();
    }
    $ctx->string(200, 'hello, world!');
})->methods('GET');

响应处理

方法名称 描述
$ctx->status(int $code): void 设置状态码
$ctx->setHeader(string $key, string $value): void 设置header
$ctx->setCookie(string $name, string $value, int $expire = 0, ...): void 设置cookie
$ctx->redirect(string $location, int $code = 302): void 重定向

重定向

$ctx->redirect('https://www.baidu.com/');
$ctx->abort();

JSON 请求与输出

获取 JSON 请求数据

$vega = new Mix\Vega\Engine();
$vega->handle('/users', function (Mix\Vega\Context $ctx) {
    $obj = $ctx->getJSON();
    if (!$obj) {
        throw new \Exception('Parameter error');
    }
    var_dump($obj);
    $ctx->JSON(200, [
        'code' => 0,
        'message' => 'ok'
    ]);
})->methods('POST');

mustGetJSON 自带有效性检查,以下代码等同于上面

$vega = new Mix\Vega\Engine();
$vega->handle('/users', function (Mix\Vega\Context $ctx) {
    $obj = $ctx->mustGetJSON();
    var_dump($obj);
    $ctx->JSON(200, [
        'code' => 0,
        'message' => 'ok'
    ]);
})->methods('POST');

JSONP 处理

$vega = new Mix\Vega\Engine();
$vega->handle('/jsonp', function (Mix\Vega\Context $ctx) {
    $ctx->JSONP(200, [
        'code' => 0,
        'message' => 'ok'
    ]);
})->methods('GET');

HTML 视图渲染

创建视图文件 foo.php

<p>id: <?= $id ?>, name: <?= $name ?></p>
<p>friends:</p>
<ul>
    <?php foreach($friends as $name): ?>
        <li><?= $name ?></li>
    <?php endforeach; ?>
</ul>

导入其他视图

<?= $this->render('header', $__data__); ?>

配置视图路径,并响应html

$vega = new Mix\Vega\Engine();
$vega->withHTMLRoot('/data/project/views');
$vega->handle('/html', function (Mix\Vega\Context $ctx) {
    $ctx->HTML(200, 'foo', [
        'id' => 1000,
        'name' => '小明',
        'friends' => [
            '小花',
            '小红'
        ]
    ]);
})->methods('GET');

静态文件处理

基于 sendfile 零拷贝,不支持在 PHP-FPM 中使用

$vega = new Mix\Vega\Engine();
$vega->static('/static', '/data/project/public/static');
$vega->staticFile('/favicon.ico', '/data/project/public/favicon.ico');

设置中间件

给某个路由配置中间件,可配置多个

$vega = new Mix\Vega\Engine();
$func = function (Mix\Vega\Context $ctx) {
    // do something
    $ctx->next();
};
$vega->handle('/hello', $func, function (Mix\Vega\Context $ctx) {
    $ctx->string(200, 'hello, world!');
})->methods('GET');

配置全局中间件,即便没有匹配到路由也会执行

$vega = new Mix\Vega\Engine();
$vega->use(function (Mix\Vega\Context $ctx) {
    $ctx->next();
});

前置中间件

$vega->use(function (Mix\Vega\Context $ctx) {
    // do something
    $ctx->next();
});

后置中间件

$vega->use(function (Mix\Vega\Context $ctx) {
    $ctx->next();
    // do something
});

404 自定义

$vega = new Mix\Vega\Engine();
$vega->use(function (Mix\Vega\Context $ctx) {
    try{
        $ctx->next();
    } catch (Mix\Vega\Exception\NotFoundException $ex) {
        $ctx->string(404, 'New 404 response');
        $ctx->abort();
    }
});

500 全局异常捕获

$vega = new Mix\Vega\Engine();
$vega->use(function (Mix\Vega\Context $ctx) {
    try{
        $ctx->next();
    } catch (\Throwable $ex) {
        if ($ex instanceof Mix\Vega\Abort || $ex instanceof Mix\Vega\Exception\NotFoundException) {
            throw $ex;
        }
        $ctx->string(500, 'New 500 response');
        $ctx->abort();
    }
});

License

Apache License Version 2.0, http://www.apache.org/licenses/