談談 Java 中自定義註解及使用場景

點擊上方「全棧程序員社區」，星標公衆號
java

重磅乾貨，第一時間送達

做者：快給我飯吃程序員

www.jianshu.com/p/a7bedc771204web

Java自定義註解通常使用場景爲：自定義註解+攔截器或者AOP，使用自定義註解來本身設計框架，使得代碼看起來很是優雅。本文將先從自定義註解的基礎概念提及，而後開始實戰，寫小段代碼實現自定義註解+攔截器，自定義註解+AOP。面試

一. 什麼是註解(Annotation)

Java註解是什麼，如下是引用自維基百科的內容spring

Java註解又稱Java標註，是JDK5.0版本開始支持加入源代碼的特殊語法元數據。json

Java語言中的類、方法、變量、參數和包等均可以被標註。和Javadoc不一樣，Java標註能夠經過反射獲取標註內容。在編譯器生成類文件時，標註能夠被嵌入到字節碼中。Java虛擬機能夠保留標註內容，在運行時能夠獲取到標註內容。固然它也支持自定義Java標註。後端

二. 註解體系圖

元註解：java.lang.annotation中提供了元註解，可使用這些註解來定義本身的註解。主要使用的是Target和Retention註解springboot

註解處理類：既然上面定義了註解，那得有辦法拿到咱們定義的註解啊。java.lang.reflect.AnnotationElement接口則提供了該功能。註解的處理是經過java反射來處理的。微信

以下，反射相關的類Class, Method, Field都實現了AnnotationElement接口。app

所以，只要咱們經過反射拿到Class, Method, Field類，就可以經過getAnnotation(Class<T>)拿到咱們想要的註解並取值。

搜索Java知音公衆號，回覆「後端面試」，送你一份Java面試題寶典

三. 經常使用元註解

Target：描述了註解修飾的對象範圍，取值在java.lang.annotation.ElementType定義，經常使用的包括：

METHOD：用於描述方法
PACKAGE：用於描述包
PARAMETER：用於描述方法變量
TYPE：用於描述類、接口或enum類型

Retention: 表示註解保留時間長短。取值在java.lang.annotation.RetentionPolicy中，取值爲：

SOURCE：在源文件中有效，編譯過程當中會被忽略
CLASS：隨源文件一塊兒編譯在class文件中，運行時忽略
RUNTIME：在運行時有效

只有定義爲RetentionPolicy.RUNTIME時，咱們才能經過註解反射獲取到註解。

因此，假設咱們要自定義一個註解，它用在字段上，而且能夠經過反射獲取到，功能是用來描述字段的長度和做用。

@Target(ElementType.FIELD)  //  註解用於字段上
@Retention(RetentionPolicy.RUNTIME)  // 保留到運行時，可經過註解獲取
public @interface MyField {
    String description();
    int length();
}

四. 示例-反射獲取註解

先定義一個註解：

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyField {
    String description();
    int length();
}

經過反射獲取註解

public class MyFieldTest {

    //使用咱們的自定義註解
    @MyField(description = "用戶名", length = 12)
    private String username;

    @Test
    public void testMyField(){

        // 獲取類模板
        Class c = MyFieldTest.class;

        // 獲取全部字段
        for(Field f : c.getDeclaredFields()){
            // 判斷這個字段是否有MyField註解
            if(f.isAnnotationPresent(MyField.class)){
                MyField annotation = f.getAnnotation(MyField.class);
                System.out.println("字段:[" + f.getName() + "], 描述:[" + annotation.description() + "], 長度:[" + annotation.length() +"]");
            }
        }

    }
}

運行結果

應用場景一：自定義註解+攔截器實現登陸校驗

接下來，咱們使用springboot攔截器實現這樣一個功能，若是方法上加了@LoginRequired，則提示用戶該接口須要登陸才能訪問，不然不須要登陸。

首先定義一個LoginRequired註解

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface LoginRequired {
    
}

而後寫兩個簡單的接口，訪問sourceA，sourceB資源

@RestController
public class IndexController {

    @GetMapping("/sourceA")
    public String sourceA(){
        return "你正在訪問sourceA資源";
    }

    @GetMapping("/sourceB")
    public String sourceB(){
        return "你正在訪問sourceB資源";
    }

}

沒添加攔截器以前成功訪問

實現spring的HandlerInterceptor 類先實現攔截器，但不攔截，只是簡單打印日誌，以下：

public class SourceAccessInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("進入攔截器了");
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {

    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {

    }
}

實現spring類WebMvcConfigurer，建立配置類把攔截器添加到攔截器鏈中

@Configuration
public class InterceptorTrainConfigurer implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new SourceAccessInterceptor()).addPathPatterns("/**");
    }
}

攔截成功以下

在sourceB方法上添加咱們的登陸註解@LoginRequired

@RestController
public class IndexController {

    @GetMapping("/sourceA")
    public String sourceA(){
        return "你正在訪問sourceA資源";
    }

    @LoginRequired
    @GetMapping("/sourceB")
    public String sourceB(){
        return "你正在訪問sourceB資源";
    }

}

簡單實現登陸攔截邏輯

@Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("進入攔截器了");

        // 反射獲取方法上的LoginRequred註解
        HandlerMethod handlerMethod = (HandlerMethod)handler;
        LoginRequired loginRequired = handlerMethod.getMethod().getAnnotation(LoginRequired.class);
        if(loginRequired == null){
            return true;
        }

        // 有LoginRequired註解說明須要登陸，提示用戶登陸
        response.setContentType("application/json; charset=utf-8");
        response.getWriter().print("你訪問的資源須要登陸");
        return false;
    }

運行成功，訪問sourceB時須要登陸了，訪問sourceA則不用登陸

應用場景二：自定義註解+AOP 實現日誌打印

先導入切面須要的依賴包

<dependency>
      <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-aop</artifactId>
</dependency>

定義一個註解@MyLog

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyLog {
    
}

定義一個切面類，見以下代碼註釋理解：

@Aspect // 1.代表這是一個切面類
@Component
public class MyLogAspect {

    // 2. PointCut表示這是一個切點，@annotation表示這個切點切到一個註解上，後面帶該註解的全類名
    // 切面最主要的就是切點，全部的故事都圍繞切點發生
    // logPointCut()表明切點名稱
    @Pointcut("@annotation(me.zebin.demo.annotationdemo.aoplog.MyLog)")
    public void logPointCut(){};

    // 3. 環繞通知
    @Around("logPointCut()")
    public void logAround(ProceedingJoinPoint joinPoint){
        // 獲取方法名稱
        String methodName = joinPoint.getSignature().getName();
        // 獲取入參
        Object[] param = joinPoint.getArgs();

        StringBuilder sb = new StringBuilder();
        for(Object o : param){
            sb.append(o + "; ");
        }
        System.out.println("進入[" + methodName + "]方法,參數爲:" + sb.toString());

        // 繼續執行方法
        try {
            joinPoint.proceed();
        } catch (Throwable throwable) {
            throwable.printStackTrace();
        }
        System.out.println(methodName + "方法執行結束");

    }
}

在步驟二中的IndexController寫一個sourceC進行測試，加上咱們的自定義註解：

    @MyLog
    @GetMapping("/sourceC/{source_name}")
    public String sourceC(@PathVariable("source_name") String sourceName){
        return "你正在訪問sourceC資源";
    }

啓動springboot web項目，輸入訪問地址

本文分享自微信公衆號 - 全棧程序員社區（mush_it）。
若有侵權，請聯繫 support@oschina.cn 刪除。
本文參與「OSC源創計劃」，歡迎正在閱讀的你也加入，一塊兒分享。