白い光線が、柔らかな赤い縁の光をまとった透明なガラスブロックをまっすぐ通り抜ける。
機能 · ピュア PHP

拡張モジュールなし。ブラックボックスなし。PHP だけ。

フレームワークは Composer で動き、振る舞いを付け加えた普通の PHP ファイルを生成します。読むのも、デバッグするのも、実行するのも、いつものツールでできます。

PHP 拡張モジュール不要

コンパイラーは PHP で書かれています。

フレームワークは普通の Composer パッケージとして動作します。クラスを解析し、ルールと照合して、振る舞いを付け加えた新しい PHP ソースを生成します。独自の拡張モジュールをインストール、有効化、再ビルドする必要はありません。

開発時は、クラスが最初に読み込まれたときにウィービングされます。本番環境では、デプロイ時やイメージのビルド時に cache:warmup:aop で一度だけコンパイルします。リクエストは生成された PHP ファイルを include するだけです。

  • 独自の拡張モジュールは不要。必要なのは 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 のソースを生成します。ウィービングされたクラスごとにキャッシュに 2 つのファイルができ、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);
        
        
        
      
        
        
            }
        
        
        
      
        
        
        }
        
        
        
      

ウィービング後のソース

クラスの本体は、トレイト OrderServiceOriginalTrait になります。変わるのは宣言の行だけなので、行番号はそのままで、Xdebug のブレークポイントも止まります。追加された 1 行がプロキシを読み込みます。

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 のまま、トレイトを use します。振る舞いを持つ各メソッドは、それをミドルウェアとして実行し、private なエイリアスを通して元のメソッドを呼びます。

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+クリックで振る舞いへ
        
        
      
        
        
                    ],
        
        
        
      
        
        
                    $this->placeOrderOriginalAlias(...),
        元のメソッド
        
        
      
        
        
                );
        
        
        
      
        
        
                return $__joinPoint->__invoke($this, [$cart]);
        
        
        
      
        
        
            }
        
        
        
      
        
        
        }
        
        
        
      
静的な PHP ファイル

PHPStan が理解できるオブジェクト指向のコード

ウィービングされたコードは型付きのシグネチャを持つクラスとトレイトで、間にマジックメソッドは挟まりません。各ジョインポイントはジェネリクスの docblock を持つため、キャッシュディレクトリの中でも、PHPStan と IDE は $__joinPoint->__invoke() が Order を返すことを把握できます。

  • クラス名、final キーワード、型付きのシグネチャはそのまま
  • 実行されるものはすべてキャッシュ内のファイルで、__call() による間接呼び出しはなし
  • ジョインポイントは @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 を参照してください。