一：簡介

開發中經常使用到註解，在專案中也偶爾會見到過自定義註解，今天就來探討一下這個註解是什麼鬼，以及註解的應用場景和如何自定義註解。

下面列舉開發中常見的註解

• @Override：用於標識該方法繼承自超類, 當父類的方法被刪除或修改了，編譯器會提示錯誤資訊(我們最經常看到的toString()方法上總能看到這貨)
• @Deprecated：表示該類或者該方法已經不推薦使用，已經過期了，如果使用者還是要使用，會生成編譯的警告

• @SuppressWarnings：用於忽略的編譯器警告資訊

• Junit測試：@Test

• Spring的一些註解：@Controller、@RequestMapping、@RequestParam、@ResponseBody、@Service、@Component、@Repository、@Resource、@Autowire
• Java驗證的註解：@NotNull、@Email

下面看一下註解Override.java的廬山真面目

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
public @interface Override {

}

二：註解基本知識

1. 註解資料型別

註解是寫在.java檔案中，使用@interface作為關鍵字, 所以註解也是Java的一種資料型別，從廣泛的定義來說，Class、Interface、Enum、Annotation都屬於Class型別。

2. 元註解

在建立註解的時候，需要使用一些註解來描述自己建立的註解，就是寫在@interface上面的那些註解，這些註解被稱為元註解，如在Override中看到的@Target、@Retention等。下面列出一些元註解

• @Documented: 用於標記在生成javadoc時是否將註解包含進去，可以看到這個註解和@Override一樣，註解中空空如也，什麼東西都沒有

  @Documented
  @Retention(RetentionPolicy.RUNTIME)
  @Target(ElementType.ANNOTATION_TYPE)
  public @interface Documented {
  
  }

• @Target：用於定義註解可以在什麼地方使用，預設可以在任何地方使用，也可以指定使用的範圍，開發中將註解用在類上(如@Controller)、欄位上(如@Autowire)、方法上(如@RequestMapping)、方法的引數上(如@RequestParam)等比較常見。

  • TYPE : 類、介面或enum宣告
  • FIELD: 域(屬性)宣告
  • METHOD: 方法宣告
  • PARAMETER: 引數宣告
  • CONSTRUCTOR: 構造方法宣告
  • LOCAL_VARIABLE:區域性變數宣告
  • ANNOTATION_TYPE:註釋型別宣告
  • PACKAGE: 包宣告

  Target.java

  @Documented
  @Retention(RetentionPolicy.RUNTIME)
  @Target(ElementType.ANNOTATION_TYPE)
  public @interface Target {
      /**
       * Returns an array of the kinds of elements an annotation type
       * can be applied to.
       * @return an array of the kinds of elements an annotation type
       * can be applied to
       */
      ElementType[] value();
  }

  public enum ElementType {
      /** Class, interface (including annotation type), or enum declaration */
      TYPE,
  
      /** Field declaration (includes enum constants) */
      FIELD,
  
      /** Method declaration */
      METHOD,
  
      /** Formal parameter declaration */
      PARAMETER,
  
      /** Constructor declaration */
      CONSTRUCTOR,
  
      /** Local variable declaration */
      LOCAL_VARIABLE,
  
      /** Annotation type declaration */
      ANNOTATION_TYPE,
  
      /** Package declaration */
      PACKAGE,
  
      /** Type parameter declaration */
      TYPE_PARAMETER,
  
      /** Use of a type */
      TYPE_USE
  }

• @Inherited：允許子類繼承父類中的註解，可以通過反射獲取到父類的註解

  @Documented
  @Retention(RetentionPolicy.RUNTIME)
  @Target(ElementType.ANNOTATION_TYPE)
  public @interface Inherited {
  
  }

• @Constraint：用於校驗屬性值是否合法

  @Documented
  @Target({ElementType.ANNOTATION_TYPE})
  @Retention(RetentionPolicy.RUNTIME)
  public @interface Constraint {
      Class<? extends ConstraintValidator<?, ?>>[] validatedBy();
  }

• @Retention：註解的宣告週期，用於定義註解的存活階段，可以存活在原始碼級別、編譯級別(位元組碼級別)、執行時級別

  • SOURCE：原始碼級別，註解只存在原始碼中，一般用於和編譯器互動，用於檢測程式碼。如@Override, @SuppressWarings。
  • CLASS：位元組碼級別，註解存在於原始碼和位元組碼檔案中，主要用於編譯時生成額外的檔案，如XML，Java檔案等，但執行時無法獲得。 如mybatis生成實體和對映檔案，這個級別需要新增JVM載入時候的代理（javaagent），使用代理來動態修改位元組碼檔案。

  • RUNTIME：執行時級別，註解存在於原始碼、位元組碼、java虛擬機器中，主要用於執行時，可以使用反射獲取相關的資訊。

    @Documented
    @Retention(RetentionPolicy.RUNTIME)
    @Target(ElementType.ANNOTATION_TYPE)
    public @interface Retention {
        /**
         * Returns the retention policy.
         * @return the retention policy
         */
        RetentionPolicy value();
    }

3. 註解的內容

在上面的註解原始碼中可以看到有的註解中沒有任何內容，有的註解的有內容，看似像方法。

註解的內容的語法格式： 資料型別 屬性名() default 預設值，資料型別用於描述屬性的資料型別，預設值是說當沒有給屬性賦值時使用預設值，一般String使用空字串”“作為預設值，陣列一般使用空陣列{ }作為預設值.

下面看一下SpringMVC中的RequestMapping的註解的宣告

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Mapping
public @interface RequestMapping {
    String name() default "";

    @AliasFor("path")
    String[] value() default {};

    @AliasFor("value")
    String[] path() default {};

    RequestMethod[] method() default {};
    String[] params() default {};
    String[] headers() default {};
    String[] consumes() default {};
    String[] produces() default {};
}

使用SpringMVC中的RequestMapping註解

@RequestMapping(value = "/list", 
                method = RequestMethod.POST, 
                produces = {"application/json;charset=UTF-8;"})
public String list(){

}

4. 註解的使用場景

可以通過註解的宣告週期來分析註解的使用場景：

• SOURCE原始碼級別：給編譯器使用，如@Override、@Deprecated 等， 這部分開發者應該使用的場景不多
• CLASS：位元組碼級別，這部分也很少見到
• RUNTIME：執行時級別，這個是最多的，幾乎開發者使用到的註解都是執行時級別，執行時註解常用的有以下幾種情況
  
  • 註解中沒有任何屬性的，空的註解，這部分註解通常起到一個標註的作用，如@Test、@Before、@After，通過獲取這些標記註解在邏輯上做一些特殊的處理
  • 可以使用約束註解@Constraint來對屬性值進行校驗，如@Email, @NotNull等
  • 可以通過在註解中使用屬性來配置一些引數，然後可以使用反射獲取這些引數，這些註解沒有其他特殊的功能，只是簡單的代替xml配置的方式來配置一些引數。使用註解來配置引數這在Spring boot中得到了熱捧，如@Configuration

關於配置方式xml vs annotation, 一般使用xml配置一些和業務關係不太緊密的配置，使用註解配置一些和業務密切相關的引數。

三：註解和反射基本API

// 獲取某個型別的註解
public <A extends Annotation> A getAnnotation(Class<A> annotationClass);
// 獲取所有註解(包括父類中被Inherited修飾的註解)
public Annotation[] getAnnotations(); 
// 獲取宣告的註解(但是不包括父類中被Inherited修飾的註解)
public Annotation[] getDeclaredAnnotations();
// 判斷某個物件上是否被某個註解進行標註
public boolean isAnnotationPresent(Class<? extends Annotation> annotationClass)

// 獲取某個類宣告的所有欄位
public Field[] getDeclaredFields() throws SecurityException;
// 獲取某個方法
public Method getMethod(String name, Class<?>... parameterTypes);

四：自定義註解

使用自定義註解+攔截器或者是AOP等可以進行許可權的控制。

下面通過定義一個註解用來限制當用戶訪問介面時必須要登入的示例

步驟一：定義註解
RequiresLogin.java

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

}

步驟二：使用註解

@Controller
@RequestMapping("/user")
public class UserController {
    @RequiresLogin
    @RequestMapping(value = "/list", produces = {"application/json;charset=UTF-8;"})
    public String getUserList(){

        System.out.println("--------------");
        return "[{'id': 1, 'username':'zhangsan'}]";
    }
}

步驟三：使用AOP進行攔截，解析註解

public class LoginAdvices {
    public void before(JoinPoint joinPoint) throws Exception{

        Object target = joinPoint.getTarget();
        String methodName = joinPoint.getSignature().getName();

        System.out.println(target + "-------" + methodName);
        Method method = target.getClass().getMethod(methodName);
        boolean annotationPresent = method.isAnnotationPresent(RequiresLogin.class);
        if (annotationPresent) {
            // 使用者必須登入
            boolean isLogin = false;
            if (!isLogin) {
                throw new Exception("訪問該介面必須先登入");
            } else {
                System.out.println("已登入...");
            }
        }
    }
}

在applicationContext.xml中配置aop

<bean id="loginAdvices" class="com.mengdee.manager.aop.LoginAdvices"/>
    <!-- aop配置 -->
    <aop:config proxy-target-class="true">
        <!--切面 -->
        <aop:aspect ref="loginAdvices">
            <!-- 切點 -->
            <aop:pointcut id="pointcut1" expression="execution(* com.mengdee.manager.controller.*.*(..))"/>
            <!--連線通知方法與切點 -->
            <aop:before method="before" pointcut-ref="pointcut1"/>
        </aop:aspect>
    </aop:config>

自定義異常

• 為什麼要自定義異常
  Java雖然提供了豐富的異常處理類，但是在專案中還會經常使用自定義異常，其主要原因是Java提供的異常類在某些情況下還是不能滿足各種業務的需求。 例如系統中有些錯誤是符合Java語法，但不符合業務邏輯。如當用戶登入時賬號不存在或者賬號已鎖定可以自定義一個賬號異常AccountException。
  或者有些情況下Java的同一個異常可能會有多種原因引起，在排查問題時不容易定位錯誤，此時可以使用自定義一個更加明確的異常。

• 自定義異常的好處：自定義異常可以使異常更加明確，可以隱藏底層的異常，這樣更安全，異常資訊更加直觀。

• 自定義異常的使用：自定義異常一般繼承自Exception或者RuntimeException，根據業務需要可以帶一些屬性作為建構函式的引數，自定義異常需要程式設計師手動丟擲異常，並處理異常。

• 下面是Apache Shiro中自定義異常的示例

public class ShiroException extends RuntimeException {
    public ShiroException() {
    }

    public ShiroException(String message) {
        super(message);
    }

    public ShiroException(Throwable cause) {
        super(cause);
    }

    public ShiroException(String message, Throwable cause) {
        super(message, cause);
    }
}