注解应用：打印日志

注解应用：打印日志

1.定义注解

/**
 * 打印
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface MethodLog {
    /**
     * 需要打印入参
     * @return
     */
    boolean needPrintArgs() default true;
    /**
     * 需要打印返回值
     * @return
     */
    boolean needReturnT() default true;
    /**
     * 方法的描述
     * @return
     */
    String methodDesc() default "";

    /**
     * 参数的描述（数组）
     * @return
     */
    String[] paramsDesc() default {};

    /**
     * 返回值的描述
     * @return
     */
    String returnDesc() default "返回值";
}

2.借助切面来获取方法传参、返回值和方法的注解

/**
 * aop获取传参跟返回值 -- 支持方法维度切换
 */
@Aspect
@Component
@Slf4j
public class MethodLogAspect {

    /**
     * 定义切点
     */
    @Pointcut(value = "@annotation(com.baturu.biz.common.annotation.MethodLog)")
    public void log() {

    }

    /**
     * 使用环绕通知打印日志
     * @param joinPoint
     * @return
     * @throws Throwable
     */
    @Around("log()")
    public Object around(ProceedingJoinPoint joinPoint) throws Throwable {
        MethodLog methodLog = this.getMethodLog(joinPoint);
        if(methodLog == null){
            Object result = joinPoint.proceed();
            return result;
        }
        //拼接调用方法前的日志
        if(methodLog.needPrintArgs()){
            String beforeLog = buildBeforeLog(methodLog,joinPoint);
            log.info(beforeLog);
        }
        //开始执行方法
        Object result = joinPoint.proceed();
        //拼接调用方法后的日志
        if(methodLog.needReturnT()){
            String afterLog = buildAfterLog(methodLog,result,joinPoint);
            log.info(afterLog);
        }
        return result;
    }

    /**
     * 获取是否有这个注解
     * @param joinPoint
     * @return
     */
    private MethodLog getMethodLog(ProceedingJoinPoint joinPoint) {
        Method method = ((MethodSignature)joinPoint.getSignature()).getMethod();
        Annotation[] annotations = method.getAnnotations();
        MethodLog alog = null;
        if (annotations != null && annotations.length > 0) {
            for (Annotation annotation : annotations) {
                if (annotation instanceof MethodLog) {
                    alog = (MethodLog) annotation;
                }
            }
        }
        return alog;
    }

    /***
     * 构造调用方法结束后的日志
     * @param alog
     * @param result
     * @return
     */
    private String buildAfterLog(MethodLog alog, Object result, ProceedingJoinPoint joinPoint) {
        Method method = ((MethodSignature) joinPoint.getSignature()).getMethod();
        String methodCompleteName = joinPoint.getSignature().getDeclaringTypeName() +"#"+method.getName();
        StringBuilder sb = new StringBuilder();
        if (alog != null) {
            String methodDesc = StringUtils.isBlank(alog.methodDesc())? methodCompleteName:alog.methodDesc();
            String returnDesc = alog.returnDesc();
            result = result == null ? "无返回值" : result;
            sb.append(methodDesc)
                    .append(":")
                    .append(returnDesc)
                    .append(":")
                    .append(result);
        }
        return sb.toString();
    }

    /**
     * 构造调用方法前的日志
     * @param alog
     * @param joinPoint
     * @return
     */
    private String buildBeforeLog(MethodLog alog, ProceedingJoinPoint joinPoint) {
        Method method = ((MethodSignature) joinPoint.getSignature()).getMethod();
        StringBuilder sb = new StringBuilder();
        if (alog != null) {
            Parameter[] parameters = method.getParameters();
            String[] paramNames = buildParamNames(parameters);
            String[] paramDescS = alog.paramsDesc().length > 0 ? alog.paramsDesc() : paramNames;
            Object[] params = joinPoint.getArgs();
            sb.append(joinPoint.getSignature().getDeclaringTypeName())
                    .append("#")
                    .append(method.getName())
                    .append(":")
                    .append(alog.methodDesc())
                    .append(":")
                    .append(Arrays.toString(paramDescS))
                    .append(":")
                    .append(Arrays.toString(params));
        }
        return sb.toString();
    }

    private String[] buildParamNames(Parameter[] parameters) {
        String[] parmers = new String[parameters.length];
        if(parameters.length > 0){
            for (int i = 0 ; i<parameters.length ; i++){
                parmers[i] = parameters[i].getName();
            }
        }
        return parmers;
    }

}

3.使用

@MethodLog(methodDesc = "打印面单",paramsDesc="包裹号")
public ResultDTO<PackageShowDTO> print(String packageNo) {
	...
	return ResultDTO.succeedWith(packageShowDTO);
}

调用结果：

打印面单:[包裹号]:[O200068931_3]
打印面单:返回值:ResultDTO(model=PackageShowDTO(packageNo=O200068931_3,...))

只是举一个注解的使用方式，当然注解都不是单一使用的，通常都跟切面，本地线程变量一起。