- 依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
</dependency>
<!-- 用于日志切面中,以 json 格式打印出入参 -->
<dependency>
<groupId>com.google.code.gson</groupId>
<artifactId>gson</artifactId>
<version>2.8.5</version>
</dependency>
2.编写注解
import java.lang.annotation.*;
/**
* @author 犬小哈 (微信号:小哈学Java)
* @site www.exception.site
* @date 2019/2/12
* @time 下午9:19
* @discription
**/
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
@Documented
public @interface WebLog {
/**
* 日志描述信息
*
* @return
*/
String description() default "";
}
3.编写带有该注解的切面定义类
注意修改以下@Pointcut("@annotation(site.exception.springbootaopwebrequest.aspect.WebLog)")
WebLog注解类的全限定名按照自己代码所在的包地址修改
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.context.annotation.Profile;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import javax.servlet.http.HttpServletRequest;
import java.lang.reflect.Method;
/**
* @author 犬小哈 (微信号:小哈学Java)
* @site www.exception.site
* @date 2019/2/12
* @time 下午9:19
* @discription
**/
@Aspect
@Component
@Profile({"dev", "test"})
public class WebLogAspect {
private final static Logger logger = LoggerFactory.getLogger(WebLogAspect.class);
/** 换行符 */
private static final String LINE_SEPARATOR = System.lineSeparator();
/** 以自定义 @WebLog 注解为切点 */
@Pointcut("@annotation(site.exception.springbootaopwebrequest.aspect.WebLog)")
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();
// 获取 @WebLog 注解的描述信息
String methodDescription = getAspectLogDescription(joinPoint);
// 打印请求相关参数
logger.info("========================================== Start ==========================================");
// 打印请求 url
logger.info("URL : {}", request.getRequestURL().toString());
// 打印描述信息
logger.info("Description : {}", methodDescription);
// 打印 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 ===========================================" + LINE_SEPARATOR);
}
/**
* 环绕
* @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;
}
/**
* 获取切面注解的描述
*
* @param joinPoint 切点
* @return 描述信息
* @throws Exception
*/
public String getAspectLogDescription(JoinPoint joinPoint)
throws Exception {
String targetName = joinPoint.getTarget().getClass().getName();
String methodName = joinPoint.getSignature().getName();
Object[] arguments = joinPoint.getArgs();
Class targetClass = Class.forName(targetName);
Method[] methods = targetClass.getMethods();
StringBuilder description = new StringBuilder("");
for (Method method : methods) {
if (method.getName().equals(methodName)) {
Class[] clazzs = method.getParameterTypes();
if (clazzs.length == arguments.length) {
description.append(method.getAnnotation(WebLog.class).description());
break;
}
}
}
return description.toString();
}
}
4.编写测试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.aspect.WebLog;
import site.exception.springbootaopwebrequest.entity.User;
/**
* @author 犬小哈 (微信号:小哈学Java)
* @site www.exception.site
* @date 2019/2/12
* @time 下午9:19
* @discription
**/
@RestController
public class TestController {
private final static Logger logger = LoggerFactory.getLogger(TestController.class);
/**
* POST 方式接口测试
* @param user
* @return
*/
@PostMapping("/user/login")
@WebLog(description = "请求了用户登录接口")
public User userLogin(@RequestBody User user) {
logger.info("user login ...");
return user;
}
/**
* GET 方式接口测试
* @return
*/
@GetMapping("/user/{id}")
@WebLog(description = "请求了用户登录接口")
public String findUserInfo(@PathVariable("id") String userId) {
logger.info("find user info ...");
return "success";
}
/**
* GET 方式接口测试
* @return
*/
@GetMapping("/test")
@WebLog(description = "测试方法")
public String test() {
logger.info("testGet ...");
return "success";
}
/**
* 单文件上传接口测试
* @return
*/
@PostMapping("/file/upload")
@WebLog(description = "单文件上传接口")
public String testFileUpload(@RequestParam("file") MultipartFile file) {
logger.info("testFileUpload ...");
return "success";
}
/**
* 多文件上传接口测试
* @return
*/
@PostMapping("/multiFile/upload")
@WebLog(description = "多文件上传接口")
public String testMultiFileUpload(@RequestParam("file") MultipartFile[] file) {
logger.info("testMultiFileUpload ...");
return "success";
}
}
其中,controller类中的User类如下
import java.io.Serializable;
import java.util.Date;
/**
* @author 犬小哈 (微信号:小哈学Java)
* @site www.exception.site
* @date 2019/2/12
* @time 下午9:19
* @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;
}
}
6.切面日志的输出效果
从上图中可以看到,每个对于每个请求,开始与结束一目了然,并且打印了以下参数:
- URL: 请求接口地址;
- Description: 接口的中文说明信息;
- HTTP Method: 请求的方法,是
POST
,GET
, 还是DELETE
等; - Class Method: 被请求的方法路径 : 包名 + 方法名;
- IP: 请求方的 IP 地址;
- Request Args: 请求入参,以 JSON 格式输出;
- Response Args: 响应出参,以 JSON 格式输出;
- Time-Consuming: 请求耗时,以此估算每个接口的性能指数;
参考:https://www.cnblogs.com/quanxiaoha/p/10789843.html
代码GitHub地址:https://github.com/weiwosuoai/spring-boot-tutorial/tree/master/spring-boot-aop-web-request