Xaop高性能 PHP AOP 扩展
Xaop —— PHP高性能的AOP扩展
功能特色
文档注解AOP模式
方法注入AOP模式
启用对应功能扩展需要在 php.ini 文件配置指令: xaop.aop_mode,如下:
; To enable the AOP mode ; 1 不启用AOP ; 2 文档注解AOP模式 ; 3 方法注入AOP模式 xaop.aop_mode = 3
1、文档注解AOP模式 DEMO:
<?php /** *@Aspect */ class Swing { public function _before() { echo '_before'; } /** *@before(value="Xaop._before") */ public function goodLists() { echo 'goodLists'; } }
因为基于 ZendOPcode,所以不需要使用代理对象完成切面,直接调用方法 即可:
<?php $swig = new Swing(); $swig->goodLists(); // 输出如下: _before goodLists
文档注解支持 自定义注解 与扩展 内置注解:
-
自定义注解
自定义注解必须继承自 Xaop\Annotation 接口,并且实现 input 方法即可,如下示例自定义了一个 @Tag 注解:
namespace app; use Xaop\Annotation; class Tag implements Annotation { function input($object, $annotations) { var_dump($object); foreach($annotations as $key => $val) { echo $key . '=' . $val . PHP_EOL; } } }
使用的时候只需要传入全名即可:
<?php /** * @Aspect */ class Swing { /** * @app\Tag( money = 5000, user = "Xaop" ) */ public function getMoney() { } }
-
内置注解
内置强大的六个专用注解: @api、@disable、@before 、@after、@success、@failure
-
@api
开发 API 推荐使用,使用本注解,直接可以向客户端返回 JSON 或者 XML 数据,只需要在修饰的方法体返回数据数据即可,注解包含两个参数:
type 与 charset, 如下使用:
/** *@api(type=JSON, charset=UTF-8) */ public function newLists() { return [ ['12' => {xxx,xxx}], ['23'=>{xxx,xxx}] ]; }
或者
/** *@api(type=xml, charset=UTF-8) */ public function newLists() { return [ ['12' => {xxx,xxx}], ['23'=>{xxx,xxx}] ]; }
注意:参数名区分大小写,参数值不区分大小写。
-
@disable
使用本注解可以禁用类的方法,使用本注解修饰的方法,就不会调用,并且不会提示任何错误信息,直接返回,本注解不包含任何参数。
-
@before
前置通知,在方法之前执行本注解包含的方法:如:
@before(value="app\models\User.startTransaction")
在执行之前开启事务支持
-
@after
后置通知,在方法之后执行本注解包含的方法:如:
@after(value="app\log\InvokeLog.record")
在接口调用之后进行日志记录
-
@success
方法体返回 true 的时候调用的通知:如:
@success(value="app\models\User.commit")
在方法执行成功之后提交事务
-
@failure
方法体返回 false之后调用的通知,如下:
@failure(value="app\models\User.rollback")
在方法体返回失败的时候回滚事务
2、方法注入AOP模式 DEMO:
仅支持 前置注入与后置注入 模式,环绕模式正在开发:
<?php class Swing { public function _before() { echo '_before'; } public function getLists() { echo 'getLists'; } } // 在所有的 Swing类中,以 getLists开头的方法调用的时候都会调用 Swing类的 _before 方法 \Xaop::addBeforeAop(Swing::class, "getLists*", [ Swing::class, '_before' ]); // 后置注入 // \Xaop::addAfterAop(Swing::class, "getLists*", [ Swing::class, '_after' ]);
调用即可:
$swing = new Swing(); $swing->getLists(); // 输出如下: _before getLists
Xaop APIs
前置注入:addBeforeAop
public function addBeforeAop($className, $funtionName, $callback = [ ])
后置注入:addAfterAop
public function addAfterAop($className, $funtionName, $callback = [ ])
注意:
$className与$functionName支持模糊匹配模式,使用 * 代替任意字符,并且只能存在一个 * 符号,存在多个 * 符号会报错,如下示例:
<?php namespace app; class Swing { public function _before() { echo 'before'; } public function views() { echo 'views'; } } // 给 Swing 类的 views 方法增加前置注入 \Xaop::addBeforeAop(Swing::class, 'views', [ Swing::class, '_before' ] ); // 给 Swing 类中,以 v 开头的方法增加前置注入 \Xaop::addBeforeAop(Swing::class, 'v*', [ Swing::class, '_before' ]); // 给以 app 开头的命名空间并且方法以 v 开头的增加前置注入 \Xaop::addBeforeAop("app*", 'v*', [ Swing::class, '_before' ]);
[警告⚠️]:如果 $functionName 仅仅存在 字符 *
, 此时系统会直接终止,由于 *
匹配任何方法,当你匹配方法的时候,如果仅仅使用 *
去匹配任何方法,那么会造成闭合调用(调用本方法之前都调用本方法),造成PHP内核终止。之所以保留单个 *
字符,是因为 $className 可以使用 单个 *
去匹配任何类或者命名空间。