在業(yè)務(wù)開(kāi)發(fā)過(guò)程中我們會(huì)遇到形形色色的注解，但是框架自有的注解并不是總能滿(mǎn)足復(fù)雜的業(yè)務(wù)需求，我們可以自定義注解來(lái)滿(mǎn)足我們的需求。

根據(jù)注解使用的位置，文章將分成字段注解、方法、類(lèi)注解來(lái)介紹自定義注解。

字段注解

字段注解一般是用于校驗(yàn)字段是否滿(mǎn)足要求，hibernate-validate依賴(lài)就提供了很多校驗(yàn)注解 ，如@NotNull、@Range等，但是這些注解并不是能夠滿(mǎn)足所有業(yè)務(wù)場(chǎng)景的。

比如我們希望傳入的參數(shù)在指定的String集合中，那么已有的注解就不能滿(mǎn)足需求了，需要自己實(shí)現(xiàn)。

自定義注解

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

@Target({?ElementType.FIELD})?//只允許用在類(lèi)的字段上 @Retention(RetentionPolicy.RUNTIME)?//注解保留在程序運(yùn)行期間，此時(shí)可以通過(guò)反射獲得定義在某個(gè)類(lèi)上的所有注解 @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è)類(lèi)前。

ElementType.FIELD：說(shuō)明該注解只能被聲明在一個(gè)類(lèi)的字段前。

ElementType.METHOD：說(shuō)明該注解只能被聲明在一個(gè)類(lèi)的方法前。

ElementType.PARAMETER：說(shuō)明該注解只能被聲明在一個(gè)方法參數(shù)前。

ElementType.CONSTRUCTOR：說(shuō)明該注解只能聲明在一個(gè)類(lèi)的構(gòu)造方法前。

ElementType.LOCAL_VARIABLE：說(shuō)明該注解只能聲明在一個(gè)局部變量前。

ElementType.ANNOTATION_TYPE：說(shuō)明該注解只能聲明在一個(gè)注解類(lèi)型前。

ElementType.PACKAGE：說(shuō)明該注解只能聲明在一個(gè)包名前

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

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

RetentionPolicy.SOURCE: 注解只保留在源文件中?

RetentionPolicy.CLASS?: 注解保留在class文件中，在加載到JVM虛擬機(jī)時(shí)丟棄

RetentionPolicy.RUNTIME: 注解保留在程序運(yùn)行期間，此時(shí)可以通過(guò)反射獲得定義在某個(gè)類(lèi)上的所有注解。

驗(yàn)證器類(lèi)

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

public?class?ParamConstraintValidated?implements?ConstraintValidator<Check,?Object>?{/***?合法的參數(shù)值，從注解中獲取*?*/private?List<String>?paramValues;@Overridepublic?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ù)類(lèi)型Check：注解，第二個(gè)泛型參數(shù)Object：校驗(yàn)字段類(lèi)型。需要實(shí)現(xiàn)initialize和isValid方法，isValid方法為校驗(yàn)邏輯，initialize方法初始化工作

使用方式

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

@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?{@PostMappingpublic?Object?test(@Validated?@RequestBody?User?user)?{return?"hello?world";} }

注意需要在User對(duì)象上加上@Validated注解，這里也可以使用@Valid注解，@Validated 和 @Valid 的區(qū)別，這篇建議看下。

方法、類(lèi)注解

在開(kāi)發(fā)過(guò)程中遇到過(guò)這樣的需求，如只有有權(quán)限的用戶(hù)的才能訪(fǎng)問(wèn)這個(gè)類(lèi)中的方法或某個(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包下類(lèi)似@Cacheable的注解。

權(quán)限注解

自定義注解

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

該注解的作用范圍為類(lèi)或者方法上

攔截器類(lèi)

public?class?PermissionCheckInterceptor?extends?HandlerInterceptorAdapter?{/***?處理器處理之前調(diào)用*/@Overridepublic?boolean?preHandle(HttpServletRequest?request,?HttpServletResponse?response,Object?handler)?throws?Exception?{HandlerMethod?handlerMethod?=?(HandlerMethod)handler;PermissionCheck?permission?=?findPermissionCheck(handlerMethod);//如果沒(méi)有添加權(quán)限注解則直接跳過(guò)允許訪(fǎng)問(wèn)if?(permission?==?null)?{return?true;}//獲取注解中的值String?resourceKey?=?permission.resourceKey();//TODO?權(quán)限校驗(yàn)一般需要獲取用戶(hù)信息，通過(guò)查詢(xún)數(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)?{//在類(lèi)上尋找注解permission?=?handlerMethod.getBeanType().getAnnotation(PermissionCheck.class);}return?permission;} }

權(quán)限校驗(yàn)的邏輯就是你有權(quán)限你就可以訪(fǎng)問(wèn)，沒(méi)有就不允許訪(fǎng)問(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(); }

注解可以用在方法或類(lèi)上，但是緩存注解一般是使用在方法上的。

切面

@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ù)查詢(xún)//TODO?這里做簡(jiǎn)單演示，如果key為testKey則返回hello?worldif?("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"; }

作者：何甜甜在嗎
鏈接：https://juejin.im/post/5cf376e16fb9a07eee5eb6eb

總結(jié)

以上是生活随笔為你收集整理的Spring 自定义注解玩法大全，从入门到…的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。