PHP如何实现Aop

PHP如何实现Aop

莫等闲
莫等闲
2年前

前言

在软件业,AOP为Aspect Oriented Programming的缩写,意为:面向切面编程,通过预编译方式和运行期间动态代理实现程序功能的统一维护的一种技术。AOP是OOP的延续,是软件开发中的一个热点,也是Spring框架中的一个重要内容,是函数式编程的一种衍生范型。利用AOP可以对业务逻辑的各个部分进行隔离,从而使得业务逻辑各部分之间的耦合度降低,提高程序的可重用性,同时提高了开发的效率。

至于什么是面向切面,面向切面的优势可以参考: https://zhuanlan.zhihu.com/p/421999882https://www.cnblogs.com/q1104460935/p/10044965.html

目前看来比较好的实现方式是代理类,代理类就是对原始类文件进行修改,并且通过自动加载加载代理类而非原始类从而实现切入。对于常驻内存型的应用,可以使用子进程扫描的方式直接生成代理类,非常驻型则需要提前生成好后将代理类的map缓存起来下次直接使用。

下面讲下基于PHP8原生注解和上述的思路实现的切面

代理类

先看下这个类

<?php

declare(strict_types=1);

namespace App\Http\Controllers;

use Next\Di\Annotations\Inject;
use Next\Routing\Annotations\Controller;
use Next\Routing\Annotations\GetMapping;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;

#[Controller(prefix: '/')]
class IndexController
{
    #[Inject]
    protected ServerRequestInterface $request;
    #[Inject]
    protected ResponseInterface      $response;

    #[GetMapping(path: '/')]
    #[Cacheable]
    public function index(): array
    {
        return $this->response->success(message: 'Hello, ' . $this->request->get('name', 'NextPHP') . '!');
    }
}

使用了类注解,属性注解,方法注解。和代理类相关的主要有属性注解和方法注解,来看下生成的代理类

<?php

declare (strict_types=1);

namespace App\Http\Controllers;

use Next\Cache\Aspects\Cacheable;
use Next\Di\Annotations\Inject;
use Next\Routing\Annotations\Controller;
use Next\Routing\Annotations\GetMapping;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
#[Controller(prefix: '/')]
class IndexController
{
    use \Next\Aop\ProxyHandler;
    use \Next\Aop\PropertyHandler;
    public function __construct()
    {
        $this->__handleProperties();
    }
    #[Inject]
    protected ServerRequestInterface $request;
    #[Inject]
    protected ResponseInterface $response;

    #[GetMapping(path: '/')]
    #[Cacheable]
    public function index() : array
    {
        return $this->__callViaProxy(__FUNCTION__, function () {
            return $this->response->success(message: 'Hello, ' . $this->request->get('name', 'NextPHP') . '!');
        }, func_get_args());
    }
}

对比上面的代码,可以发现由于使用了Inject和Cacheable注解,代理类多了构造方法,并且index方法的方法体被$this->__callViaProxy包裹了。在运行时实际加载的类文件是代理类,而不是原始类。那么如何实现这一过程呢,下面是hyperf的一段代码

$loaders = spl_autoload_functions();

// Proxy the composer class loader
foreach ($loaders as &$loader) {
    $unregisterLoader = $loader;
    if (is_array($loader) && $loader[0] instanceof ComposerClassLoader) {
        /** @var ComposerClassLoader $composerClassLoader */
        $composerClassLoader = $loader[0];
        AnnotationRegistry::registerLoader(function ($class) use ($composerClassLoader) {
            return (bool) $composerClassLoader->findFile($class);
        });
        $loader[0] = new static($composerClassLoader, $proxyFileDirPath, $configDir);
    }
    spl_autoload_unregister($unregisterLoader);
}

unset($loader);

// Re-register the loaders
foreach ($loaders as $loader) {
    spl_autoload_register($loader);
}

注册新的类加载器,而加载被代理的文件时会加载对应的代理类。下面是NextPHP的实现

/** @var Composer\Autoload\ClassLoader $loader */
unlink($proxyMap);
if (!file_exists($proxyMap)) {
    if (($pid = pcntl_fork()) == -1) {
        throw new ProcessException('Process fork failed.');
    }
    pcntl_wait($pid);
}
$loader->addClassMap($this->getProxyMap());
// 收集注解

思路:因为扫描注解过程会加载类文件,加载之后不能被重新加载(目前不知道咋实现,知道的可以讲下),所以采用子进程扫描生成代理类映射。如上代码,$proxyMap是代理类映射文件,内容例如下:

<?php 
return array (
  'App\\Http\\Controllers\\IndexController' => '/home/cheng/next/next-http-project/bin/../runtime/aop/proxy/App_Http_Controllers_IndexController_Proxy.php',
  'App\\Listeners\\DatabaseQueryListener' => '/home/cheng/next/next-http-project/bin/../runtime/aop/proxy/App_Listeners_DatabaseQueryListener_Proxy.php',
  'App\\Http\\Middlewares\\ExceptionHandlerMiddleware' => '/home/cheng/next/next-http-project/bin/../runtime/aop/proxy/App_Http_Middlewares_ExceptionHandlerMiddleware_Proxy.php',
);

当文件不存在的时候fork子进程,然后使用pcntl_wait等待子进程退出,接着走到$this->getProxyMap() 方法,方法内容如下:

protected function getProxyMap()
{
    if(代理类映射不存在) {
        // 收集注解
        // 生成代理类,并写入
        // 生成代理类映射,并写入文件
        exit;
    }
    
    // 返回代理类映射
}

如上伪代码,代理类不存在会导致子进程退出,而在上面的代码中事先将代理类映射删掉了,所以重启服务肯定会启动两个进程,一个扫描注解,生成代理类后退出,一个等待退出后直接加载代理类映射,当然框架中实现还添加了缓存,可以参考next/aop包。重新回到fork子进程的代码,可以看到$loader->addClassMap(), 代码如下:

public function addClassMap(array $classMap)
{
    if ($classMap) {
        $this->classMap = array_merge($this->classMap, $classMap);
    } else {
        $this->classMap = $classMap;
    }
}

将覆盖原始的类自动加载映射,至此代理类生成原理和代理方法介绍完毕,生成代理类需要使用"nikic/php-parser"包。

如何代理

接下来看到代理类的代码,控制器方法里添加了以下代码

public function __construct()
{
    $this->__handleProperties();
}

$this->__handleProperties() 主要是用来处理属性的,在注解扫描过程中会将符合条件的注解收集起来,这个方法会根据收集的注解,在实例化对象后将对应的属性使用对应的注解来处理,例如Inject注解,将容器中的实例注入到该属性中,因此在编写代码的时候不必要在构造方法中初始化值,都有代理类完成。这样的好处是你不必依赖容器或这其他服务来注入或者操作属性,直接使用new关键字实例化依然可以自动注入

被切入的方法

然后看到控制器方法index

public function index() : array
{
    return $this->__callViaProxy(__FUNCTION__, function () {
        return $this->response->success(message: 'Hello, ' . $this->request->get('name', 'NextPHP') . '!');
    }, func_get_args());
}

可以看到$this->__callVieProxy传递了三个参数,依次是本方法名,闭包(包含原方法体),原方法参数列表,走到这,就意味着这个方法被切入了。

来看下__callVieProxy方法:

protected function __callViaProxy(string $method, Closure $callback, array $parameters): mixed
{
    /** @var AspectInterface $aspect */
    $pipeline = array_reduce(
        array_reverse([...AspectCollector::getClassAspects(__CLASS__), ...AspectCollector::getMethodAspects(__CLASS__, $method)]),
        fn($stack, $aspect) => fn(JoinPoint $joinPoint) => $aspect->process($joinPoint, $stack),
        fn(JoinPoint $joinPoint) => $joinPoint->process()
    );
    return $pipeline(new JoinPoint($this, $method, $parameters, $callback));
}

方法很简单,将收集的该方法的切面,使用array_reduce处理。最终调用的方法在JoinPoint中,该对象包含所有元数据,例如对象,方法和方法参数,这些都是可以在切面类中拿到并且可以修改的,最终调用的方法如下

public function process(): mixed
{
    return call_user_func_array($this->callback, $this->parameters);
}

可以看到调用闭包并传递处理后的参数。

切面类实现如下

<?php

declare(strict_types=1);

namespace Next\Cache\Aspects;

use Closure;
use Next\Aop\Contracts\AspectInterface;
use Next\Aop\JoinPoint;
use Psr\Container\ContainerExceptionInterface;
use ReflectionException;

#[\Attribute(\Attribute::TARGET_METHOD)]
class TestRandom implements AspectInterface
{
    public function __construct(
        protected int     $ramdom = 0,
    )
    {
    }

    /**
     * @throws ContainerExceptionInterface
     * @throws ReflectionException
     */
    public function process(JoinPoint $joinPoint, Closure $next): mixed
    {
        echo 'before';
        $result = $next($joinPoint);
        echo 'after';
        return $result;
    }
}

可以看到调用方法和pipeline原理类似。构造方法的参数是可以通过使用注解的时候传递的。

总结

php的aop的重点:代理类生成,如何调用

浅薄理解,相对于其他框架的思路可能略显幼稚。感兴趣可以参与开发 next/aop: https://github.com/next-laboratory/aop

THE END

猜你喜欢

推荐了几个

查看更多

Nginx-基础总结

# 常规配置模板 ``` #user www www; worker_processes auto; error_log /home/wwwlogs/nginx_error.log crit; #pid /usr/loc

Windows下配置多版本PHP开发环境,自由切Composer

Windows下配置多个不同php版本共存是件麻烦事,之前一直使用WSL2, 由于WSL2读取windows文件速度极慢,所以需要将文件上传到WSL2内部,虽然PhpStorm支持自动上传,但是文件同步不是很好。于是切换到WSL1,读取速度

LNMP安装与配置

> 以下所有软件均安装在/usr/local目录,如果修改,需要注意配置文件中的路径。所有软件配置用户和用户组均为www,系统采用Ubuntu20或者Centos8 (opencloudos) 。 # linux 安装与配置:不赘述,一般

Windows服务管理

通常可以通过`运行` -> `services.msc` 启动Windows服务管理,但是可以做的操作有限,所以主要介绍下命令行下如何管理服务。因为需要管理员权限,所以通过以下步骤启动命令行/Powershell(管理员): `运行` ->

Mysql基础命令及语法笔记

# show 命令 > help show 查看允许的show语句 ```sql show databases show tables show [full] columns from <table> show create datab

npm & yarn 更换源等常用命令或操作

# npm > 由于node下载第三方依赖包是从国外服务器下载,虽然没有被墙,但是下载的速度是非常的缓慢且有可能会出现异常。 > 所以为了提高效率,我们还是把npm的镜像源替换成淘宝的镜像源。有几种方式供我们选择 ## 使用cnpm

PHP如何实现Aop

# 前言 在软件业,AOP为Aspect Oriented Programming的缩写,意为:面向切面编程,通过预编译方式和运行期间动态代理实现程序功能的统一维护的一种技术。AOP是OOP的延续,是软件开发中的一个热点,也是Spring

MongoDB学习笔记

# 优劣: 高性能、易部署、易使用,存储数据非常方便。 不支持连表查询,不支持sql语句,不支持事务存储过程等,所以不适合存储数据间关系比较复杂的数据,一般主要是当做一个**数据仓库**来使用。 **适用于**:日志系统,股票数据等。