spring AOP 實現日誌寫庫

設計原則和思路：

• 元註解方式結合AOP，靈活記錄操作日誌
• 能夠記錄詳細錯誤日誌爲運維提供支持
• 日誌記錄儘可能減少性能影響

1.定義日誌記錄元註解

2.定義用於記錄日誌的實體類

1. import java.io.Serializable;
2. import com.leon.common.util.StringUtils;
3. import com.fasterxml.jackson.annotation.JsonFormat;
4. import java.util.Date;
5. import java.util.Map;
7. /**
8. * 日誌類-記錄用戶操作行爲
9. * @author lin.r.x
10. *
11. */
12. public class Log implements Serializable{
13. private static final long serialVersionUID = 1L;
15. private String logId; //日誌主鍵
16. private String type; //日誌類型
17. private String title; //日誌標題
18. private String remoteAddr; //請求地址
19. private String requestUri; //URI
20. private String method; //請求方式
21. private String params; //提交參數
22. private String exception; //異常
23. @JsonFormat(pattern="yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
24. private Date operateDate; //開始時間
25. private String timeout; //結束時間
26. private String userId; //用戶ID
27.     private String resultParams;    //返回參數
29. public String getLogId() {
30. return StringUtils.isBlank(logId) ? logId : logId.trim();
31. }
32. public void setLogId(String logId) {
33. this.logId = logId;
34. }
35.      public String getResultParams() {
36.         return resultParams;
37.     }
38.     public void setResultParams(String resultParams) {
39.         this.resultParams = resultParams;
40.     }
42. public String getType() {
43. return StringUtils.isBlank(type) ? type : type.trim();
44. }
45. public void setType(String type) {
46. this.type = type;
47. }
50. public String getTitle() {
51. return StringUtils.isBlank(title) ? title : title.trim();
52. }
53. public void setTitle(String title) {
54. this.title = title;
55. }
58. public String getRemoteAddr() {
59. return StringUtils.isBlank(remoteAddr) ? remoteAddr : remoteAddr.trim();
60. }
61. public void setRemoteAddr(String remoteAddr) {
62. this.remoteAddr = remoteAddr;
63. }
66. public String getRequestUri() {
67. return StringUtils.isBlank(requestUri) ? requestUri : requestUri.trim();
68. }
69. public void setRequestUri(String requestUri) {
70. this.requestUri = requestUri;
71. }
74. public String getMethod() {
75. return StringUtils.isBlank(method) ? method : method.trim();
76. }
77. public void setMethod(String method) {
78. this.method = method;
79. }
82. public String getParams() {
83. return StringUtils.isBlank(params) ? params : params.trim();
84. }
85. public void setParams(String params) {
86. this.params = params;
87. }
89. /**
90. * 設置請求參數
91. * @param paramMap
92. */
93. public void setMapToParams(Map<String, String[]> paramMap) {
94. if (paramMap == null){
95. return;
96. }
97. StringBuilder params = new StringBuilder();
98. for (Map.Entry<String, String[]> param : ((Map<String, String[]>)paramMap).entrySet()){
99. params.append(("".equals(params.toString()) ? "" : "&") + param.getKey() + "=");
100. String paramValue = (param.getValue() != null && param.getValue().length > 0 ? param.getValue()[0] : "");
101. params.append(StringUtils.abbr(StringUtils.endsWithIgnoreCase(param.getKey(), "password") ? "" : paramValue, 100));
102. }
103. this.params = params.toString();
104. }
107. public String getException() {
108. return StringUtils.isBlank(exception) ? exception : exception.trim();
109. }
110. public void setException(String exception) {
111. this.exception = exception;
112. }
115. public Date getOperateDate() {
116. return operateDate;
117. }
118. public void setOperateDate(Date operateDate) {
119. this.operateDate = operateDate;
120. }
123. public String getTimeout() {
124. return StringUtils.isBlank(timeout) ? timeout : timeout.trim();
125. }
126. public void setTimeout(String timeout) {
127. this.timeout = timeout;
128. }
131. public String getUserId() {
132. return StringUtils.isBlank(userId) ? userId : userId.trim();
133. }
134. public void setUserId(String userId) {
135. this.userId = userId;
136. }
138. }

工具類代碼:

3.定義日誌AOP切面類(日誌新增及修改其它業務操作不做介紹):

package com.isoftstone.api.common.log.aspect;

import java.lang.reflect.Method;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Map;

import javax.servlet.http.HttpServletRequest;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.After;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.AfterThrowing;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.NamedThreadLocal;
import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;
import org.springframework.stereotype.Component;

import com.isoftstone.api.common.config.security.UserUtils;
import com.isoftstone.api.common.log.target.SystemControllerLog;
import com.isoftstone.api.common.log.target.SystemServiceLog;
import com.isoftstone.api.common.log.utils.DateUtils;
import com.isoftstone.api.common.log.utils.UuidUtils;
import com.isoftstone.api.common.utils.JsonUtils;
import com.isoftstone.api.common.utils.redis.RedisUtil;
import com.isoftstone.api.log.entity.Log;
import com.isoftstone.api.log.service.LogService;
import com.isoftstone.api.system.entity.Users;


/**
* @author leon
* @createDate 2018年6月6日 上午10:33:35
* @version v1.0
* @classRemarks 日誌切面類
*/
@Aspect
@Component
public class SystemLogAspect {
    
    private static Logger logger = LoggerFactory.getLogger(SystemLogAspect.class);
    
    private static final ThreadLocal<Date> beginTimeThreadLocal = new NamedThreadLocal<Date>("ThreadLocal beginTime");
    private static final ThreadLocal<Log> logThreadLocal =  new NamedThreadLocal<Log>("ThreadLocal log");

    private static final ThreadLocal<Users> currentUser=new NamedThreadLocal<>("ThreadLocal user");
    
    @Autowired(required=false)
    HttpServletRequest request;

    @Autowired
    ThreadPoolTaskExecutor threadPoolTaskExecutor;
    
    @Autowired
    LogService logService;
    
    @Autowired
    RedisUtil redisUtil;
    
    /**
     * Service層切點 
     */
    @Pointcut("@annotation(com.isoftstone.api.common.log.target.SystemServiceLog)")
    public void serviceAspect(){}
    
    /**
     * Controller層切點 註解攔截
     */
    @Pointcut("@annotation(com.isoftstone.api.common.log.target.SystemControllerLog)")
    public void controllerAspect(){}
    
    /*@Pointcut("execution(* com.isoftstone.api.*.controller.*.*(..))")
    public void controllerPointerCut(){}*/

    /**
     * 前置通知 用於攔截Controller層記錄用戶的操作的開始時間
     * @param joinPoint 切點
     * @throws InterruptedException 
     */
    @Before("controllerAspect()")
    public void doBefore(JoinPoint joinPoint) throws InterruptedException{
        
        logger.info("進入日誌切面前置通知!!");
        Date beginTime=new Date();
        beginTimeThreadLocal.set(beginTime);//線程綁定變量（該數據只有當前請求的線程可見）  
        if (logger.isDebugEnabled()){//這裏日誌級別爲debug
            logger.debug("開始計時: {}  URI: {}", new SimpleDateFormat("yyyy-MM-dd HH:mm:ss.SSS")
                .format(beginTime), request.getRequestURI());
        }

        //讀取session中的用戶 
        /*HttpSession session = request.getSession();       
        Users user = (Users) session.getAttribute("ims_user"); */   
        Users user=UserUtils.getUser(redisUtil);
        currentUser.set(user);

    }

    /**
     * 後置通知 用於攔截Controller層記錄用戶的操作
     * @param joinPoint 切點
     */
    @After("controllerAspect()")
    public void doAfter(JoinPoint joinPoint) {
        logger.info("進入日誌切面後置通知!!");
        Users user = currentUser.get();
        if(user !=null){
            String title="";
            String type="info";                       //日誌類型(info:入庫,error:錯誤)
            String remoteAddr=request.getRemoteAddr();//請求的IP
            String requestUri=request.getRequestURI();//請求的Uri
            String method=request.getMethod();        //請求的方法類型(post/get)
            Map<String,String[]> params=request.getParameterMap(); //請求提交的參數
            
            try {
                title=getControllerMethodDescription2(joinPoint);
            } catch (Exception e) {
                e.printStackTrace();
            }    
            // 打印JVM信息。
            long beginTime = beginTimeThreadLocal.get().getTime();//得到線程綁定的局部變量（開始時間）  
            long endTime = System.currentTimeMillis();  //2、結束時間  
            if (logger.isDebugEnabled()){
                logger.debug("計時結束：{}  URI: {}  耗時： {}   最大內存: {}m  已分配內存: {}m  已分配內存中的剩餘空間: {}m  最大可用內存: {}m",
                        new SimpleDateFormat("yyyy-MM-dd HH:mm:ss.SSS").format(endTime), 
                        request.getRequestURI(), 
                        DateUtils.formatDateTime(endTime - beginTime),
                        Runtime.getRuntime().maxMemory()/1024/1024, 
                        Runtime.getRuntime().totalMemory()/1024/1024, 
                        Runtime.getRuntime().freeMemory()/1024/1024, 
                        (Runtime.getRuntime().maxMemory()-Runtime.getRuntime().totalMemory()+Runtime.getRuntime().freeMemory())/1024/1024); 
            }
            logger.info("設置日誌信息存儲到表中!!");
            Log log=new Log();
            log.setLogId(UuidUtils.creatUUID());
            log.setTitle(title);
            log.setType(type);
            log.setRemoteAddr(remoteAddr);
            log.setRequestUri(requestUri);
            log.setMethod(method);
            log.setMapToParams(params);
            log.setException("無異常!");
            log.setUserId(user.getUsername());
            Date operateDate=beginTimeThreadLocal.get();
            log.setOperateDate(operateDate);
            log.setTimeout(DateUtils.formatDateTime(endTime - beginTime));

            //1.直接執行保存操作
            //this.logService.addLog(log);

            //2.優化:異步保存日誌
            //new SaveLogThread(log, logService).start();

            //3.再優化:通過線程池來執行日誌保存
            threadPoolTaskExecutor.execute(new SaveLogThread(log, logService));
            logThreadLocal.set(log);
        }

    }
    
    @AfterReturning(returning = "res", pointcut = "controllerAspect()")
    public void doAfterReturning(Object res) throws Throwable {
        // 處理完請求，返回內容
        logger.info("==========返回參數日誌=========");
        logger.info("返回接口響應參數:"+JsonUtils.obj2JSON(res));
        Log log = logThreadLocal.get();
        if (log!=null) {
            log.setResultParams(JsonUtils.obj2JSON(res));
            logger.info("==========更新日誌參數=========");
            new UpdateLogThread(log, logService).start();
        }
    }

    /**
     *  異常通知 記錄操作報錯日誌
     * @param joinPoint
     * @param e
     */
    @AfterThrowing(pointcut = "controllerAspect()", throwing = "e")  
    public  void doAfterThrowing(JoinPoint joinPoint, Throwable e) {
        logger.info("進入日誌切面異常通知!!");
        logger.info("異常信息:"+e.getMessage());
        Log log = logThreadLocal.get();
        if (log!=null) {
            log.setType("error");
            log.setException(e.toString());
            new UpdateLogThread(log, logService).start();
        }
    }

    /**
     * 獲取註解中對方法的描述信息 用於service層註解
     * @param joinPoint切點
     * @return discription
     */
    public static String getServiceMthodDescription2(JoinPoint joinPoint) {
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();
        Method method = signature.getMethod();
        SystemServiceLog serviceLog = method.getAnnotation(SystemServiceLog.class);
        String discription = serviceLog.description();
        return discription;
    }

    /**
     * 獲取註解中對方法的描述信息 用於Controller層註解
     * 
     * @param joinPoint 切點
     * @return discription
     */
    public static String getControllerMethodDescription2(JoinPoint joinPoint) {
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();
        Method method = signature.getMethod();
        SystemControllerLog controllerLog = method.getAnnotation(SystemControllerLog.class);
        String discription = controllerLog.description();
        return discription;
    }

    /**
     * 保存日誌線程
     */
    private static class SaveLogThread implements Runnable {
        private Log log;
        private LogService logService;

        public SaveLogThread(Log log, LogService logService) {
            this.log = log;
            this.logService = logService;
        }

        @Override
        public void run() {
            logService.addLog(log);
        }
    }

    /**
     * 日誌更新線程
     */
    private static class UpdateLogThread extends Thread {
        private Log log;
        private LogService logService;

        public UpdateLogThread(Log log, LogService logService) {
            super(UpdateLogThread.class.getSimpleName());
            this.log = log;
            this.logService = logService;
        }

        @Override
        public void run() {
            this.logService.putLog(log);
        }
    }

}

線程池配置代碼:

package com.isoftstone.api.common.log.thread;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;

/**
* @author leon
* @createDate 2018年6月6日 上午11:23:22
* @version v1.0
* @classRemarks 線程池配置
*/

@Configuration
@ConfigurationProperties(prefix="threadpool")
public class ExecutePoolConfiguration {
    
    private static Logger logger = LoggerFactory.getLogger(ExecutePoolConfiguration.class);

    /**
     * application.yml 配置方式
        threadpool:
          core-pool-size: 10
          max-pool-size: 20
          queue-capacity: 1000
          keep-alive-seconds: 300
     */
    @Value("${threadpool.core-pool-size}")
    private int corePoolSize;

    @Value("${threadpool.max-pool-size}")
    private int maxPoolSize;

    @Value("${threadpool.queue-capacity}")
    private int queueCapacity;

    @Value("${threadpool.keep-alive-seconds}")
    private int keepAliveSeconds;


    @Bean(name="threadPoolTaskExecutor")
    public ThreadPoolTaskExecutor threadPoolTaskExecutor(){
        
        ThreadPoolTaskExecutor pool = new ThreadPoolTaskExecutor();
        pool.setKeepAliveSeconds(keepAliveSeconds);
        pool.setCorePoolSize(corePoolSize);//核心線程池數
        pool.setMaxPoolSize(maxPoolSize); // 最大線程
        pool.setQueueCapacity(queueCapacity);//隊列容量
        pool.setRejectedExecutionHandler(new java.util.concurrent.ThreadPoolExecutor.CallerRunsPolicy()); //隊列滿，線程被拒絕執行策略
        return pool;
    }

}

屬性文件中添加下列配置:

4.spring boot配置掃描切面，開啓@AspectJ註解的支持

5.使用範例LoginController方法中添加日誌註解

6.運行效果