Xaop 正在参加 2020 年度 OSC 中国开源项目评选,请投票支持!
Xaop 在 2020 年度 OSC 中国开源项目评选 中已获得 {{ projectVoteCount }} 票,请投票支持!
投票让它出道
已投票
授权协议: BSD
开发语言: C/C++ PHP
操作系统: 跨平台
收录时间: 2018-09-13

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

    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")

      在方法体返回失败的时候回滚事务

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 可以使用 单个 * 去匹配任何类或者命名空间。

展开阅读全文

代码

的 Gitee 指数为
超过 的项目

Xaop 的相关博客

XAOP的使用示范例子

代码地址如下:<br>http://www.demodashi.com/demo/12976.html XAOP 一个简易的AOP(Android)应用框架。囊括了最实用的AOP应用...

PHP AOP 扩展 Xaop 现在支持属性 AOP 模式

支持属性AOP模式之前,Xaop仅支持方法的切入(文档注释注解模式 与 方法注入两种模式的 AOP),现在已经支持属性的AOP啦,下面来...

PHP的AOP扩展雨后春笋般的复活啦

Xaop PHP高性能的AOP扩展 功能特色 基于对象的文档注解AOP模式 方法注入AOP模式 框架 Yaf CSpeed Xannotation Phalcon 系统指...

快速上手系列--Android应用开发模板

Android应用开发模板 Android空壳模板工程,快速搭建(集成了XUI、XUtil、XAOP、XPage、XUpdate、XHttp2、友盟统计和walle多渠...

X-Library系列Android应用框架详解

自2017年初开始,我就致力于Android应用框架的研究,到2018年开始在Github上陆续开源系列作品,再到2019年收获我的第一个sta...

XPush 一个轻量级、可插拔的Android消息推送框架。一键集成推送(极光推送、友盟推送、华为、小米推送等),提供有效的保活机制,支持推送的拓展,充分解耦推送和业务逻辑

XPush 一个轻量级、可插拔的Android消息推送框架。一键集成推送(极光推送、友盟推送、华为、小米推送等),提供有效的保活机...

Xaop 的相关问答

还没有任何问答,马上提问

评论 (2)

加载中
打分: 还行
这得把源代码先预编译一次吧。
2018/09/23 20:17
回复
举报
扩展只需要编译扩展就可以,不需要重新编译PHP源码的,Xaop源码目录自带有 install脚本,只需要 sudo ./install 就可以自动化编译安装的。
2018/09/23 22:16
回复
举报
更多评论
2 评论
13 收藏
分享
返回顶部
顶部