Spring Boot Logging#

1
title: Spring Security 官网文档
2
desc: 点击跳转官网查看详细内容
3
logo: /assets/common-icon/spring-initializr.svg
4
link: https://docs.spring.io/spring-boot/docs/3.1.1/reference/htmlsingle/#features.logging
5
color: rgba(173, 216, 590, 0.15)

1
@RestController
2
@Slf4j
3
@BusLog(name = "人员管理")
4
@RequestMapping("/person")
5
public class PersonController {
6

7
    @Autowired
8
    private IPersonService personService;
9
    @Autowired
10
    private IBusLogService busLogService;
11

12

13
    @PostMapping
14
    public Person add(@RequestBody Person person) {
15
       try{
16
           //添加信息信息
17
        Person result = this.personService.registe(person);
18
        //保存业务日志
19
        this.saveLog(person);
20
        log.info("//增加person执行完成");
21
       }catch(Exception e){
22
           //保存异常操作日志
23
           this.saveExceptionLog(e);
24
       }
25
        return result;
26
    }
27
}

1
@Target({ElementType.TYPE, ElementType.METHOD})
2
@Retention(RetentionPolicy.RUNTIME)
3
public @interface ILog {
4

5
}

1
@Aspect
2
public class ILogPrintAspect {
3

4
    @Pointcut("@within(com.sbc.log.annotation.ILog) || @annotation(com.sbc.log.annotation.ILog)")
5
    public void pointcut() {
6
    }
7

8
    @Around("pointcut()")
9
    public Object around(ProceedingJoinPoint pjp) throws Throwable {
10
        long startTime = SystemClock.now();
11
        MethodSignature methodSignature = (MethodSignature) pjp.getSignature();
12
        Logger log = LoggerFactory.getLogger(methodSignature.getDeclaringType());
13
        String beginTime = DateUtil.now();
14
        Object result = null;
15
        try {
16
            result = pjp.proceed();
17
        } finally {
18
            Method targetMethod = pjp.getTarget().getClass().getDeclaredMethod(methodSignature.getName(), methodSignature.getMethod().getParameterTypes());
19
            ILog logAnnotation = Optional.ofNullable(targetMethod.getAnnotation(ILog.class)).orElse(pjp.getTarget().getClass().getAnnotation(ILog.class));
20
            if (logAnnotation != null) {
21
                ILogPrintDTO logPrint = new ILogPrintDTO();
22
                logPrint.setBeginTime(beginTime);
23
                if (logAnnotation.input()) {
24
                    logPrint.setInputParams(buildInput(pjp));
25
                }
26
                if (logAnnotation.output()) {
27
                    logPrint.setOutputParams(result);
28
                }
29
                String methodType = "", requestURI = "";
30
                try {
31
                    ServletRequestAttributes servletRequestAttributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
32
                    assert servletRequestAttributes != null;
33
                    methodType = servletRequestAttributes.getRequest().getMethod();
34
                    requestURI = servletRequestAttributes.getRequest().getRequestURI();
35
                } catch (Exception ignored) {
36
                }
37
                log.info("[{}] {}, executeTime: {}ms, info: {}", methodType, requestURI, SystemClock.now() - startTime, JSON.toJSONString(logPrint));
38
            }
39

40
            // 操作数据插入数据库
41
            // ......
42
        }
43
        return result;
44
    }
45

46
    /**
47
     * 构建输入参数
48
     *
49
     * @param pjp 切入点
50
     * @return 输入参数
51
     */
52
    private Object[] buildInput(ProceedingJoinPoint pjp) {
53
        Object[] args = pjp.getArgs();
54
        Object[] printArgs = new Object[args.length];
55
        for (int i = 0; i < args.length; i++) {
56
            if ((args[i] instanceof HttpServletRequest) || args[i] instanceof HttpServletResponse) {
57
                continue;
58
            }
59
            if (args[i] instanceof byte[]) {
60
                printArgs[i] = "byte array";
61
            } else if (args[i] instanceof MultipartFile) {
62
                printArgs[i] = "file";
63
            } else {
64
                printArgs[i] = args[i];
65
            }
66
        }
67
        return printArgs;
68
    }
69
}