【Spring Boot】Aop方式记录Web请求

1. 前言

使用Logback框架记录日志，不多介绍，推荐阅读：【Spring Boot】Logback日志。

本文主要介绍使用Aop方式拦截Web请求并记录日志。

2. 实现

2.1 Maven配置

2.1.1 版本

<spring.boot.version>2.1.0.RELEASE</spring.boot.version>
<hutool.version>5.0.0</hutool.version>
<user.agent.version>1.20</user.agent.version>
<lombok.version>1.18.2</lombok.version>

2.1.2 依赖

主要是引入starter-web和starter-aop，其他的都是辅助依赖。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
</dependency>

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <scope>test</scope>
</dependency>

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <optional>true</optional>
</dependency>

<dependency>
    <groupId>cn.hutool</groupId>
    <artifactId>hutool-all</artifactId>
</dependency>

<!-- 解析 UserAgent 信息 -->
<dependency>
    <groupId>eu.bitwalker</groupId>
    <artifactId>UserAgentUtils</artifactId>
</dependency>

2.2 切面

application.yml、logback-spring.xml以及启动类，按正常套路走便是，和本篇主题没多大关系，不知道的可看前言提到的推荐阅读。

最主要的是这个切面类的介绍。

@Aspect //声明该类是切面类
@Component
@Slf4j  //添加该注解，在方法中可直接使用log.info()进行日志打印
public class AopLog {
    private static final String START_TIME = "request-start";

    /**
     * 切入点，具体要拦截那些个方法
     * execution表达式里面啊主要包含六个部分
      * 第一个：public，是方法的访问修饰符
       * 第二个：*，是方法的返回值类型，*表示任意类型
       * 第三个：com.xkcoding.log.aop.controller，包路径
       * 第四个：*Controller，类名，在这是以Controller结尾的类
       * 第五个：*，代表任意方法
       * 第六个：(..)，代表任意个方法参数
     */
    @Pointcut("execution(public * com.xkcoding.log.aop.controller.*Controller.*(..))")
    public void log() {

    }

    /**
     * 前置操作，在执行方法体之前操作
     *
     * @param point 切入点
     */
    @Before("log()")
    public void beforeLog(JoinPoint point) {
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();

        HttpServletRequest request = Objects.requireNonNull(attributes).getRequest();

        log.info("【请求 URL】：{}", request.getRequestURL());
        log.info("【请求 IP】：{}", request.getRemoteAddr());
        log.info("【请求类名】：{}，【请求方法名】：{}", point.getSignature().getDeclaringTypeName(), point.getSignature().getName());

        Map<String, String[]> parameterMap = request.getParameterMap();
        log.info("【请求参数】：{}，", JSONUtil.toJsonStr(parameterMap));
        Long start = System.currentTimeMillis();
        request.setAttribute(START_TIME, start);
    }

    /**
     * 环绕操作，在方法返回结果后操作
     *
     * @param point 切入点
     * @return 原方法返回值
     * @throws Throwable 异常信息
     */
    @Around("log()")
    public Object aroundLog(ProceedingJoinPoint point) throws Throwable {
        Object result = point.proceed();
        log.info("【返回值】：{}", JSONUtil.toJsonStr(result));
        return result;
    }

    /**
     * 后置操作，在执行方法体之后，返回结果之前操作
     */
    @AfterReturning("log()")
    public void afterReturning() {
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = Objects.requireNonNull(attributes).getRequest();

        Long start = (Long) request.getAttribute(START_TIME);
        Long end = System.currentTimeMillis();
        log.info("【请求耗时】：{}毫秒", end - start);

        String header = request.getHeader("User-Agent");
        UserAgent userAgent = UserAgent.parseUserAgentString(header);
        log.info("【浏览器类型】：{}，【操作系统】：{}，【原始User-Agent】：{}", userAgent.getBrowser().toString(), userAgent.getOperatingSystem().toString(), header);
    }
}

2.3 Controller类

随便写个Controller类用来测试一下。

@RestController
public class TestController {

    /**
     * 测试方法
     *
     * @param who 测试参数
     * @return {@link Dict}
     */
    @GetMapping("/test")
    public Dict test(String who) {
        return Dict.create().set("who", StrUtil.isBlank(who) ? "me" : who);
    }

}