记录一次SpringBoot实现AOP编程

需求

　　最近碰到一个问题，需要对关键操作的入参和返回值进行记录，并不是使用log记录，而是插入到数据库中。

　　思路：如果采用硬编码，在每个操作后都添加，会产生大量重复代码。因而打算使用自定义注解，通过AOP对注解进行拦截，对有注解的方法进行拦截，下面给出自己Demo的实现。

实现

　　第一步：导入Maven依赖。

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

　　第二步：自定义注解，定义注解的属性。

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface RecordRpc {
    // 具体路径
    String url();
    // 数据来源
    String dataSource();
    // 备注
    String remarks();
}

　　第三步：定义对注解拦截后的具体操作

@Aspect
@Component
public class RecordAnnotationAop {

    @Autowired
    PostService postService;

    // 声明拦截的注解
    @Pointcut("@annotation(ticket.annotation.RecordRpc)")
    private void cutMethod() {

    }

    // 使用环绕通知，对目标方法进行拦截
    @Around("cutMethod()")
    public Object around(ProceedingJoinPoint joinPoint) throws Throwable {


        // 执行拦截的方法
        Object proceed = joinPoint.proceed();

        // 获取目标方法的名称
        String methodName = joinPoint.getSignature().getName();
        // 获取方法传入参数
        Object[] params = joinPoint.getArgs();
        JSONObject obj = new JSONObject();
        if (params.length > 0) {
            for (int i = 0; i < params.length; i++) {
                obj.put("arg[" + i + "]", params[i]);
            }
        }
        System.out.println("AOP入参：" + methodName + obj.toJSONString());

        // 获取执行结果
        System.out.println("AOP执行结果：");
        if (proceed != null) {
            System.out.println(JSON.toJSON(proceed));
        }
        // 获取注解上参数
        System.out.println("注解上参数：");
        RecordRpc annotation = getDeclaredAnnotation(joinPoint);
        System.out.println("url:" + annotation.url());
        System.out.println("dataSource:" + annotation.dataSource());
        System.out.println("remarks:" + annotation.remarks());
　       return proceed;　
    }

    /**
     * 获取方法中声明的注解信息
     *
     * @param joinPoint
     * @return
     * @throws NoSuchMethodException
     */
    public RecordRpc getDeclaredAnnotation(ProceedingJoinPoint joinPoint) throws NoSuchMethodException {
        // 获取方法名
        String methodName = joinPoint.getSignature().getName();
        // 反射获取目标类
        Class<?> targetClass = joinPoint.getTarget().getClass();
        // 拿到方法对应的参数类型
        Class<?>[] parameterTypes = ((MethodSignature) joinPoint.getSignature()).getParameterTypes();
        // 根据类、方法、参数类型（重载）获取到方法的具体信息
        Method objMethod = targetClass.getMethod(methodName, parameterTypes);
        // 拿到方法定义的注解信息
        RecordRpc annotation = objMethod.getDeclaredAnnotation(RecordRpc.class);
        // 返回
        return annotation;
    }
}

　　第四步：注解使用

 　　结果展示：

 　　大家看明白了吗？如果大家设计api开放接口，在设计鉴权这块的时候 ，也是可以通过自定义注解来完成哦，其核心的思想是将公共的操作抽取出来，也就是面向切面编程的思想。

 参考：https://www.cnblogs.com/lingyejun/p/9941350.html