快捷導(dǎo)航

詳解基于SpringBoot使用AOP技術(shù)實現(xiàn)操作日志管理

更新時間：2019年11月14日 10:00:19 作者：伍婷

這篇文章主要介紹了詳解基于SpringBoot使用AOP技術(shù)實現(xiàn)操作日志管理，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧

操作日志對于程序員或管理員而言，可以快速定位到系統(tǒng)中相關(guān)的操作，而對于操作日志的管理的實現(xiàn)不能對正常業(yè)務(wù)實現(xiàn)進(jìn)行影響，否則即不滿足單一原則，也會導(dǎo)致后續(xù)代碼維護(hù)困難，因此我們考慮使用AOP切面技術(shù)來實現(xiàn)對日志管理的實現(xiàn)。

文章大致內(nèi)容：
1、基本概念
2、基本應(yīng)用
3、日志管理實戰(zhàn)

對這幾部分理解了，會對AOP的應(yīng)用應(yīng)該很輕松。

一、基本概念

項目	描述
Aspect（切面）	跨越多個類的關(guān)注點的模塊化，切面是通知和切點的結(jié)合。通知和切點共同定義了切面的全部內(nèi)容——它是什么，在何時和何處完成其功能。事務(wù)處理和日志處理可以理解為切面
Join point（連接點）	程序執(zhí)行過程中的一個點，如方法的執(zhí)行或異常的處理
Advice（通知）	切面在特定連接點上采取的動作
Pointcut（切點）	匹配連接點的斷言。通知與切入點表達(dá)式相關(guān)聯(lián)，并在切入點匹配的任何連接點上運行(例如，具有特定名稱的方法的執(zhí)行)。切入點表達(dá)式匹配的連接點概念是AOP的核心，Spring默認(rèn)使用AspectJ切入點表達(dá)式語言
Introduction（引用）	為類型聲明其他方法或字段。Spring AOP允許您向任何建議的對象引入新的接口(和相應(yīng)的實現(xiàn))。例如，您可以使用介紹使bean實現(xiàn)IsModified接口，以簡化緩存
Target object（目標(biāo)）	由一個或多個切面通知的對象。也稱為“通知對象”。由于Spring AOP是通過使用運行時代理實現(xiàn)的，所以這個對象始終是代理對象
AOP proxy（代理）	AOP框架為實現(xiàn)切面契約(通知方法執(zhí)行等)而創(chuàng)建的對象。在Spring框架中，AOP代理是JDK動態(tài)代理或CGLIB代理
Weaving（織入）	織入是將通知添加對目標(biāo)類具體連接點上的過程，可以在編譯時(例如使用AspectJ編譯器)、加載時或運行時完成

Spring切面可以應(yīng)用5種類型的通知：

前置通知（Before）：在目標(biāo)方法被調(diào)用之前調(diào)用通知
后置通知（After）：在目標(biāo)方法完成之后調(diào)用通知（無論是正常還是異常退出）
返回通知（After-returning）：在目標(biāo)方法成功執(zhí)行之后調(diào)用通知
異常通知（After-throwing）：在目標(biāo)方法拋出異常后調(diào)用通知
環(huán)繞通知（Around）：通知包裹了被通知的方法，在被通知的方法調(diào)用之前和調(diào)用之后執(zhí)行自定義的行為

其執(zhí)行的順序為：

在這里插入圖片描述

后續(xù)的基本應(yīng)用，會將 環(huán)繞通知、前置通知、后置通知、返回通知、異常通知進(jìn)行實現(xiàn)，并演示其執(zhí)行順序。

二、基本應(yīng)用

聲明通知
大家可以將下面的代碼復(fù)制出來，驗證上面的執(zhí)行順序。

@Aspect
public class Test {
 private static int step = 0;

 @Pointcut("@annotation(com.chenyanwu.erp.erpframework.annotation.Log)") // the pointcut expression
 private void operation() {}

 @Before("operation()")
 public void doBeforeTask() {
  System.out.println(++step + " 前置通知");
 }

 @After("operation()")
 public void doAfterTask() {
  System.out.println(++step + " 后置通知");
 }

 @AfterReturning(pointcut = "operation()", returning = "retVal")
 public void doAfterReturnningTask(Object retVal) {
  System.out.println(++step + " 返回通知，返回值為：" + retVal.toString());
 }

 @AfterThrowing(pointcut = "operation()", throwing = "ex")
 public void doAfterThrowingTask(Exception ex) {
  System.out.println(++step + " 異常通知，異常信息為：" + ex.getMessage());
 }

 /**
  * 環(huán)繞通知需要攜帶ProceedingJoinPoint類型的參數(shù) 
  * 環(huán)繞通知類似于動態(tài)代理的全過程ProceedingJoinPoint類型的參數(shù)可以決定是否執(zhí)行目標(biāo)方法 
  * 且環(huán)繞通知必須有返回值，返回值即目標(biāo)方法的返回值
  */
 //@Around("operation()")
 public Object doAroundTask(ProceedingJoinPoint pjp) {
  String methodname = pjp.getSignature().getName();
  Object result = null;
  try {
   // 前置通知
   System.out.println("目標(biāo)方法" + methodname + "開始，參數(shù)為" + Arrays.asList(pjp.getArgs()));
   // 執(zhí)行目標(biāo)方法
   result = pjp.proceed();
   // 返回通知
   System.out.println("目標(biāo)方法" + methodname + "執(zhí)行成功，返回" + result);
  } catch (Throwable e) {
   // 異常通知
   System.out.println("目標(biāo)方法" + methodname + "拋出異常: " + e.getMessage());
  }
  // 后置通知
  System.out.println("目標(biāo)方法" + methodname + "結(jié)束");
  return result;
 }
}

其中需要注意的是切入點：@Pointcut的表達(dá)式
格式：

execution(modifiers-pattern? ret-type-pattern declaring-type-pattern? name-pattern(param-pattern)throws-pattern?)
括號中各個pattern分別表示：

修飾符匹配（modifier-pattern?）
返回值匹配（ret-type-pattern）可以為*表示任何返回值,全路徑的類名等
類路徑匹配（declaring-type-pattern?）
方法名匹配（name-pattern）可以指定方法名或者代表所有, set 代表以set開頭的所有方法
參數(shù)匹配（(param-pattern)）可以指定具體的參數(shù)類型，多個參數(shù)間用“,”隔開，各個參數(shù)也可以用“”來表示- 匹配任意類型的參數(shù)，如(String)表示匹配一個String參數(shù)的方法；(,String) 表示匹配有兩個參數(shù)的方法，第一個參數(shù)可以是任意類型，而第二個參數(shù)是String類型；可以用(…)表示零個或多個任意參數(shù)
異常類型匹配（throws-pattern?）
其中后面跟著“?”的是可選項

示例：

1）execution(* (…))
//表示匹配所有方法
2）execution(public * com. savage.service.UserService.(…))
//表示匹配com.savage.server.UserService中所有的公有方法
3）execution(* com.savage.server….(…))
//表示匹配com.savage.server包及其子包下的所有方法

三、日志管理實戰(zhàn)

有了上面基本應(yīng)用的理解，現(xiàn)在我們直接就貼代碼：

1、依賴的jar包

<!-- aop依賴 -->
<dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-aop</artifactId>
</dependency>

2、自定義注解

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Log {
 String value() default "";
}

3、實現(xiàn)切面

@Aspect
@Order(5)
@Component
public class LogAspect {

 private Logger logger = LoggerFactory.getLogger(LogAspect.class);

 @Autowired
 private ErpLogService logService;

 @Autowired
 ObjectMapper objectMapper;

 private ThreadLocal<Date> startTime = new ThreadLocal<Date>();

 @Pointcut("@annotation(com.chenyanwu.erp.erpframework.annotation.Log)")
 public void pointcut() {

 }

 /**
  * 前置通知，在Controller層操作前攔截
  *
  * @param joinPoint 切入點
  */
 @Before("pointcut()")
 public void doBefore(JoinPoint joinPoint) {
  // 獲取當(dāng)前調(diào)用時間
  startTime.set(new Date());
 }

 /**
  * 正常情況返回
  *
  * @param joinPoint 切入點
  * @param rvt  正常結(jié)果
  */
 @AfterReturning(pointcut = "pointcut()", returning = "rvt")
 public void doAfter(JoinPoint joinPoint, Object rvt) throws Exception {
  handleLog(joinPoint, null, rvt);
 }

 /**
  * 異常信息攔截
  *
  * @param joinPoint
  * @param e
  */
 @AfterThrowing(pointcut = "pointcut()", throwing = "e")
 public void doAfter(JoinPoint joinPoint, Exception e) throws Exception {
  handleLog(joinPoint, e, null);
 }

 @Async
 private void handleLog(final JoinPoint joinPoint, final Exception e, Object rvt) throws Exception{
  // 獲得注解
  Method method = getMethod(joinPoint);
  Log log = getAnnotationLog(method);
  if (log == null) {
   return;
  }
  Date now = new Date();
  // 操作數(shù)據(jù)庫日志表
  ErpLog erpLog = new ErpLog();
  erpLog.setErrorCode(0);
  erpLog.setIsDeleted(0);
  // 請求信息
  HttpServletRequest request = ToolUtil.getRequest();
  erpLog.setType(ToolUtil.isAjaxRequest(request) ? "Ajax請求" : "普通請求");
  erpLog.setTitle(log.value());
  erpLog.setHost(request.getRemoteHost());
  erpLog.setUri(request.getRequestURI().toString());
//  erpLog.setHeader(request.getHeader(HttpHeaders.USER_AGENT));
  erpLog.setHttpMethod(request.getMethod());
  erpLog.setClassMethod(joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName());
  // 請求的方法參數(shù)值
  Object[] args = joinPoint.getArgs();
  // 請求的方法參數(shù)名稱
  LocalVariableTableParameterNameDiscoverer u
    = new LocalVariableTableParameterNameDiscoverer();
  String[] paramNames = u.getParameterNames(method);
  if (args != null && paramNames != null) {
   StringBuilder params = new StringBuilder();
   params = handleParams(params, args, Arrays.asList(paramNames));
   erpLog.setParams(params.toString());
  }
  String retString = JsonUtil.bean2Json(rvt);
  erpLog.setResponseValue(retString.length() > 5000 ? JsonUtil.bean2Json("請求參數(shù)數(shù)據(jù)過長不與顯示") : retString);
  if (e != null) {
   erpLog.setErrorCode(1);
   erpLog.setErrorMessage(e.getMessage());
  }
  Date stime = startTime.get();
  erpLog.setStartTime(stime);
  erpLog.setEndTime(now);
  erpLog.setExecuteTime(now.getTime() - stime.getTime());
  erpLog.setUsername(MySysUser.loginName());
  HashMap<String, String> browserMap = ToolUtil.getOsAndBrowserInfo(request);
  erpLog.setOperatingSystem(browserMap.get("os"));
  erpLog.setBrower(browserMap.get("browser"));
  erpLog.setId(IdUtil.simpleUUID());
  logService.insertSelective(erpLog);
 }

 /**
  * 是否存在注解，如果存在就獲取
  */
 private Log getAnnotationLog(Method method) {
  if (method != null) {
   return method.getAnnotation(Log.class);
  }
  return null;
 }

 private Method getMethod(JoinPoint joinPoint) {
  Signature signature = joinPoint.getSignature();
  MethodSignature methodSignature = (MethodSignature) signature;
  Method method = methodSignature.getMethod();
  if (method != null) {
   return method;
  }
  return null;
 }

 private StringBuilder handleParams(StringBuilder params, Object[] args, List paramNames) throws JsonProcessingException {
  for (int i = 0; i < args.length; i++) {
   if (args[i] instanceof Map) {
    Set set = ((Map) args[i]).keySet();
    List list = new ArrayList();
    List paramList = new ArrayList<>();
    for (Object key : set) {
     list.add(((Map) args[i]).get(key));
     paramList.add(key);
    }
    return handleParams(params, list.toArray(), paramList);
   } else {
    if (args[i] instanceof Serializable) {
     Class<?> aClass = args[i].getClass();
     try {
      aClass.getDeclaredMethod("toString", new Class[]{null});
      // 如果不拋出NoSuchMethodException 異常則存在 toString 方法 ，安全的writeValueAsString ，否則 走 Object的 toString方法
      params.append(" ").append(paramNames.get(i)).append(": ").append(objectMapper.writeValueAsString(args[i]));
     } catch (NoSuchMethodException e) {
      params.append(" ").append(paramNames.get(i)).append(": ").append(objectMapper.writeValueAsString(args[i].toString()));
     }
    } else if (args[i] instanceof MultipartFile) {
     MultipartFile file = (MultipartFile) args[i];
     params.append(" ").append(paramNames.get(i)).append(": ").append(file.getName());
    } else {
     params.append(" ").append(paramNames.get(i)).append(": ").append(args[i]);
    }
   }
  }
  return params;
 }
}

4、對應(yīng)代碼添加注解

@Log("新增學(xué)生")
 @RequestMapping(value = "/create", method = RequestMethod.POST)
 @ResponseBody
 public ResultBean<String> create(@RequestBody @Validated ErpStudent item) {
  if(service.insertSelective(item) == 1) {
   // 插入
   insertErpSFamilyMember(item);
   return new ResultBean<String>("");
  }

  return new ResultBean<String>(ExceptionEnum.BUSINESS_ERROR, "新增學(xué)生異常！", "新增失敗!", "");
 }

通過對業(yè)務(wù)進(jìn)行操作后，會寫入數(shù)據(jù)庫，界面查詢：

在這里插入圖片描述