Spring AOP 面向切面編程必須知道的事

時間 2019-11-06

原文原文鏈接

一、概覽

什麼是面向切面編程？java

面向切面編程是一種編程範式（其餘常見的編程範式有面向過程編程，面向對象編程OOP，面向函數編程，面向事件驅動編程，面向切面編程），它不是一種編程語言，面向切面編程能夠解決特定的問題，可是不能解決全部問題，它是面向對象編程的補充，不是替代。spring

它能夠很大程度上解決代碼重複性問題，並且能夠實現關注點分離，好比功能性需求和非功能性需求的分離，從而實現集中管理，加強代碼的可讀性，可維護性。express

二、AOP常見的使用場景

在系統開發過程當中常見的使用場景主要有編程

權限控制緩存

緩存控制編程語言

事務控制分佈式

審計日誌函數

性能監控性能

分佈式追蹤this

異常處理

三、Spring AOP 兩個主要關注點

Pointcut express

切面表達式，主要表達經過怎樣的方式找到切面插入的邏輯點，pointcut express 提供了豐富的表達式可讓咱們進行切面的插入。

五種Advice

找到切入點後，須要明確在什麼時機進行代碼植入，主要有五種，以下：

@Before 前置通知

@After(finally) ,後置通知，在方法執行完以後切入

@AfterReturning,返回通知，返回值返回以後

@AfterThrowing,異常通知，拋出異常以後

@Around ,環繞通知，環繞通知包含了上面全部的類型

以上兩個關注點總結一句話就是在什麼地方什麼時機進行咱們的代碼切入。

四、常見切面表達式

一、within表達式，匹配包或者類下面的方法

import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.stereotype.Component;

/**
 * //匹配ProductService類裏頭的全部方法
 * @Pointcut("within(com.ruoli.service.ProductService)")
 * //匹配com.ruoli包及子包下全部類的方法
 * @Pointcut("within(com.ruoli..*)")
 */
@Aspect
@Component
public class PkgTypeAspectConfig {
   @Pointcut("within(com.ruoli.service.sub.*)")
   public void matchType(){}

   @Before("matchType()")
   public void before(){
       System.out.println("");
       System.out.println("###before");
   }
}

二、對象匹配

import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.stereotype.Component;

/**
 * //匹配AOP對象的目標對象爲指定類型的方法,即LogService的aop代理對象的方法
 * @Pointcut("this(com.ruoli.log.Loggable)")
 * //匹配實現Loggable接口的目標對象(而不是aop代理後的對象)的方法
 * @Pointcut("target(com.ruoli.log.Loggable)")
 * //this 能夠攔截 DeclareParents(Introduction)
 * //target 不攔截 DeclareParents(Introduction)
 * //匹配全部以Service結尾的bean裏頭的方法
 * @Pointcut("bean(*Service)")
 * Created by cat on 2016-12-04.
 */
@Aspect
@Component
public class ObjectAspectConfig {

   @Pointcut("bean(logService)")
   public void matchCondition(){}

   @Before("matchCondition()")
   public void before(){
       System.out.println("");
       System.out.println("###before");
   }
}

三、參數匹配，配置指定參數的方法

import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.stereotype.Component;

/**
 * //匹配任何以find開頭並且只有一個Long參數的方法
 * @Pointcut("execution(* *..find*(Long))")
 * //匹配任何以find開頭的並且第一個參數爲Long型的方法
 * @Pointcut("execution(* *..find*(Long,..))")
 * //匹配任何只有一個Long參數的方法
 * @Pointcut("within(com.ruoli..*) && args(Long)")
 * //匹配第一個參數爲Long型的方法
 * @Pointcut("within(com.ruoli..*) && args(Long,..)")
 * Created by cat on 2016-12-04.
 */
@Aspect
@Component
public class ArgsAspectConfig {
   @Pointcut("args(Long,String) && within(com.ruoli.service.*)")
   public void matchArgs(){}

   @Before("matchArgs()")
   public void before(){
       System.out.println("");
       System.out.println("###before");
   }
}

四、註解匹配

主要有方法級別註解，類級別註解，參數級別註解。

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.stereotype.Component;

/**
 * //匹配方法標註有AdminOnly的註解的方法
 * @Pointcut("@annotation(com.ruoli.anno.AdminOnly) && within(com.ruoli..*)")
 * //匹配標註有NeedSecured的類底下的方法 //class級別
 * @Pointcut("@within(com.ruoli.anno.NeedSecured) && within(com.ruoli..*)")
 * //匹配標註有NeedSecured的類及其子類的方法 //runtime級別
 * 在spring context的環境下,兩者沒有區別
 * @Pointcut("@target(com.ruoli.anno.NeedSecured) && within(com.ruoli..*)")
 * //匹配傳入的參數類標註有Repository註解的方法
 * @Pointcut("@args(com.ruoli.anno.NeedSecured) && within(com.ruoli..*)")
 * Created by cat on 2016-12-04.
 */
@Aspect
@Component
public class AnnoAspectConfig {

   @Pointcut("@args(com.ruoli.anno.NeedSecured) && within(com.ruoli..*)")
   public void matchAnno(){}

   @Before("matchAnno()")
   public void before(){
       System.out.println("");
       System.out.println("###before");
   }

}

五、execution 表達式

import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.stereotype.Component;

/**
 * //匹配任何公共方法
 @Pointcut("execution(public * com.ruoli.service.*.*(..))")

 //匹配com.imooc包及子包下Service類中無參方法
 @Pointcut("execution(* com.ruoli..*Service.*())")

 //匹配com.imooc包及子包下Service類中的任何只有一個參數的方法
 @Pointcut("execution(* com.ruoli..*Service.*(*))")

 //匹配com.imooc包及子包下任何類的任何方法
 @Pointcut("execution(* com.ruoli..*.*(..))")

 //匹配com.imooc包及子包下返回值爲String的任何方法
 @Pointcut("execution(String com.ruoli..*.*(..))")

 //匹配異常
 execution(public * com.ruoli.service.*.*(..) throws java.lang.IllegalAccessException)

 * 
 */
@Aspect
@Component
public class ExecutionAspectConfig {

	@Pointcut("execution(public * com.ruoli.service..*Service.*(..) throws java.lang.IllegalAccessException)")
	public void matchCondition(){}

	@Before("matchCondition()")
	public void before(){
	 System.out.println("");
	 System.out.println("###before");
	}
}

五、五種通知代碼示例

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
import org.omg.CORBA.Object;
import org.springframework.stereotype.Component;

/**
 * @Before("matchAnno()")
 * @After("matchAnno())") //至關於finally
 * @AfterReturning("matchException()")
 * @AfterThrowing("matchException()")
 * @Around("matchException()")
 * @Before(value = "matchLongArg() && args(productId)")
 * public void beforeWithArgs(Long productId)
 * @AfterReturning(value = "matchReturn()",returning = "returnValue")
 * public void getReulst(Object returnValue)
 * 
 */
@Aspect
@Component
public class AdviceAspectConfig {

    /******pointcut********/

    @Pointcut("@annotation(com.ruoli.anno.AdminOnly) && within(com.ruoli..*)")
    public void matchAnno(){}

    @Pointcut("execution(* *..find*(Long)) && within(com.ruoli..*) ")
    public void matchLongArg(){}

    @Pointcut("execution(public * com.ruoli.service..*Service.*(..) throws java.lang.IllegalAccessException) && within(com.ruoli..*)")
    public void matchException(){}

    @Pointcut("execution(String com.ruoli..*.*(..)) && within(com.ruoli..*)")
    public void matchReturn(){}


    /******advice********/
    @Before("matchLongArg() && args(productId)")
    public void before(Long productId){
        System.out.println("###before,get args:"+productId);
    }
   @Around("matchException()")
   public java.lang.Object after(ProceedingJoinPoint joinPoint){
       System.out.println("###before");
       java.lang.Object result = null;
       try{
           result = joinPoint.proceed(joinPoint.getArgs());
           System.out.println("###after returning");
       }catch (Throwable e){
           System.out.println("###ex");
           //throw
           e.printStackTrace();
       }finally {
           System.out.println("###finally");
       }
       return result;
   }

}