Spring自定義注解的實(shí)現(xiàn)與使用方式
一、什么是注解?
注解就是一種標(biāo)志,單獨(dú)使用注解,就相當(dāng)于在類、方法、參數(shù)和包上加上一個(gè)裝飾,什么功能也沒有,僅僅是一個(gè)標(biāo)志,然后這個(gè)標(biāo)志可以加上一些自己定義的參數(shù)。
就像下面這樣,創(chuàng)建一個(gè)@interface的注解,然后就可以使用這個(gè)注解了,加在我們需要裝飾的方法上,但是什么功能也沒有。
public @interface AuthorityVerify { String value() default ""; }
二、聊聊 JAVA 自帶的注解
1、定義
聊到Java注解,就不得不說@interface這個(gè)東西,它跟類(Class)、枚舉(enum)、接口(interface)等一樣,用于設(shè)置類型,比如下方的代碼,就是一個(gè)注解類:
/** * 自定義權(quán)限校驗(yàn)接口 * * @author 億先生 * @date 2024年1月23日18:57:15 */ @Target({ElementType.METHOD, ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) public @interface AuthorityVerify { String value() default ""; }
備注:
- 修飾符
- 訪問修飾符必須為public,不寫默認(rèn)為pubic;
- 關(guān)鍵字
- 關(guān)鍵字為@interface;
- 注解名稱
- 注解名稱為自定義注解的名稱,例如上面的XinLinLog 就是注解名稱
- 注解類型元素
- 注解類型元素是注解中內(nèi)容,根據(jù)需要標(biāo)志參數(shù),例如上面的注解的value;
2、元注解
說到注解就不得不說元注解,元注解就是作用在注解身上的,用來描述該注解的使用范圍,接下來我們就來說說@Target、@Retention、@Document ed、@Inherited 這四大元注解的作用。
@Target
用于描述注解的使用范圍,該注解可以使用在什么地方
Target類型 | 描述 |
---|---|
ElementType.TYPE | 應(yīng)用于類、接口(包括注解類型)、枚舉 |
ElementType.FIELD | 應(yīng)用于屬性(包括枚舉中的常量) |
ElementType.METHOD | 應(yīng)用于方法 |
ElementType.PARAMETER | 應(yīng)用于方法的形參 |
ElementType.CONSTRUCTOR | 應(yīng)用于構(gòu)造函數(shù) |
ElementType.LOCAL_VARIABLE | 應(yīng)用于局部變量 |
ElementType.ANNOTATION_TYPE | 應(yīng)用于注解類型 |
ElementType.PACKAGE | 應(yīng)用于包 |
備注: 例如@Target(ElementType.METHOD),標(biāo)志的注解使用在方法上,但是我們在這個(gè)注解標(biāo)志在類上,就會報(bào)錯(cuò)
@Retention
表明該注解的生命周期
生命周期類型 | 描述 |
---|---|
RetentionPolicy.SOURCE | 編譯時(shí)被丟棄,不包含在類文件中 |
RetentionPolicy.CLASS | JVM加載時(shí)被丟棄,包含在類文件中,默認(rèn)值 |
RetentionPolicy.RUNTIME | 由JVM 加載,包含在類文件中,在運(yùn)行時(shí)可以被獲取到 |
@Documented
表明該注解標(biāo)記的元素可以被Javadoc 或類似的工具文檔化
@Inherited
是一個(gè)標(biāo)記注解,@Inherited闡述了某個(gè)被標(biāo)注的類型是被繼承的。
如果一個(gè)使用了@Inherited修飾的annotation類型被用于一個(gè)class,則這個(gè)annotation將被用于該class的子類。
3、注解能用于哪些場景?
一般我們可以通過注解來實(shí)現(xiàn)一些重復(fù)的邏輯,就像封裝了的一個(gè)方法,可以用在一些權(quán)限校驗(yàn)、字段校驗(yàn)、字段屬性注入、保存日志、緩存
三、結(jié)合Spring AOP切面實(shí)現(xiàn)功能
上面總結(jié)的注解的定義,但是創(chuàng)建這樣一個(gè)注解,僅僅是一個(gè)標(biāo)志,裝飾類、方法、屬性的,并沒有功能,要想實(shí)現(xiàn)功能,需要我們通過攔截器、AOP切面這些地方獲取注解標(biāo)志,然后實(shí)現(xiàn)我們的功能。
1、AOP是什么?
全稱Aspect Oriented Programming,翻譯過來就是大名鼎鼎的 “面向切面編程”,它是對面向?qū)ο蟮囊环N補(bǔ)充和完善。
場景:
數(shù)據(jù)源切換、事務(wù)管理、權(quán)限控制、日志打印等。
特點(diǎn):
- ①侵入性小,幾乎可以不改動原來邏輯的情況下把新的邏輯加入業(yè)務(wù)。
- ②實(shí)現(xiàn)方便,使用幾個(gè)注解就可以實(shí)現(xiàn),使系統(tǒng)更容易擴(kuò)展。
- ③更好的復(fù)用代碼,比如事務(wù)日志打印,簡單邏輯適合所有情況。
2、注解的含義
注解 | 描述 |
---|---|
@Aspect | 切面。表示一個(gè)橫切進(jìn)業(yè)務(wù)的一個(gè)對象。它里面包含切入點(diǎn)(Pointcut)和Advice(通知)。 |
@Pointcut | 切入點(diǎn)。表示需要切入的位置,比如某些類或者某些方法,也就是先定一個(gè)范圍。 |
@Before | Advice(通知)的一種,切入點(diǎn)的方法體執(zhí)行之前執(zhí)行。 |
@Around | Advice(通知)的一種,環(huán)繞切入點(diǎn)執(zhí)行也就是把切入點(diǎn)包裹起來執(zhí)行。 |
@After | Advice(通知)的一種,在切入點(diǎn)正常運(yùn)行結(jié)束后執(zhí)行。 |
@AfterReturning | Advice(通知)的一種,在切入點(diǎn)正常運(yùn)行結(jié)束后執(zhí)行,異常則不執(zhí)行 |
@AfterThrowing | Advice(通知)的一種,在切入點(diǎn)運(yùn)行異常時(shí)執(zhí)行。 |
- 正常的執(zhí)行順序是:@Around ->@Before->主方法體->@Around中pjp.proceed()->@After->@AfterReturning
- 異常執(zhí)行順序?yàn)椋ˋround中pjp.proceed()之前):@Around -> @After -> @AfterThrowing
- 異常執(zhí)行順序?yàn)椋ˋround中pjp.proceed()之后):@Around ->@Before->主方法體->@Around中pjp.proceed()->@After->@AfterThrowing
擴(kuò)展:Pointcut切入點(diǎn)的語法
/** * 1、使用within表達(dá)式匹配 * 下面示例表示匹配com.leo.controller包下所有的類的方法 */ @Pointcut("within(com.leo.controller..*)") public void pointcutWithin(){ } /** * 2、this匹配目標(biāo)指定的方法,此處就是HelloController的方法 */ @Pointcut("this(com.leo.controller.HelloController)") public void pointcutThis(){ } /** * 3、target匹配實(shí)現(xiàn)UserInfoService接口的目標(biāo)對象 */ @Pointcut("target(com.leo.service.UserInfoService)") public void pointcutTarge(){ } /** * 4、bean匹配所有以Service結(jié)尾的bean里面的方法, * 注意:使用自動注入的時(shí)候默認(rèn)實(shí)現(xiàn)類首字母小寫為bean的id */ @Pointcut("bean(*ServiceImpl)") public void pointcutBean(){ } /** * 5、args匹配第一個(gè)入?yún)⑹荢tring類型的方法 */ @Pointcut("args(String, ..)") public void pointcutArgs(){ } /** * 6、@annotation匹配是@Controller類型的方法 */ @Pointcut("@annotation(org.springframework.stereotype.Controller)") public void pointcutAnnocation(){ } /** * 7、@within匹配@Controller注解下的方法,要求注解的@Controller級別為@Retention(RetentionPolicy.CLASS) */ @Pointcut("@within(org.springframework.stereotype.Controller)") public void pointcutWithinAnno(){ } /** * 8、@target匹配的是@Controller的類下面的方法,要求注解的@Controller級別為@Retention(RetentionPolicy.RUNTIME) */ @Pointcut("@target(org.springframework.stereotype.Controller)") public void pointcutTargetAnno(){ } /** * 9、@args匹配參數(shù)中標(biāo)注為@Sevice的注解的方法 */ @Pointcut("@args(org.springframework.stereotype.Service)") public void pointcutArgsAnno(){ } /** * 10、使用excution表達(dá)式 * execution( * modifier-pattern? //用于匹配public、private等訪問修飾符 * ret-type-pattern //用于匹配返回值類型,不可省略 * declaring-type-pattern? //用于匹配包類型 * name-pattern(param-pattern) //用于匹配類中的方法,不可省略 * throws-pattern? //用于匹配拋出異常的方法 * ) * * 下面的表達(dá)式解釋為:匹配com.leo.controller.HelloController類中以hello開頭的修飾符為public返回類型任意的方法 */ @Pointcut(value = "execution(public * com.leo.controller.HelloController.hello*(..))") public void pointCut() { }
需要注意:上面的匹配的類型中支持或(||)與(&&)非(!)運(yùn)算。
3、小Demo
①引入依賴包
<!--spring切面aop依賴--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-aop</artifactId> </dependency>
②創(chuàng)建切面實(shí)現(xiàn)功能(這里以權(quán)限校驗(yàn)為例)
Ⅰ創(chuàng)建咱們的一個(gè)切面類
/** * 權(quán)限校驗(yàn) 切面實(shí)現(xiàn) * * @author: 陌溪 * @create: 2020-03-06-19:05 */ @Aspect @Component @Slf4j public class AuthorityVerifyAspect { }
@Aspect: 切面。表示一個(gè)橫切進(jìn)業(yè)務(wù)的一個(gè)對象。它里面包含切入點(diǎn)(Pointcut)和Advice(通知)。
Ⅱ在切面類中創(chuàng)建一個(gè)用于掃描我們上面所用到的注解
@Pointcut(value = "@annotation(authorityVerify)") public void pointcut(AuthorityVerify authorityVerify) { }
@Pointcut: 切入點(diǎn)。表示需要切入的位置,比如某些類或者某些方法,也就是先定一個(gè)范圍。
Ⅲ在創(chuàng)建一個(gè)通知方法
@Around(value = "pointcut(authorityVerify)") public Object doAround(ProceedingJoinPoint joinPoint, AuthorityVerify authorityVerify) throws Throwable { ServletRequestAttributes attribute = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes(); HttpServletRequest request = attribute.getRequest(); //獲取請求路徑 String url = request.getRequestURI(); // 解析出請求者的ID和用戶名 String adminUid = request.getAttribute(SysConf.ADMIN_UID).toString(); // 管理員能夠訪問的路徑 String visitUrlStr = redisUtil.get(RedisConf.ADMIN_VISIT_MENU + RedisConf.SEGMENTATION + adminUid); LinkedTreeMap<String, String> visitMap = new LinkedTreeMap<>(); if (StringUtils.isNotEmpty(visitUrlStr)) { // 從Redis中獲取 visitMap = (LinkedTreeMap<String, String>) JsonUtils.jsonToMap(visitUrlStr, String.class); } else { // 查詢數(shù)據(jù)庫獲取 Admin admin = adminService.getById(adminUid); String roleUid = admin.getRoleUid(); Role role = roleService.getById(roleUid); String caetgoryMenuUids = role.getCategoryMenuUids(); String[] uids = caetgoryMenuUids.replace("[", "").replace("]", "").replace("\"", "").split(","); List<String> categoryMenuUids = new ArrayList<>(Arrays.asList(uids)); // 這里只需要查詢訪問的按鈕 QueryWrapper<CategoryMenu> queryWrapper = new QueryWrapper<>(); queryWrapper.in(SQLConf.UID, categoryMenuUids); queryWrapper.eq(SQLConf.MENU_TYPE, EMenuType.BUTTON); queryWrapper.eq(SQLConf.STATUS, EStatus.ENABLE); List<CategoryMenu> buttonList = categoryMenuService.list(queryWrapper); for (CategoryMenu item : buttonList) { if (StringUtils.isNotEmpty(item.getUrl())) { visitMap.put(item.getUrl(), item.getUrl()); } } // 將訪問URL存儲到Redis中 redisUtil.setEx(RedisConf.ADMIN_VISIT_MENU + SysConf.REDIS_SEGMENTATION + adminUid, JsonUtils.objectToJson(visitMap), 1, TimeUnit.HOURS); } // 判斷該角色是否能夠訪問該接口 if (visitMap.get(url) != null) { log.info("用戶擁有操作權(quán)限,訪問的路徑: {},擁有的權(quán)限接口:{}", url, visitMap.get(url)); //執(zhí)行業(yè)務(wù) return joinPoint.proceed(); } else { log.info("用戶不具有操作權(quán)限,訪問的路徑: {}", url); return ResultUtil.result(ECode.NO_OPERATION_AUTHORITY, MessageConf.RESTAPI_NO_PRIVILEGE); } }
@Around: Advice(通知)的一種,環(huán)繞切入點(diǎn)執(zhí)行也就是把切入點(diǎn)包裹起來執(zhí)行。
總結(jié)
以上為個(gè)人經(jīng)驗(yàn),希望能給大家一個(gè)參考,也希望大家多多支持腳本之家。
相關(guān)文章
Java創(chuàng)建student類詳細(xì)代碼例子
這篇文章主要給大家介紹了關(guān)于Java創(chuàng)建student類的相關(guān)資料,學(xué)生類(Student)是一種面向?qū)ο蟮木幊谈拍?其主要用于描述學(xué)生的屬性和行為,文中通過代碼介紹的非常詳細(xì),需要的朋友可以參考下2023-11-11springboot如何獲取相對路徑文件夾下靜態(tài)資源的方法
這篇文章主要介紹了springboot如何獲取相對路徑文件夾下靜態(tài)資源的方法,小編覺得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過來看看吧2019-05-05通過@Resource注解實(shí)現(xiàn)屬性裝配代碼詳解
這篇文章主要介紹了通過@Resource注解實(shí)現(xiàn)屬性裝配代碼詳解,具有一定借鑒價(jià)值,需要的朋友可以參考下2018-01-01SpringBoot3整合WebSocket詳細(xì)指南
SpringBoot 3 整合 WebSocket 提供了一種高效的實(shí)時(shí)通信解決方案,通過本文的配置和示例,可以快速實(shí)現(xiàn),感興趣的哦朋友跟隨小編一起看看吧2024-12-12java實(shí)現(xiàn)入棧push和出棧pop過程
文章詳細(xì)介紹了棧的概念、特點(diǎn)以及如何使用數(shù)組和鏈表實(shí)現(xiàn)棧,通過入棧(push)和出棧(pop)操作,展示了棧的數(shù)據(jù)處理過程,并提供了具體的代碼實(shí)現(xiàn)2024-12-12SpringBoot?LocalDateTime格式轉(zhuǎn)換方案詳解(前端入?yún)?
這篇文章主要介紹了SpringBoot?LocalDateTime格式轉(zhuǎn)換(前端入?yún)?,本文用示例介紹SpringBoot全局格式配置,將前端傳過來的時(shí)間自動轉(zhuǎn)化為LocalDateTime,需要的朋友可以參考下2023-04-04java評論、回復(fù)功能設(shè)計(jì)與實(shí)現(xiàn)方法
很多項(xiàng)目或者系統(tǒng)都有評論或者回復(fù)的需求,但評論回復(fù)的實(shí)現(xiàn)往往都比較復(fù)雜,也不好實(shí)現(xiàn),下面這篇文章主要給大家介紹了關(guān)于java評論、回復(fù)功能設(shè)計(jì)與實(shí)現(xiàn)的相關(guān)資料,需要的朋友可以參考下2022-06-06SpringBoot解決Required?String?parameter?xxx?is?not?prese
這篇文章主要介紹了SpringBoot解決Required?String?parameter?xxx?is?not?present問題,具有很好的參考價(jià)值,希望對大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2022-01-01