2. 程式人生 > 程式設計 >Springboot2 配置AOP日誌的方法步驟

Springboot2 配置AOP日誌的方法步驟

阿新 • • 發佈：2020-06-22

Spring boot2 配置AOP前置增強,後置增強,異常增強,環繞增強,最終增強

關於AOP切面相關具體概念不做過多闡述(概念弄懂有利於理解思想),這是配置AOP的各種增強日誌,解決日誌巢狀在業務程式碼的麻煩和不科學

先來個Git demo專案壓壓驚:https://github.com/zhang-xiao-xiang/boot-aop (有的更新了一些)

1pom依賴(這裡使用log4j2作為日誌框架,因為比log4j或者其他日誌框架,它效率更高,功能更加強大)

    <!-- 引入log4j2依賴(注意還有排除依賴) -->
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-log4j2</artifactId>
    </dependency>
    <!-- 排除exclude掉spring-boot的預設log框架配置 -->
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter</artifactId>
      <exclusions>
        <exclusion>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-logging</artifactId>
        </exclusion>
      </exclusions>
    </dependency>
    <dependency>
      <!-- 加上這個才能辨認到log4j2.yml檔案(如果日誌要輸出到本地或者具體磁碟,需要配置yml) -->
      <groupId>com.fasterxml.jackson.dataformat</groupId>
      <artifactId>jackson-dataformat-yaml</artifactId>
    </dependency>
    <!--AOP的支援依賴-->
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-aop</artifactId>
    </dependency>

2編寫切面類

package com.example.nba.aop;//改成你的包名即可
 
import java.util.Arrays;
 
 
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.After;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.AfterThrowing;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
 
import javax.servlet.http.HttpServletRequest;
 
/**
 * AopLog
 *
 * @author 10905 2019/1/4
 * @version 1.0
 */
@Aspect
@Component
public class AopLog {
  //使用org.slf4j.Logger,這是Spring實現日誌的方法
  private final static Logger logger = LoggerFactory.getLogger(AopLog.class);
 
  //	切入點註解的表示式：就是需要AOP的地方(一般是業務邏輯層service,當然服務介面呼叫層controller也行,兩者一起列印日誌也行
  //	這個類似正則表示式,可以控制日誌的精度(包下,類下,方法下)和切面的型別(業務層面,服務介面層面)相當靈活)
    @Pointcut("execution(* com.example.nba.controller.PlayerApi.*(..))")
  // @Pointcut("execution(* com.example.nba.repository.PlayerRep.*(..))")
  //切入點簽名的方法，注意返回值必須是void,相當於切入點的無參構造
  public void mypointcut() {
  }
 
  //	前置增強
  @Before("mypointcut()")
  public void Mybefore(JoinPoint jp) {
    logger.info("*前置增強*呼叫了【" + jp.getTarget().getClass().getSimpleName() +
        "】的【" + jp.getSignature().getName() + "】的方法，方法入參為【"
        + Arrays.toString(jp.getArgs()) + "】");
    // 接收到請求，記錄請求內容(這裡同樣可以在前置增強配置請求的相關資訊)
    ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
    HttpServletRequest request = attributes.getRequest();
    logger.info("請求的地址URL : " + request.getRequestURL().toString());
    logger.info("請求的方式HTTP_METHOD : " + request.getMethod());
    logger.info("請求的IP : " + request.getRemoteAddr());
    logger.info("請求的全類名 : " + jp.getSignature().getDeclaringTypeName() + "." + jp.getSignature().getName());
    logger.info("請求的引數(陣列形式) : " + Arrays.toString(jp.getArgs()));
 
  }
 
  //後置增強
  @AfterReturning(pointcut = "mypointcut()",returning = "result")
  public void MyafterReturing(JoinPoint jp,Object result) {
    logger.info("*後置增強*呼叫了【" + jp.getTarget().getClass().getSimpleName() +
        "】的【" + jp.getSignature().getName() + "】的方法，方法返回值【" + result + "】");
  }
 
  //	異常丟擲增強
  @AfterThrowing(pointcut = "mypointcut()",throwing = "e")
  public void afterThrowing(JoinPoint jp,RuntimeException e) {
    logger.error("*異常增強*【" + jp.getSignature().getName().getClass().getSimpleName() + "】方法發生異常【" + e + "】");
  }
 
  //	最終增強
  @After("mypointcut()")
  public void afterLogger(JoinPoint jp) {
    logger.info("*最終增強*【" + jp.getSignature().getName() + "】方法結束執行。");
  }
 
  //環繞增強
  @Around("mypointcut()")
  public Object aroundLogger(ProceedingJoinPoint jp) throws Throwable {
    logger.info("在==>>" + jp.getTarget().getClass().getName() + "類裡面使用AOP環繞增強==");
    logger.info("*環繞增強*呼叫【" + jp.getTarget().getClass().getSimpleName() + "】的【 " + jp.getSignature().getName()
        + "】方法。方法入參【" + Arrays.toString(jp.getArgs()) + "】");
    try {
      Object result = jp.proceed();
      logger.info("*環繞增強*呼叫 " + jp.getTarget() + "的【 "
          + jp.getSignature().getName() + "】方法。方法返回值【" + result + "】");
      return result;
    } catch (Throwable e) {
      logger.error(jp.getSignature().getName() + " 方法發生異常【" + e + "】");
      throw e;
    } finally {
      logger.info("*環繞增強*執行finally【" + jp.getSignature().getName() + "】方法結束執行<<==。");
    }
  } 
}

3測試(資料庫程式碼和業務層等程式碼就不貼上去了,主要參考AOP的pom依賴和切面類),比如我瀏覽器請求

http://localhost:8080/player/findAll

控制器顯示:

Springboot2 配置AOP日誌的方法步驟

json格式的aop配置(注意檔案格式入參需要判斷一下(因為excel,PDF,png等格式無法轉json)),假如現在的需求是請求和返回引數均以json格式為主,並且記錄日誌到資料庫(排除查詢日誌的介面,因為查詢日誌不需要記錄到資料庫,這裡涉及到AOP排除某個介面或者說是某個切面,具體見下)

日誌實體(表)

package com.xinzuo.lvyou.pojo;
 
import java.io.Serializable;
import java.util.Date;
 
import com.baomidou.mybatisplus.annotation.TableId;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.experimental.Accessors;
 
/**
 * <p>
 * 日誌記錄監控表
 * </p>
 *
 * @author zhangxiaoxiang
 * @since 2019-07-08
 */
@Data
@EqualsAndHashCode(callSuper = false)
@Accessors(chain = true)
public class LogMonitor implements Serializable {
 
  private static final long serialVersionUID = 1L;
 
  /**
   * 日誌主鍵ID
   */
  @TableId
  private String logId;
 
  /**
   * 請求IP地址
   */
  private String requestIp;
 
  /**
   * 操作介面反饋描述
   */
  private String summarize;
  /**
   * 響應狀態嗎
   */
  private Integer responseCode;
 
  /**
   * 請求方式
   */
  private String requestType;
 
  /**
   * 請求介面
   */
  private String requestApi;
 
  /**
   * 請求引數
   */
  private String requestPara;
 
  /**
   * 返回引數
   */
  private String responsePara;
 
  /**
   * 請求到響應處理時間(毫秒)
   */
  private Integer responseTime;
 
  /**
   * 建立時間(請求發出的時間)
   */
  private Date createTime;
 
  /**
   * 日誌所屬(0移動前端日誌,1PC端日誌)
   */
  private Integer belongTo;
}

下面是json格式並帶有記錄到資料庫的需求的,假如返回的格式是三段式json,如下

{
  "code": 200,"msg": "查詢打卡次數成功","data": {
    "photoSave": null,"user": null,"amount": 27
  }
}

切面類的編寫如下

package com.xinzuo.lvyou.aop;
 
import com.alibaba.fastjson.JSONArray;
import com.gexin.fastjson.JSON;
import com.gexin.fastjson.JSONObject;
import com.xinzuo.lvyou.dao.LogMonitorDao;
import com.xinzuo.lvyou.pojo.LogMonitor;
import com.xinzuo.lvyou.util.KeyUtil;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
 
import javax.servlet.http.HttpServletRequest;
import java.util.Arrays;
import java.util.Date;
 
/**
 * AopLog:日誌切面類
 *
 * @author zhangxiaoxiang
 * @date: 2019/05/22
 */
@Component
@Aspect
public class AopJsonLog {
  /**
   * 記錄日誌到資料庫
   */
  @Autowired
  private LogMonitorDao logMonitorDao;
  //記錄到資料庫
  LogMonitor logMonitor = new LogMonitor();
  long start = 0;
 
  /**
   * 使用org.slf4j.Logger,這是Spring實現日誌的方法
   */
  private final static Logger logger = LoggerFactory.getLogger(AopJsonLog.class);
 
  @Pointcut("execution(* com.xinzuo.lvyou.admin..*(..)) ")
  public void myPointcut() {
  }
 
  /**
   * 前置增強 單獨配置的前端介面切面
   * 日誌列印排除在外,查詢日誌介面就不記錄資料庫
   * 排除某個方法使用!execution(* com.xinzuo.lvyou.controller.LogMonitorController.*(..))
   *
   * @param jp
   */
  @Before("execution(* com.xinzuo.lvyou.controller..*(..)) && !execution(* com.xinzuo.lvyou.controller.LogMonitorController.*(..))")
  public void MyBefore(JoinPoint jp) {
    logger.info("---------------------------------前端請求介面日誌----------------------------------------------");
    // 接收到請求，記錄請求內容(這裡同樣可以在前置增強配置請求的相關資訊)
    ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
    HttpServletRequest request = attributes.getRequest();
    logger.info("訪問的介面:" + jp.getTarget().getClass().getName() + "." + jp.getSignature().getName());
    try {
      logger.info("請求入參為:" + new JSONArray(Arrays.asList(jp.getArgs())).toString());
    } catch (Exception e) {
      logger.info("請求入參為:圖片,視訊,excel,PDF等格式(此時無法轉換成JSON格式)");
      //由於知道這裡異常的原因是json轉換引數異常,所以就不列印了,不捕獲,以免控制檯難看或者日誌難看
      //e.printStackTrace();
    }
    //logger.info("請求的地址URL:      " + request.getRequestURL().toString());
    //logger.info("請求的方式HTTP_METHOD:  " + request.getMethod());
    //logger.info("請求的IP:        " + request.getRemoteAddr());
 
    start = System.currentTimeMillis();
    logMonitor.setLogId(KeyUtil.genUniqueKey());
    logMonitor.setRequestType(request.getMethod());
    logMonitor.setRequestApi(jp.getTarget().getClass().getName() + "." + jp.getSignature().getName());
    try {
      logMonitor.setRequestPara(new JSONArray(Arrays.asList(jp.getArgs())).toString());
    } catch (Exception e) {
      logMonitor.setRequestPara("請求入參為:圖片,PDF等格式(此時無法轉換成JSON格式)");
    }
    logMonitor.setRequestIp(request.getRemoteAddr());
    logMonitor.setCreateTime(new Date());
 
 
  }
 
  /**
   * 後置增強
   * 排除某個方法使用!execution(* com.xinzuo.lvyou.controller.LogMonitorController.*(..))
   * 日誌列印排除在外,查詢日誌介面就不記錄資料庫
   * @param jp
   * @param vo
   */
  @AfterReturning(pointcut = "execution(* com.xinzuo.lvyou.controller..*(..)) && !execution(* com.xinzuo.lvyou.controller.LogMonitorController.*(..))",returning = "vo")
  public void MyafterReturing(JoinPoint jp,Object vo) {
 
    //logger.info("訪問的介面: " + jp.getTarget().getClass().getName() + "." + jp.getSignature().getName());
    //入參列印json陣列格式
//    try {
//      logger.info("請求入參為:" + new JSONArray(Arrays.asList(jp.getArgs())).toString());
//    } catch (Exception e) {
//      logger.info("請求入參為圖片,PDF等格式(此時無法轉換成JSON格式)");
//      //由於知道這裡異常的原因是json轉換引數異常,以免控制檯難看或者日誌難看
//      //e.printStackTrace();
//    }
    logger.info("方法返回值:" + JSON.toJSONString(vo));
    logMonitor.setResponsePara(JSON.toJSONString(vo));
    long end = System.currentTimeMillis();
    //解析json
    JSONObject json= null;
    try {
      json = JSON.parseObject(JSON.toJSONString(vo));
      logMonitor.setResponseCode(Integer.valueOf(json.get("code").toString()));
      logMonitor.setSummarize(json.get("msg").toString());
    } catch (Exception e) {
      logMonitor.setSummarize("進行圖片,PDF等格式操作(由於這個操作特殊一點,所以後臺直接把返回狀態碼預設為200,以實際為準)");
      logMonitor.setResponseCode(200);
      //e.printStackTrace();
    }
 
 
    logMonitor.setBelongTo(0);
    logMonitor.setResponseTime((int) (end - start));
    try {
      logMonitorDao.insert(logMonitor);
    } catch (Exception e) {
      logger.info("AOP系統故障!");
    }
  }
 
//  /**
//   * 異常丟擲增強
//   *
//   * @param jp
//   * @param e
//   */
//  @AfterThrowing(pointcut = "myPointcut()",throwing = "e")
//  public void afterThrowing(JoinPoint jp,RuntimeException e) {
//    logger.error("異常增強:" + jp.getSignature().getName().getClass().getSimpleName() + "方法發生異常【" + e + "】");
//  }
 
  /**
   * 環繞增強 :測試的時候finally的切面日誌註釋不列印,因為日誌多了反而不好除錯,上線時再取消註釋
   *
   * @param jp
   * @return
   * @throws Throwable
   */
  @Around("myPointcut()")
  public Object aroundLogger(ProceedingJoinPoint jp) throws Throwable {
 
    logger.info("admin---------------------------------後臺請求介面日誌----------------------------------------------");
    logger.info("訪問的介面:" + jp.getTarget().getClass().getName() + "." + jp.getSignature().getName());
    //入參列印json陣列格式
 
    try {
      logger.info("請求入參為:" + new JSONArray(Arrays.asList(jp.getArgs())).toString());
    } catch (Exception e) {
      logger.info("請求入參為:圖片,以免控制檯難看或者日誌難看
      //e.printStackTrace();
    }
 
    try {
      Object result = jp.proceed();
      logger.info("方法返回值:" + JSON.toJSONString(result));
      return result;
    } catch (Throwable e) {
      logger.info("訪問的介面:" + jp.getTarget().getClass().getName() + "." + jp.getSignature().getName());
      logger.info("請求入參為:" + new JSONArray(Arrays.asList(jp.getArgs())).toString());
      logger.error(jp.getSignature().getName() + " 方法發生異常【" + e + "】");
      throw e;
    } finally {
      //logger.info("訪問的介面: " + jp.getTarget().getClass().getName() + "."+jp.getSignature().getName());
      //logger.info("請求入參為: "+ new JSONArray(Arrays.asList(jp.getArgs())).toString());
      //logger.info("執行   :" + jp.getSignature().getName() + "方法結束。");
    }
  } 
}

------------------------------------下面是spring AOP配置需要的額外依賴-----------------------------------------

    <dependency>
      <groupId>aopalliance</groupId>
      <artifactId>aopalliance</artifactId>
      <version>1.0</version>
    </dependency>  
    <dependency>
      <groupId>org.aspectj</groupId>
      <artifactId>aspectjrt</artifactId>
      <version>1.6.12</version>
    </dependency>
    <dependency>
      <groupId>org.aspectj</groupId>
      <artifactId>aspectjweaver</artifactId>
      <version>1.6.12</version>
    </dependency>
    <dependency>
      <groupId>cglib</groupId>
      <artifactId>cglib</artifactId>
      <version>2.2</version>
    </dependency>

到此這篇關於Springboot2 配置AOP日誌的方法步驟的文章就介紹到這了,更多相關Springboot2 配置AOP日誌內容請搜尋我們以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援我們！

相關推薦

Springboot2 配置AOP日誌的方法步驟

Spring boot2 配置AOP前置增強,後置增強,異常增強,環繞增強,最終增強 關於AOP切面相關具體概念不做過多闡述(概念弄懂有利於理解思想),這是配置AOP的各種增強日誌,解決日誌巢狀在業務程式碼的麻煩和不科學

CentOS7安裝配置 Redis的方法步驟

導語 Redis 不用多介紹了，下面開始安裝配置吧。 安裝 下載原始碼 wget http://download.redis.io/releases/redis-4.0.12.tar.gz；

Django安裝配置mysql的方法步驟

近期做那個python的開發，今天就來簡單的寫一下Django安裝配置mysql的方法步驟

如何在VSCode上輕鬆舒適的配置Python的方法步驟

前言 之前被學長推薦使用了VSCode，後驚歎了VSCode的強大，尤其是他的配置，比之前使用sublime方便多了，剛好實驗室也來了一批新的學弟學妹，來仔細的逐步的講解一些，在自己的電腦上輕鬆的配置VSCode並完成美化等。

vscode配置anaconda3的方法步驟

注意： 由於博文已經很多這方面的內容，這裡不介紹安裝vscode和anaconda的步驟，只討論如下情況：

IDEA2020配置Git的方法步驟

注：此方法可用於配置gitee也可用於配置github 1.在github中建立一個賬號：https://github.com/join?source=header-home

Spring 使用JavaConfig實現配置的方法步驟

不使用Spring的XML配置，全權交給java來做！ JavaConfig是Spring的一個子專案，在Spring4之後，它稱為了Spring的核心功能！

plsql 連線oracle資料庫詳細配置的方法步驟

第一次用這種方式連線oracle資料庫，自己百度搞了快兩個小時才弄好，百度的資源也不靠譜，看了好多都不完整，搞完了報各種錯誤，各種連不上資料庫，自己整理下資料，希望給其他的同行予以借鑑，不能保證每個人都能操

Ubuntu安裝MySQL5.7並配置資料儲存路徑的方法步驟

一、安裝MySQL 本文是通過APT方式安裝,安裝的最新版本是5.7.21 （注意：通過APT方式安裝的版本都是現在最新的版本，通過這種方式安裝好之後開機自啟動都已經配置好，和命令列上的環境變數，無需手動配置。）

docker完整配置nginx+php+mysql的方法步驟

首先了解一個方法： 使用docker exec進入Docker容器 docker在1.3.X版本之後還提供了一個新的命令exec用於進入容器，這種方式相對更簡單一些，下面我們來看一下該命令的使用：

PyCharm使用之配置SSH Interpreter的方法步驟

在文章PyCharm使用之利用Docker映象搭建Python開發環境中，該文章介紹了在PyCharm中如何利用Docker映象搭建Python開發環境。在本文中，將會介紹如何使用PyCharm來配置SSH Interpreter，本文中的SSH Interpreter用Doc

安裝Pycharm2019以及配置anconda教程的方法步驟

一、獲取安裝包： Pycharm 官網 下載頁面 ：點選開啟 Anconda 官網 下載頁面 ：點選開啟

springboot配置aop切面日誌列印過程解析

這篇文章主要介紹了springboot配置aop切面日誌列印過程解析,文中通過示例程式碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下

vs2019永久配置opencv開發環境的方法步驟

有很多同學肯定想學習opencv相關的知識，但是有些情況下每建一次專案都要重新引入下各種檔案是不是很苦惱，所以我也面臨了這個問題，在網上看到很多的同學的方法，有的也都是很一樣的，將什麼.dll加入環境變數，然後

YII2框架中日誌的配置與使用方法例項分析

本文例項講述了YII2框架中日誌的配置與使用方法。分享給大家供大家參考，具體如下：

VSCode 配置C++開發環境的方法步驟

第一步、安裝VSCode應用程式 開啟VSCode官網，下載對應安裝包並預設安裝(這裡指明：安裝路徑可以修改)

在Ubuntu中安裝VSCode並配置C/C++開發環境的方法步驟

第一步，開啟Ubuntu Software下載VSCode。（so easy） 官網地址：https://code.visualstudio.com/docs/?dv=linux64_deb

VueCli4專案配置反向代理proxy的方法步驟

Vue Cli4建立專案之後，沒有配置vue.config.js，如果直接發起axios請求，可能會引起跨域問題.

VSCode配置C++環境的方法步驟（MSVC）

 最近心血來潮，想用一下微軟的VSCode寫一下C++，然而第一步就卡住了，竟然不會配置C++環境，陸陸續續搞了兩天，總算是弄明白了，網上msvc教程比較少，就打算分享出來，也記錄下自己的歷程。

Spring框架基於AOP實現簡單日誌管理步驟解析

SPringAOP的使用 技術概述，描述這個技術是做什麼？學習該技術的原因，技術的難點在哪裡。