Spring 自定义注解玩法大全，从入门到…

程序员的成长之路

互联网/程序员/技术/资料共享 

阅读本文大概须要 5 分钟。

做者：何甜甜在吗
连接：https://juejin.im/post/5cf376e16fb9a07eee5eb6eb

在业务开发过程当中咱们会遇到形形色色的注解，可是框架自有的注解并非总能知足复杂的业务需求，咱们能够自定义注解来知足咱们的需求。

根据注解使用的位置，文章将分红字段注解、方法、类注解来介绍自定义注解。

字段注解

字段注解通常是用于校验字段是否知足要求， hibernate-validate依赖就提供了不少校验注解 ，如 @NotNull、 @Range等，可是这些注解并非可以知足全部业务场景的。

好比咱们但愿传入的参数在指定的 String集合中，那么已有的注解就不能知足需求了，须要本身实现。

自定义注解

定义一个 @Check注解，经过 @interface声明一个注解

@Target({ ElementType.FIELD}) //只容许用在类的字段上
@Retention(RetentionPolicy.RUNTIME) //注解保留在程序运行期间，此时能够经过反射得到定义在某个类上的全部注解
@Constraint(validatedBy = ParamConstraintValidated.class)
public @interface Check {
    /**
     * 合法的参数值
     * */
    String[] paramValues();

    /**
     * 提示信息
     * */
    String message() default "参数不为指定值";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};
}

@Target 定义注解的使用位置，用来讲明该注解能够被声明在那些元素以前。

ElementType.TYPE：说明该注解只能被声明在一个类前。

ElementType.FIELD：说明该注解只能被声明在一个类的字段前。

ElementType.METHOD：说明该注解只能被声明在一个类的方法前。

ElementType.PARAMETER：说明该注解只能被声明在一个方法参数前。

ElementType.CONSTRUCTOR：说明该注解只能声明在一个类的构造方法前。

ElementType.LOCAL_VARIABLE：说明该注解只能声明在一个局部变量前。

ElementType.ANNOTATION_TYPE：说明该注解只能声明在一个注解类型前。

ElementType.PACKAGE：说明该注解只能声明在一个包名前

@Constraint 经过使用validatedBy来指定与注解关联的验证器

@Retention 用来讲明该注解类的生命周期。

RetentionPolicy.SOURCE: 注解只保留在源文件中 

RetentionPolicy.CLASS : 注解保留在class文件中，在加载到JVM虚拟机时丢弃

RetentionPolicy.RUNTIME: 注解保留在程序运行期间，此时能够经过反射得到定义在某个类上的全部注解。

验证器类

验证器类须要实现 ConstraintValidator泛型接口

public class ParamConstraintValidated implements ConstraintValidator<Check, Object> {
    /**
     * 合法的参数值，从注解中获取
     * */
    private List<String> paramValues;

    @Override
    public void initialize(Check constraintAnnotation) {
        //初始化时获取注解上的值
        paramValues = Arrays.asList(constraintAnnotation.paramValues());
    }

    public boolean isValid(Object o, ConstraintValidatorContext constraintValidatorContext) {
        if (paramValues.contains(o)) {
            return true;
        }

        //不在指定的参数列表中
        return false;
    }
}

第一个泛型参数类型 Check：注解，第二个泛型参数 Object：校验字段类型。须要实现 initialize和 isValid方法， isValid方法为校验逻辑， initialize方法初始化工做

使用方式

定义一个实体类

@Data
public class User {
    /**
     * 姓名
     * */
    private String name;

    /**
     * 性别 man or women
     * */
    @Check(paramValues = {"man", "woman"})
    private String sex;
}

对 sex字段加校验，其值必须为 woman或者 man

测试

@RestController("/api/test")
public class TestController {
    @PostMapping
    public Object test(@Validated @RequestBody User user) {
        return "hello world";
    }
}

注意须要在 User对象上加上 @Validated注解，这里也能够使用 @Valid注解， @Validated 和 @Valid 的区别，这篇建议看下。

方法、类注解

在开发过程当中遇到过这样的需求，如只有有权限的用户的才能访问这个类中的方法或某个具体的方法、查找数据的时候先不从数据库查找，先从 guava cache中查找，在从 redis查找，最后查找 mysql（多级缓存）。

这时候咱们能够自定义注解去完成这个要求，第一个场景就是定义一个权限校验的注解，第二个场景就是定义 spring-data-redis包下相似 @Cacheable的注解。

权限注解

自定义注解

@Target({ ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface PermissionCheck {
    /**
     * 资源key
     * */
    String resourceKey();
}

该注解的做用范围为类或者方法上

拦截器类

public class PermissionCheckInterceptor extends HandlerInterceptorAdapter {
    /**
     * 处理器处理以前调用
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response,
                             Object handler) throws Exception {
        HandlerMethod handlerMethod = (HandlerMethod)handler;
        PermissionCheck permission = findPermissionCheck(handlerMethod);

        //若是没有添加权限注解则直接跳过容许访问
        if (permission == null) {
            return true;
        }

        //获取注解中的值
        String resourceKey = permission.resourceKey();

        //TODO 权限校验通常须要获取用户信息，经过查询数据库进行权限校验
        //TODO 这里只进行简单演示，若是resourceKey为testKey则校验经过，不然不经过
        if ("testKey".equals(resourceKey)) {
            return true;
        }

        return false;
    }

    /**
     * 根据handlerMethod返回注解信息
     *
     * @param handlerMethod 方法对象
     * @return PermissionCheck注解
     */
    private PermissionCheck findPermissionCheck(HandlerMethod handlerMethod) {
        //在方法上寻找注解
        PermissionCheck permission = handlerMethod.getMethodAnnotation(PermissionCheck.class);
        if (permission == null) {
            //在类上寻找注解
            permission = handlerMethod.getBeanType().getAnnotation(PermissionCheck.class);
        }

        return permission;
    }
}

权限校验的逻辑就是你有权限你就能够访问，没有就不容许访问，本质其实就是一个拦截器。咱们首先须要拿到注解，而后获取注解上的字段进行校验，校验经过返回 true，不然返回 false

测试

 @GetMapping("/api/test")
 @PermissionCheck(resourceKey = "test")
 public Object testPermissionCheck() {
     return "hello world";
 }

该方法须要进行权限校验因此添加了 PermissionCheck注解。

缓存注解

自定义注解

@Target({ ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface CustomCache {
    /**
     * 缓存的key值
     * */
    String key();
}

注解能够用在方法或类上，可是缓存注解通常是使用在方法上的。

切面

@Aspect
@Component
public class CustomCacheAspect {
    /**
     * 在方法执行以前对注解进行处理
     *
     * @param pjd
     * @param customCache 注解
     * @return 返回中的值
     * */
    @Around("@annotation(com.cqupt.annotation.CustomCache) && @annotation(customCache)")
    public Object dealProcess(ProceedingJoinPoint pjd, CustomCache customCache) {
        Object result = null;

        if (customCache.key() == null) {
            //TODO throw error
        }

        //TODO 业务场景会比这个复杂的多，会涉及参数的解析如key多是#{id}这些，数据查询
        //TODO 这里作简单演示，若是key为testKey则返回hello world
        if ("testKey".equals(customCache.key())) {
            return "hello word";
        }

        //执行目标方法
        try {
            result = pjd.proceed();
        } catch (Throwable throwable) {
            throwable.printStackTrace();
        }

        return result;
    }
}

由于缓存注解须要在方法执行以前有返回值，因此没有经过拦截器处理这个注解，而是经过使用切面在执行方法以前对注解进行处理。

若是注解没有返回值，将会返回方法中的值

测试

@GetMapping("/api/cache")
@CustomCache(key = "test")
public Object testCustomCache() {
    return "don't hit cache";
}

<END>

推荐阅读：

下载速度15MB/s，度盘新版本？

用数据库实现了一个分布式锁，虽简陋，但能用！

5T技术资源大放送！包括但不限于：C/C++，Linux，Python，Java，PHP，人工智能，单片机，树莓派，等等。在公众号内回复「2048」，便可免费获取！！

微信扫描二维码，关注个人公众号

朕已阅 

本文分享自微信公众号 - 程序员的成长之路（cxydczzl）。
若有侵权，请联系 support@oschina.cn 删除。
本文参与“OSC源创计划”，欢迎正在阅读的你也加入，一块儿分享。