声明

声明切面

Aspect 类与任何其他正常的 bean 类似，并且可能像任何其他类一样拥有方法和字段，但它们将使用 @Aspect 注释，如下所示:

  1. use Swoft\Aop\Annotation\Mapping\Aspect;
  3. /**
  4.  * Class DemoAspect
  5.  *
  6.  * @since 2.0
  7.  *
  8.  * @Aspect(order=1)
  9.  */
  10. class DemoAspect
  11. {
  12.     // ...
  13. }

@Aspect

定义一个类为切面类

  • order 优先级，多个切面，越小预先执行

声明切入点

一个切入点有助于确定不同的意见执行感兴趣的连接点（即方法）。

  1. /**
  2.  * Class DemoAspect
  3.  *
  4.  * @since 2.0
  5.  *
  6.  * @Aspect(order=1)
  7.  *
  8.  * @PointBean(
  9.  *     include={"testOrderAop"}
  10.  * )
  11.  */
  12. class DemoAspect
  13. {
  14.     // ...
  15. }

@PointBean

定义bean切入点, 这个bean类里的方法执行都会经过此切面类的代理

  • include 定义需要切入的实体名称集合
  • exclude 定义需要排除的实体名称集合

@PointAnnotation

定义注解切入点, 所有包含使用了对应注解的方法都会经过此切面类的代理

  • include 定义需要切入的注解名称集合
  • exclude 定义需要排除的注解集合

PointExecution

定义匹配切入点, 指明要代理目标类的哪些方法

  • include 定义需要切入的匹配集合，匹配的类方法，支持正则表达式
  • exclude 定义需要排序的匹配集合，匹配的类方法，支持正则表达式

@PointBean、@PointAnnotation、@PointExecution 三种定义的关系是并集，三种里面定义的排除也是并集后在排除。建议为了便于理解和使用，一个切面类尽量只使用上面三个中的一个

声明通知

  1. use Swoft\Aop\Annotation\Mapping\After;
  2. use Swoft\Aop\Annotation\Mapping\AfterReturning;
  3. use Swoft\Aop\Annotation\Mapping\AfterThrowing;
  4. use Swoft\Aop\Annotation\Mapping\Around;
  5. use Swoft\Aop\Annotation\Mapping\Aspect;
  6. use Swoft\Aop\Annotation\Mapping\Before;
  7. use Swoft\Aop\Annotation\Mapping\PointBean;
  8. use Swoft\Aop\Point\JoinPoint;
  9. use Swoft\Aop\Point\ProceedingJoinPoint;
  11. /**
  12.  * Class DemoAspect
  13.  *
  14.  * @since 2.0
  15.  *
  16.  * @Aspect(order=1)
  17.  *
  18.  * @PointBean(
  19.  *     include={"testOrderAop"}
  20.  * )
  21.  */
  22. class DemoAspect
  23. {
  24.     /**
  25.      * @Before()
  26.      */
  27.     public function before()
  28.     {
  29.         // before
  30.     }
  32.     /**
  33.      * @After()
  34.      */
  35.     public function after()
  36.     {
  37.         // After
  38.     }
  40.     /**
  41.      * @AfterReturning()
  42.      *
  43.      * @param JoinPoint $joinPoint
  44.      *
  45.      * @return mixed
  46.      */
  47.     public function afterReturn(JoinPoint $joinPoint)
  48.     {
  49.         $ret = $joinPoint->getReturn();
  51.         // After return
  53.         return $ret;
  54.     }
  56.     /**
  57.      * @Around()
  58.      *
  59.      * @param ProceedingJoinPoint $proceedingJoinPoint
  60.      *
  61.      * @return mixed
  62.      */
  63.     public function around(ProceedingJoinPoint $proceedingJoinPoint)
  64.     {
  65.         // Before around
  66.         $result = $proceedingJoinPoint->proceed();
  67.         // After around
  69.         return $result;
  70.     }
  72.     /**
  73.      * @param \Throwable $throwable
  74.      *
  75.      * @AfterThrowing()
  76.      */
  77.     public function afterThrowing(\Throwable $throwable)
  78.     {
  79.         // afterThrowing
  80.     }
  81. }
  • @Before 前置通知，在目标方法执行前先执行此方法
  • @After 后置通知，在目标方法执行后执行此方法
  • @AfterReturning 最终返回通知
  • @AfterThrowing 异常通知，在目标方法执行抛出异常时执行此方法
  • @Around 环绕通知，在目标方法执行前、后都执行此方法