Go!PHP面向对象的现代AOP框架

PHP技术
119
0
0
2024-08-15

简介

AOP是一个现代的面向切面的框架,使用简单的PHP,具有丰富的功能,适用于新级别的软件开发。该框架允许在传统的面向对象的PHP代码中解决横切问题,为您的代码提供高效和透明的钩子系统。

特征

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

什么是AOP?

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

在AOP术语中,执行点被称为连接点。这些点的集合称为切入点,在连接点之前、之后或“周围”执行的新行为称为通知。你可以在Introduction部分阅读更多关于AOP的内容。

安装

AOP框架可以与composer一起安装。安装非常简单

Step 1 使用composer下载库

请composer下载最新版本的Go!AOP框架及其依赖项,运行以下命令:

composer require goaop/framework

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

Step 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)
    {
    }
}

Step 3 在前端控制器中配置aspect内核

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

Step 4 创建一个方面

方面是AOP哲学的关键元素。走!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)
    {
        echo 'Calling Before Interceptor for: ',
            $invocation,
            ' with arguments: ',
            json_encode($invocation->getArguments()),
            "<br>\n";
    }
}

很简单,不是吗?我们在这里声明,我们希望在执行Example类中的所有动态公共方法之前安装一个钩子。这是在注释#0的帮助下完成的#钩子可以是任何类型,你稍后会看到它们。但是我们不改变类Example中的任何代码!我能感受到你的惊讶。

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

要注册aspect,只需在内核的 configureAop() 方法中添加它的实例:

// app/ApplicationAspectKernel.php

use Aspect\MonitorAspect;

//...

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

//...

Step 6 可选配置

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

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