PHP 基于 SW-X 框架,搭建高性能API架构(四)

前言

官网地址:SW-X框架-专注高性能便捷开发而生的PHP-SwooleX框架

希望各大佬举起小手,给小弟一个star:https://github.com/swoolex/swoolexlex


1、什么是中间件

中间件属于AOP切面编程的衍生,SW-X中的中间件可以通过绑定路由地址,实现控制器无切入的关联绑定。

在中间件中,可以进行请求拦截(前置操作)、或者请求缓存销毁(后置操作)等业务。


2、通过路由绑定中间件

接回上章案例,我们现在要对/api/*前缀的所有接口,统一绑定一个名为Auth的中间件。

需要先再/config/middleware.php中间件配置文件中注册绑定规则:

<?php
return [
    // 匹配中间件,路由前半段是/api/开头的都会绑定到
    '/api/*' => [
        \box\middleware\Auth::class,
    ],
];

所有中间件不强制继承\x\Middleware基类,但一般建议继承,\x\Middleware类提供了一个error()方法,当开发者想中断应用继续向下执行时,可以调用该方法,抛出自定义的提示内容到客户端,该方法兼容了框架中4种不同的服务。

中间件建议(但不强制)统一存放在/box/middleware/目录下, 便于项目管理。

接下来,我们在/box/middleware/目录下,创建一个Auth.php类,并写入代码:

<?php
/**
 * +----------------------------------------------------------------------
 * 权限中间件
 * +----------------------------------------------------------------------
 * 官网:SW-X框架-专注高性能便捷开发而生的PHP-SwooleX框架
 * +----------------------------------------------------------------------
 * 作者:小黄牛 <1731223728@qq.com>
 * +----------------------------------------------------------------------
 * 开源协议:http://www.apache.org/licenses/LICENSE-2.0
 * +----------------------------------------------------------------------
*/
namespace box\middleware;
use x\Middleware;
use x\Restful;
class Auth extends Middleware{
    // 需要跳过的路由
    private $_skip = [
        'shop/delete',
    ];
    // 需要跳过的前置路由
    private $_group_skip = [
        'login/',
    ];
    /**
     * 前置操作
     * @todo 无
     * @author 小黄牛
     * @version v2.5.0 + 2021.07.20
     * @deprecated 暂不启用
     * @global 无
     * @return void
    */
    public function handle() {
        // 获得当前路由地址
        $route = \x\Config::get('route');
        $url = str_replace($route['suffix'], '', ltrim(\x\Request::url(), $route['cutting']));
        $url = substr_replace($url, '', 0, (strpos($url, $route['cutting'])+1));
        // 跳过校验
        if (in_array($url, $this->_skip)) {
            return true;
        }
        // 跳过校验
        foreach ($this->_group_skip as $v) {
            if (stripos($url, $v) === 0) {
                return true;
            }
        }
        // 通过上下文,获得请求实例
        $Request = \x\context\Request::get();
        $get = $Request->get;// get表单
        $post = $Request->post;// post表单
        $header = $Request->header;// post表单
        // 没有访问权限
        if (!isset($get['test'])) {
            Restful::code(Restful::ACTION_ERROR())->callback();
            // 返回false表示中断执行
            return false;
        }
        // 返回true表示继续向下执行
        return true;
    }
}

同时,由于上面我们使用了一个ACTION_ERROR状态码,所以要在Restful状态码文件中加入响应的配置。

/restful/default/code.php修改成如下代码:

<?php
return [
    'ERROR' => 0, // 默认失败状态码
    'SUCCESS' => 1, // 默认成功状态码
    'ACTION_ERROR' => 40001, // 默认成功状态码
];

/restful/default/msg.php修改成如下代码:

<?php
return [
    // 默认错误状态码对应的tips
    'ERROR' => [
        'default' => '请求失败', // 默认值
    ],
    // 默认成功状态码对应的tips
    'SUCCESS' => [
        'default' => '请求成功', // 默认值
        'test' => '测试msg',
    ],
    // 权限校验失败
    'ACTION_ERROR' => [
        'default' => '权限校验失败', // 默认值
    ],
];

这时候我们访问http://IP地址:端口/api/shop/select接口,就会看到框架抛出了下面的状态码:

{
  "code": 40001,
  "msg": "权限校验失败",
  "data": []
}

如果访问http://IP地址:端口/api/shop/select?test=就是通过的。

同时,我们还可以创建/app/http/v1_0_1/controller/shop/delete.php/app/http/v1_0_1/controller/login/send.php接口,来测试中间件判断是否能够正常跳过。


/app/http/v1_0_1/controller/shop/delete.php代码如下:

<?php
namespace app\http\v1_0_1\controller\shop;
use x\controller\Http;
// 引入Restful组件
use x\Restful;
class delete extends Http
{
    public function index() {
        // Restful组件抛出接口响应
        return Restful::code(Restful::SUCCESS())->data([
            'title' => '我是api/shop/delete,跳过了中间件校验',
        ])->callback();
    }
}

/app/http/v1_0_1/controller/login/send.php代码如下:

<?php
namespace app\http\v1_0_1\controller\login;
use x\controller\Http;
// 引入Restful组件
use x\Restful;
class send extends Http
{
    public function index() {
        // Restful组件抛出接口响应
        return Restful::code(Restful::SUCCESS())->data([
            'title' => '我是api/login/send,跳过了中间件校验',
        ])->callback();
    }
}


创建完成后,就可以通过下列地址查看测试效果了:

http://IP地址:端口/api/shop/delete

http://IP地址:端口/api/login/send


上一篇:一个操作系统的实现(3)


下一篇:CSS绘图实现三角形并使用grid布局