Spring 自定义注解玩法大全，从入门到…
在业务开发过程中我们会遇到形形色色的注解，但是框架自有的注解并不是总能满足复杂的业务需求，我们可以自定义注解来满足我们的需求。
根据注解使用的位置，文章将分成字段注解、方法、类注解来介绍自定义注解。
字段注解
字段注解一般是用于校验字段是否满足要求，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;@Overridepublic 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 {@PostMappingpublic 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 {/*** 处理器处理之前调用*/@Overridepublic 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 worldif ("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";
}
作者：何甜甜在吗
链接：https://juejin.im/post/5cf376e16fb9a07eee5eb6eb
Spring 自定义注解玩法大全，从入门到…相关推荐
- @aspect注解_Spring自定义注解玩法大全，从入门到放弃
在业务开发过程中我们会遇到形形色色的注解,但是框架自有的注解并不是总能满足复杂的业务需求,我们可以自定义注解来满足我们的需求. 根据注解使用的位置,文章将分成字段注解.方法.类注解来介绍自定义注解. ...
- 电商平台营销活动玩法大全、拓客、吸粉、裂变、引流、团购返现、限时折扣、找人代付、砍价代付、多人拼团、优惠套餐、秒杀折扣、满减优惠、电商营销、电商推广、商品促销、营销红包、Axure原型、rp原型
电商平台营销活动玩法大全.拓客.吸粉.裂变.引流.团购返现.限时折扣.找人代付.砍价代付.多人拼团.优惠套餐.秒杀折扣.满减优惠.电商营销.电商推广.商品促销.营销红包.Axure原型.rp原型 Ax ...
- Spring自定义注解
转载自:Spring自定义注解 前言 自定义注解在开发中是一把利器,经常会被使用到.在上一篇文章中有提到了自定义校验注解的用法. 然而最近接到这样一个需求,主要是针对某些接口的返回数据需要进行一个加密 ...
- 绝地求生自定义服务器租一天多少钱,绝地求生自定义服务器怎么玩 绝地求生自定义服务器玩法解析...
绝地求生自定义服务器怎么玩,绝地求生自定义服务器是游戏中新上线的玩法模式,相信许多吃鸡玩家都非常好奇自定义模式的玩法,今天小编就为大家分享下绝地求生自定义服务器玩法解析. 绝地求生自定义服务器玩法解析 ...
- 绝地求生自定义服务器租一天多少钱,绝地求生自定义服务器怎么玩 自定义服务器玩法一览...
绝地求生自定义服务器马上就要上线了,那么自定义服务器要怎么玩呢?下面小编就给大家带来自定义服务器的玩法讲解,对自定义服务器感兴趣的小伙伴一起来看看啊. 自定义服务器玩法一览 为了让每位玩家可以创建自己 ...
- 自定义服务器怎么进去,绝地求生自定义服务器玩法介绍 自定义服务器怎么玩...
绝地求生自定义服务器玩法介绍,自定义服务器马上就要上线了,相信不少玩家也是期待已久了,那么自定义服务器怎么玩呢?下面就来一起看下吧. 绝地求生自定义服务器玩法解析 为了让每位玩家可以创建自己的游戏房间 ...
- spring -- 自定义注解
我们直接通过代码解释自定义注解的使用及各个含义 package com.sysware.cloud.dts.annotation;import java.lang.annotation.*; @Ret ...
- Spring 自定义注解使用案例 首先创建一个注解@interface
在Spring中使用自定义注解的本质就是使用Spring 的 AOP编程. 首先创建一个注解@interface import org.springframework.data.mongodb.cor ...
- Spring自定义注解简单使用四步走
在实际开发中,很多时刻我们会有记录请求日志,定时任务日志等需求,在每个方法中都编写相同的代码去记录日志显然是不合理的. Spring已经为我们提供了面向切面编程的思想,不妨简单的使用下自定义注解. 简 ...
最新文章
- go语言中的类型转换
- Pandas数据探索分析，分享两个神器！
- fatal error C1083: 无法打开包括文件:“stdio.h
- React之解决类中的this
- Oracle 优化和性能调整
- parallels desktop
- bind()的实现(持续更新中)
- 自动化测试之—Hamcrest匹配器
- c需要简单编程语言,教你C 语言简单编程速成
- FTP，SFTP，FTPS,TF区别
- mysql索引失效口诀
- Python3+Selenium3自动化测试 - 实例 - 登录QQ邮箱并自动发送邮件
- 放量跌与缩量跌的区别是什么？
- Intellij Idea 全屏设置
- 认知科学和认知神经科学_设计师认知科学阅读清单
- 深扒程序员外包，为啥我不建议你去外包公司？
- 那些惊艳了我的第三方插件收集
- springcloud之简介
- 学习在kvm上创建vtpm
- ERP项目实施过程中的致命过失(转)