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源創計劃」，歡迎正在閱讀的你也加入，一塊兒分享。