adgoal/goaop-framework

PHP 面向切面编程框架。

2.2.1 2019-01-02 10:16 UTC

README

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

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

特性

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

AOP 是什么?

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

在 AOP 术语中,执行点称为连接点(join points)。一组这些点称为切点,而在连接点之前、之后或“周围”执行的新行为称为建议。你可以在 介绍 部分中了解更多关于 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)
    {
        $obj = $invocation->getThis();
        echo 'Calling Before Interceptor for method: ',
             is_object($obj) ? get_class($obj) : $obj,
             $invocation->getMethod()->isStatic() ? '::' : '->',
             $invocation->getMethod()->getName(),
             '()',
             ' 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());
    }

//...

现在,您可以随时使用方面的力量!尽情地更改任何地方。如果您喜欢这个项目,您可以支持它 Flattr this Gratipay

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实体的编织。Doctrine会将这两个类都解释为具体实体,并为它们分配相同的元数据,这会弄乱数据库和关系(参见goaop#327)。

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

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

7. 贡献

要贡献更改,请参阅Contribute Readme

文档

有关Go!库的文档可以在官方网站找到。