spring-boot使用AOP統一處理日誌

時間 2019-11-15

標籤 spring boot 使用 aop 統一處理日誌欄目 Spring 简体版

原文原文鏈接

AOP我想你們都很清楚,有時候咱們須要處理一些請求日誌,或者對某些方法進行一些監控,若是出現例外狀況應該進行怎麼樣的處理,如今,咱們從spring boot中引入AOPweb

開發環境:jdk版本號爲1.8,spring boot的版本號爲1.4.1spring

首先,咱們先引入jar包,

POM文件添加以下內容:數組

<!--引用AOP-->
<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-aop</artifactId>
</dependency>
<!--引用GSON,用於打印-->
<dependency>
   <groupId>com.google.code.gson</groupId>
   <artifactId>gson</artifactId>
   <version>2.7</version>
</dependency>

引入jar包後,咱們在boot的啓動方法,增長兩個簡單的請求處理方法:app

@SpringBootApplication(scanBasePackages = {"com"})
@RestController
public class DemoApplication{

   public static void main(String[] args) {
      SpringApplication.run(DemoApplication.class, args);
   }


   //測試無參的get請求
   @RequestMapping(value = "/testAspect",method = RequestMethod.GET)
   public UserVo test(){
      UserVo userVo = new UserVo();
      userVo.setAge("23");
      userVo.setName("賀小五");
      userVo.setSex("男");

      return userVo;
   }

   //測試有參的get請求,讓aop打印參數內容
   @RequestMapping(value = "/testAspectArgs",method = RequestMethod.GET)
   public UserVo test(String name,String age,String sex){
      UserVo userVo = new UserVo();
      userVo.setName(name);
      userVo.setAge(age);
      userVo.setSex(sex);

      return userVo;
   }

增長了兩個簡單的處理請求方法後,咱們來增長咱們的aopspring-boot

/**
 * 項目名:SpringBootDemo
 * 建立人:賀小五
 * 建立時間:16/12/4 下午7:05
 * 類名:AspectDemo
 * 類描述:
 */
//申明是個切面
@Aspect
//申明是個spring管理的bean
@Component
@Order(1)
public class AspectDemo {


   private Logger log = Logger.getLogger(getClass());

   private Gson gson = new Gson();

   //申明一個切點 裏面是 execution表達式
   @Pointcut("execution(public * com.example.DemoApplication.*(..))")
   private void controllerAspect(){}


   //請求method前打印內容
   @Before(value = "controllerAspect()")
   public void methodBefore(JoinPoint joinPoint){
      ServletRequestAttributes requestAttributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
      HttpServletRequest request = requestAttributes.getRequest();

      //打印請求內容
      log.info("===============請求內容===============");
      log.info("請求地址:"+request.getRequestURL().toString());
      log.info("請求方式:"+request.getMethod());
      log.info("請求類方法:"+joinPoint.getSignature());
      log.info("請求類方法參數:"+ Arrays.toString(joinPoint.getArgs()));
      log.info("===============請求內容===============");
   }


   //在方法執行完結後打印返回內容
   @AfterReturning(returning = "o",pointcut = "controllerAspect()")
   public void methodAfterReturing(Object o ){
      log.info("--------------返回內容----------------");
      log.info("Response內容:"+gson.toJson(o));
      log.info("--------------返回內容----------------");
   }

二者配置好以後,接下來,咱們請求,而後查看打印日誌,首先,啓動咱們的容器,而後咱們先請求有參的處理請求方法的,打印日誌以下:測試

能夠發現,請求的url,method,以及args參數的值,還有類型,以及返回的內容都打印出來了,說明,這是AOP攔截成功了.google

接下來,咱們測試下請求無參的處理請求方法,打印日誌以下:url

咱們能夠發現,這個方法,打印的方法參數是個空數組,是由於方法不須要參數傳遞.spa

以上就是spring boot引用aop進行處理web的日誌處理,下面將添加AOP切面的主要幾個註解,下面只是對註解的描述跟使用,具體測試,做者就不進行測試了,各位看官有興趣的話,能夠本身測試一下:.net

類註解:

@Aspect 將一個類定義爲一個切面類

@order(i) 標記切面類的處理優先級,i值越小,優先級別越高.PS:能夠註解類,也能註解到方法上

方法註解:

@Pointcut 定義一個方法爲切點裏面的內容爲一個表達式,下面詳細介紹

@Before 在切點前執行方法,內容爲指定的切點

@After 在切點後,return前執行,

@AfterReturning 在切入點,return後執行,若是想對某些方法的返回參數進行處理,能夠在這操做

@Around 環繞切點,在進入切點前,跟切點後執行

@AfterThrowing 在切點後拋出異常進行處理

@order(i) 標記切點的優先級,i越小,優先級越高

@Pointcut註解組合使用:

上面代碼中,咱們定義了一個切點,該切點只進行處理指定路徑的:
@Pointcut("execution(public * com.example.DemoApplication.*(..))")
private void controllerAspect(){}
如今,咱們在定義一個處理其餘路徑下的切點:
@Pointcut("execution(public * com.demo.*.*(..))")
private void controllerDemo(){}
以上切點,都是分別處理不一樣的內容,若是咱們須要一個切點來處理他們二者,咱們能夠這麼配置:
@Pointcut(value = "controllerAspect()||controllerDemo()")
private void all(){}
在@Pointcut註解內,直接引用其它被@Pointcut註解過的方法名稱,這樣,該切點就能夠處理兩個路徑下的方法

@Pointcut註解中的execution表達式: public * com.demo.*.*(..)

第一個 public 表示方法的修飾符,能夠用*代替

第一個 * 表示返回值,*表明全部

com.demo.* 包路徑,.*表示路徑下的全部包

第三個.* 表示路徑下,全部包下的全部類的方法

(..) 表示不限方法參數

關於@order(i)註解的一些注意事項:

註解類,i值是,值越小,優先級越高

註解方法,分兩種狀況

註解的是 @Before 是i值越小,優先級越高

註解的是 @After或者@AfterReturning 中,i值越大,優先級越高

總結二者的歸納就是:

在切入點前的操做，按order的值由小到大執行

在切入點後的操做，按order的值由大到小執行

延伸:

有看官可能會問,若是我要打印請求從進來,到結束,所須要的時間,定義一個成員變量,用來統計時間,同時給@Before跟@AfterReturning訪問,可能會有同步的問題,因此咱們引用一個ThreadLocal<Long>指定泛型的對象,在@Before記錄請求的時間,在@AfterReturning扣除記錄的時間,就是消耗的時間,代碼以下:

/**
 * 項目名:SpringBootDemo
 * 建立人:賀小五
 * 建立時間:16/12/4 下午7:05
 * 類名:AspectDemo
 * 類描述:
 */
//申明是個切面
@Aspect
//申明是個spring管理的bean
@Component
@Order(1)
public class AspectDemo {


   private Logger log = Logger.getLogger(getClass());

   private Gson gson = new Gson();

   ThreadLocal<Long>  startTime = new ThreadLocal<Long>();


   //申明一個切點 裏面是 execution表達式
   @Pointcut("execution(public * com.example.DemoApplication.*(..))")
   private void controllerAspect() {
   }


   //請求method前打印內容
   @Before(value = "controllerAspect()")
   public void methodBefore(JoinPoint joinPoint) {
      startTime.set(System.currentTimeMillis());

      ServletRequestAttributes requestAttributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
      HttpServletRequest request = requestAttributes.getRequest();

      //打印請求內容
      log.info("===============請求內容===============");
      log.info("請求地址:" + request.getRequestURL().toString());
      log.info("請求方式:" + request.getMethod());
      log.info("請求類方法:" + joinPoint.getSignature());
      log.info("請求類方法參數:" + Arrays.toString(joinPoint.getArgs()));
      log.info("===============請求內容===============");
   }


   //在方法執行完結後打印返回內容
   @AfterReturning(returning = "o", pointcut = "controllerAspect()")
   public void methodAfterReturing(Object o) {
      log.info("--------------返回內容----------------");
      log.info("Response內容:" + gson.toJson(o));
      log.info("--------------返回內容----------------");

      log.info("請求處理時間爲:"+(System.currentTimeMillis() - startTime.get()));

   }

}

以上,均爲本人測試而得出的結果,可能會有出入,或者錯誤,歡迎指正

歡迎轉載,請註明出處跟做者,謝謝!