基于注解实现通用日志打印

拼搏现实的明天。 2021-09-23 13:32 316阅读 0赞

# 前言 #

最近做项目发现公司所有接口打印日志都需要打印接口调用时间，接口中每次写这段代码实在恶心，故基于面向切面编程使用注解解决该问题。

# 1.定义注解 #

value为对应的接口名称，默认为BaseController

@Target(ElementType.METHOD)
    @Retention(RetentionPolicy.RUNTIME)
    public @interface OwnLog {
        String value() default "BaseController";
    }

# 2.面向切面处理 #

package com.xxx.log;
    
    import com.alibaba.fastjson.JSONObject;
    import lombok.extern.slf4j.Slf4j;
    import org.aspectj.lang.JoinPoint;
    import org.aspectj.lang.ProceedingJoinPoint;
    import org.aspectj.lang.annotation.AfterReturning;
    import org.aspectj.lang.annotation.Around;
    import org.aspectj.lang.annotation.Aspect;
    import org.aspectj.lang.annotation.Before;
    import org.springframework.stereotype.Component;
    
    /**
     * Description:
     * 作者：Marco.Gu
     */
    @Aspect
    @Component
    @Slf4j
    public class LogAspect {
        @Before(value = "@annotation(ownLog)")
        public void before(JoinPoint point, OwnLog ownLog) {
            //point.getArgs()获取请求参数
            log.info("服务{}调用开始,请求参数:{}", ownLog.value(), JSONObject.toJSONString(point.getArgs()));
            System.out.println(String.format("服务%s调用开始,request:%s", ownLog.value(), JSONObject.toJSONString(point.getArgs())));
        }
    
        @Around(value = "@annotation(ownLog)")
        public Object around(ProceedingJoinPoint point, OwnLog ownLog) {
            Object result = null;
            String name = ownLog.value();
            long start = System.currentTimeMillis();
            try {
                result = point.proceed();
            } catch (Throwable throwable) {
                throwable.printStackTrace();
            } finally {
                long end = System.currentTimeMillis();
                System.out.println(String.format("服务%s,耗时:%dms", name, (end - start)));
            }
            return result;
        }
    
        //设置rvt为返回参数
        @AfterReturning(value = "@annotation(ownLog)", returning = "rvt")
        public void afterReturning(JoinPoint point, OwnLog ownLog, Object rvt) {
            log.info("服务{}调用结束，response：{}", ownLog.value(), JSONObject.toJSONString(rvt));
            System.out.println(String.format("服务%s调用结束,response:%s", ownLog.value(), JSONObject.toJSONString(rvt)));
        }
    }

# 3.使用注解 #

@OwnLog("addEnrolmentUser")
        @PostMapping(value = "/add-enrolment-user")
        @ApiOperation(value = "添加报名用户", notes = "根据用户信息添加报名的用户")
        public BizBaseResponse addEnrolmentUser(@RequestBody EnrolmentUserRequest enrolmentUserRequest) {
            BizBaseResponse reponse = BizBaseResponse.success();
            try {
                String request = objectMapper.writeValueAsString(enrolmentUserRequest);
                log.info("请求参数为{}", request);
            } catch (JsonProcessingException e) {
                log.error("请求参数解析异常", e);
                reponse = BizBaseResponse.operationFailed(e.getMessage());
            }
            EnrolmentUser enrolmentUser = new DTOToVO().getEnrolmentUser(enrolmentUserRequest);
            enrolmentUserService.addEnrolmentUser(enrolmentUser);
            return reponse;
        }

# 4.控台打印 #

服务addEnrolmentUser调用开始,request:[{"age":0,"country":"string","health":"一般","idNum":"12345","name":"string","phoneNum":"string","status":"审核中"}]
    服务addEnrolmentUser,耗时:13ms
    服务addEnrolmentUser调用结束,response:{"code":10000,"message":"操作成功","success":true}