詳解基于SpringBoot使用AOP技術實現操作日志管理

發布時間: 2019-11-14 11:32:37 來源: 互聯網 欄目: Java 點擊:

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

操作日志對于程序員或管理員而言,可以快速定位到系統中相關的操作,而對于操作日志的管理的實現不能對正常業務實現進行影響,否則即不滿足單一原則,也會導致后續代碼維護困難,因此我們考慮使用AOP切面技術來實現對日志管理的實現。

文章大致內容:
1、基本概念
2、基本應用
3、日志管理實戰

對這幾部分理解了,會對AOP的應用應該很輕松。

一、基本概念

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

Spring切面可以應用5種類型的通知:

  • 前置通知(Before):在目標方法被調用之前調用通知
  • 后置通知(After):在目標方法完成之后調用通知(無論是正常還是異常退出)
  • 返回通知(After-returning):在目標方法成功執行之后調用通知
  • 異常通知(After-throwing):在目標方法拋出異常后調用通知
  • 環繞通知(Around):通知包裹了被通知的方法,在被通知的方法調用之前和調用之后執行自定義的行為

其執行的順序為:

在這里插入圖片描述

在這里插入圖片描述

后續的基本應用,會將 環繞通知前置通知后置通知返回通知異常通知進行實現,并演示其執行順序。

二、基本應用

聲明通知
大家可以將下面的代碼復制出來,驗證上面的執行順序。

@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());
 }

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

其中需要注意的是切入點:@Pointcut的表達式
格式:

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開頭的所有方法
  • 參數匹配((param-pattern))可以指定具體的參數類型,多個參數間用“,”隔開,各個參數也可以用“”來表示- 匹配任意類型的參數,如(String)表示匹配一個String參數的方法;(,String) 表示匹配有兩個參數的方法,第一個參數可以是任意類型,而第二個參數是String類型;可以用(…)表示零個或多個任意參數
  • 異常類型匹配(throws-pattern?)
  • 其中后面跟著“?”的是可選項

示例:

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

三、日志管理實戰

有了上面基本應用的理解,現在我們直接就貼代碼:

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、實現切面

@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) {
  // 獲取當前調用時間
  startTime.set(new Date());
 }

 /**
  * 正常情況返回
  *
  * @param joinPoint 切入點
  * @param rvt  正常結果
  */
 @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();
  // 操作數據庫日志表
  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());
  // 請求的方法參數值
  Object[] args = joinPoint.getArgs();
  // 請求的方法參數名稱
  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("請求參數數據過長不與顯示") : 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、對應代碼添加注解

@Log("新增學生")
 @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, "新增學生異常!", "新增失敗!", "");
 }

通過對業務進行操作后,會寫入數據庫,界面查詢:

在這里插入圖片描述

日志管理的完整的代碼可以從git上獲取:
https://github.com/chyanwu/erp-framework

以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支持我們。

本文標題: 詳解基于SpringBoot使用AOP技術實現操作日志管理
本文地址: http://www.leskzw.tw/ruanjian/java/286276.html

如果認為本文對您有所幫助請贊助本站

支付寶掃一掃贊助微信掃一掃贊助

  • 支付寶掃一掃贊助
  • 微信掃一掃贊助
  • 支付寶先領紅包再贊助
    聲明:凡注明"本站原創"的所有文字圖片等資料,版權均屬編程客棧所有,歡迎轉載,但務請注明出處。
    Java中自定義注解類及使用實例解析Java中間消息件ActiveMQ使用實例
    Top 广东好彩1中奖规则