springboot使用攔截器打印入口日誌有兩種方法：（1）繼承 HandlerInterceptorAdapter 類；（2）AOP攔截
本文實現兩種方法（本文展示實現過程和期間遇到的問題及解決方法）
第一種 繼承 HandlerInterceptorAdapter 類
1、新建BaseInterceptor類繼承 HandlerInterceptorAdapter，實現攔截操作：
這裏攔截的內容比較簡單。在實際業務中，可能需要對上傳的數據進行攔截：這時 ，會發生一個問題，攔截器中獲取到Request請求對象中的參數後，controller中便獲取不到了。這個問題的具體描述和解決方法在另一篇文檔中描述。
package ***;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.lang.Nullable;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Map;
/**
* @author wangyan
* @description 攔截後preHandle方法實現的操作（打印入口日誌）
* @date 2019/7/12 10:13
*/
@Component
public class BaseInterceptor extends HandlerInterceptorAdapter {
protected final Logger logger = LoggerFactory.getLogger(this.getClass());
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
throws Exception {
info("******************【RequestBeginning】********************");
info("----------------StartProcessingRequest----------------");
try {
Long currentTime = System.currentTimeMillis();
SimpleDateFormat formatter = new SimpleDateFormat("yyyy/MM/dd HH:mm:ss");
Date date = new Date(currentTime);
info("CurrentTime：{}",formatter.format(date));
info("ResponseTime:{}",(System.currentTimeMillis() - currentTime) + "ms");
String requestURL = request.getRequestURI();
info("RequestURL： {} ", requestURL);
info("GetMethod: {}", handler);
} catch (Exception e) {
error("MVC業務處理-攔截器異常：", e);
}
info("-------------------------End-------------------------");
return true;
}
/**
* This implementation is empty.
*/
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
@Nullable ModelAndView modelAndView) throws Exception {
logger.info("after");
}
/**
* This implementation is empty.
*/
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler,
@Nullable Exception ex) throws Exception {
logger.info("Completion");
}
/**
* This implementation is empty.
*/
@Override
public void afterConcurrentHandlingStarted(HttpServletRequest request, HttpServletResponse response,
Object handler) throws Exception {
logger.info("Concurrent");
}
protected final void error(String msg, Object... objects) {
logger.error(msg, objects);
}
protected final void info(String msg, Object... objects) {
logger.info(msg, objects);
}
}
2、config下新建BaseInterceptorConfig類，定義需要攔截的內容：
package io.transwarp.esb.config;
import io.transwarp.esb.aop.logging.BaseInterceptor;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
/**
* @author wangyan
* @description 定義需要攔截的路徑
* @date 2019/7/12 10:19
*/
@Configuration
public class BaseInterceptorConfig extends WebMvcConfigurationSupport {
@Autowired
BaseInterceptor baseInterceptor;
@Override
protected void addInterceptors(InterceptorRegistry registry) {
//排除此路徑，其他都攔截
// registry.addInterceptor(baseInterceptor).excludePathPatterns("/base/test");
//指定路徑，只攔截此路徑
registry.addInterceptor(baseInterceptor)
.addPathPatterns("/base/test")
.excludePathPatterns("/swagger-resources/**", "/webjars/**", "/v2/**", "/swagger-ui.html/**");
//如果兩個同時存在，排除生效，指定的路徑會攔截兩次
//添加攔截器
super.addInterceptors(registry);
}
@Override
protected void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("swagger-ui.html")
.addResourceLocations("classpath:/META-INF/resources/");
registry.addResourceHandler("/webjars/**")
.addResourceLocations("classpath:/META-INF/resources/webjars/");
}
}
3、以上是實現攔截器的全部代碼。這期間需要注意：引入攔截器後，swagger不能使用。這需要將swagger相關的路徑都排除在攔截器外，是由BaseInterceptorConfig類裏的
.excludePathPatterns("/swagger-resources/**", "/webjars/**", "/v2/**", "/swagger-ui.html/**");
來實現的。
4、最終結果如下：
***************************【RequestBeginning】***************************
----------------StartProcessingRequest----------------
CurrentTime：2019/07/15 10:35:34
ResponseTime:2ms
RequestURL： /base/testGetMethod: public java.lang.String io.transwarp.esb.controller.EsbController.test(java.lang.String)
-------------------------End-------------------------
第二種 AOP攔截
1、gradle 加入依賴：
compile group: 'org.aspectj', name: 'aspectjweaver', version: '1.9.2'
maven 加入依賴：
<!-- https://mvnrepository.com/artifact/org.aspectj/aspectjweaver -->
<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjweaver</artifactId>
<version>1.9.2</version>
</dependency>
2、新建 LoggingAspect 類
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.*;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
/**
* @description
* @author wangyan
* @date 2019/7/11 15:36
*/
@Aspect
@Component
public class LoggingAspect {
protected final Logger logger = LoggerFactory.getLogger(this.getClass());
// 定義一個 Pointcut, 使用 切點表達式函數 來描述對哪些 Join point 使用 advise.
@Pointcut("within(io.transwarp.esb.controller.EsbController)")
public void controllerLog(){
}
// 定義 advise
@Before("controllerLog()")
public void logMethodInvokeParam(JoinPoint joinPoint) {
logger.info("---Before method {} invoke, param: {}---", joinPoint.getSignature().toShortString(), joinPoint.getArgs());
}
@AfterReturning(pointcut = "controllerLog()", returning = "retVal")
public void logMethodInvokeResult(JoinPoint joinPoint, Object retVal) {
logger.info("---After method {} invoke, result: {}---", joinPoint.getSignature().toShortString(), joinPoint.getArgs());
}
@AfterThrowing(pointcut = "controllerLog()", throwing = "exception")
public void logMethodInvokeException(JoinPoint joinPoint, Exception exception) {
logger.info("---method {} invoke exception: {}---", joinPoint.getSignature().toShortString(), exception.getMessage());
}
}
3、AOP的實現方式很簡單，但需注意引入jar包
下載地址：
https://github.com/WangYanZ/esb/tree/master/src/main/java/io/transwarp/esb/aop/logging