PHP实现动态代理及AOP

先看下PHP静态代理特点

• 继承型静态代理
  • 需要手动编写管理大量(一对一)的代理类
  • 代理对象可以通过类型声明检查
• 非继承型静态代理
  • 只用写一个代理类
  • 代理对象无法通过类型声明检查

其实对于PHP来说，动态代理解决的核心问题是不想手动写很多的代理类，又想使用强类型声明的便利性。
比如在自动注入中，需要根据类型声明来匹配对象。此时，非继承型静态代理就无法满足，而继承型则需要为每一个目标类创建一个代理类，动态代理便是在运行时自动完成代理类生成。

如果我们把动态代理结合到容器和注入服务，在代理方法中去触发切面钩子，便可以实现PHP的AOP支持。从而在不修改原功能代码的情况下对其执行实现扩展增强。

整体demo见gitee：https://gitee.com/VwenX/php-dynamic-proxy-and-aop_demo

部分代码及示例

DynamicProxy.php 负责生成、加载代理类、提供代理实例

cglibProxyTargetObj = $target; }
${functionList}
}
';

    // 代理类关系
    private static array $classProxyMap = [];


    public static function getProxy(object $obj)
    {
        $className = '\\' . get_class($obj);

        $proxyClassName = self::getProxyClassName($className);

        return new ($proxyClassName)($obj);
    }

    private static function getProxyClassName(string $targetClassName): string
    {
        $proxyClassName = self::$classProxyMap[$targetClassName] ?? null;
        if ($proxyClassName !== null){
            return $proxyClassName;
        }

        $proxyClass = self::genProxyClass($targetClassName);

        // 加载类
        eval($proxyClass['body']);

        $proxyClassName = $proxyClass['name'];
        self::$classProxyMap[$targetClassName] = $proxyClassName;

        return $proxyClassName;
    }


    private static function genProxyClass(string $class)
    {
        try {
            $classRef = new ReflectionClass($class);
        } catch (ReflectionException $e) {
            throw new Error($e->getMessage(), $e->getCode(), $e);
        }
        if ($classRef->isFinal()){
            throw new Error('无法动态代理final类' . $class);
        }

        $funcTpl = 'public function ${methodName}(...$args)${returntype}{ return AOP::invoke(new AspectPoint($this->cglibProxyTargetObj, \'${methodName}\', $args)); }';
        $functionList = [];
        $methods = $classRef->getMethods(ReflectionMethod::IS_PUBLIC);
        foreach ($methods as $method) {
            if ($method->isFinal()){
                throw new Error('无法动态代理final方法' . $method->name);
            }
            // 获取返回类型签名
            $methodReturnType = $method->getReturnType();
            if ($methodReturnType === null){
                $methodReturnType = '';
            }else{
                $methodReturnType = ': ' . $methodReturnType;
            }
            $functionList[] = str_replace(['${methodName}', '${returntype}'], [$method->name, $methodReturnType], $funcTpl);
        }
        $replaceMap = [
            '${namespace}' => __NAMESPACE__ . '\\CGProxy',
            '${className}' => $classRef->getShortName() . '_CGProxy',
            '${targetClass}' => $class,
            '${functionList}' => join(PHP_EOL, $functionList),
        ];
        $classBody =  str_replace(array_keys($replaceMap), array_values($replaceMap), self::$proxyClassTpl);

        return [
            'name' => '\\' . $replaceMap['${namespace}'] . '\\' . $replaceMap['${className}'],
            'body' => $classBody,
        ];
    }

}

TestTarget.php目标测试类 开放了两个方法用来做切面测试

 $gender===self::Gender_Man ? '男' : '女',
            '年龄' => date('Y', time()) - $birthYear,
            '运势' => '前程似锦',
        ];
    }

    public function sum(int $numA, int $numB): int
    {
        return $numA + $numB;
    }

}

LoggerInterceptor.php 日志拦截器 切入所有(有切入点的)方法 记录参数、结果

getArgs(), JSON_UNESCAPED_UNICODE) . PHP_EOL;
    }

    public function after(AspectPoint $aspectPoint, &$res)
    {
        echo '进入拦截器' . __CLASS__ . '.' . __FUNCTION__ . ' 结果: ' . json_encode($res, JSON_UNESCAPED_UNICODE) . PHP_EOL;
        $this->log[] = join(' ', [
            get_class($aspectPoint->getTargetObj()),
            $aspectPoint->getTargetFunc(),
            json_encode($aspectPoint->getArgs(), JSON_UNESCAPED_UNICODE),
            json_encode($res, JSON_UNESCAPED_UNICODE),
        ]);
    }

    public function __destruct()
    {
        echo PHP_EOL . '记录器日志：' . PHP_EOL;
        echo join(PHP_EOL, $this->log);
    }

}

FortuneTellingInterceptor.php fortuneTelling方法的拦截器 对特定情况进行结果加工

getArgs()[0] === TestTarget::Gender_Woman){
            echo '优化结果' . PHP_EOL;
            $age = $res['年龄'];
            if ($age > 20 && $age < 30){
                $res['年龄'] = 18;
                $res['性别'] = '小仙女';
                $res['运势'] .= ' 挑花朵朵';
            }
        }
    }

}

index.php 测试代码

sum(1, 2));
    dump('女 1992 ：', $testTarget->fortuneTelling(TestTarget::Gender_Woman, 1992));
    dump('男 1992 ：', $testTarget->fortuneTelling(TestTarget::Gender_Man, 1992));
    dump('女 1988 ：', $testTarget->fortuneTelling(TestTarget::Gender_Woman, 1988));
}

$testTarget = DynamicProxy::getProxy(new TestTarget());
dump('对象类型：', get_class($testTarget));
test($testTarget);

测试结果

image.png

通过测试我们可以看到我们测试代码中的$testTarget对象是动态生成的临时代理类的实例，因为其代理类是继承于目标对象的类(和JAVA的cglib代理一样)，所以可以通过function test(TestTarget $testTarget)的类型检查。创建的两个拦截器也都成功执行，而我们并没有去改动目标类TestTarget的任何代码就可以对其实例方法的执行进行记录和修改，只需要实现拦截器定义切入点和附加操作即可。

注：仅由代理访问的方法可以切入，如在目标对象内部通过this访问则不会走代理。