[Java知识库]spring boot + aop 自定义日志--收集操作日志

背景：
spring boot + aop，自定义注解收集controller层日志；

1. 自定义注解
   1.1 自定义注解 pom.xml

 <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-dependencies</artifactId>
        <version>2.5.5</version>
    </parent>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-log4j2</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
        </dependency>
        <dependency>
            <groupId>com.google.code.gson</groupId>
            <artifactId>gson</artifactId>
            <version>2.8.5</version>
        </dependency>
    </dependencies>

1.2 自定义操作日志注解

import java.lang.annotation.*;

/**
 * 自定义操作日志注解
 */
@Target({ElementType.PARAMETER,ElementType.METHOD}) //注解放置的目标位置,METHOD是可注解在方法级别上
@Retention(RetentionPolicy.RUNTIME) //注解在哪个阶段执行
@Documented
public @interface OperLog {

    String operModul() default ""; //操作模块
    String operType() default ""; // 操作类型
    String operDesc() default ""; // 操作说明
}

1.3 用于打印输出日志的切面

import com.alibaba.fastjson.JSONObject;
import com.dexin.pinyougou.common.vo.ResultVO;
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.*;
import org.aspectj.lang.reflect.MethodSignature;
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;
import java.util.Objects;

/**
 * 切面处理类，操作日志异常日志记录处理
 */
@Aspect
@Component
@Slf4j
public class OperLogAspect {
    private Logger logger = LoggerFactory.getLogger(OperLogAspect.class);
    /**
     * ..表示包及子包 该方法代表controller层的所有方法  TODO 路径需要根据自己项目定义
     */
    @Pointcut("@annotation(com.dexin.pinyougou.common.log.OperLog)")
    public void controllerMethod() {
    }


    /**
     * 方法执行前
     *
     * @param joinPoint
     * @throws Exception
     */
    @Before(value = "controllerMethod()")
    public void LogRequestInfo(JoinPoint joinPoint) throws Throwable {
        logger.info("=================================");
        HttpServletRequest request = ((ServletRequestAttributes) Objects.requireNonNull(RequestContextHolder.getRequestAttributes())).getRequest();

        StringBuilder requestLog = new StringBuilder();
        //方法名称
        String methodName = joinPoint.getSignature().getName();
        // 方法参数
        Object[] args = joinPoint.getArgs();

        MethodSignature signature = (MethodSignature) joinPoint.getSignature();

        OperLog operlog = signature.getMethod().getAnnotation(OperLog.class);
        requestLog.append("请求信息：").append("URL = {").append(request.getRequestURI()).append("},\n")
                .append("请求方式 = {").append(request.getMethod()).append("},\n")
                .append("请求IP = {").append(request.getRemoteAddr()).append("},\n")
                .append("类方法 = {").append(signature.getDeclaringTypeName()).append("}.\n")
                .append(signature.getName()).append("},\t").append("}.\n")
                .append("操作类型：{").append(operlog.operType()).append("}.\n")
                .append(",操作模块：{").append(operlog.operModul()).append("}.\n")
                .append(",操作信息{").append(operlog.operDesc());

        // 处理请求参数
        String[] paramNames = ((MethodSignature) signature).getParameterNames();
        Object[] paramValues = joinPoint.getArgs();
        int paramLength = null == paramNames ? 0 : paramNames.length;
        if (paramLength == 0) {
            requestLog.append("请求参数 = {} ");
        } else {
            requestLog.append("请求参数 = [");
            for (int i = 0; i < paramLength - 1; i++) {
                requestLog.append(paramNames[i]).append("=").append(JSONObject.toJSONString(paramValues[i])).append(",");
            }
            requestLog.append(paramNames[paramLength - 1]).append("=").append(JSONObject.toJSONString(paramValues[paramLength - 1])).append("]");
        }

        logger.info(requestLog.toString());
        logger.info("=================================");
    }


    /**
     * 方法执行后
     *
     * @param resultVO
     * @throws Exception
     */
    @AfterReturning(returning = "resultVO", pointcut = "controllerMethod()")
    public void logResultVOInfo(ResultVO resultVO) throws Exception {
        logger.info("请求结果：" + resultVO.getCode() + "\t" + resultVO.getMsg());
        logger.info("============end==================");
    }


}

2. 将以上java文件打成jar，在另外一个工程引入；
3. 在另外一个工程，创建controller

@RestController
@RequestMapping("/brand")
public class BrandController {

    /**
     * 返回全部列表
     *
     * @return
     */
    @OperLog(operModul = "BrandController",operType = "findAll",operDesc = "返回全部列表")
    @GetMapping("/findAll")
    public String findAll() {
        return "get all success";
    }
}

4. 创建启动类

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
import org.springframework.context.annotation.ComponentScan;

@MapperScan("com.dexin.sellergoods.dao")
@SpringBootApplication(exclude = {DataSourceAutoConfiguration.class})
@ComponentScan(value = "com.dexin.*")
public class SellerGoodsApplication {
    public static void main(String[] args) {
        SpringApplication.run(SellerGoodsApplication.class, args);
    }
}

6. 接口调用日志信息如下
   

7. 注意在启动类上加入扫描@ComponentScan 的作用就是根据定义的扫描路径，把符合扫描规则的类装配到spring容器中；