lisachenko/go-aop-php

该包已被废弃,不再维护。作者建议使用 goaop/framework 包。

PHP 面向切面编程框架。

资助包维护!
lisachenko

安装数: 173,839

依赖项: 5

建议者: 1

安全: 0

星标: 1,569

关注者: 86

分支: 145


README

Go! AOP 是一个纯 PHP 面向切面框架,具有丰富的功能,适用于新的软件开发水平。该框架通过提供高效且透明的钩子系统,允许在传统的面向对象的 PHP 代码中解决横切问题。

GitHub Workflow Status GitHub release Total Downloads Daily Downloads SensioLabs Insight Minimum PHP Version License

功能

  • 提供动态钩子系统,无需更改原始源代码。
  • 无需任何 PECL 扩展(php-aop、runkit、uopz)和 DI 容器即可工作。
  • 面向对象设计方面、切入点和切点。
  • 拦截类中任何公共或受保护方法的执行。
  • 拦截静态方法和最终类中的方法的执行。
  • 拦截特质中的方法的执行。
  • 拦截对象对公共/受保护属性的访问。
  • 静态类初始化钩子(在类被加载到 PHP 内存后)。
  • 对象初始化钩子(拦截 new 关键字)。
  • 拦截系统 PHP 函数的调用。
  • 通过 Around 类型的建议,可以更改任何方法/函数的返回值。
  • 丰富的切点语法,用于在源代码中定义切点。
  • 与 XDebug 的原生 AOP 调试。编织方面的代码完全可读且为原生。您可以在原始类或方面中设置断点,并且它将工作(在调试模式下)!
  • 可以与任何现有的 PHP 框架和库(带或不带额外配置)集成。
  • 高度优化以用于生产:支持 opcode 缓存、建议和方面的延迟加载、切入点缓存、不进行切点的运行时检查、不进行运行时注释解析、不使用 evals 和 __call 方法、不使用缓慢的代理和 call_user_func_array()。快速的引导过程(2-20ms)和建议调用。

什么是 AOP?

AOP(面向切面编程) 是一种处理横切关注点的技术,其中这些关注点以“模块化”的方式(即,具有适当的封装、无重复等)设计和实现,然后以简洁和稳健的方式集成到相关的执行点中,例如通过声明性或程序性手段。

在 AOP 术语中,执行点称为连接点。这些点的集合称为切点,在连接点之前、之后或“周围”执行的新行为称为建议。您可以在介绍部分中了解更多有关 AOP 的信息。

安装

Go! AOP 框架可以使用 composer 安装。安装相当简单

  1. 使用 composer 下载框架
  2. 创建应用程序方面内核
  3. 在前端控制器中配置方面内核
  4. 创建一个方面
  5. 在方面内核中注册方面

步骤 0(可选):在框架中尝试演示示例

让 composer 在空目录中创建新项目

composer create-project goaop/framework

之后,只需将您的 Web 服务器配置为 demos/ 文件夹,并在浏览器中打开它。然后您可以在深入了解将其安装到项目中之前查看一些演示示例。

步骤 1:使用 composer 下载库

运行命令以让 composer 下载包含其依赖项的最新版本的 Go! AOP 框架。

composer require goaop/framework

Composer 将框架安装到项目的 vendor/goaop/framework 目录。

步骤 2:创建应用程序方面内核

该框架的目的是为您的应用程序提供简单的 AOP 集成。您必须首先创建应用程序的 AspectKernel 类。此类将管理应用程序的所有方面。

框架提供基类,使其更容易创建自己的内核。要创建应用程序内核,扩展抽象类 Go\Core\AspectKernel

<?php
// app/ApplicationAspectKernel.php

use Go\Core\AspectKernel;
use Go\Core\AspectContainer;

/**
 * Application Aspect Kernel
 */
class ApplicationAspectKernel extends AspectKernel
{

    /**
     * Configure an AspectContainer with advisors, aspects and pointcuts
     *
     * @param AspectContainer $container
     *
     * @return void
     */
    protected function configureAop(AspectContainer $container)
    {
    }
}

3. 在前端控制器中配置方面内核

要配置方面内核,请调用内核实例的 init() 方法。

// front-controller, for Symfony2 application it's web/app_dev.php

include __DIR__ . '/vendor/autoload.php'; // use composer

// Initialize an application aspect container
$applicationAspectKernel = ApplicationAspectKernel::getInstance();
$applicationAspectKernel->init([
        'debug'        => true, // use 'false' for production mode
        'appDir'       => __DIR__ . '/..', // Application root directory
        'cacheDir'     => __DIR__ . '/path/to/cache/for/aop', // Cache directory
        // Include paths restricts the directories where aspects should be applied, or empty for all source files
        'includePaths' => [
            __DIR__ . '/../src/'
        ]
]);

4. 创建一个方面

方面是 AOP 哲学的关键元素。Go! AOP 框架仅使用简单的 PHP 类来声明方面,这使得可以使用 OOP 的所有功能。以一个例子来说,让我们拦截所有的方法并显示它们的名称

// Aspect/MonitorAspect.php

namespace Aspect;

use Go\Aop\Aspect;
use Go\Aop\Intercept\FieldAccess;
use Go\Aop\Intercept\MethodInvocation;
use Go\Lang\Annotation\After;
use Go\Lang\Annotation\Before;
use Go\Lang\Annotation\Around;
use Go\Lang\Annotation\Pointcut;

/**
 * Monitor aspect
 */
class MonitorAspect implements Aspect
{

    /**
     * Method that will be called before real method
     *
     * @param MethodInvocation $invocation Invocation
     * @Before("execution(public Example->*(*))")
     */
    public function beforeMethodExecution(MethodInvocation $invocation)
    {
        echo 'Calling Before Interceptor for: ',
            $invocation,
            ' with arguments: ',
            json_encode($invocation->getArguments()),
            "<br>\n";
    }
}

很简单,不是吗?我们在这里声明了,我们希望在类 Example 中所有动态公共方法执行之前安装一个钩子。这是通过使用注解 @Before("execution(public Example->*(*))") 实现的。钩子可以是任何类型,您稍后将会看到。但我们没有在类 Example 中更改任何代码!我现在可以感觉到您的惊讶。

5. 在方面内核中注册方面

要注册方面,只需将其实例添加到内核的 configureAop() 方法中

// app/ApplicationAspectKernel.php

use Aspect\MonitorAspect;

//...

    protected function configureAop(AspectContainer $container)
    {
        $container->registerAspect(new MonitorAspect());
    }

//...

6. 可选配置

6.1 自定义注解缓存

默认情况下,Go! AOP 使用 Doctrine\Common\Cache\FilesystemCache 进行注解缓存。但是,如果您需要使用任何其他缓存引擎进行注解,您可以通过应用程序方面内核的 annotationCache 配置选项来配置缓存驱动程序。唯一的要求是缓存驱动程序实现 Doctrine\Common\Cache\Cache 接口。

当部署到只读文件系统时,这非常有用。在这种情况下,您可以使用,例如,Doctrine\Common\Cache\ArrayCache 或基于内存的缓存驱动程序。

6.2 支持 Doctrine 实体织入(实验性,alpha)

由于Go! AOP为每个织入实体生成两套类,一个具体类和一个带有切入点代理的类,因此无法直接支持编织的实体。Doctrine将这两个类都解释为具体实体,并为它们分配相同的元数据,这会导致数据库和关系混乱(见https://github.com/goaop/framework/issues/327)。

因此,这个库提供了一个解决方案来处理Doctrine中的映射问题。解决方案是一个事件订阅者,即Go\Bridge\Doctrine\MetadataLoadInterceptor,它必须在您的项目中启动Doctrine时进行注册。有关如何操作的详细信息,请参阅http://docs.doctrine-project.org/projects/doctrine-orm/en/latest/reference/events.html

事件订阅者将修改生成的Go! Aop代理的元数据实体定义,将其作为映射的超类。这将解决您在编织Doctrine实体时可能遇到的问题。

7. 贡献

有关如何贡献更改的信息,请参阅贡献说明

文档

有关Go!库的文档可以在官方网站找到。如果您喜欢这个项目,可以通过Flattr this支持它。