## 概述
| 版本 | 新增功能 |
| --- | --- |
| 5.0.4 | 行为类的方法采用驼峰法命名 |
| | 行为绑定支持绑定到类的方法 |
行为(Behavior)是ThinkPHP扩展机制中比较关键的一项扩展,行为既可以独立调用,也可以绑定到某个标签中进行侦听,在官方提出的CBD模式中行为也占了主要的地位,可见行为在ThinkPHP框架中意义非凡。
这里指的行为是一个比较抽象的概念,你可以把行为想象成在应用执行过程中的一个动作或者处理。在框架的执行流程中,例如路由检测是一个行为,静态缓存是一个行为,用户权限检测也是行为,大到业务逻辑,小到浏览器检测、多语言检测等等都可以当做是一个行为,甚至说你希望给你的网站用户的第一次访问弹出Hello,world!这些都可以看成是一种行为,行为的存在让你无需改动框架和应用,而在外围通过扩展或者配置来改变或者增加一些功能。
而不同的行为之间也具有位置共同性,比如,有些行为的作用位置都是在应用执行前,有些行为都是在模板输出之后,我们把这些行为发生作用的位置称之为标签(位),当应用程序运行到这个标签的时候,就会被拦截下来,统一执行相关的行为,类似于AOP编程中的“切面”的概念,给某一个切面绑定相关行为就成了一种类AOP编程的思想。
## 行为标签位
在定义行为之前,我们先来了解下系统有哪些标签位,系统核心提供的标签位置包括下面几个(按照执行顺序排列):
| 标签位 | 描述 |
| --- | --- |
| `app_init` | 应用初始化标签位 |
| app\_begin | 应用开始标签位 |
| module\_init | 模块初始化标签位 |
| action\_begin | 控制器开始标签位 |
| view\_filter | 视图输出过滤标签位 |
| app\_end | 应用结束标签位 |
| log\_write | 日志write方法标签位 |
| log\_write\_done | 日志写入完成标签位(`V5.0.10+`) |
| response\_send | 响应发送标签位(`V5.0.10+`) |
| response\_end | 输出结束标签位(`V5.0.1+`) |
在每个标签位置,可以配置多个行为定义,行为的执行顺序按照定义的顺序依次执行。除非前面的行为里面中断执行了(某些行为可能需要中断执行,例如检测机器人或者非法执行行为),否则会继续下一个行为的执行。
> 除了这些系统内置标签之外,开发人员还可以在应用中添加自己的应用标签。
## 添加行为标签位
可以使用`\think\Hook`类的`listen`方法添加自己的行为侦听位置,例如:
~~~
Hook::listen('action_init');
~~~
可以给侦听方法传入参数(仅能传入一个参数),该参数使用引用传值,因此必须使用变量,例如:
~~~
Hook::listen('action_init',$params);
~~~
侦听的标签位置可以随意放置。
## 行为定义
行为类的定义很简单,定义行为的执行入口方法`run`即可,例如:
~~~
namespace app\index\behavior;
class Test
{
public function run(&$params)
{
// 行为逻辑
}
}
~~~
行为类并不需要继承任何类,相对比较灵活。
如果行为类需要绑定到多个标签,可以采用如下定义:
~~~
namespace app\index\behavior;
class Test
{
public function app_init(&$params)
{
}
public function app_end(&$params)
{
}
}
~~~
绑定到`app_init`和`app_end`后 就会调用相关的方法。
`V5.0.4+`版本以上,行为类的方法需要采用驼峰法命名,上面的行为类需要改成:
~~~
namespace app\index\behavior;
class Test
{
public function appInit(&$params)
{
}
public function appEnd(&$params)
{
}
}
~~~
## 行为绑定
行为定义完成后,就需要绑定到某个标签位置才能生效,否则是不会执行的。
使用Hook类的add方法注册行为,例如:
~~~
// 注册 app\index\behavior\CheckLang行为类到app_init标签位
Hook::add('app_init','app\\index\\behavior\\CheckLang');
//注册 app\admin\behavior\CronRun行为类到app_init标签位
Hook::add('app_init','app\\admin\\behavior\\CronRun');
~~~
如果要批量注册行为的话,可以使用:
~~~
Hook::add('app_init',['app\\index\\behavior\\CheckAuth','app\\index\\behavior\\CheckLang','app\\admin\\behavior\\CronRun']);
~~~
当应用运行到`app_init`标签位的时候,就会依次调用`app\index\behavior\CheckAuth`、`app\index\behavior\CheckLang`和`app\admin\behavior\CronRun`行为。如果其中一个行为中有中止代码的话则后续不会执行,如果返回`false`则当前标签位的后续行为将不会执行,但应用将继续运行。
我们也可以直接在`APP_PATH`目录下面或者模块的目录下面定义`tags.php`文件来统一定义行为,定义格式如下:
~~~
return [
'app_init'=> [
'app\\index\\behavior\\CheckAuth',
'app\\index\\behavior\\CheckLang'
],
'app_end'=> [
'app\\admin\\behavior\\CronRun'
]
]
~~~
如果`APP_PATH`目录下面和模块目录下面的`tags.php`都定义了app\_init的行为绑定的话,会采用合并模式,如果希望覆盖,那么可以在模块目录下面的`tags.php`中定义如下:
~~~
return [
'app_init'=> [
'app\\index\\behavior\\CheckAuth',
'_overlay'=>true
],
'app_end'=> [
'app\\admin\\behavior\\CronRun'
]
]
~~~
如果某个行为标签定义了`'_overlay' =>true` 就表示覆盖之前的相同标签下面的行为定义。
## 闭包支持
可以不用定义行为直接把闭包函数绑定到某个标签位,例如:
~~~
Hook::add('app_init',function(){
echo 'Hello,world!';
});
~~~
如果标签位有传入参数的话,闭包也可以支持传入参数,例如:
~~~
Hook::listen('action_init',$params);
Hook::add('action_init',function($params){
var_dump($params);
});
~~~
## 直接执行行为
如果需要,你也可以不绑定行为标签,直接调用某个行为,使用:
~~~
// 执行 app\index\behavior\CheckAuth行为类的run方法 并引用传入params参数
$result = Hook::exec('app\\index\\behavior\\CheckAuth','run',$params);
~~~
- 序言
- 基础
- 安装ThinkPHP
- 开发规范
- 目录结构
- 架构
- 架构总览
- 生命周期
- 入口文件
- URL访问
- 模块设计
- 命名空间
- 自动加载
- Traits引入
- API友好
- 配置
- 配置目录
- 配置格式
- 配置加载
- 读取配置
- 动态配置
- 独立配置
- 配置作用域
- 环境变量配置
- 路由
- 路由模式
- 路由定义
- 批量注册
- 变量规则
- 组合变量
- 路由参数
- 路由地址
- 资源路由
- 快捷路由
- 路由别名
- 路由分组
- MISS路由
- 闭包支持
- 路由绑定
- 绑定模型
- 域名路由
- URL生成
- 控制器
- 控制器定义
- 控制器初始化
- 前置操作
- 跳转和重定向
- 空操作
- 空控制器
- 多级控制器
- 分层控制器
- Rest控制器
- 自动定位控制器
- 资源控制器
- 请求
- 请求信息
- 输入变量
- 更改变量
- 请求类型
- 请求伪装
- HTTP头信息
- 伪静态
- 方法注入
- 属性注入
- 参数绑定
- 依赖注入
- 请求缓存
- 数据库
- 连接数据库
- 基本使用
- 查询构造器
- 查询数据
- 添加数据
- 更新数据
- 删除数据
- 查询方法
- 查询语法
- 链式操作
- where
- table
- alias
- field
- order
- limit
- page
- group
- having
- join
- union
- distinct
- lock
- cache
- comment
- fetchSql
- force
- bind
- partition
- strict
- failException
- sequence
- 聚合查询
- 时间查询
- 高级查询
- 视图查询
- 子查询
- 原生查询
- 查询事件
- 事务操作
- 监听SQL
- 存储过程
- 数据集
- 分布式数据库
- 模型
- 定义
- 模型初始化
- 新增
- 更新
- 删除
- 查询
- 聚合
- 获取器
- 修改器
- 时间戳
- 只读字段
- 软删除
- 类型转换
- 数据完成
- 查询范围
- 模型分层
- 数组访问和转换
- JSON序列化
- 事件
- 关联
- 一对一关联
- 一对多关联
- 远程一对多
- 多对多关联
- 多态关联
- 动态属性
- 关联预载入
- 关联统计
- 聚合模型
- 视图
- 视图实例化
- 模板引擎
- 模板赋值
- 模板渲染
- 输出替换
- 模板
- 模板定位
- 模板标签
- 变量输出
- 系统变量
- 请求参数
- 使用函数
- 使用默认值
- 使用运算符
- 三元运算
- 原样输出
- 模板注释
- 模板布局
- 模板继承
- 包含文件
- 标签库
- 内置标签
- 循环输出标签
- 比较标签
- 条件判断
- 资源文件加载
- 标签嵌套
- 原生PHP
- 定义标签
- 日志
- 介绍
- 日志驱动
- 日志写入
- 独立日志
- 日志清空
- 写入授权
- 错误和调试
- 调试模式
- 异常处理
- 抛出异常
- Trace调试
- 变量调试
- 性能调试
- SQL调试
- 远程调试
- 404页面
- 验证
- 验证器
- 验证规则
- 错误信息
- 验证场景
- 控制器验证
- 模型验证
- 内置规则
- 静态调用
- 表单令牌
- 安全
- 输入安全
- 数据库安全
- 上传安全
- 其它安全建议
- 杂项
- 缓存
- Session
- Cookie
- 多语言
- 分页
- 上传
- 验证码
- 图像处理
- 文件处理
- 单元测试
- 扩展
- 函数
- 类库
- 行为
- 驱动
- Composer包
- Time
- 数据库迁移工具
- Workerman
- MongoDb
- SAE
- 标签扩展
- 命令行
- 自动生成目录结构
- 创建类库文件
- 生成类库映射文件
- 生成路由缓存
- 清除缓存文件
- 生成配置缓存文件
- 生成数据表字段缓存
- 自定义命令行
- 部署
- 虚拟主机环境
- Linux 主机环境
- URL重写
- 附录
- 配置参考
- 常量参考
- 助手函数
- 升级指导
- 更新日志