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

Spring自定義注解的實現(xiàn)與使用方式

 更新時間：2024年09月20日 08:40:04   作者：億先生@  
注解是Java中用于類、方法、參數(shù)、包的裝飾標志,本身不具備功能,但可定義參數(shù),Java包含內建注解和元注解,如@Target、@Retention等,描述注解的使用范圍和生命周期,Spring的AOP（面向切面編程）可以結合注解實現(xiàn)功能,如權限控制和日志記錄

一、什么是注解？

注解就是一種標志，單獨使用注解，就相當于在類、方法、參數(shù)和包上加上一個裝飾，什么功能也沒有，僅僅是一個標志，然后這個標志可以加上一些自己定義的參數(shù)。

就像下面這樣，創(chuàng)建一個@interface的注解，然后就可以使用這個注解了，加在我們需要裝飾的方法上,但是什么功能也沒有。

public @interface AuthorityVerify {
    String value() default "";
}

二、聊聊 JAVA 自帶的注解

1、定義

聊到Java注解，就不得不說@interface這個東西，它跟類（Class）、枚舉（enum)、接口（interface）等一樣，用于設置類型，比如下方的代碼，就是一個注解類：

/**
 * 自定義權限校驗接口
 *
 * @author 億先生
 * @date 2024年1月23日18:57:15
 */
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface AuthorityVerify {
    String value() default "";
}

備注：

  • 修飾符
  • 訪問修飾符必須為public,不寫默認為pubic；
  • 關鍵字
  • 關鍵字為@interface；
  • 注解名稱
  • 注解名稱為自定義注解的名稱，例如上面的XinLinLog 就是注解名稱
  • 注解類型元素
  • 注解類型元素是注解中內容，根據(jù)需要標志參數(shù)，例如上面的注解的value；

2、元注解

說到注解就不得不說元注解，元注解就是作用在注解身上的，用來描述該注解的使用范圍，接下來我們就來說說@Target、@Retention、@Document ed、@Inherited 這四大元注解的作用。

@Target

用于描述注解的使用范圍，該注解可以使用在什么地方

Target類型描述
ElementType.TYPE應用于類、接口（包括注解類型）、枚舉
ElementType.FIELD應用于屬性（包括枚舉中的常量）
ElementType.METHOD應用于方法
ElementType.PARAMETER應用于方法的形參
ElementType.CONSTRUCTOR應用于構造函數(shù)
ElementType.LOCAL_VARIABLE應用于局部變量
ElementType.ANNOTATION_TYPE應用于注解類型
ElementType.PACKAGE應用于包

備注： 例如@Target(ElementType.METHOD)，標志的注解使用在方法上，但是我們在這個注解標志在類上，就會報錯

@Retention

表明該注解的生命周期

生命周期類型描述
RetentionPolicy.SOURCE編譯時被丟棄，不包含在類文件中
RetentionPolicy.CLASSJVM加載時被丟棄，包含在類文件中，默認值
RetentionPolicy.RUNTIME由JVM 加載，包含在類文件中，在運行時可以被獲取到

@Documented

表明該注解標記的元素可以被Javadoc 或類似的工具文檔化

@Inherited

是一個標記注解，@Inherited闡述了某個被標注的類型是被繼承的。

如果一個使用了@Inherited修飾的annotation類型被用于一個class，則這個annotation將被用于該class的子類。

3、注解能用于哪些場景？

一般我們可以通過注解來實現(xiàn)一些重復的邏輯，就像封裝了的一個方法，可以用在一些權限校驗、字段校驗、字段屬性注入、保存日志、緩存

三、結合Spring AOP切面實現(xiàn)功能

上面總結的注解的定義，但是創(chuàng)建這樣一個注解，僅僅是一個標志，裝飾類、方法、屬性的，并沒有功能，要想實現(xiàn)功能，需要我們通過攔截器、AOP切面這些地方獲取注解標志，然后實現(xiàn)我們的功能。

1、AOP是什么？

全稱Aspect Oriented Programming，翻譯過來就是大名鼎鼎的 “面向切面編程”，它是對面向對象的一種補充和完善。

場景：

數(shù)據(jù)源切換、事務管理、權限控制、日志打印等。

特點：

  • ①侵入性小，幾乎可以不改動原來邏輯的情況下把新的邏輯加入業(yè)務。
  • ②實現(xiàn)方便，使用幾個注解就可以實現(xiàn)，使系統(tǒng)更容易擴展。
  • ③更好的復用代碼，比如事務日志打印，簡單邏輯適合所有情況。

2、注解的含義

注解描述
@Aspect切面。表示一個橫切進業(yè)務的一個對象。它里面包含切入點(Pointcut)和Advice（通知）。
@Pointcut切入點。表示需要切入的位置，比如某些類或者某些方法，也就是先定一個范圍。
@BeforeAdvice（通知）的一種，切入點的方法體執(zhí)行之前執(zhí)行。
@AroundAdvice（通知）的一種，環(huán)繞切入點執(zhí)行也就是把切入點包裹起來執(zhí)行。
@AfterAdvice（通知）的一種，在切入點正常運行結束后執(zhí)行。
@AfterReturningAdvice（通知）的一種，在切入點正常運行結束后執(zhí)行，異常則不執(zhí)行
@AfterThrowingAdvice（通知）的一種，在切入點運行異常時執(zhí)行。
  • 正常的執(zhí)行順序是：@Around ->@Before->主方法體->@Around中pjp.proceed()->@After->@AfterReturning
  • 異常執(zhí)行順序為（Around中pjp.proceed()之前）：@Around -> @After -> @AfterThrowing
  • 異常執(zhí)行順序為（Around中pjp.proceed()之后）：@Around ->@Before->主方法體->@Around中pjp.proceed()->@After->@AfterThrowing

擴展：Pointcut切入點的語法

    /**
     * 1、使用within表達式匹配
     * 下面示例表示匹配com.leo.controller包下所有的類的方法
     */
    @Pointcut("within(com.leo.controller..*)")
    public void pointcutWithin(){

    }

    /**
     * 2、this匹配目標指定的方法，此處就是HelloController的方法
     */
    @Pointcut("this(com.leo.controller.HelloController)")
    public void pointcutThis(){

    }

    /**
     * 3、target匹配實現(xiàn)UserInfoService接口的目標對象
     */
    @Pointcut("target(com.leo.service.UserInfoService)")
    public void pointcutTarge(){

    }

    /**
     * 4、bean匹配所有以Service結尾的bean里面的方法，
     * 注意：使用自動注入的時候默認實現(xiàn)類首字母小寫為bean的id
     */
    @Pointcut("bean(*ServiceImpl)")
    public void pointcutBean(){

    }

    /**
     * 5、args匹配第一個入?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ù)中標注為@Sevice的注解的方法
     */
    @Pointcut("@args(org.springframework.stereotype.Service)")
    public void pointcutArgsAnno(){

    }


    /**
     * 10、使用excution表達式
     * execution(
     *  modifier-pattern?           //用于匹配public、private等訪問修飾符
     *  ret-type-pattern            //用于匹配返回值類型，不可省略
     *  declaring-type-pattern?     //用于匹配包類型
     *  name-pattern(param-pattern) //用于匹配類中的方法，不可省略
     *  throws-pattern?             //用于匹配拋出異常的方法
     * )
     *
     * 下面的表達式解釋為：匹配com.leo.controller.HelloController類中以hello開頭的修飾符為public返回類型任意的方法
     */
    @Pointcut(value = "execution(public * com.leo.controller.HelloController.hello*(..))")
    public void pointCut() {

    }

需要注意：上面的匹配的類型中支持或(||)與(&&)非(!)運算。

3、小Demo

①引入依賴包

<!--spring切面aop依賴-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
</dependency>

②創(chuàng)建切面實現(xiàn)功能（這里以權限校驗為例）

Ⅰ創(chuàng)建咱們的一個切面類

/**
 * 權限校驗 切面實現(xiàn)
 *
 * @author: 陌溪
 * @create: 2020-03-06-19:05
 */
@Aspect
@Component
@Slf4j
public class AuthorityVerifyAspect {

}

@Aspect： 切面。表示一個橫切進業(yè)務的一個對象。它里面包含切入點(Pointcut)和Advice（通知）。

Ⅱ在切面類中創(chuàng)建一個用于掃描我們上面所用到的注解

@Pointcut(value = "@annotation(authorityVerify)")
public void pointcut(AuthorityVerify authorityVerify) {

}

@Pointcut： 切入點。表示需要切入的位置，比如某些類或者某些方法，也就是先定一個范圍。

Ⅲ在創(chuàng)建一個通知方法

@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("用戶擁有操作權限，訪問的路徑: {}，擁有的權限接口：{}", url, visitMap.get(url));
       //執(zhí)行業(yè)務
       return joinPoint.proceed();
     } else {
       log.info("用戶不具有操作權限，訪問的路徑: {}", url);
       return ResultUtil.result(ECode.NO_OPERATION_AUTHORITY, MessageConf.RESTAPI_NO_PRIVILEGE);
     }
}

@Around： Advice（通知）的一種，環(huán)繞切入點執(zhí)行也就是把切入點包裹起來執(zhí)行。

總結

以上為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。

相關文章

  • SpringBoot整合Lombok的步驟詳解

    SpringBoot整合Lombok的步驟詳解

    在Java開發(fā)中,我們經(jīng)常需要編寫大量的模板代碼,比如getter和setter方法、構造函數(shù)、toString、equals和hashCode等,本文將詳細介紹如何在Spring Boot項目中整合Lombok,以及Lombok的一些常用注解,需要的朋友可以參考下
    2024-11-11
  • 解決JDBC Connection Reset的問題分析

    解決JDBC Connection Reset的問題分析

    這篇文章主要介紹了解決JDBC Connection Reset的問題，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教
    2023-04-04
  • Java創(chuàng)建student類詳細代碼例子

    Java創(chuàng)建student類詳細代碼例子

    這篇文章主要給大家介紹了關于Java創(chuàng)建student類的相關資料,學生類(Student)是一種面向對象的編程概念,其主要用于描述學生的屬性和行為,文中通過代碼介紹的非常詳細,需要的朋友可以參考下
    2023-11-11
  • springboot如何獲取相對路徑文件夾下靜態(tài)資源的方法

    springboot如何獲取相對路徑文件夾下靜態(tài)資源的方法

    這篇文章主要介紹了springboot如何獲取相對路徑文件夾下靜態(tài)資源的方法,小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧
    2019-05-05
  • 通過@Resource注解實現(xiàn)屬性裝配代碼詳解

    通過@Resource注解實現(xiàn)屬性裝配代碼詳解

    這篇文章主要介紹了通過@Resource注解實現(xiàn)屬性裝配代碼詳解，具有一定借鑒價值,需要的朋友可以參考下
    2018-01-01
  • SpringBoot3整合WebSocket詳細指南

    SpringBoot3整合WebSocket詳細指南

    SpringBoot 3 整合 WebSocket 提供了一種高效的實時通信解決方案,通過本文的配置和示例,可以快速實現(xiàn),感興趣的哦朋友跟隨小編一起看看吧
    2024-12-12
  • java實現(xiàn)入棧push和出棧pop過程

    java實現(xiàn)入棧push和出棧pop過程

    文章詳細介紹了棧的概念、特點以及如何使用數(shù)組和鏈表實現(xiàn)棧,通過入棧（push）和出棧（pop）操作,展示了棧的數(shù)據(jù)處理過程,并提供了具體的代碼實現(xiàn)
    2024-12-12
  • SpringBoot?LocalDateTime格式轉換方案詳解(前端入?yún)?

    SpringBoot?LocalDateTime格式轉換方案詳解(前端入?yún)?

    這篇文章主要介紹了SpringBoot?LocalDateTime格式轉換(前端入?yún)?,本文用示例介紹SpringBoot全局格式配置，將前端傳過來的時間自動轉化為LocalDateTime,需要的朋友可以參考下
    2023-04-04
  • java評論、回復功能設計與實現(xiàn)方法

    java評論、回復功能設計與實現(xiàn)方法

    很多項目或者系統(tǒng)都有評論或者回復的需求,但評論回復的實現(xiàn)往往都比較復雜,也不好實現(xiàn),下面這篇文章主要給大家介紹了關于java評論、回復功能設計與實現(xiàn)的相關資料,需要的朋友可以參考下
    2022-06-06
  • SpringBoot解決Required?String?parameter?xxx?is?not?present問題

    SpringBoot解決Required?String?parameter?xxx?is?not?prese

    這篇文章主要介紹了SpringBoot解決Required?String?parameter?xxx?is?not?present問題，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教
    2022-01-01

最新評論