thinkphp5.1中用注解的方式实现:
稳定版:composer require cshaptx4869/thinkphp-annotation
最新版:composer require cshaptx4869/thinkphp-annotation:dev-master
tags.php
添加行为
‘action_begin‘ => [ \Fairy\ControllerAnnotationScaner::class ]
添加 system.php
配置文件(可选)
return [ ‘annotation‘ => [ ‘cache‘ => false,//是否开启注解读取缓存 ‘writelist‘ => []//注解读取白名单 ] ]
PS:默认验证器注解验证不通过会终止程序运行并返回
json
格式的验证错误信息。如果不想要默认输出可继承 \Fairy\ControllerAnnotationScaner 类并定义 getValidateErrorMsg($msg) 方法来获取验证错误信息,自定义后续处理。
v0.1.0 | ||
---|---|---|
注解名 | 申明范围 | 作用 |
@Autowire | 属性 | 自动注入类对象 |
@DynamicAutowire | 方法 | 声明当前方法允许属性注入的类 |
@IgnoreAutowire | 方法 | 声明当前方法忽略属性注入的类 |
@RequestParam | 方法 | 过滤、格式化请求参数 |
@Validator | 方法 | 验证器验证 |
dev-master | ||
---|---|---|
注解名 | 申明范围 | 作用 |
@Autowire | 属性 | 自动注入类对象 |
@Transaction | 方法 | 开启事务返回值等价于true就会自动commit,否则rollback |
@RequestParam | 方法 | 过滤、格式化请求参数 |
@Validator | 方法 | 验证器验证 |
ArticleController
控制器:
<?php namespace app\index\controller; use app\index\validate\Article\SaveValidate; use app\common\model\ArticleModel; // 引入对应的注解 use Fairy\Annotation\Autowire; use Fairy\Annotation\RequestParam; use Fairy\Annotation\Validator; use think\Request; class ArticleController { /** * 属性对象注入 * @Autowire()
* @var ArticleModel */ public $articleModel; /** * 数据验证 * clsss: thinkphp定义的验证器类名(必填) string类型 * scene: 验证场景名 string类型 * batch:是否批量验证 bool类型 * throw: 验证失败是否抛出异常 bool类型 * @Validator( * class="SaveValidate"::class, * scene="save", * batch=false, * throw=false * ) * * 获取参数 * fields: 定义要获取的字段名,可批量设置默认值 array类型 * mapping: 转换前台传递的字段名为自定义的字段名 array类型 * method: 获取参数的方法,支持get、post、put、delte string类型 * json: 格式化json字段的数据 array类型 * * json使用示例: * json:{field1,field2,...fieldn} * 表示格式化field1,field2,...,字段的json数据 * * 支持json一维和二维字段的涮选,如 * json:{field1:{childField1,childField2...}} * 表示格式化field1字段的json数据,并只获取field1字段下的childField1和childField2下标的值(支持深度一维和二维,会自动识别) * * @RequestParam( * fields={"title","image_url","content","category_id","is_temporary","extra":"默认值"}, * json={"category_id"}, * mapping={"image_url":"img_url"}, * method="post" * ) */ public function save(Request $request) { //获取过滤过后的参数 $postData = $request->requestParam; return MyToolkit::success($this->articleModel->store($postData)); } }
AaaModel 模型
<?php namespace app\common\model; use Fairy\Annotation\Autowire; use Fairy\Annotation\Transaction; use Fairy\ModelAnnotationScaner; use think\Db; use think\Model; class AaaModel extends Model { // 模型中使用Autowire注解的trait use ModelAnnotationScaner; /** * @Autowire() * @var AccountModel */ public $accountModel; /** * 注解控制事务 * 返回值等价于true commit 否则 rollback * @Transaction() */ public function store() { return Db::name(‘aaa‘)->insert([‘id‘ => 14, ‘username‘ => ‘bob‘]) > 0; } }
一些ide已经提供了对注释的支持,推荐安装,以便提供注解语法提示
原文:https://www.cnblogs.com/cshaptx4869/p/12178960.html