文章首发于我的网站 [www.exception.site/springboot/…)java
本节中,您将学习如何在 Spring Boot 中使用 AOP 切面统一处理请求日志,打印进出参相关参数。git
能够看到,每一个对于每一个请求,开始与结束一目了然,而且打印了如下参数:github
POST
, GET
, 仍是 DELETE
等;效果应该还不错吧!接下来就让咱们一步一步去实现该功能, 首先,新建一个 Spring Boot Web 项目。web
在项目 pom.xml
文件中添加依赖:spring
<!-- aop 依赖 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
</dependency>
<!-- 用于日志切面中,以 json 格式打印出入参(原本使用阿里的 FASTJSON, 可是对于文件上传的接口,打印参数会报错,换为 Gson) -->
<dependency>
<groupId>com.google.code.gson</groupId>
<artifactId>gson</artifactId>
<version>2.8.5</version>
</dependency>
复制代码
在配置 AOP 切面以前,咱们须要了解下 aspectj
相关注解的做用:json
接下来,定义一个 WebLogAspect.java
切面类,代码以下:springboot
package site.exception.springbootaopwebrequest.aspect;
import com.google.gson.Gson;
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.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import javax.servlet.http.HttpServletRequest;
/** * @author www.exception.site (exception 教程网) * @date 2019/2/12 * @time 14:03 * @discription **/
@Aspect
@Component
public class WebLogAspect {
private final static Logger logger = LoggerFactory.getLogger(WebLogAspect.class);
/** 以 controller 包下定义的全部请求为切入点 */
@Pointcut("execution(public * site.exception.springbootaopwebrequest.controller..*.*(..))")
public void webLog() {}
/** * 在切点以前织入 * @param joinPoint * @throws Throwable */
@Before("webLog()")
public void doBefore(JoinPoint joinPoint) throws Throwable {
// 开始打印请求日志
ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
HttpServletRequest request = attributes.getRequest();
// 打印请求相关参数
logger.info("========================================== Start ==========================================");
// 打印请求 url
logger.info("URL : {}", request.getRequestURL().toString());
// 打印 Http method
logger.info("HTTP Method : {}", request.getMethod());
// 打印调用 controller 的全路径以及执行方法
logger.info("Class Method : {}.{}", joinPoint.getSignature().getDeclaringTypeName(), joinPoint.getSignature().getName());
// 打印请求的 IP
logger.info("IP : {}", request.getRemoteAddr());
// 打印请求入参
logger.info("Request Args : {}", new Gson().toJson(joinPoint.getArgs()));
}
/** * 在切点以后织入 * @throws Throwable */
@After("webLog()")
public void doAfter() throws Throwable {
logger.info("=========================================== End ===========================================");
// 每一个请求之间空一行
logger.info("");
}
/** * 环绕 * @param proceedingJoinPoint * @return * @throws Throwable */
@Around("webLog()")
public Object doAround(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
long startTime = System.currentTimeMillis();
Object result = proceedingJoinPoint.proceed();
// 打印出参
logger.info("Response Args : {}", new Gson().toJson(result));
// 执行耗时
logger.info("Time-Consuming : {} ms", System.currentTimeMillis() - startTime);
return result;
}
}
复制代码
咱们经过 @Aspect
声明了 WebLogAspect.java
为切面类,以后,经过 @Pointcut
定义了打印请求日志的切点,切点为 site.exception.springbootaopwebrequest.controller
包下全部的请求接口。app
切点定义好后,咱们经过 @Before
在切点以前打印请求的相关参数,经过 @Around
打印了请求接口的耗时时间,最后经过 @After
作了请求的收尾工做。spring-boot
到这里,切面相关的代码就完成了!学习
咱们针对 GET, POST, 文件提交,以及多文件提交四种接口分别测试其效果, 接口定义以下:
package site.exception.springbootaopwebrequest.controller;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.multipart.MultipartFile;
import site.exception.springbootaopwebrequest.entity.User;
/** * @author www.exception.site (exception 教程网) * @date 2019/2/16 * @time 21:03 * @discription **/
@RestController
public class TestController {
private final static Logger logger = LoggerFactory.getLogger(TestController.class);
/** * POST 方式接口测试 * @param user * @return */
@PostMapping("/user")
public User testPost(@RequestBody User user) {
logger.info("testPost ...");
return user;
}
/** * GET 方式接口测试 * @return */
@GetMapping("/user")
public String testGet(@RequestParam("username") String username, @RequestParam("password") String password) {
logger.info("testGet ...");
return "success";
}
/** * 单文件上传接口测试 * @return */
@PostMapping("/file/upload")
public String testFileUpload(@RequestParam("file") MultipartFile file) {
logger.info("testFileUpload ...");
return "success";
}
/** * 多文件上传接口测试 * @return */
@PostMapping("/multiFile/upload")
public String testMultiFileUpload(@RequestParam("file") MultipartFile[] file) {
logger.info("testMultiFileUpload ...");
return "success";
}
}
复制代码
User.java:
package site.exception.springbootaopwebrequest.entity;
import java.io.Serializable;
import java.util.Date;
/** * @author www.exception.site (exception 教程网) * @date 2019/2/16 * @time 21:00 * @discription **/
public class User implements Serializable {
/** * 用户名 */
private String username;
/** * 密码 */
private String password;
/** * 建立时间 */
private Date createTime;
public String getUsername() {
return username;
}
public void setUsername(String username) {
this.username = username;
}
public String getPassword() {
return password;
}
public void setPassword(String password) {
this.password = password;
}
public Date getCreateTime() {
return createTime;
}
public void setCreateTime(Date createTime) {
this.createTime = createTime;
}
}
复制代码
请求 http://localhost:8080/user?username=张三&password=123456
接口,观察日志打印状况:
GET 接口正常打印日志!
经过 Postman 请求 http://localhost:8080/user
POST 接口:
看看控制台输出效果:
POST 接口也是 OK 的!
请求单文件提交接口: http://localhost:8080/file/upload
:
日志输出以下:
请求单文件提交接口: http://localhost:8080/multiFile/upload
:
切面日志输出:
笔者在开始阶段的确使用的是阿里 FASTJSON 来作出入参的打印,可是对于文件上传接口,FASTJSON 转换会出错,故改用谷歌的 Gson。