最新国产好看的视频,伊人天堂AV在线,国产Aaaaaa视频,蜜臀视频在线观看一区,人妻av色图,密臀久久久精品影片,青青视频免费观看毛片,久草在线观看视,国产三级精品色情在线

淺談Spring自定義注解從入門到精通

 更新時間:2019年09月02日 09:33:04   作者:Java知音_  
這篇文章主要介紹了淺談Spring自定義注解從入門到精通,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧

在業(yè)務開發(fā)過程中我們會遇到形形色色的注解,但是框架自有的注解并不是總能滿足復雜的業(yè)務需求,我們可以自定義注解來滿足我們的需求。根據(jù)注解使用的位置,文章將分成字段注解、方法、類注解來介紹自定義注解

字段注解

字段注解一般是用于校驗字段是否滿足要求,hibernate-validate依賴就提供了很多校驗注解 ,如@NotNull、@Range等,但是這些注解并不是能夠滿足所有業(yè)務場景的。比如我們希望傳入的參數(shù)在指定的String集合中,那么已有的注解就不能滿足需求了,需要自己實現(xiàn)。

自定義注解

定義一個@Check注解,通過@interface聲明一個注解

@Target({ ElementType.FIELD}) 
//只允許用在類的字段上
@Retention(RetentionPolicy.RUNTIME) 
//注解保留在程序運行期間,此時可以通過反射獲得定義在某個類上的所有注解
@Constraint(validatedBy = ParamConstraintValidated.class)
public @interface Check {
  /**
   * 合法的參數(shù)值
   **/
  String[] paramValues();
 
  /**
   * 提示信息
   **/
  String message() default "參數(shù)不為指定值";
 
  Class<?>[] groups() default {};
 
  Class<? extends Payload>[] payload() default {};
}

@Target 定義注解的使用位置,用來說明該注解可以被聲明在那些元素之前。

  • ElementType.TYPE:說明該注解只能被聲明在一個類前。
  • ElementType.FIELD:說明該注解只能被聲明在一個類的字段前。
  • ElementType.METHOD:說明該注解只能被聲明在一個類的方法前。
  • ElementType.PARAMETER:說明該注解只能被聲明在一個方法參數(shù)前。
  • ElementType.CONSTRUCTOR:說明該注解只能聲明在一個類的構造方法前。
  • ElementType.LOCAL_VARIABLE:說明該注解只能聲明在一個局部變量前。
  • ElementType.ANNOTATION_TYPE:說明該注解只能聲明在一個注解類型前。
  • ElementType.PACKAGE:說明該注解只能聲明在一個包名前

@Constraint 通過使用validatedBy來指定與注解關聯(lián)的驗證器

@Retention用來說明該注解類的生命周期。

  • RetentionPolicy.SOURCE: 注解只保留在源文件中
  • RetentionPolicy.CLASS : 注解保留在class文件中,在加載到JVM虛擬機時丟棄
  • RetentionPolicy.RUNTIME: 注解保留在程序運行期間,此時可以通過反射獲得定義在某個類上的所有注解。

驗證器類

驗證器類需要實現(xiàn)ConstraintValidator泛型接口

public class ParamConstraintValidated implements ConstraintValidator<Check, Object> {
  /**
   * 合法的參數(shù)值,從注解中獲取
   * */
  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;
    }
 
    //不在指定的參數(shù)列表中
    return false;
  }
}

第一個泛型參數(shù)類型Check:注解,第二個泛型參數(shù)Object:校驗字段類型。需要實現(xiàn)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注解

方法、類注解

在開發(fā)過程中遇到過這樣的需求,如只有有權限的用戶的才能訪問這個類中的方法或某個具體的方法、查找數(shù)據(jù)的時候先不從數(shù)據(jù)庫查找,先從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 權限校驗一般需要獲取用戶信息,通過查詢數(shù)據(jù)庫進行權限校驗
    //TODO 這里只進行簡單演示,如果resourceKey為testKey則校驗通過,否則不通過
    if ("testKey".equals(resourceKey)) {
      return true;
    }
 
    return false;
  }
 
  /**
   * 根據(jù)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 {
  /**
   * 在方法執(zhí)行之前對注解進行處理
   *
   * @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 業(yè)務場景會比這個復雜的多,會涉及參數(shù)的解析如key可能是#{id}這些,數(shù)據(jù)查詢
    //TODO 這里做簡單演示,如果key為testKey則返回hello world
    if ("testKey".equals(customCache.key())) {
      return "hello word";
    }
 
    //執(zhí)行目標方法
    try {
      result = pjd.proceed();
    } catch (Throwable throwable) {
      throwable.printStackTrace();
    }
 
    return result;
  }
}

因為緩存注解需要在方法執(zhí)行之前有返回值,所以沒有通過攔截器處理這個注解,而是通過使用切面在執(zhí)行方法之前對注解進行處理。如果注解沒有返回值,將會返回方法中的值

測試

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

小結

本篇文章主要介紹了開發(fā)過程中遇到自定義注解的場景以及自定義注解實現(xiàn)。如有紕漏,歡迎指正。

源碼

https://github.com/TiantianUpup/custom-annotation

以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支持腳本之家。

相關文章

  • Java中獲取文件大小的詳解及實例代碼

    Java中獲取文件大小的詳解及實例代碼

    這篇文章主要介紹了Java中獲取文件大小的詳解及實例代碼的相關資料,一種是使用File的length()方法,另外一種是使用FileInputStream的available()方法,這里就說下如何使用需要的朋友可以參考下
    2016-12-12
  • IntelliJ IDEA中出現(xiàn)

    IntelliJ IDEA中出現(xiàn)"PSI and index do not match"錯誤的解決辦法

    今天小編就為大家分享一篇關于IntelliJ IDEA中出現(xiàn)"PSI and index do not match"錯誤的解決辦法,小編覺得內容挺不錯的,現(xiàn)在分享給大家,具有很好的參考價值,需要的朋友一起跟隨小編來看看吧
    2018-10-10
  • Java的抽象方法和抽象類實例詳解

    Java的抽象方法和抽象類實例詳解

    這篇文章主要介紹了Java的抽象方法和抽象類,結合實例形式詳細分析了java抽象方法和抽象類的相關原理、使用方法及操作注意事項,需要的朋友可以參考下
    2019-09-09
  • Java中實現(xiàn)樹形菜單的兩種方式

    Java中實現(xiàn)樹形菜單的兩種方式

    這篇文中,我一共會用兩種方式來實現(xiàn)目錄樹的數(shù)據(jù)結構,兩種寫法邏輯是一樣的,只是一種適合新手理解,一種看著簡單明了但是對于小白不是很好理解,在這里我會很詳細的講解每一步代碼,主要是方便新人看懂,彌補曾經(jīng)自己學習過程中的苦惱,需要的朋友可以參考下
    2023-09-09
  • Java實現(xiàn)常用緩存淘汰算法:FIFO、LRU、LFU

    Java實現(xiàn)常用緩存淘汰算法:FIFO、LRU、LFU

    在高并發(fā)、高性能的質量要求不斷提高時,我們首先會想到的就是利用緩存予以應對。而常用的幾個緩存淘汰算法有:FIFO、LRU和LFU,本文將為大家詳細介紹一下這三個算法并用java實現(xiàn),感興趣的可以跟隨小編一起學習一下
    2021-12-12
  • Java的String類中的startsWith方法和endsWith方法示例詳解

    Java的String類中的startsWith方法和endsWith方法示例詳解

    大家應該都知道startsWith()方法用于檢測字符串是否以指定的前綴開始,endsWith()方法用于測試字符串是否以指定的后綴結束,本文就Java的String類中的startsWith方法和endsWith方法給大家詳細講解,感興趣的朋友一起看看吧
    2023-11-11
  • IDEA JavaWeb項目啟動運行后出現(xiàn)404錯誤的解決方法

    IDEA JavaWeb項目啟動運行后出現(xiàn)404錯誤的解決方法

    這篇文章主要介紹了IDEA JavaWeb項目啟動運行后出現(xiàn)404錯誤的解決方法,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧
    2019-12-12
  • 用攔截器修改返回response,對特定的返回進行修改操作

    用攔截器修改返回response,對特定的返回進行修改操作

    這篇文章主要介紹了用攔截器修改返回response,對特定的返回進行修改操作。具有很好的參考價值,希望對大家有所幫助。一起跟隨小編過來看看吧
    2020-09-09
  • springMVC前臺傳數(shù)組類型,后臺用list類型接收實例代碼

    springMVC前臺傳數(shù)組類型,后臺用list類型接收實例代碼

    這篇文章主要介紹了springMVC前臺傳數(shù)組類型,后臺用list類型接收實例代碼,具有一定借鑒價值,需要的朋友可以參考下。
    2017-12-12
  • spring?boot集成smart-doc自動生成接口文檔詳解

    spring?boot集成smart-doc自動生成接口文檔詳解

    這篇文章主要介紹了spring?boot集成smart-doc自動生成接口文檔詳解,smart-doc是一款同時支持java?restful?api和Apache?Dubbo?rpc接口文檔生成的工具,smart-doc顛覆了傳統(tǒng)類似swagger這種大量采用注解侵入來生成文檔的實現(xiàn)方法
    2022-09-09

最新評論

葫芦岛市| 贵溪市| 绥芬河市| 梅州市| 南皮县| 庆云县| 同仁县| 循化| 延津县| 呼图壁县| 清河县| 通许县| 成武县| 嘉峪关市| 新民市| 门头沟区| 巴青县| 兰州市| 镇平县| 沂水县| 阜南县| 夏河县| 肥西县| 阿拉善右旗| 平谷区| 浦江县| 阿勒泰市| 崇阳县| 昭通市| 霍州市| 水富县| 沿河| 徐汇区| 应城市| 宜良县| 崇义县| 恭城| 锡林浩特市| 舟曲县| 即墨市| 通许县|