詳解AOP與Filter攔截請求打印日志實用例子
更新時間：2018年09月10日 15:25:26 作者：EalenXie
這篇文章主要介紹了詳解AOP與Filter攔截請求打印日志實用例子，小編覺得挺不錯的，現在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧
相信各位同道在寫代碼的時候，肯定會寫一些日志打印，因為這對往后的運維而言，至關重要的。
那么我們請求一個restfull接口的時候，哪些信息是應該被日志記錄的呢？
以下做了一個基本的簡單例子，這里只是示例說明基本常規(guī)實現記錄的信息，根據項目的真實情況選用:
1 . Http請求攔截器(Filter) : 從HttpServletRequest獲取基本的請求信息
import name.ealen.util.HttpUtil;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.annotation.Order;
import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
/**
* Created by EalenXie on 2018/9/7 15:56.
* Http請求攔截器,日志打印請求基本相關信息
*/
@Configuration
public class FilterConfiguration {
private static final Logger log = LoggerFactory.getLogger(FilterConfig.class);
@Bean
@Order(Integer.MIN_VALUE)
@Qualifier("filterRegistration")
public FilterRegistrationBean filterRegistration() {
FilterRegistrationBean<Filter> registration = new FilterRegistrationBean<>();
registration.setFilter(controllerFilter());
registration.addUrlPatterns("/*");
return registration;
}
private Filter controllerFilter() {
return new Filter() {
@Override
public void init(FilterConfig filterConfig) {
log.info("ControllerFilter init Success");
}
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain chain) throws IOException, ServletException {
HttpServletRequest request = (HttpServletRequest) servletRequest;
HttpServletResponse response = (HttpServletResponse) servletResponse;
String requestId = request.getHeader("Request-Id");
if (requestId == null) requestId = request.getRequestedSessionId();
System.out.println();
log.info("Http Request Request-Id : " + requestId);
log.info("Http Request Information : {\"URI\":\"" + request.getRequestURL() +
"\",\"RequestMethod\":\"" + request.getMethod() +
"\",\"ClientIp\":\"" + HttpUtil.getIpAddress(request) +
"\",\"Content-Type\":\"" + request.getContentType() +
"\"}");
chain.doFilter(request, response);
}
@Override
public void destroy() {
log.info("ControllerFilter destroy");
}
};
}
}
2 . Controller的攔截AOP : 獲取 請求的對象，請求參數，返回數據，請求返回狀態(tài)，內部方法耗時。
import com.alibaba.fastjson.JSON;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.core.env.Environment;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Component;
import javax.annotation.Resource;
/**
* Created by EalenXie on 2018/9/7 14:19.
* AOP打印日志 : 請求的對象,請求參數,返回數據,請求狀態(tài),內部方法耗時
*/
@Aspect
@Component
public class ControllerInterceptor {
private static final Logger log = LoggerFactory.getLogger(ControllerInterceptor.class);
@Resource
private Environment environment;
@Around(value = "execution (* name.ealen.web.*.*(..))")
public Object processApiFacade(ProceedingJoinPoint pjp) {
String appName;
try {
appName = environment.getProperty("spring.application.name").toUpperCase();
} catch (Exception e) {
appName = "UNNAMED";
}
long startTime = System.currentTimeMillis();
String name = pjp.getTarget().getClass().getSimpleName();
String method = pjp.getSignature().getName();
Object result = null;
HttpStatus status = null;
try {
result = pjp.proceed();
log.info("RequestTarget : " + appName + "." + name + "." + method);
log.info("RequestParam : " + JSON.toJSON(pjp.getArgs()));
if (result instanceof ResponseEntity) {
status = ((ResponseEntity) result).getStatusCode();
} else {
status = HttpStatus.OK;
}
} catch (Throwable throwable) {
status = HttpStatus.INTERNAL_SERVER_ERROR;
result = new ResponseEntity<>("{\"Internal Server Error\" : \"" + throwable.getMessage() + "\"}", status);
throwable.printStackTrace();
} finally {
log.info("ResponseEntity : {" + "\"HttpStatus\":\"" + status.toString() + "\"" + ",\"ResponseBody\": " + JSON.toJSON(result) + "}");
log.info("Internal Method Cost Time: {}ms", System.currentTimeMillis() - startTime);
}
return result;
}
}
3 . 提供一個簡單的restfull接口 :
package name.ealen.web;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/**
* Created by EalenXie on 2018/9/7 14:24.
*/
@RestController
public class SayHelloController {
@RequestMapping("/sayHello")
public String sayHello() {
return "hello world";
}
@RequestMapping("/say")
public ResponseEntity<?> say(@RequestBody Object o) {
return new ResponseEntity<>(o, HttpStatus.OK);
}
}
4 . 使用Postman進行基本測試 :
5 . 控制臺可以看到基本效果 :
以上只是關于Controller應該記錄日志的一個簡單的例子，完整代碼可見 https://github.com/EalenXie/springboot-controller-logger
以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支持腳本之家。
相關文章
這篇文章主要介紹了Spring框架實現AOP添加日志記錄功能過程詳解,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2019-12-12
這篇文章給大家分享了IntelliJ IDEA 詳細圖解最常用的配置的相關知識點內容，有需要的朋友們可以參考學習下。2018-07-07
這篇文章主要介紹了springmvc如何使用map接收參數的操作，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-10-10
這篇文章主要為大家詳細介紹了Java將數字金額轉為大寫中文金額，具有一定的參考價值，感興趣的小伙伴們可以參考一下2019-08-08
SpringMVC中@RequestMapping注解的實現
RequestMapping是一個用來處理請求地址映射的注解,本文主要介紹了SpringMVC中@RequestMapping注解的實現,具有一定的參考價值,感興趣的可以了解一下2024-01-01
這篇文章主要介紹了Java中的final關鍵字，有需要的朋友可以參考一下2014-01-01
SQL?Server是由Microsoft開發(fā)和推廣的以客戶/服務器（c/s）模式訪問、使用Transact-SQL語言的關系數據庫管理系統（DBMS）,本文給大家介紹了Spring?Boot集成SQL?Server的詳細指南,需要的朋友可以參考下2024-11-11
給出n個數，需要我們找出出現次數超過一半的數，下面小編給大家分享下我的實現思路及關鍵代碼，感興趣的朋友一起學習吧2016-07-07
這篇文章主要介紹了MyBatis實現動態(tài)SQL的實現方法，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2019-12-12
相信每一個學生學編程的時候，應該都會寫一個小項目——圖書管理系統。為什么這么說呢？我認為一個學校的氛圍很大一部分可以從圖書館的氛圍看出來，而圖書管理系統這個不大不小的項目，接觸的多，也比較熟悉，不會有陌生感，能夠練手，又有些難度，所以我的小項目也來了2021-11-11