注解都不會用，怎讓Java對你動情
本文轉載自微信公眾號「小菜良記」，作者蔡不菜丶 。轉載本文請聯(lián)系小菜良記公眾號。
初識
“「注解」 也稱為 元數(shù)據(jù)。為我們在代碼中添加信息提供了一種形式化的方法，使我們可以在稍后某個時刻非常方便地使用這些數(shù)據(jù)。
注解是在 Java 1.5 之后引入的，它可以提供用來完整地描述程序中所需的信息，可以由編譯器來測試和驗證的格式，存儲有關程序的額外信息。
注解的使用很簡單，只需要和 @ 符號搭配。有些 Java 初學者常常會把 「注解」 和「注釋」 混淆，但是兩者的作用卻大同小異，都是用來描述信息，不同的是 「注解」 描述的信息是給應用程序看的，而 「注釋」 描述的信息是給開發(fā)人員看的。
初學者對「注解」的印象可能不深，「注解」也許不起眼但是處處可見。
最常見到的便是 @Override，表示當前的方法定義將覆蓋父類的方法，如果拼寫錯誤，或者方法簽名對不上被覆蓋的方法，編譯器就會發(fā)出錯誤提示。
既然都說到@Override注解了，那仔細回憶下，腦子里估計就浮現(xiàn)出@SuppressWarnnings注解。還記得我最早見到這個注解的時候，還是Myeclipse提示我使用的，我也不管三七二十一，就給標注上了。后來才知道這個注解是用來關閉編譯器對類、方法、成員變量、變量初始化的警告。
上面兩個都說完了，那不妨再來一個，這個可能是最不常見的。那就是@Deprecated
不要因為這個類加了橫線感到奇怪，那是因為@Deprecated的效果。它的具體功能就是用于標識方法或類，標識該類或方法已過時，建議不要使用。如果開發(fā)人員使用了注解為它的元素，那么編譯器就會發(fā)出警告信息。
剛剛開局不久，我們就已經(jīng)學到了三個注解的使用，雖然只是基本的，但接下來我們就通過這三個注解為導線通關打怪吧。
首關之程媧造注
注解一旦構造出來，就享有編譯器的類型檢查保護。讓我們先看下一組代碼熱熱身：
- public class TestService {
- @MyAnnotation
- public void runTset() {
- System.out.println("annotation test");
- }
- }
不要納悶，Java 中確實沒有一個注解名為MyAnnotation，但這個怎么來的呢，就是我們自己造的。
那么關子賣完了，接下來就來揭秘注解的制造：
- @Target(ElementType.METHOD)
- @Retention(RetentionPolicy.RUNTIME)
- public @interface MyAnnotation {
- }
這樣子，一個簡單的注解就新鮮出爐了。需要注意的是這可不是一個接口，需要留言interface前面還有一個@，這個標識要是漏掉了，那可以天差地別。
細心的小伙伴可能注意到了，定義的注解頭上怎么還有注解。
這就是接下來要講到，敲黑板，注意看!
元注解來幫忙
在定義注解時，會需要一些元注解。上面出現(xiàn)了兩個，分別是@Target和@Retention.
其中@Target用來定義你的注解將應用于什么地方(例如一個方法或一個域)，@Retention用來定義該注解在哪一個級別可用，在源代碼中(「SOURCE」)，類文件中(「CLASS」)或者運行時(「RUNTIME」)。Java 提供了四種元注解，如下：
| 名稱 | 用處 |
|---|---|
| 「@Target」 | 標識該注解可以用于什么地方。其中 ElementType 參數(shù)包括：1. CONSTARUCTOR：構造器的聲明2. FIELD：域聲明（包括enum實例）3. LOCAL_VARIABLE：局部變量聲明4. METHOD：方法聲明5. PACKAGE：包聲明6. TYPE：類、接口（包括注解類型）或enum 聲明 |
| 「@Retention」 | 表示需要在什么級別保存該注解信息，其中RetentionPolicy參數(shù)包括：1. SOURCE：注解將被編譯器丟棄2. CLASS：注解在 class 文件中可用，但會被 VM 丟棄3. RUNTIME：VM 將在運行期也保留注解，因此可以通過反射機制讀取注解的信息 |
| 「@Documented」 | 將此注解包含在 JavaDoc 中 |
| 「@Inherited」 | 允許子類繼承父類的注解 |
注解也分類
我們在上面示例中創(chuàng)建了一個 @MyAnnotation 注解。看起來很簡單，沒什么內(nèi)容，因此這種注解我們也稱為 「標記注解」，注解也分幾類：
- 標記注解：注解內(nèi)部沒有屬性。使用方式：「@注解名」
- //定義
- @Target(ElementType.METHOD)
- @Retention(RetentionPolicy.RUNTIME)
- public @interface MyAnnotation {
- }
- 單值注解：注解內(nèi)部只有一個屬性。使用方式：「@注解名(key = value)」
- //定義
- @Target(ElementType.METHOD)
- @Retention(RetentionPolicy.RUNTIME)
- public @interface SingleValueAnnotation {
- String name();
- }
- //使用
- @SingleValueAnnotation(name = "test")
- public void singleTest() {}
- 多值注解：注解內(nèi)部有過個屬性。使用方式：「@注解名(key = value, key = value, ...)」
- //定義
- @Target(ElementType.METHOD)
- @Retention(RetentionPolicy.RUNTIME)
- public @interface MultiValueAnnotation {
- String name();
- int num();
- }
- //使用
- @MultiValueAnnotation(name = "test", num = 1)
- public void multiTest() {}
值也有默認
當我們使用的不是標記注解時，如果在使用注解的時候不給注解中的屬性賦上值，那么編譯器就會報錯，提示我們需要賦值。
這樣子是很不方便，有時候我們并沒有使用到或值是固定的不想重復寫，那么這個時候就需要借助「default」關鍵字來幫忙我們解決這種問題。
- @Target(ElementType.METHOD)
- @Retention(RetentionPolicy.RUNTIME)
- public @interface MultiValueAnnotation {
- String name();
- int num() default 0;
- }
我們在屬性上使用了 default 關鍵字來聲明 num 屬性的默認值為 0 ，這樣子我們在使用上述那個注解的時候就可以不用手動給num賦值了。
次關之造器解注
注解具有讓編譯器進行編譯檢查的作用，但是如果沒有用來讀取注解的工具，那注解也不會比注釋更有用，起碼注釋可以讓開發(fā)人員更直觀的看到此段代碼的用處。
重回反射想要創(chuàng)建與使用 「注解處理器」，我們還需要借助反射機制來構造這類工具。以下是簡單的例子：
- public class AnnotationHandle {
- public static void track(Class<?> c) {
- for (Method m : c.getDeclaredMethods()) {
- MultiValueAnnotation annotation = m.getAnnotation(MultiValueAnnotation.class);
- if (annotation != null) {
- System.out.println("name:" + annotation.name() +
- "\n num:" + annotation.num());
- }
- }
- }
- public static void main(String[] args) {
- track(TestService.class);
- }
- }
- /* OUTPUT:
- name:test
- num:0
- */
在上述例子中我們用到了兩個反射的方法：getDeclaredMethods()和getAnnotation()。
其中getDeclaredMethods() 用來返回該類的所有方法，getAnnotation()用來獲取指定類型的注解對象。如果方法上沒有該注解則會返回 「null」 值。
注解元素可用類型
上述@MultiValueAnnotation注解中我們定義了 String類型的 「name」 和 int類型的 「num」，除此之外我們還可以使用其他類型如下：
- 「基本類型」(「int、float、boolean等」)
- 「String」
- 「Class」
- 「enum」
- 「Annotation」
- 「以上類型的數(shù)組」
如果使用了上面以外的其他類型，那么編譯器就會報錯。而且要注意的是，「也不能使用基本類型的包裝類型」
默認值的限制
上述例子中我們也看到了，我們可以在使用注解的時候給注解屬性賦值，也可以在定義注解的時候給注解一個默認值，但是這兩者都說明了一件事：「那就是，注解元素不能有不確定的值，要么具有默認值，要么在使用注解時提供元素的值」
基本元素不存在null值，因此對于非基本類型的元素，無論是在使用中聲明，還是在定義時聲明， 「都不能將 null 值作為其值」。因此在實際開發(fā)中，我們往往會定義一些特殊值作為不存在的標識，例如 「負數(shù)」 或 「空字符串」
三關之運注帷幄
在前面兩關中，我們學會了定義注解和創(chuàng)建注解處理器。接下來我們就要來更加深入掌握注解!
注解也能嵌套
在修飾注解元素的時候我們看到可以使用Annotation來修飾，估計看到那的時候會覺得有點奇怪。在這里就來為你來揭秘。
先來看一組注解：
@Constraints
- @Target(ElementType.FIELD)
- @Retention(RetentionPolicy.RUNTIME)
- public @interface Constraints {
- boolean primaryKey() default false;
- boolean unique() default false;
- }
@SQLString
- @Target(ElementType.FIELD)
- @Retention(RetentionPolicy.RUNTIME)
- public @interface SQLString {
- String name() default "";
- Constraints constraints() default @Constraints;
- }
我們在@SQLString注解中使用Constraints注解元素，并將默認值設為@Constraints。這個時候Constraints中的值都是@Constraints注解中定義的默認值，如果我們要使用自定義的話，做法如下：
- @Target(ElementType.FIELD)
- @Retention(RetentionPolicy.RUNTIME)
- public @interface SQLString {
- String name() default "";
- Constraints constraints() default @Constraints(primaryKey = true);
- }
這樣子我們就可以使用自己定義的「value」
注解不支持繼承
我們不能使用extends來繼承某個@interface，但是可以通過嵌套的方式來解決這一煩惱。
AOP與注解的搭配
「AOP」 在當今開發(fā)中我們并不陌生，那么 「AOP」 和 「注解」 能產(chǎn)生什么化學反應呢，請看以下代碼：
@ApiLog：
- @Retention(RetentionPolicy.RUNTIME)
- @Target({ElementType.METHOD, ElementType.TYPE})
- public @interface ApiLog {
- /**
- * 接口名稱
- */
- String name();
- }
使用：
- @GetMapping(value = "/getConfig")
- @ApiLog(name = "獲取系統(tǒng)相關配置")
- public Result getConfig() throws Exception {
- return sendOK(SystemService.getConfig(type));
- }
Aop使用：
- @Aspect
- @Component
- public class SysLogAspect {
- @Autowired
- private LogService logService;
- @Pointcut("@annotation(cbuc.life.annotation.ApiLog)")
- public void logPointCut() {
- }
- @Around("logPointCut()")
- public Object around(ProceedingJoinPoint point) throws Throwable {
- long beginTime = System.currentTimeMillis();
- //執(zhí)行方法
- Object result = point.proceed();
- //執(zhí)行時長(毫秒)
- long time = System.currentTimeMillis() - beginTime;
- //保存日志
- saveSysLog(point, time);
- return result;
- }
- private void saveSysLog(ProceedingJoinPoint joinPoint, long time) {
- MethodSignature signature = (MethodSignature) joinPoint.getSignature();
- Method method = signature.getMethod();
- LogEntity log = new LogEntity();
- ApiLog apiLog = method.getAnnotation(ApiLog.class);
- if(apiLog != null){
- //注解上的描述
- log.setMethodDescribe(syslog.value());
- }
- //請求的方法名
- String className = joinPoint.getTarget().getClass().getName();
- String methodName = signature.getName();
- log.setMethod(className + "." + methodName + "()");
- //請求的參數(shù)
- Object[] args = joinPoint.getArgs();
- String params = JSON.toJSONString(args[0]);
- log.setParams(params);
- //獲取request
- HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
- //設置IP地址
- log.setIp(ServletUtil.getIpAddress(request));
- //用戶名
- String username = LoginInfo.getUsername();
- log.setUsername(username);
- //保存系統(tǒng)日志
- logService.save(log);
- }
- }
通過以上代碼，我們可以在期望記錄日志的方法上增加@ApiLog注解，該方法的動作就會被記錄進日志表，不管方法叫什么名字，類在什么位置，都可以輕松的解決，而且沒有代碼入侵!
