>[info]中间件主要用于拦截或过滤应用的`HTTP`请求,并进行必要的业务处理。在tp5.1.6引入
新版部分核心功能使用中间件处理,你可以灵活关闭。包括Session功能、请求缓存和多语言功能。
## **简单案例**
### **步骤1:定义中间件**
>[danger]中间件的入口执行方法必须是`handle`方法,而且第一个参数是`Request`对象,第二个参数是一个闭包。
中间件`handle`方法的返回值必须是一个`Response`对象。
>[info]app\admin\middleware\Check.php
~~~
namespace app\admin\middleware;
class Check
{
public function handle($request, \Closure $next)
{
if ($request->param('name') == 'think') {
//向$request请求类添加新属性 ,然后在你的`controller`中可以通过`$this->request->pay`获取相关的值
$request->pay= 'WeChat';
//
return redirect('index/think');
}
return $next($request);
}
}
~~~
>[info]在某些需求下,可以使用第三个参数传入额外的参数。
~~~
<?php
namespace app\admin\middleware;
class Check
{
public function handle($request, \Closure $next, $name)
{
if ($name == 'think') {
return redirect('index/think');
}
return $next($request);
}
}
~~~
### **步骤2:配置中间件**
>[info] 在app/middleware.php(全局中间件) 或者 app/admin/middleware.php(针对admin模块)里添加如下代码
~~~
return [
app\admin\middleware\Check::class,
];
~~~
# **结束调度**
中间件支持定义请求结束前的回调机制,你只需要在中间件类中添加`end`方法。
~~~
public function end(\think\Response $response)
{
// 回调行为
}
~~~
>[danger] 注意,在`end`方法里面不能有任何的响应输出。因为回调触发的时候请求响应输出已经完成了。
# **前置/后置中间件**
>[info] 中间件是在请求具体的操作之前还是之后执行,完全取决于中间件的定义本身
## **前置行为的中间件**
~~~
<?php
namespace app\middleware;
class Before
{
public function handle($request, \Closure $next)
{
// 添加中间件执行代码
return $next($request);
}
}
~~~
## **后置行为的中间件**
~~~
<?php
namespace app\middleware;
class After
{
public function handle($request, \Closure $next)
{
$response = $next($reque st);
// 添加中间件执行代码
return $response;
}
}
~~~
中间件方法同样也可以支持依赖注入。
来个比较实际的例子,我们需要判断当前浏览器环境是在微信或支付宝
~~~
namespace app\middleware;
/**
* 访问环境检查,是否是微信或支付宝等
*/
class InAppCheck
{
public function handle($request, \Closure $next)
{
if (preg_match('~micromessenger~i', $request->header('user-agent'))) {
$request->InApp = 'WeChat';
} else if (preg_match('~alipay~i', $request->header('user-agent'))) {
$request->InApp = 'Alipay';
}
return $next($request);
}
}
~~~
然后在你的移动版的应用里添加一个`middleware.php`文件
例如:`/path/app/mobile/middleware.php`
~~~
return [
app\middleware\InAppCheck::class,
];
~~~
然后在你的`controller`中可以通过`request()->InApp`获取相关的值
## **定义中间件别名**
可以直接在应用配置目录下的`middleware.php`中先预定义中间件(其实就是增加别名标识),例如:
~~~
return [
'alias' => [
'auth' => app\middleware\Auth::class,
'check' => app\middleware\Check::class,
],
];
~~~
可以支持使用别名定义一组中间件,例如:
~~~
return [
'alias' => [
'check' => [
app\middleware\Auth::class,
app\middleware\Check::class,
],
],
];
~~~
# **注册中间件**
新版的中间件分为全局中间件、应用中间件(多应用模式下有效)、路由中间件以及控制器中间件四个组。执行顺序分别为:
>[info] 全局中间件->应用中间件->路由中间件->控制器中间件
## **路由中间件**
最常用的中间件注册方式是注册路由中间件
~~~
Route::rule('hello/:name','hello')
->middleware(\app\middleware\Auth::class);
~~~
支持注册多个中间件
~~~
Route::rule('hello/:name','hello')
->middleware([\app\middleware\Auth::class, \app\middleware\Check::class]);
~~~
可以直接在应用配置目录下的`middleware.php`中先预定义中间件(其实就是增加别名标识),例如:
~~~
return [
'auth' => app\middleware\Auth::class,
'check' => app\middleware\Check::class
];
~~~
然后直接在路由中使用中间件别名注册
~~~
Route::rule('hello/:name','hello')
->middleware(['auth', 'check']);
~~~
可以支持使用别名定义一组中间件,例如:
~~~
return [
'check' => [
app\middleware\Auth::class,
app\middleware\Check::class
],
];
~~~
然后,直接使用下面的方式注册中间件
~~~
Route::rule('hello/:name','hello')
->middleware('check');
~~~
支持对路由分组注册中间件
~~~
Route::group('hello', function(){
Route::rule('hello/:name','hello');
})->middleware('auth');
~~~
支持对某个域名注册中间件
~~~
Route::domain('admin', function(){
// 注册域名下的路由规则
})->middleware('auth');
~~~
如果需要传入额外参数给中间件,可以使用
~~~
Route::rule('hello/:name','hello')
->middleware('auth', 'admin');
~~~
如果需要定义多个中间件,使用数组方式
~~~
Route::rule('hello/:name','hello')
->middleware([Auth::class, 'Check']);
~~~
可以统一传入同一个额外参数
~~~
Route::rule('hello/:name','hello')
->middleware(['auth', 'check'], 'admin');
~~~
或者分开多次调用,指定不同的参数
~~~
Route::rule('hello/:name','hello')
->middleware('auth', 'admin')
->middleware('hello', 'thinkphp');
~~~
如果你希望某个路由中间件是全局执行(不管路由是否匹配),可以不需要在路由里面定义,支持直接在路由配置文件中定义,例如在`config/route.php`配置文件中添加:
~~~
'middleware' => [
app\middleware\Auth::class,
app\middleware\Check::class,
],
~~~
这样,所有该应用下的请求都会执行`Auth`和`Check`中间件。
## **使用闭包定义中间件**
你不一定要使用中间件类,在某些简单的场合你可以使用闭包定义中间件,但闭包函数必须返回`Response`对象实例。
~~~
Route::group('hello', function(){
Route::rule('hello/:name','hello');
})->middleware(function($request,\Closure $next){
if ($request->param('name') == 'think') {
return redirect('index/think');
}
return $next($request);
});
~~~
## **全局中间件**
全局中间件在`app`目录下面`middleware.php`文件中定义,使用下面的方式:
~~~
<?php
return [
\app\middleware\Auth::class,
'check',
'Hello',
];
~~~
中间件的注册应该使用完整的类名,如果已经定义了中间件别名(或者分组)则可以直接使用。
全局中间件的执行顺序就是定义顺序。可以在定义全局中间件的时候传入中间件参数,支持两种方式传入。
~~~
<?php
return [
[\app\http\middleware\Auth::class, 'admin'],
'Check',
['hello','thinkphp'],
];
~~~
上面的定义表示 给`Auth`中间件传入`admin`参数,给`Hello`中间件传入`thinkphp`参数。
## **应用中间件**
支持应用中间件定义,你可以直接在应用目录下面增加`middleware.php`文件,定义方式和全局中间件定义一样,只是只会在该应用下面生效。
## **控制器中间件**
支持为控制器定义中间件。只需要在控制器中定义`middleware`属性,例如:
~~~
<?php
namespace app\controller;
class Index
{
protected $middleware = ['auth'];
public function index()
{
return 'index';
}
public function hello()
{
return 'hello';
}
}
~~~
当执行`index`控制器的时候就会调用`auth`中间件,一样支持使用完整的命名空间定义。
如果需要设置控制器中间的生效操作,可以如下定义:
~~~
<?php
namespace app\controller;
class Index
{
protected $middleware = [
'auth' => ['except' => ['hello'] ],
'check' => ['only' => ['hello'] ],
];
public function index()
{
return 'index';
}
public function hello()
{
return 'hello';
}
}
~~~
## 中间件向控制器传参
可以通过给请求对象赋值的方式传参给控制器(或者其它地方),例如
~~~
<?php
namespace app\middleware;
class Hello
{
public function handle($request, \Closure $next)
{
$request->hello = 'ThinkPHP';
return $next($request);
}
}
~~~
然后在控制器的方法里面可以直接使用
~~~
public function index(Request $request)
{
return $request->hello; // ThinkPHP
}
~~~
# **内置中间件**
新版内置了几个系统中间件,包括:
| 中间件类 | 描述 |
| --- | --- |
| think\\middleware\\AllowCrossDomain | 跨域请求支持 |
| think\\middleware\\CheckRequestCache | 请求缓存 |
| think\\middleware\\LoadLangPack | 多语言加载 |
| think\\middleware\\SessionInit | Session初始化 |
| ~~think\\middleware\\TraceDebug~~ | ~~页面Trace支持~~ |
|think\middleware\FormTokenCheck|表单令牌|
这些内置中间件默认都没有定义,你可以在应用的`middleware.php`文件中、路由或者控制器中定义这些中间件,如果不需要使用的话,取消定义即可。
- 空白目录
- php语法结构
- 安装与更新
- 开启调试模式及代码跟踪器
- 架构
- 源码分析
- 应用初始化
- 请求流程
- 中间件源码分析
- 请求处理源码分析
- Request源码分析
- 模板编译流程
- 路由与请求流程
- 容器
- 获取目录位置
- 入口文件
- 多应用模式及URL访问
- 依赖注入与容器
- 容器属性及方法
- Container
- App
- facade
- 中间件(middleware)
- 系统服务
- extend 扩展类库
- 笔记
- 配置
- env配置定义及获取
- 配置文件的配置获取
- 单应用模式-(配置)文件目录结构(默认)
- 多应用模式(配置)文件目录结构(配置文件)
- 配置文件
- 应用配置:app.php
- 缓存配置: cache.php
- 数据库配置:database.php
- 路由和URL配置:route.php
- Cookie配置:cookie.php
- Session配置:session.php
- 命令行配置:console.php
- 多语言配置:lang.php
- 日志配置:log.php
- 页面Trace配置:trace.php
- 磁盘配置: filesystem.php
- 中间件配置:middleware.php
- 视图配置:view.php
- 改成用yaconf配置
- 事件
- 例子:省略事件类的demo
- 例子2:完整事件类
- 例子3:事件订阅,监听多个事件
- 解析
- 路由
- 路由定义
- 路由地址
- 变量规则
- MISS路由
- URL生成
- 闭包支持
- 路由参数
- 路由中间件
- 路由分组
- 资源路由
- 注解路由
- 路由绑定
- 域名路由
- 路由缓存
- 跨域路由
- 控制器
- 控制器定义
- 空控制器、空操作
- 空模块处理
- RESTFul资源控制器
- 控制器中间件
- 请求对象Request(url参数)
- 请求信息
- 获取输入变量($_POST、$_GET等)
- 请求类型的获取与伪装
- HTTP头信息
- 伪静态
- 参数绑定
- 请求缓存
- 响应对象Response
- 响应输出
- 响应参数
- 重定向
- 文件下载
- 错误页面的处理办法
- 应用公共文件common.php
- 模型
- 模型定义及常规属性
- 模型数据获取与模型赋值
- 查询
- 数据集
- 增加
- 修改
- 删除
- 条件
- 查询范围scope
- 获取器
- 修改器
- 搜索器
- 软删除
- 模型事件
- 关联预载入
- 模型关联
- 一对一关联
- 一对多关联
- 多对多关联
- 自动时间戳
- 事务
- 数据库
- 查询构造器
- 查询合集
- 子查询
- 聚合查询
- 时间查询
- 视图查询(比join简单)
- 获取查询参数
- 快捷方法
- 动态查询
- 条件查询
- 打印sql语句
- 增
- 删
- 改
- 查
- 链式操作
- 查询表达式
- 分页查询
- 原生查询
- JSON字段
- 链接数据库配置
- 分布式数据库
- 查询事件
- Db获取器
- 事务操作
- 存储过程
- Db数据集
- 数据库驱动
- 视图
- 模板
- 模板配置
- 模板位置
- 模板渲染
- 模板变量与赋值(assign)
- 模板输出替换
- url生成
- 模板详解
- 内置标签
- 三元运算
- 变量输出
- 函数输出
- Request请求参数
- 模板注释及原样输出
- 模板继承
- 模板布局
- 原生PHP
- 模板引擎
- 视图过滤
- 视图驱动
- 验证
- 验证进阶之最终版
- 错误和日志
- 异常处理
- 日志处理
- 调试
- 调试模式
- Trace调试
- SQL调试
- 变量调试
- 远程调试
- 杂项
- 缓存
- Session
- Cookie
- 多语言
- 上传
- 扩展说明
- N+1查询
- TP类库
- 扩展类库
- 数据库迁移工具
- Workerman
- think助手工具库
- 验证码
- Swoole
- request
- app
- Response
- View
- Validate
- Config
- 命令行
- 助手函数
- 升级指导(功能的添加与删除说明)
- siyucms
- 开始
- 添加页面流程
- 列表页加载流程
- 弹出框
- 基础控制器
- 基础模型
- 快速构建
- 表单form构建
- 表格table构建
- MakeBuilder
- 前端组件
- 日期组件
- layer 弹层组件
- Moment.js 日期处理插件
- siyucms模板布局
- 函数即其变量
- 前端页面
- $.operate.方法
- $.modal.方法:弹出层
- $.common.方法:通用方法
- 被cms重写的表格options
- 自定义模板
- 搜索框
- 自定义form表单
- 获取表单搜索参数并组装为url字符串