自定义日志注解（可获取方法名、参数等）

这里主要依赖了spring的AOP来实现的，如果没有引用spring的，不可以使用这种方式。

一、引入依赖

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

 <dependency>
     <groupId>org.apache.commons</groupId>
     <artifactId>commons-lang3</artifactId>
     <version>3.9</version>
 </dependency>

二、自定义日志注解

package com.example.demo.log;

import java.lang.annotation.*;

/**
 * 日志通过startLog、endLog、errorLog三个字段控制，如果想简单些， 可以只出入operate
 * startLog：方法进入时的日志
 * endLog：方法执行完之后的日志
 * errorLog：错误日志
 */
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface OperateLog {

    String startLog() default ""; // 方法开始执行前日志

    String endLog() default ""; // 方法结束执行日志

    String operate() default "";//操作

    String errorLog() default "";//错误日志

}

三、创建日志注解解析类

package com.example.demo.log;

import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.stereotype.Component;

import java.lang.reflect.Method;
import java.util.Arrays;

/**
 * 日志注解解析器，日志可以异步保存到数据库，这里只是打印了而已，
 */
@Aspect
@Component
@Slf4j
public class OperateLogResolver {

    /**
     * 切点
     */
    private final String EXECUTION = "@annotation(com.example.demo.log.OperateLog)";

    @Around(EXECUTION)
    public Object arround(ProceedingJoinPoint joinPoint) throws Throwable {

        //获取要执行的方法
        Method method = ((MethodSignature) joinPoint.getSignature()).getMethod();

        String className = joinPoint.getSignature().getDeclaringTypeName();

        String methodName = String.format("%s.%s", className, method.getName());

        //获取注解信息
        OperateLog upgradeProgress = method.getAnnotation(OperateLog.class);

        String operate = upgradeProgress.operate(); // 当前操作

        //开始日志
        String startLog = StringUtils.defaultIfBlank(upgradeProgress.startLog(), StringUtils.isNotEmpty(operate) ? String.format("start %s", operate) : String.format("start execute %s", methodName));

        //结束日志
        String endLog = StringUtils.defaultIfBlank(upgradeProgress.endLog(), StringUtils.isNotEmpty(operate) ? String.format("execute %s successfully", operate) : String.format("execute %s successfully", methodName));

        //错误日志
        String errorLog = StringUtils.defaultIfBlank(upgradeProgress.errorLog(), StringUtils.isNotEmpty(operate) ? String.format("execute %s error", operate) : String.format("execute %s error", methodName));


        //记录方法执行前日志
        log.info(startLog);

        //获取方法信息
        String[] argNames = ((MethodSignature) joinPoint.getSignature()).getParameterNames(); //参数名

        // 参数值：
        final Object[] argValues = joinPoint.getArgs();

        StringBuilder sb = new StringBuilder();
        for (int i = 0; i < argNames.length; i++) {
            String value = argValues[i] == null ? "null" : argValues[i].toString();
            sb.append(argNames[i]).append("=").append(value).append(",");
        }
        String paramStr = sb.length() > 0 ? sb.toString().substring(0, sb.length() - 1) + "]" : "";
        log.info("参数信息为：[ {}", paramStr);

        //执行方法
        Object result = null;

        try {
            result = joinPoint.proceed();
        } catch (Exception e) {
            log.error(errorLog, e);

        }

        String resultStr = result == null ? "null" : result.toString();
        log.info("返回结果为：{}",resultStr);

        //记录方法执行后日志
        log.info(endLog);

        return result;
    }

}

四、使用日志注解

@OperateLog(
         operate = "update user"
 )
 public User updateUser(User user,String greet) {
     System.out.println(greet);
     user.setAge(user.getAge() + 2);
     user.setName(StringUtils.defaultIfBlank("NULL NAME", StringUtils.upperCase(user.getName())));
     return user;
 }

打印的日志信息内容如下：

2019-11-11 20:31:48.004  INFO 10856 --- [nio-8080-exec-1] com.example.demo.log.OperateLogResolver  : start update user
2019-11-11 20:31:48.005  INFO 10856 --- [nio-8080-exec-1] com.example.demo.log.OperateLogResolver  : 参数信息为：[ user=User(name=liuxing, age=20),greet=hello]
hello
2019-11-11 20:31:48.019  INFO 10856 --- [nio-8080-exec-1] com.example.demo.log.OperateLogResolver  : 返回结果为：User(name=NULL NAME, age=22)
2019-11-11 20:31:48.019  INFO 10856 --- [nio-8080-exec-1] com.example.demo.log.OperateLogResolver  : execute update user successfully