快捷導(dǎo)航

springboot的切面應(yīng)用方式(注解Aspect)

更新時(shí)間：2024年11月14日 09:41:16 作者：你是豬，

文章總結(jié)：Spring?Boot提供了三種攔截器：Filter、Interceptor和Aspect,Filter主要用于內(nèi)容過(guò)濾和非登錄狀態(tài)的非法請(qǐng)求過(guò)濾,無(wú)法獲取Spring框架相關(guān)的信息,Interceptor可以在獲取請(qǐng)求類(lèi)名、方法名的同時(shí),獲取請(qǐng)求參數(shù),但無(wú)法獲取參數(shù)值

spring boot 攔截的方式

1.過(guò)濾器filter

可以獲取http、http請(qǐng)求和響應(yīng)，但無(wú)法獲取與spring框架相關(guān)的信息，如哪個(gè)control處理，哪個(gè)方法處理，有哪些參數(shù)，這些都是無(wú)法獲取的。

主要用于內(nèi)容上的過(guò)濾，敏感字替換成*等，也可用于非登入狀態(tài)的非法請(qǐng)求過(guò)濾。

2.攔截器interceptor

除了獲取http、http請(qǐng)求和響應(yīng)對(duì)象，還可以獲取請(qǐng)求的類(lèi)名、方法名，但攔截器無(wú)法獲取請(qǐng)求參數(shù)的值，從DispatcherServlet類(lèi)源碼分析。

主要用于對(duì)公共的一些攔截獲取，例如請(qǐng)求的IP 地址，IP黑白名單里的過(guò)過(guò)濾，非登入狀態(tài)的接口請(qǐng)求攔截。

3.切面攔截Aspect

能獲取到方法請(qǐng)求的參數(shù)，方法名，以及方法返回的json數(shù)據(jù)，更多的是用于數(shù)據(jù)的處理，比如對(duì)操作進(jìn)行記錄，修改，新建，查詢(xún)，審批等操作記錄進(jìn)行處理統(tǒng)計(jì)。

對(duì)返回的json中的一些特殊數(shù)據(jù)，比如字典值替換成對(duì)應(yīng)的數(shù)據(jù)，避免前端轉(zhuǎn)化，等等。

執(zhí)行順序

正常情況：過(guò)濾器、攔截器、切片，
異常報(bào)錯(cuò)：切片、ControllerAdvice注解類(lèi)、攔截器、過(guò)濾器

切片的使用

示例

import com.alibaba.fastjson.JSONObject;
import com.cmhit.crm.constants.FunctionEnum;
import com.cmhit.crm.service.OperateLogService;
import com.cmhit.crm.utils.JsonUtil;
import com.cmhit.crm.vo.operlog.OperateLogCreateReqVO;
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

import java.util.Objects;

@Slf4j
@Aspect
@Component
public class OperateLogAspect {
   
   //操作日志service
   @Autowired 
   private OperateLogService operateLogService;
  //操作日志實(shí)體
   private OperateLogCreateReqVO operateLog = new OperateLogCreateReqVO();

   // 定義一個(gè)切入點(diǎn)
   @Pointcut("execution(* com.cmhit.crm.controller.*.*(..))")
   public void operlog(){
      //這里面不要寫(xiě)代碼，不會(huì)執(zhí)行的
   }

   // 前置通知
   @Before(value = "operlog()")
   public void before(JoinPoint jp) {
       //方法名獲取
       String name = jp.getSignature().getName();
       //方法參數(shù)獲取
       Object[] args = jp.getArgs();
       //設(shè)置操作日志
       setOperateLogType(name,args);
       log.debug("{}方法開(kāi)始執(zhí)行...開(kāi)始設(shè)置設(shè)置操作日志的操作類(lèi)型",name);
   }

   // 后置通知
   @After(value = "operlog()")
   public void after(JoinPoint jp) {
       String name = jp.getSignature().getName();
       log.debug("{}方法執(zhí)行結(jié)束...",name);
   }

   // 返回通知
   @AfterReturning(value = "operlog()")
   public void afterReturning(JoinPoint jp) {
       String name = jp.getSignature().getName();
       if (Objects.nonNull(operateLog.getSourceId())) {
           operateLog.setOperationResult("操作成功！");
           operateLogService.insertOperateLog(operateLog);
       }
       log.debug("{}方法執(zhí)行成功",name);
   }

   // 異常通知
   @AfterThrowing(value = "operlog()", throwing = "e")
   public void afterThrowing(JoinPoint jp, Exception e) {
       String name = jp.getSignature().getName();
       if (Objects.nonNull(operateLog.getSourceId())){
           operateLog.setOperationResult(e.getMessage());
           operateLogService.insertOperateLog(operateLog);
       }
       log.debug("{}方法拋異常,異常是{}",name , e.getMessage());
   }

   // 環(huán)繞通知
   @Around("operlog()")
   public Object around(ProceedingJoinPoint pjp) throws Throwable {
       String name = pjp.getSignature().getName();
       // 統(tǒng)計(jì)方法執(zhí)行時(shí)間
      long start = System.currentTimeMillis();
      Object result = pjp.proceed();
      long end = System.currentTimeMillis();
      System.out.println(name + "方法執(zhí)行時(shí)間為：" + (end - start) + " ms");
       return result;
   }
   private void setOperateLogType(String name,Object[] args){
     //公司的業(yè)務(wù)邏輯，這里建立使用自己的
    }

   }
   //參數(shù)處理方法
   private void dealGetinfoArgs(Object[] args){
    //自己寫(xiě)邏輯吧
   }
  

}