作者：何甜甜在嗎
鏈接：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;
}
}
第一個泛型引數型別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();
}
注解可以用在方法或類上，但是快取注解一般是使用在方法上的，關注公眾號Java技術堆疊在后臺回復spring可以獲取我整理的Spring最全干貨教程，
切面
@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";
}
推薦去我的博客閱讀更多：
1.Java JVM、集合、多執行緒、新特性系列教程
2.Spring MVC、Spring Boot、Spring Cloud 系列教程
3.Maven、Git、Eclipse、Intellij IDEA 系列工具教程
4.Java、后端、架構、阿里巴巴等大廠最新面試題
覺得不錯，別忘了點贊+轉發哦！
轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/10014.html
標籤：Java