Xaop PHP高性能的AOP扩展
功能特色
框架
-
Yaf
-
CSpeed
-
Xannotation
-
Phalcon
系统指令及其含义
安装
git clone https://github.com/liqiongfan/xaop.git
cd xaop
/usr/local/path_to_php/bin/phpize
./configure --with-php-config=/usr/local/path_to_php/bin/php-config
make -j && sudo make install
启用对应功能扩展需要在 php.ini 文件配置指令： xaop.aop_mode，如下：
; To enable the AOP mode
; 1 不启用AOP
; 2 文档注解AOP模式
; 3 方法注入AOP模式
xaop.aop_mode = 2
1、方法注入AOP模式:
<?php
class Swing
{
public function \_\_get($name)
{
echo '\_\_get<br>';
}
public function \_\_set($name, $value)
{
echo '\_\_set<br>';
}
}
// 注入前置AOP
Xaop::addBeforeAop(Swing::class, "\_\_get\*", function(){
echo '\_\_get\*\_before<br>';
});
// 注入后置AOP
Xaop::addAfterAop(Swing::class, "\_\_get\*", function(){
echo '\_\_get\*\_after<br>';
});
// 注入后置返回AOP(当方法返回不是null的内容后，此AOP生效)
Xaop::addAfterReturnAop(Swing::class, "\_\_get\*", function(){
echo '\_\_get\*\_after\_return<br>';
});
// 注入后置抛出异常AOP(当方法抛出异常的时候，此AOP生效)
Xaop::addAfterThrowAop(Swing::class, "\_\_get\*", function(){
echo '\_\_get\*\_after\_throw<br>';
});
// 注入环绕AOP(注意环绕AOP与其他的AOP不可同用，存在环绕AOP的情况下，一切以环绕AOP为准)
//Xaop::addAroundAop(NULL, "\_\_get\*", function($exec){
// echo '\_before<br>';
// var\_dump(Xaop::exec($exec));
// echo '\_after<br>';
//});
<?php
$swing = new Swing();
$swing->di;
//输出结果如下
\_\_get\*\_before
\_\_get
\_\_get\*\_after
**注意**
**Xaop** 支持 五种 **AOP** 模式，分别是 **前置AOP(addBeforeAop)**、**后置AOP(addAfterAop)**、**后置返回AOP(addAfterReturnAop)**、**后置异常AOP(addAfterThrowAop)**、**环绕AOP(addAroundAop)**
其中 **环绕AOP** 跟其他的 **AOP** 互斥，如果存在环绕 **AOP** ，系统将会优先以 **环绕AOP** 模式处理，并且 **环绕AOP** 回调函数存在一个参数： **$xaopExec** 的一个资源表示当前的方法上下文，环绕AOP模式下，如果不在环绕AOP方法内，调用 ：`Xaop::exec($xaopExec);` 那么实际的方法将会丢失，不会调用，在环绕模式下，实际方法需要开发者自行调用，并且在同个回调方法内，调用多次 `Xaop::exec($xaopExec);`，**仅生效一次**，重复调用无效。如：
Xaop::addAroundAop(NULL, "\_\_get\*", function($exec){
echo '\_before<br>';
Xaop::exec($exec); // 此处调用多次，Xaop自动拦截，只执行一次
echo '\_after<br>';
});
#### 2、基于对象调用的文档注解AOP模式:
<?php
/\*\*
\* Class Swing
\* @Aspect
\*/
class Swing
{
function \_magicGetBefore() {
echo '\_magicGetBefore()' . PHP\_EOL;
}
function \_magicGetAfter() {
echo '\_magicGetAfter()' . PHP\_EOL;
}
function \_magicSuccess() {
echo '\_magicSuccess()' . PHP\_EOL;
}
function \_magicFailure() {
echo '\_magicFailure()' . PHP\_EOL;
}
/\*\*
\* @before( value="Swing.\_magicGetBefore" )
\* @after( value="Swing.\_magicGetAfter" )
\* @success( value="Swing.\_magicSuccess" )
\*/
public function \_\_get($name)
{
echo '\_\_get' . PHP\_EOL;
return true;
}
/\*\*
\* @before( value="Swing.\_magicGetBefore" )
\* @after( value="Swing.\_magicGetAfter" )
\* @failure( value="Swing.\_magicFailure" )
\*/
public function \_\_set($name, $value)
{
echo '\_\_set' . PHP\_EOL;
return false;
}
}
示例1：
// 调用 \_\_get
$swing = new Swing();
$swing->di
输出结果如下：
\_magicGetBefore()
\_\_get
\_magicSuccess()
\_magicGetAfter()
示例2：
// 调用 \_\_set
$swing = new Swing();
$swing->di = "di";
输出结果如下：
\_magicGetBefore()
\_\_set
\_magicFailure()
\_magicGetAfter()
**Xaop** 目前 **基于对象的文档注解 AOP模式** ，如果使用 **静态调用(self::|parent::|static::|class)** 等都不会被捕捉，核心不进行捕捉的原因在于文档注解存在调用注解类的 `input`方法，而 `input`方法的第一个参数为类的对象，因此会额外增加一次对象的生成开销，为了减少对象生成开销，核心去除了静态方法的捕捉功能。
因为基于 **Zend 执行引擎**，所以不需要使用代理对象完成切面，**直接调用方法** 即可：
<?php
$swig = new Swing();
$swig->goodLists();
// 输出如下：
\_before goodLists
文档注解支持 **自定义注解** 与扩展 **内置注解**：
* **自定义注解**
自定义注解必须继承自 **Xaop\\Annotations** 接口，并且实现 **input** 方法即可，如下示例自定义了一个 **[@Tag](https://my.oschina.net/u/196791)** 注解：
namespace app;
use Xaop\\Annotations;
class Tag implements Annotations {
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](https://my.oschina.net/unicloud)**、**[@disable](https://my.oschina.net/u/3227561)**、**[@before](https://my.oschina.net/u/3870904)** 、**@after**、**@success**、**@failure**、 **@deprecated**
1. **@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\] \];
}
**注意：参数名区分大小写，参数值不区分大小写。**
2. **@disable**
使用本注解可以禁用类的方法，使用本注解修饰的方法，就不会调用，并且不会提示任何错误信息，直接返回，本注解不包含任何参数。
3. **@before**
前置通知，在方法之前执行本注解包含的方法：如：
@before(value="app\\models\\User.startTransaction")
使用场景：**在执行业务代码逻辑之前开启事务支持**
4. **@after**
后置通知，在方法之后执行本注解包含的方法：如：
@after(value="app\\log\\InvokeLog.record")
使用场景：**在接口调用之后进行日志记录**
5. **@success**
方法体返回 **true** 的时候调用的通知：如：
@success(value="app\\models\\User.commit")
使用场景：**在业务逻辑代码执行成功之后提交事务**
6. **@failure**
方法体返回 **false**之后调用的通知，如下：
@failure(value="app\\models\\User.rollback")
使用场景：**在业务逻辑代码方法体返回失败的时候回滚事务**
7. **@deprecated**
标注类的方法是**过期**方法，当调用此方法的时候，会提示一条 **E\_DEPRECATED** 的警告信息，需要在 php.ini 文件中开启
@deprecated