自定义注解

元注解和自定义注解

1. 元注解：描述注解的注解
   @Target、@Retention（保留策略：source-源文件，class-class文件，runtime-jvm加载class文件后依旧存在）、@document、@Inherited
2. 自定义注解：除以上四个，其他都是自定义注解
   使用：1·声明注解

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
@Documented
public @interface ParamLog {
    /**
     * 日志描述信息
     *
     * @return
     */
    String description() default "";

}

2·利用aop使之生效

@Aspect
@Component
@Profile({"dev", "test"})
/**
不指定，任何环境下都能注册这个组件
开发环境develop、测试环境test、生产环境master
  数据源：(/dev) (/test) (/master)
  加了环境标识的bean，只有这个环境被激活的时候才能注册到容器中。默认是default环境
  写在配置类上，只有是指定的环境的时候，整个配置类里面的所有配置才能开始生效（根据application.yml文件的后缀判断的）
*/
public class ParamLogAspect {

    private final static Logger logger = LoggerFactory.getLogger(ParamLogAspect.class);
    /**
     * 换行符
     */
    private static final String LINE_SEPARATOR = System.lineSeparator();

    /**
     * 以自定义 @ParamLog 注解为切点
     * 方式一：使用方法的方式创建切面信息，
     * 方式二：直接在@before和@around中使用@annotation(com.bycxbj.common.log.annotation.ParamLog)
     */
    @Pointcut("@annotation(com.bycxbj.common.log.annotation.ParamLog)")
    public void ParamLog() {
    }

    /**
     * 在切点之前织入
     *
     * @param joinPoint
     * @throws Throwable
     */
    @Before("ParamLog()")
    public void doBefore(JoinPoint joinPoint) throws Throwable {
        // 开始打印请求日志
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();

        // 获取 @ParamLog 注解的描述信息
        String methodDescription = getAspectLogDescription(joinPoint);

        // 打印请求相关参数
        logger.info("========================================== Start ==========================================");
        // 打印请求 url
        logger.info("URL            : {}", request.getRequestURL().toString());
        // 打印描述信息
        logger.info("Description    : {}", methodDescription);
        // 打印 Http method
        logger.info("HTTP Method    : {}", request.getMethod());
        // 打印调用 controller 的全路径以及执行方法
        logger.info("Class Method   : {}.{}", joinPoint.getSignature().getDeclaringTypeName(), joinPoint.getSignature().getName());
        // 打印请求的 IP
        logger.info("IP             : {}", request.getRemoteAddr());
        // 打印请求入参
        logger.info("Request Args   : {}", getParams(joinPoint));
    }

    /**
     * 在切点之后织入
     *
     * @throws Throwable
     */
    @After("ParamLog()")
    public void doAfter() throws Throwable {
        // 接口结束后换行，方便分割查看
        logger.info("=========================================== End ===========================================" + LINE_SEPARATOR);
    }

    /**
     * 环绕
     *
     * @param proceedingJoinPoint
     * @return
     * @throws Throwable
     */
    @Around("ParamLog()")
    public Object doAround(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
        long startTime = System.currentTimeMillis();
        Object result = proceedingJoinPoint.proceed();
        // 打印出参
        logger.info("Response Args  : {}", JSONObject.toJSONString(result));
        // 执行耗时
        logger.info("Time-Consuming : {} ms", System.currentTimeMillis() - startTime);
        return result;
    }


    /**
     * 获取切面注解的描述
     *
     * @param joinPoint 切点
     * @return 描述信息
     * @throws Exception
     */
    public String getAspectLogDescription(JoinPoint joinPoint)
            throws Exception {
        String targetName = joinPoint.getTarget().getClass().getName();
        String methodName = joinPoint.getSignature().getName();
        Object[] arguments = joinPoint.getArgs();
        Class targetClass = Class.forName(targetName);
        Method[] methods = targetClass.getMethods();
        StringBuilder description = new StringBuilder("");
        for (Method method : methods) {
            if (method.getName().equals(methodName)) {
                Class[] clazzs = method.getParameterTypes();
                if (clazzs.length == arguments.length) {
                    description.append(method.getAnnotation(ParamLog.class).description());
                    break;
                }
            }
        }
        return description.toString();
    }

    private String getParams(JoinPoint joinPoint) {
        String params = "";
        if (joinPoint.getArgs() != null && joinPoint.getArgs().length > 0) {
            for (int i = 0; i < joinPoint.getArgs().length; i++) {
                Object arg = joinPoint.getArgs()[i];
                if ((arg instanceof HttpServletResponse) || (arg instanceof HttpServletRequest)
                        || (arg instanceof MultipartFile) || (arg instanceof MultipartFile[])) {
                    continue;
                }
                params += JSONObject.toJSONString(joinPoint.getArgs()[i]);
            }
        }
        return params;
    }


}