goaop/framework

PHP面向切面编程框架。

资助包维护!
lisachenko

安装: 3,631,195

依赖项: 38

建议者: 2

安全: 0

星星: 1,658

关注者: 86

分支: 163

开放问题: 11


README

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

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

特性

  • 为 PHP 提供动态钩子系统,无需修改原始源代码。
  • 无需任何 PECL 扩展(php-aop、runkit、uopz)和 DI 容器即可工作。
  • 方面、切入点、切点的面向对象设计。
  • 拦截类中的任何公共或受保护方法的执行。
  • 拦截静态方法和最终类中的方法的执行。
  • 拦截 traits 中的方法的执行。
  • 拦截对象对公共/受保护属性的访问。
  • 静态类初始化钩子(在类加载到 PHP 内存后)。
  • 对象初始化钩子(拦截 new 关键字)。
  • 拦截系统 PHP 函数的调用。
  • 通过 Around 类型的建议,可以更改任何方法/函数的返回值。
  • 丰富的切入点语法,用于在源代码中定义切入点。
  • 与 XDebug 集成,提供 AOP 的原生调试。织入了方面的代码是可读的和本地的。您可以在原始类或方面中设置断点,它将工作(在调试模式下)!
  • 可以与任何现有的 PHP 框架和库(带或不带额外配置)集成。
  • 高度优化用于生产使用:支持 opcache、建议和方面的懒加载、切入点缓存、无需运行时检查切入点、无需运行时解析注解、无 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目录下。

第二步:创建应用程序方面内核

该框架的目的是为您的应用程序提供易于集成的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)
    {
    }
}

第三步:在前控制器中配置方面内核

要配置方面内核,请调用内核实例的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/'
        ]
]);

第四步:创建方面

方面是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中更改任何代码!我现在能感觉到你的惊讶。

第五步:在方面内核中注册方面

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

// app/ApplicationAspectKernel.php

use Aspect\MonitorAspect;

//...

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

//...

可选配置

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

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

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

第七步:贡献

要贡献更改,请参阅贡献Readme

文档

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