一道白光径直穿过一块透明玻璃,玻璃边缘泛着红色光晕。
特性 · 纯 PHP

无需扩展,没有黑盒,只有 PHP。

框架通过 Composer 安装,生成挂接了你的行为的普通 PHP 文件。用你已经在用的工具阅读、调试和运行它们。

无需 PHP 扩展

编译器本身用 PHP 编写。

框架就是一个普通的 Composer 包。它解析你的类,按你的规则进行匹配,生成挂接了行为的新 PHP 源码。无需安装、启用或重新编译任何自定义扩展。

在开发环境中,类在首次加载时织入。在生产环境中,用 cache:warmup:aop 在部署或构建镜像时一次性编译好。请求只需 include 生成的 PHP 文件。

  • 无需自定义扩展:只依赖 PHP 内置的 tokenizer 扩展。
  • PHP 升级后无需重新编译:安装兼容的 Composer 依赖,再预热缓存即可。
  • 处处同一个编译器:开发、CI 和生产环境。
  • 只读的生产环境:预先生成的文件可以在只读文件系统上运行。
index.php生产

        
        
        <?php
        
        
        
      
        
        
         
        
        
        
      
        
        
        use Go\Aop\Features;
        
        
        
      
        
        
         
        
        
        
      
        
        
        include __DIR__ . '/../vendor/autoload.php';
        
        
        
      
        
        
         
        
        
        
      
        
        
        ApplicationAspectKernel::getInstance()->init([
        
        
        
      
        
        
            'debug'        => false,
        
        
        
      
        
        
            'appDir'       => __DIR__ . '/..',
        
        
        
      
        
        
            'cacheDir'     => __DIR__ . '/../var/cache/aop',
        
        
        
      
        
        
            'includePaths' => [__DIR__ . '/../src'],
        
        
        
      
        
        
            'features'     => Features::PREBUILT_CACHE,
        
        
        
      
        
        
        ]);
        
        
        
      
Terminal部署

        
        
        # install: the weaver is a Composer package
        
        
        
      
        
        
        composer require goaop/framework
        
        
        
      
        
        
        # deploy: weave the whole cache once
        
        
        
      
        
        
        vendor/bin/aspect cache:warmup:aop public/index.php
        
        
        
      
不用 eval()

生成的 PHP,像其他文件一样加载。

框架生成 PHP 源码,而不是执行字符串里的代码。每个织入的类在缓存中生成两个文件,通过 PHP 标准的 include 加载。OPcache 像对待其他 PHP 文件一样处理它们,生成的每一行都可以查看和调试。

你的源码

一个事务行为挂接在 placeOrder() 上。你的文件保持你写下时的原样。

OrderService.php你的代码

        
        
        <?php
        
        
        
      
        
        
         
        
        
        
      
        
        
        declare(strict_types=1);
        
        
        
      
        
        
         
        
        
        
      
        
        
        namespace App\Order;
        
        
        
      
        
        
         
        
        
        
      
        
        
        final class OrderService
        
        
        
      
        
        
        {
        
        
        
      
        
        
            public function __construct(
        
        
        
      
        
        
                private readonly OrderRepository $orders,
        
        
        
      
        
        
            ) {}
        
        
        
      
        
        
         
        
        
        
      
        
        
            public function placeOrder(Cart $cart): Order
        
        
        
      
        
        
            {
        
        
        
      
        
        
                return $this->orders->create($cart);
        
        
        
      
        
        
            }
        
        
        
      
        
        
        }
        
        
        
      

织入后的源码

你的类体,成为 trait OrderServiceOriginalTrait。只有声明这一行有变化,所以行号保持一致,Xdebug 断点照常触发。新增的一行负责加载代理类。

OrderServiceOriginalTrait.php织入后

        
        
        <?php
        
        
        
      
        
        
         
        
        
        
      
        
        
        declare(strict_types=1);
        
        
        
      
        
        
         
        
        
        
      
        
        
        namespace App\Order;
        
        
        
      
        
        
         
        
        
        
      
        
        
        trait OrderServiceOriginalTrait
        原为:final class OrderService
        
        
      
        
        
        {
        
        
        
      
        
        
            public function __construct(
        
        
        
      
        
        
                private readonly OrderRepository $orders,
        
        
        
      
        
        
            ) {}
        
        
        
      
        
        
         
        
        
        
      
        
        
            public function placeOrder(Cart $cart): Order
        
        
        
      
        
        
            {
        
        
        
      
        
        
                return $this->orders->create($cart);
        
        
        
      
        
        
            }
        
        
        
      
        
        
        }
        
        
        
      
        
        
        include_once AOP_CACHE_DIR . '/src/Order/OrderService.php';
        
        
        
      

代理类

PHP 实际加载的类:沿用你的类名,依然是 final,并使用这个 trait。每个带有行为的方法先以中间件的方式运行行为,再通过私有别名调用你的原始方法。

OrderService.php生成

        
        
        <?php
        
        
        
      
        
        
        declare(strict_types=1);
        
        
        
      
        
        
        namespace App\Order;
        
        
        
      
        
        
        use Go\Aop\Framework\InterceptorInjector;
        
        
        
      
        
        
        use Go\Aop\Framework\Interceptor;
        
        
        
      
        
        
        use Go\Aop\Framework\The;
        
        
        
      
        
        
        use Go\Aop\Intercept\DynamicMethodInvocation;
        
        
        
      
        
        
        use App\Aspect\TransactionAspect;
        
        
        
      
        
        
        final class OrderService implements \Go\Aop\Proxy
        同名,依然 final
        
        
      
        
        
        {
        
        
        
      
        
        
            use OrderServiceOriginalTrait {
        你的类体
        
        
      
        
        
                OrderServiceOriginalTrait::placeOrder as private placeOrderOriginalAlias;
        
        
        
      
        
        
            }
        
        
        
      
        
        
            public function placeOrder(\App\Order\Cart $cart): \App\Order\Order
        
        
        
      
        
        
            {
        
        
        
      
        
        
                /** @var DynamicMethodInvocation<self, \App\Order\Order> $__joinPoint */
        为 PHPStan 和 IDE 标注类型
        
        
      
        
        
                static $__joinPoint = InterceptorInjector::forMethod(
        
        
        
      
        
        
                    self::class,
        
        
        
      
        
        
                    'placeOrder',
        
        
        
      
        
        
                    [
        
        
        
      
        
        
                        Interceptor::around(The::aspect(TransactionAspect::class)->inTransaction(...)),
        Ctrl-click 打开行为
        
        
      
        
        
                    ],
        
        
        
      
        
        
                    $this->placeOrderOriginalAlias(...),
        你的原始方法
        
        
      
        
        
                );
        
        
        
      
        
        
                return $__joinPoint->__invoke($this, [$cart]);
        
        
        
      
        
        
            }
        
        
        
      
        
        
        }
        
        
        
      
静态 PHP 文件

PHPStan 读得懂的面向对象代码

织入后的代码由带类型化签名的类和 trait 组成,中间没有任何魔术方法。每个 joinpoint(连接点)都带有泛型 docblock,所以 PHPStan 和你的 IDE 知道 $__joinPoint->__invoke() 返回的是 Order,即使在缓存目录里也一样。

  • 保留你的类名、final 关键字和类型化签名
  • 运行的一切都是缓存中的文件,没有 __call() 间接调用
  • Joinpoint 声明 @template 类型,例如 MethodInvocation<OrderService, Order>
  • 缓存路径与源码一一对应,审查者和扫描工具能找到每个文件
OrderService.php类型信息

        
        
            public function placeOrder(\App\Order\Cart $cart): \App\Order\Order
        
        
        
      
        
        
            {
        
        
        
      
        
        
                /** @var DynamicMethodInvocation<self, \App\Order\Order> $__joinPoint */
        
        
        
      
        
        
                static $__joinPoint = InterceptorInjector::forMethod(
        
        
        
            static $__joinPoint
            DynamicMethodInvocation<OrderService, Order>__invoke(…): Order
            来自织入文件中的 @var docblock
          
      
        
        
                    self::class,
        
        
        
      
        
        
                    'placeOrder',
        
        
        
      
        
        
                    [
        
        
        
      
        
        
                        Interceptor::around(The::aspect(TransactionAspect::class)->inTransaction(...)),
        
        
        
      
        
        
                    ],
        
        
        
      
        
        
                    $this->placeOrderOriginalAlias(...),
        
        
        
      
        
        
                );
        
        
        
      
        
        
                return $__joinPoint->__invoke($this, [$cart]);
        
        
        
      
        
        
            }
        
        
        
      
Project缓存目录

        
        
        var/cache/aop/
        
        
        
      
        
        
        ├── _include.cache                         # class map for Composer
        
        
        
      
        
        
        └── src/
        
        
        
      
        
        
            ├── Aspect/
        
        
        
      
        
        
            │   └── TransactionAspect.cache.php    # compiled pointcuts of the behavior
        
        
        
      
        
        
            └── Order/
        
        
        
      
        
        
                ├── OrderService.php               # proxy class
        
        
        
      
        
        
                └── OrderServiceOriginalTrait.php  # your class body
        
        
        
      

织入后的方法以一等可调用对象(first-class callable)的形式直接调用你的行为,所以 IDE 可以直接跳转过去。详见 README。