README

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

特性

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

AOP是什么？

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

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

安装

Go! AOP框架可以通过composer安装。安装非常简单。

使用composer下载框架
创建应用程序方面内核
在前控制器中配置方面内核
创建方面
在方面内核中注册方面

步骤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(array(
        'debug' => true, // use 'false' for production mode
        // Cache directory
        'cacheDir'  => __DIR__ . '/path/to/cache/for/aop',
        // Include paths restricts the directories where aspects should be applied, or empty for all source files
        'includePaths' => array(
            __DIR__ . '/../src/'
        )
));

4. 创建一个方面

方面是AOP哲学的关键元素。Go! AOP框架仅使用简单的PHP类来声明方面，这使得可以使用面向对象编程的所有功能来处理方面类。以一个示例来说明，我们将拦截所有方法并显示它们的名称

// 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());
    }

//...

现在您已经准备好使用方面的力量了！您可以随意更改任何地方。如果您喜欢这个项目，您可以通过以下方式支持它

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会将这两个类都解释为具体实体，并为它们分配相同的元数据，这将导致数据库和关系混乱（见 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. 贡献

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

文档

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

mingyuanyun / goaop-framework

维护者

详细信息