vasilevit / goaop_framework
PHP 面向切面编程框架。
Requires
- php: ^8
- doctrine/annotations: ^1.11.1
- doctrine/cache: ^1.10
- goaop/parser-reflection: ^4
- jakubledl/dissect: ~1.0
- laminas/laminas-code: ^4.0
- symfony/finder: ^4.4|^5.1
Requires (Dev)
- adlawson/vfs: ^0.12.1
- doctrine/orm: ^2.5
- phpstan/phpstan: ^0.12.64
- phpunit/phpunit: ^9.5
- symfony/console: ^4.4|^5.1
- symfony/filesystem: ^4.4|^5.1
- symfony/process: ^4.4|^5.1
- webmozart/glob: ^4.1
Suggests
- symfony/console: Enables the usage of the command-line tool.
This package is auto-updated.
Last update: 2024-08-29 12:26:45 UTC
README
Go! AOP 是一个纯 PHP 编写的现代面向切面编程框架,具有丰富的功能,为软件开发的新水平提供支持。该框架通过为现有代码提供高效且透明的钩子系统,允许通过传统的面向对象 PHP 代码解决横切问题。
特性
- 为 PHP 提供动态钩子系统,无需更改原始源代码。
- 无需任何 PECL 扩展(php-aop、runkit、uopz)和 DI 容器即可工作。
- 面向对象设计方面、切入点和对切点。
- 拦截类中任何公共或受保护的方法的执行。
- 拦截静态方法和最终类中的方法的执行。
- 拦截 traits 中的方法的执行。
- 拦截对对象公共/受保护属性的访问。
- 静态类初始化钩子(在类被加载到 PHP 内存中之后)。
- 对象初始化钩子(拦截
new
关键字)。 - 拦截系统 PHP 函数的调用。
- 通过
Around
类型的建议,可以更改任何方法/函数的返回值。 - 丰富的点切语法,可用于在源代码中定义点切。
- 与 XDebug 集成进行 AOP 原生调试。织入方面的代码完全可读且是本地的。你可以在原始类或方面中设置断点,并且它将工作(在调试模式下)!
- 可以与任何现有的 PHP 框架和库(带或不带附加配置)集成。
- 高度优化以用于生产:支持 opcode 缓存、建议和方面的懒加载、切入点缓存、不执行点切的运行时检查、不解析运行时注解、无 evals 和
__call
方法、无慢速代理和call_user_func_array()
。快速引导过程(2-20ms)和建议调用。
AOP 是什么?
AOP (面向切面编程) 是一种处理横切关注点的技术,这些关注点以“模块化”的方式(即,通过适当的封装、无重复等)设计和实现,然后以简洁和可靠的方式集成到所有相关的执行点,例如通过声明性或程序性方法。
在 AOP 术语中,执行点称为切入点。这些点的集合称为切入点,在切入点之前、之后或“周围”执行的新行为称为建议。你可以在 简介 部分中了解更多关于 AOP 的信息。
安装
Go! AOP 框架可以使用 composer 进行安装。安装相当简单
- 使用 composer 下载框架
- 创建应用程序方面内核
- 在入口控制器中配置方面内核
- 创建方面
- 在方面内核中注册方面
步骤 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实体。Doctrine将这两个类都解释为具体实体,并为它们分配相同的元数据,这会搞乱数据库和关系(请参阅goaop#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!库的文档可以在官方站点找到。如果您喜欢这个项目,您可以通过支持它。