欧美bbbwbbbw肥妇,免费乱码人妻系列日韩,一级黄片

淺談Spring自定義注解從入門(mén)到精通

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

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

字段注解

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

自定義注解

定義一個(gè)@Check注解,通過(guò)@interface聲明一個(gè)注解

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

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

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

@Constraint 通過(guò)使用validatedBy來(lái)指定與注解關(guān)聯(lián)的驗(yàn)證器

@Retention用來(lái)說(shuō)明該注解類的生命周期。

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

驗(yàn)證器類

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

public class ParamConstraintValidated implements ConstraintValidator<Check, Object> {
  /**
   * 合法的參數(shù)值,從注解中獲取
   * */
  private List<String> paramValues;
 
  @Override
  public void initialize(Check constraintAnnotation) {
    //初始化時(shí)獲取注解上的值
    paramValues = Arrays.asList(constraintAnnotation.paramValues());
  }
 
  public boolean isValid(Object o, ConstraintValidatorContext constraintValidatorContext) {
    if (paramValues.contains(o)) {
      return true;
    }
 
    //不在指定的參數(shù)列表中
    return false;
  }
}

第一個(gè)泛型參數(shù)類型Check:注解,第二個(gè)泛型參數(shù)Object:校驗(yàn)字段類型。需要實(shí)現(xiàn)initialize和isValid方法,isValid方法為校驗(yàn)邏輯,initialize方法初始化工作

使用方式

定義一個(gè)實(shí)體類

@Data
public class User {
  /**
   * 姓名
   * */
  private String name;
 
  /**
   * 性別 man or women
   * */
  @Check(paramValues = {"man", "woman"})
  private String sex;
}

對(duì)sex字段加校驗(yàn),其值必須為woman或者man

測(cè)試

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

注意需要在User對(duì)象上加上@Validated注解,這里也可以使用@Valid注解

方法、類注解

在開(kāi)發(fā)過(guò)程中遇到過(guò)這樣的需求,如只有有權(quán)限的用戶的才能訪問(wèn)這個(gè)類中的方法或某個(gè)具體的方法、查找數(shù)據(jù)的時(shí)候先不從數(shù)據(jù)庫(kù)查找,先從guava cache中查找,在從redis查找,最后查找mysql(多級(jí)緩存)。

這時(shí)候我們可以自定義注解去完成這個(gè)要求,第一個(gè)場(chǎng)景就是定義一個(gè)權(quán)限校驗(yàn)的注解,第二個(gè)場(chǎng)景就是定義spring-data-redis包下類似@Cacheable的注解。

權(quán)限注解

自定義注解

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

該注解的作用范圍為類或者方法上

攔截器類

public class PermissionCheckInterceptor extends HandlerInterceptorAdapter {
  /**
   * 處理器處理之前調(diào)用
   */
  @Override
  public boolean preHandle(HttpServletRequest request, HttpServletResponse response,
               Object handler) throws Exception {
    HandlerMethod handlerMethod = (HandlerMethod)handler;
    PermissionCheck permission = findPermissionCheck(handlerMethod);
 
    //如果沒(méi)有添加權(quán)限注解則直接跳過(guò)允許訪問(wèn)
    if (permission == null) {
      return true;
    }
 
    //獲取注解中的值
    String resourceKey = permission.resourceKey();
 
    //TODO 權(quán)限校驗(yàn)一般需要獲取用戶信息,通過(guò)查詢數(shù)據(jù)庫(kù)進(jìn)行權(quán)限校驗(yàn)
    //TODO 這里只進(jìn)行簡(jiǎn)單演示,如果resourceKey為testKey則校驗(yàn)通過(guò),否則不通過(guò)
    if ("testKey".equals(resourceKey)) {
      return true;
    }
 
    return false;
  }
 
  /**
   * 根據(jù)handlerMethod返回注解信息
   *
   * @param handlerMethod 方法對(duì)象
   * @return PermissionCheck注解
   */
  private PermissionCheck findPermissionCheck(HandlerMethod handlerMethod) {
    //在方法上尋找注解
    PermissionCheck permission = handlerMethod.getMethodAnnotation(PermissionCheck.class);
    if (permission == null) {
      //在類上尋找注解
      permission = handlerMethod.getBeanType().getAnnotation(PermissionCheck.class);
    }
 
    return permission;
  }
}

權(quán)限校驗(yàn)的邏輯就是你有權(quán)限你就可以訪問(wèn),沒(méi)有就不允許訪問(wèn),本質(zhì)其實(shí)就是一個(gè)攔截器。我們首先需要拿到注解,然后獲取注解上的字段進(jìn)行校驗(yàn),校驗(yàn)通過(guò)返回true,否則返回false

測(cè)試

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

該方法需要進(jìn)行權(quán)限校驗(yàn)所以添加了PermissionCheck注解

緩存注解

自定義注解

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

注解可以用在方法或類上,但是緩存注解一般是使用在方法上的

切面

@Aspect
@Component
public class CustomCacheAspect {
  /**
   * 在方法執(zhí)行之前對(duì)注解進(jìn)行處理
   *
   * @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è)務(wù)場(chǎng)景會(huì)比這個(gè)復(fù)雜的多,會(huì)涉及參數(shù)的解析如key可能是#{id}這些,數(shù)據(jù)查詢
    //TODO 這里做簡(jiǎn)單演示,如果key為testKey則返回hello world
    if ("testKey".equals(customCache.key())) {
      return "hello word";
    }
 
    //執(zhí)行目標(biāo)方法
    try {
      result = pjd.proceed();
    } catch (Throwable throwable) {
      throwable.printStackTrace();
    }
 
    return result;
  }
}

因?yàn)榫彺孀⒔庑枰诜椒▓?zhí)行之前有返回值,所以沒(méi)有通過(guò)攔截器處理這個(gè)注解,而是通過(guò)使用切面在執(zhí)行方法之前對(duì)注解進(jìn)行處理。如果注解沒(méi)有返回值,將會(huì)返回方法中的值

測(cè)試

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

小結(jié)

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

源碼

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

以上就是本文的全部?jī)?nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。

相關(guān)文章

  • 關(guān)于java編譯過(guò)程中的bug說(shuō)明

    關(guān)于java編譯過(guò)程中的bug說(shuō)明

    本篇文章是對(duì)java編譯過(guò)程中的bug進(jìn)行了詳細(xì)的說(shuō)明介紹,需要的朋友參考下
    2013-05-05
  • SpringBoot如何整合nacos詳解

    SpringBoot如何整合nacos詳解

    今天教各位小伙伴SpringBoot是如何整合nacos的,文中有非常詳細(xì)的代碼示例,對(duì)正在學(xué)習(xí)Java的小伙伴們有很好的幫助,需要的朋友可以參考下
    2021-06-06
  • java的SimpleDateFormat線程不安全的幾種解決方案

    java的SimpleDateFormat線程不安全的幾種解決方案

    但我們知道SimpleDateFormat是線程不安全的,處理時(shí)要特別小心,要加鎖或者不能定義為static,要在方法內(nèi)new出對(duì)象,再進(jìn)行格式化,本文就介紹了幾種方法,感興趣的可以了解一下
    2021-08-08
  • 為什么Java volatile++不是原子性的詳解

    為什么Java volatile++不是原子性的詳解

    這篇文章主要給大家介紹了關(guān)于為什么Java volatile++不是原子性的相關(guān)資料,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧
    2021-02-02
  • Java基礎(chǔ)類學(xué)習(xí)之String詳解

    Java基礎(chǔ)類學(xué)習(xí)之String詳解

    這篇文章主要為大家詳細(xì)介紹了Java基礎(chǔ)類中String的相關(guān)知識(shí),文中的示例代碼講解詳細(xì),對(duì)我們學(xué)習(xí)Java有一定的幫助,需要的可以參考一下
    2022-12-12
  • Java使用Graphics2D實(shí)現(xiàn)字符串文本自動(dòng)換行

    Java使用Graphics2D實(shí)現(xiàn)字符串文本自動(dòng)換行

    這篇文章主要為大家詳細(xì)介紹了Java如何使用Graphics2D實(shí)現(xiàn)字符串文本自動(dòng)換行,文中的示例代碼講解詳細(xì),感興趣的小伙伴可以跟隨小編一起學(xué)習(xí)一下
    2024-04-04
  • Spring Boot集成Swagger2項(xiàng)目實(shí)戰(zhàn)

    Spring Boot集成Swagger2項(xiàng)目實(shí)戰(zhàn)

    在日常的工作中,我們往往需要給前端(WEB端、IOS、Android)或者第三方提供接口,這個(gè)時(shí)候我們就需要給他們提供一份詳細(xì)的API說(shuō)明文檔。這篇文章我們就來(lái)分享一種API文檔維護(hù)的方式,即通過(guò)Swagger來(lái)自動(dòng)生成Restuful API文檔
    2018-01-01
  • java正則表達(dá)式匹配網(wǎng)頁(yè)所有網(wǎng)址和鏈接文字的示例

    java正則表達(dá)式匹配網(wǎng)頁(yè)所有網(wǎng)址和鏈接文字的示例

    這篇文章主要介紹了java正則表達(dá)式匹配網(wǎng)頁(yè)所有網(wǎng)址和鏈接文字java正則表達(dá)式匹配,需要的朋友可以參考下
    2014-03-03
  • spring web.xml指定配置文件過(guò)程解析

    spring web.xml指定配置文件過(guò)程解析

    這篇文章主要介紹了spring web.xml指定配置文件過(guò)程解析,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下
    2020-02-02
  • MyBatis中關(guān)于SQL的寫(xiě)法總結(jié)

    MyBatis中關(guān)于SQL的寫(xiě)法總結(jié)

    這篇文章主要介紹了MyBatis中關(guān)于SQL的寫(xiě)法總結(jié),具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教
    2022-08-08

最新評(píng)論