quickmobile / go-aop-php
PHP 面向切面编程库。
Requires
- php: >=5.4.0
- andrewsville/php-token-reflection: ~1.3
- doctrine/annotations: ~1.0
- jakubledl/dissect: ~1.0
Requires (Dev)
- symfony/console: ~2.1
Suggests
- symfony/console: Enables the usage of the command-line tool.
This package is not auto-updated.
Last update: 2024-09-24 17:08:59 UTC
README
Go! AOP 是一个纯 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 下载框架
- 创建应用程序方面内核
- 在前控制器中配置方面内核
- 创建方面
- 在方面内核中注册方面
步骤 1:使用 composer 下载库
运行以下命令让 composer 下载 Go! AOP 框架及其依赖项
$ composer require lisachenko/go-aop-php
Composer 将框架安装到您的项目目录 vendor/lisachenko/go-aop-php
。
步骤 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类来声明方面!因此,可以针对方面类使用所有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()); } //...
现在你可以使用方面的力量了!随意更改任何地方。如果你喜欢这个项目,你可以支持它
文档
有关Go!库的文档可以在官方网站找到。