Springboot 列印 接口 耗時
三種方式 下面為大家一一對應
- aop切面的方式
- 過濾器的方式
- 攔截器的方式
1 aop切面的方式
1.1 實作思路
- 引入aop依賴
- 自定義注解
- 定義切面，采用環繞通知
1.2 代碼實作
1）引入依賴
<!--aop-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
</dependency>
2）自定義注解LogAnnotation
/**
* 日志注解
* METHOD 方法上 type 類上
*/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface LogAnnotation {
/**
* 子產品
*/
String module() default "";
/**
* 簡單描述接口的作用
*/
String operation() default "";
}
3）定義切面
簡單分析一下切面實作的功能：
/**
* @author : look-word
* 2022-07-27 16:03
**/
@Slf4j
@Aspect
@Component
public class LogAspect {
/**
* 切入點
*/
@Pointcut("@annotation(look.word.reggie.common.aop.LogAnnotation)")
public void logPointCut() {
}
/**
* 環繞通知
*
* @param point 連接配接點
*/
@Around("logPointCut()")
public Object around(ProceedingJoinPoint point) throws Throwable {
long beginTime = System.currentTimeMillis();
//執行方法
Object result = point.proceed();
//執行時長(毫秒)
long time = System.currentTimeMillis() - beginTime;
//儲存日志
recordLog(point, time);
return result;
}
private void recordLog(ProceedingJoinPoint joinPoint, long time) {
MethodSignature signature = (MethodSignature) joinPoint.getSignature();
// 擷取目前方法
Method method = signature.getMethod();
LogAnnotation logAnnotation = method.getAnnotation(LogAnnotation.class);
log.info("=====================log start================================");
log.info("module:{}", logAnnotation.module());
log.info("operation:{}", logAnnotation.operation());
//請求的方法名
String className = joinPoint.getTarget().getClass().getName();
String methodName = signature.getName();
log.info("request method:{}", className + "." + methodName + "()");
//請求的參數
Object[] args = joinPoint.getArgs();
Stream<?> stream = ArrayUtils.isEmpty(args) ? Stream.empty() : Arrays.stream(args);
List<Object> logArgs =
stream.filter(arg -> (!(arg instanceof HttpServletRequest) && !(arg instanceof HttpServletResponse))).collect(Collectors.toList());
String params = JSON.toJSONString(logArgs);
log.info("params:{}", params);
//擷取request 設定IP位址
HttpServletRequest request = HttpContextUtils.getHttpServletRequest();
log.info("ip:{}", IpUtils.getIpAddr(request));
log.info("execute time : {} ms", time);
log.info("=====================log end================================");
}
}
1.3 功能測試
在接口上添加注解即可，還有描述資訊
2 過濾器的方式
這種方式簡單點 但是可配置性不高
**注意：**一定得掃描到spring容器中
建立一個類 實作 filter接口
- init:該方法是對filter對象進行初始化的方法，僅在容器初始化filter對象結束後被調用一次，參數FilterConfig可以獲得filter的初始化參數；
- doFilter:可以對request和response進行
。<u>預處理</u>
request和response對象傳遞到過濾鍊上的下一個資源。其中FilterChain可以将處理後的
- destroy():該方法在容器銷毀對象前被調用。
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
@Component
public class LogFilter implements Filter {
private static final Logger LOG = LoggerFactory.getLogger(LogFilter.class);
@Override
public void init(FilterConfig filterConfig) throws ServletException {
}
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
// 列印請求資訊
HttpServletRequest request = (HttpServletRequest) servletRequest;
LOG.info("------------- LogFilter 開始 -------------");
LOG.info("請求位址: {} {}", request.getRequestURL().toString(), request.getMethod());
LOG.info("遠端位址: {}", request.getRemoteAddr());
long startTime = System.currentTimeMillis();
filterChain.doFilter(servletRequest, servletResponse);
LOG.info("------------- LogFilter 結束 耗時：{} ms -------------", System.currentTimeMillis() - startTime);
}
}
結果
總結
1.過濾器用來實作通用的功能，減少代碼備援，提高可維護性；
2.一個過濾器可以配置給多個資源使用（編碼過濾器）；
3.一個資源也可以配置多個過濾器，按照配置順序調用。
3 攔截器的方式
如果不懂 請先看了 介紹再來
攔截器的介紹
話不說多 直接上代碼
建立攔截器
/**
* 攔截器：Spring架構特有的，常用于登入校驗，權限校驗，請求日志列印 /login
* @author : look-word
* 2022-06-26 13:55
**/
@Component
public class LogInterceptor implements HandlerInterceptor {
private static final Logger LOG = LoggerFactory.getLogger(LogInterceptor.class);
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
// 列印請求資訊
LOG.info("------------- LogInterceptor 開始 -------------");
LOG.info("請求位址: {} {}", request.getRequestURL().toString(), request.getMethod());
LOG.info("遠端位址: {}", request.getRemoteAddr());
long startTime = System.currentTimeMillis();
request.setAttribute("requestStartTime", startTime);
return true;
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
long startTime = (Long) request.getAttribute("requestStartTime");
LOG.info("------------- LogInterceptor 結束 耗時：{} ms -------------", System.currentTimeMillis() - startTime);
}
}
注冊攔截器
把我們的攔截器 注冊到 攔截器鍊中
/**
* @author : look-word
* 2022-06-26 14:03
**/
@Configuration
public class SpringMvcConfig implements WebMvcConfigurer {
@Resource
private LogInterceptor logInterceptor;
/**
* 注冊攔截器
* @param registry
*/
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry
.addInterceptor(logInterceptor)
.addPathPatterns("/**")// 對那些接口攔截
.excludePathPatterns("/login");// 對哪些接機口放行
WebMvcConfigurer.super.addInterceptors(registry);
}
}
測試結果