前言
你知道自定義註解的魅力所在嗎？前端
你知道自定義註解該怎麼使用嗎？java
本文一開始的這兩個問題，須要您仔細思考下，而後結合這兩個問題來閱讀下面的內容；若是您在閱讀完文章後對這兩個問題有了比較清晰的，請動動您發財的小手，點贊留言呀！redis
本文主線：
-
註解是什麼；數據庫
-
實現一個自定義註解；編程
-
自定義註解的實戰應用場景；json
注意：本文在介紹自定義註解實戰應用場景時，須要結合攔截器、AOP進行使用，因此本文也會簡單聊下AOP相關知識點，若是對於AOP的相關內容不太清楚的能夠參考此 細說Spring——AOP詳解 文章進行了解。後端
註解
註解是什麼？
①、引用自維基百科的內容：api
Java註解又稱Java標註，是JDK5.0版本開始支持加入源代碼的特殊語法 元數據 。瀏覽器
Java語言中的類、方法、變量、參數和包等均可以被標註。和Javadoc不一樣，Java標註能夠經過反射獲取標註內容。在編譯器生成類文件時，標註能夠被嵌入到字節碼中。Java虛擬機能夠保留標註內容，在運行時能夠獲取到標註內容。 固然它也支持自定義Java標註。網絡
②、引用自網絡的內容：
Java 註解是在 JDK5 時引入的新特性，註解（也被稱爲 元數據 ）爲咱們在代碼中添加信息提供了一種形式化的方法，使咱們能夠在稍後某個時刻很是方便地使用這些數據。
元註解是什麼？
元註解 的做用就是負責註解其餘註解。Java5.0定義了4個標準的meta-annotation（元註解）類型，它們被用來提供對其它 annotation類型做說明。
標準的元註解：
-
@Retention
-
@Documented
-
@Inherited
在詳細說這四個元數據的含義以前，先來看一個在工做中會常用到的 @Autowired 註解，進入這個註解裏面瞧瞧： 此註解中使用到了@Target、@Retention、@Documented 這三個元註解 。
@Target({ElementType.CONSTRUCTOR, ElementType.METHOD, ElementType.PARAMETER, ElementType.FIELD, ElementType.ANNOTATION_TYPE}) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface Autowired { boolean required() default true; }
@Target元註解：
@Target註解，是專門用來限定某個自定義註解可以被應用在哪些Java元素上面的，標明做用範圍；取值在
java.lang.annotation.ElementType進行定義的。
public enum ElementType { /** 類，接口（包括註解類型）或枚舉的聲明 */ TYPE, /** 屬性的聲明 */ FIELD, /** 方法的聲明 */ METHOD, /** 方法形式參數聲明 */ PARAMETER, /** 構造方法的聲明 */ CONSTRUCTOR, /** 局部變量聲明 */ LOCAL_VARIABLE, /** 註解類型聲明 */ ANNOTATION_TYPE, /** 包的聲明 */ PACKAGE }
根據此處能夠知道 @Autowired 註解的做用範圍：
// 能夠做用在 構造方法、方法、方法形參、屬性、註解類型 上 @Target({ElementType.CONSTRUCTOR, ElementType.METHOD, ElementType.PARAMETER, ElementType.FIELD, ElementType.ANNOTATION_TYPE})
@Retention元註解：
@Retention註解，翻譯爲持久力、保持力。即用來修飾自定義註解的生命週期。
註解的生命週期有三個階段：
-
Java源文件階段；
-
編譯到class文件階段；
-
運行期階段；
一樣使用了RetentionPolicy 枚舉類型對這三個階段進行了定義：
public enum RetentionPolicy { /** * Annotations are to be discarded by the compiler. * （註解將被編譯器忽略掉） */ SOURCE, /** * Annotations are to be recorded in the class file by the compiler * but need not be retained by the VM at run time. This is the default * behavior. * （註解將被編譯器記錄在class文件中，但在運行時不會被虛擬機保留，這是一個默認的行爲） */ CLASS, /** * Annotations are to be recorded in the class file by the compiler and * retained by the VM at run time, so they may be read reflectively. * （註解將被編譯器記錄在class文件中，並且在運行時會被虛擬機保留，所以它們能經過反射被讀取到） * @see java.lang.reflect.AnnotatedElement */ RUNTIME }
再詳細描述下這三個階段：
①、若是被定義爲 RetentionPolicy.SOURCE，則它將被限定在Java源文件中，那麼這個註解即不會參與編譯也不會在運行期起任何做用，這個註解就和一個註釋是同樣的效果，只能被閱讀Java文件的人看到；
②、若是被定義爲 RetentionPolicy.CLASS，則它將被編譯到Class文件中，那麼編譯器能夠在編譯時根據註解作一些處理動做，可是運行時JVM（Java虛擬機）會忽略它，而且在運行期也不能讀取到；
③、若是被定義爲 RetentionPolicy.RUNTIME，那麼這個註解能夠在運行期的加載階段被加載到Class對象中。那麼在程序運行階段，能夠經過反射獲得這個註解，並經過判斷是否有這個註解或這個註解中屬性的值，從而執行不一樣的程序代碼段。
注意：實際開發中的自定義註解幾乎都是使用的 RetentionPolicy.RUNTIME 。
@Documented元註解：
@Documented註解，是被用來指定自定義註解是否能隨着被定義的java文件生成到JavaDoc文檔當中。
@Inherited元註解：
@Inherited註解，是指定某個自定義註解若是寫在了父類的聲明部分，那麼子類的聲明部分也能自動擁有該註解。
@Inherited註解只對那些@Target被定義爲 ElementType.TYPE 的自定義註解起做用。
自定義註解實現：
在瞭解了上面的內容後，咱們來嘗試實現一個自定義註解：
根據上面自定義註解中使用到的元註解得知：
①、此註解的做用範圍，可使用在類（接口、枚舉）、方法上；
②、此註解的生命週期，被編譯器保存在class文件中，並且在運行時會被JVM保留，能夠經過反射讀取；
自定義註解的簡單使用：
上面已經建立了一個自定義的註解，那該怎麼使用呢？下面首先描述下它簡單的用法，後面將會使用其結合攔截器和AOP切面編程進行實戰應用；
應用場景實現
在瞭解了上面註解的知識後，咱們乘勝追擊，看看它的實際應用場景是腫麼樣的，以此加深下咱們的理解；
實現的 Demo 項目是以 SpringBoot 實現的，項目工程結構圖以下：
場景一：自定義註解 + 攔截器 = 實現接口響應的包裝
使用自定義註解 結合 攔截器 優雅的實現對API接口響應的包裝。
在介紹自定義實現的方式以前，先簡單介紹下廣泛的實現方式，經過二者的對比，才能更加明顯的發現誰最優雅。
普通的接口響應包裝方式：
如今項目絕大部分都採用的先後端分離方式，因此須要前端和後端經過接口進行交互；目前在接口交互中使用最多的數據格式是 json，而後後端返回給前端的最爲常見的響應格式以下：
{ #返回狀態碼 code:integer, #返回信息描述 message:string, #返回數據值 data:object }
項目中常用枚舉類定義狀態碼和消息，代碼以下：
/** * @author 【 木子雷 】 公衆號 * @Title: ResponseCode * @Description: 使用枚舉類封裝好的響應狀態碼及對應的響應消息 * @date: 2019年8月23日 下午7:12:50 */ public enum ResponseCode { SUCCESS(1200, "請求成功"), ERROR(1400, "請求失敗"); private Integer code; private String message; private ResponseCode(Integer code, String message) { this.code = code; this.message = message; } public Integer code() { return this.code; } public String message() { return this.message; } }
同時項目中也會設計一個返回響應包裝類，代碼以下：
import com.alibaba.fastjson.JSONObject; import java.io.Serializable; /** * @author 【 木子雷 】 公衆號 * @Title: Response * @Description: 封裝的統一的響應返回類 * @date: 2019年8月23日 下午7:07:13 */ @SuppressWarnings("serial") public class Response<T> implements Serializable { /** * 響應數據 */ private T date; /** * 響應狀態碼 */ private Integer code; /** * 響應描述信息 */ private String message; public Response(T date, Integer code, String message) { super(); this.date = date; this.code = code; this.message = message; } public T getDate() { return date; } public void setDate(T date) { this.date = date; } public Integer getCode() { return code; } public void setCode(Integer code) { this.code = code; } public String getMessage() { return message; } public void setMessage(String message) { this.message = message; } @Override public String toString() { return JSONObject.toJSONString(this); } }
最後就是使用響應包裝類和狀態碼枚舉類 來實現返回響應的包裝了：
@GetMapping("/user/findAllUser") public Response<List<User>> findAllUser() { logger.info("開始查詢全部數據..."); List<User> findAllUser = new ArrayList<>(); findAllUser.add(new User("木子雷", 26)); findAllUser.add(new User("公衆號", 28)); // 返回響應進行包裝 Response response = new Response(findAllUser, ResponseCode.SUCCESS.code(), ResponseCode.SUCCESS.message()); logger.info("response: {} \n", response.toString()); return response; }
在瀏覽器中輸入網址： http://127.0.0.1:8080/v1/api/user/findAllUser 而後點擊回車，獲得以下數據：
{ "code": 1200, "date": [ { "age": 26, "name": "木子雷" }, { "age": 28, "name": "公衆號" } ], "message": "請求成功" }
經過看這中實現響應包裝的方式，咱們能發現什麼問題嗎？
答：代碼很冗餘，須要在每一個接口方法中都進行響應的包裝；使得接口方法包含了不少非業務邏輯代碼；
有沒有版本進行優化下呢？ en en 思考中。。。。。 啊，自定義註解 + 攔截器能夠實現呀！
自定義註解實現接口響應包裝：
①、首先建立一個進行響應包裝的自定義註解：
/** * @author 【 木子雷 】 公衆號 * @PACKAGE_NAME: com.lyl.annotation * @ClassName: ResponseResult * @Description: 標記方法返回值須要進行包裝的 自定義註解 * @Date: 2020-11-10 10:38 **/ @Target({ElementType.TYPE, ElementType.METHOD}) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface ResponseResult { }
②、建立一個攔截器，實現對請求的攔截，看看請求的方法或類上是否使用了自定義的註解：
/** * @author 【 木子雷 】 公衆號 * @PACKAGE_NAME: com.lyl.interceptor * @ClassName: ResponseResultInterceptor * @Description: 攔截器：攔截請求，判斷請求的方法或類上是否使用了自定義的@ResponseResult註解， * 並在請求內設置是否使用了自定義註解的標誌位屬性； * @Date: 2020-11-10 10:50 **/ @Component public class ResponseResultInterceptor implements HandlerInterceptor { /** * 標記位，標記請求的controller類或方法上使用了到了自定義註解，返回數據須要被包裝 */ public static final String RESPONSE_ANNOTATION = "RESPONSE_ANNOTATION"; /** * 請求預處理，判斷是否使用了自定義註解 */ @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { // 請求的接口方法 if (handler instanceof HandlerMethod) { final HandlerMethod handlerMethod = (HandlerMethod) handler; final Class<?> clazz = handlerMethod.getBeanType(); final Method method = handlerMethod.getMethod(); // 判斷是否在類對象上加了註解 if (clazz.isAnnotationPresent(ResponseResult.class)) { // 在請求中設置須要進行響應包裝的屬性標誌，在下面的ResponseBodyAdvice加強中進行處理 request.setAttribute(RESPONSE_ANNOTATION, clazz.getAnnotation(ResponseResult.class)); } else if (method.isAnnotationPresent(ResponseResult.class)) { // 在請求中設置須要進行響應包裝的屬性標誌，在下面的ResponseBodyAdvice加強中進行處理 request.setAttribute(RESPONSE_ANNOTATION, method.getAnnotation(ResponseResult.class)); } } return true; } }
③、建立一個加強Controller，實現對返回響應進行包裝的加強處理：
/** * @author 【 木子雷 】 公衆號 * @PACKAGE_NAME: com.lyl.interceptor * @ClassName: ResponseResultHandler * @Description: 對 返回響應 進行包裝 的加強處理 * @Date: 2020-11-10 13:49 **/ @ControllerAdvice public class ResponseResultHandler implements ResponseBodyAdvice<Object> { private final Logger logger = LoggerFactory.getLogger(this.getClass()); /** * 標記位，標記請求的controller類或方法上使用了到了自定義註解，返回數據須要被包裝 */ public static final String RESPONSE_ANNOTATION = "RESPONSE_ANNOTATION"; /** * 請求中是否包含了 響應須要被包裝的標記，若是沒有，則直接返回，不須要重寫返回體 * * @param methodParameter * @param aClass * @return */ @Override public boolean supports(MethodParameter methodParameter, Class<? extends HttpMessageConverter<?>> aClass) { ServletRequestAttributes ra = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes(); HttpServletRequest sr = (HttpServletRequest) ra.getRequest(); // 查詢是否須要進行響應包裝的標誌 ResponseResult responseResult = (ResponseResult) sr.getAttribute(RESPONSE_ANNOTATION); return responseResult == null ? false : true; } /** * 對 響應體 進行包裝; 除此以外還能夠對響應體進行統一的加密、簽名等 * * @param responseBody 請求的接口方法執行後獲得返回值(返回響應) */ @Override public Object beforeBodyWrite(Object responseBody, MethodParameter methodParameter, MediaType mediaType, Class<? extends HttpMessageConverter<?>> aClass, ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse) { logger.info("返回響應 包裝進行中。。。"); Response response; // boolean類型時判斷一些數據庫新增、更新、刪除的操做是否成功 if (responseBody instanceof Boolean) { if ((Boolean) responseBody) { response = new Response(responseBody, ResponseCode.SUCCESS.code(), ResponseCode.SUCCESS.message()); } else { response = new Response(responseBody, ResponseCode.ERROR.code(), ResponseCode.ERROR.message()); } } else { // 判斷像查詢一些返回數據的狀況，查詢不到數據返回 null; if (null != responseBody) { response = new Response(responseBody, ResponseCode.SUCCESS.code(), ResponseCode.SUCCESS.message()); } else { response = new Response(responseBody, ResponseCode.ERROR.code(), ResponseCode.ERROR.message()); } } return response; } }
④、最後在 Controller 中使用上咱們的自定義註解；在 Controller 類上或者 方法上使用@ResponseResult自定義註解便可； 在瀏覽器中輸入網址： http://127.0.0.1:8080/v1/api/user/findAllUserByAnnotation 進行查看：
// 自定義註解用在了方法上 @ResponseResult @GetMapping("/user/findAllUserByAnnotation") public List<User> findAllUserByAnnotation() { logger.info("開始查詢全部數據..."); List<User> findAllUser = new ArrayList<>(); findAllUser.add(new User("木子雷", 26)); findAllUser.add(new User("公衆號", 28)); logger.info("使用 @ResponseResult 自定義註解進行響應的包裝，使controller代碼更加簡介"); return findAllUser; }
至此咱們的接口返回響應包裝自定義註解實現設計完成，看看代碼是否是又簡潔，又優雅呢。
總結：本文針對此方案只是進行了簡單的實現，若是有興趣的朋友能夠進行更好的優化。
場景二：自定義註解 + AOP = 實現優雅的使用分佈式鎖
分佈式鎖的最多見的使用流程：
先看看最爲常見的分佈式鎖使用方式的實現，而後再聊聊自定義註解怎麼優雅的實現分佈式鎖的使用。
普通的分佈式鎖使用方式：
經過上面的代碼能夠獲得一個信息：若是有不少方法中須要使用分佈式鎖，那麼每一個方法中都必須有獲取分佈式鎖和釋放分佈式鎖的代碼，這樣一來就會出現代碼冗餘；
那有什麼好的解決方案嗎？ 自定義註解使代碼變得更加簡潔、優雅；
自定義註解優雅的使用分佈式鎖：
①、首先實現一個標記分佈式鎖使用的自定義註解：
/** * @author 【 木子雷 】 公衆號 * @PACKAGE_NAME: com.lyl.annotation * @ClassName: GetDistributedLock * @Description: 獲取redis分佈式鎖 註解 * @Date: 2020-11-10 16:24 **/ @Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface GetDistributedLock { // 分佈式鎖 key String lockKey(); // 分佈式鎖 value，默認爲 lockValue String lockValue() default "lockValue"; // 過時時間，默認爲 300秒 int expireTime() default 300; }
②、定義一個切面，在切面中對使用了 @GetDistributedLock 自定義註解的方法進行環繞加強通知：
/** * @author: 【 木子雷 】 公衆號 * @PACKAGE_NAME: com.lyl.aop * @ClassName: DistributedLockAspect * @Description: 自定義註解結合AOP切面編程優雅的使用分佈式鎖 * @Date: 2020-11-10 16:52 **/ @Component @Aspect public class DistributedLockAspect { private final Logger logger = LoggerFactory.getLogger(this.getClass()); @Autowired RedisService redisService; /** * Around 環繞加強通知 * * @param joinPoint 鏈接點，全部方法都屬於鏈接點；可是當某些方法上使用了@GetDistributedLock自定義註解時， * 則其將鏈接點變爲了切點；而後在切點上織入額外的加強處理；切點和其相應的加強處理構成了切面Aspect 。 */ @Around(value = "@annotation(com.lyl.annotation.GetDistributedLock)") public Boolean handlerDistributedLock(ProceedingJoinPoint joinPoint) { // 經過反射獲取自定義註解對象 GetDistributedLock getDistributedLock = ((MethodSignature) joinPoint.getSignature()) .getMethod().getAnnotation(GetDistributedLock.class); // 獲取自定義註解對象中的屬性值 String lockKey = getDistributedLock.lockKey(); String LockValue = getDistributedLock.lockValue(); int expireTime = getDistributedLock.expireTime(); if (redisService.tryGetDistributedLock(lockKey, LockValue, expireTime)) { // 獲取分佈式鎖成功後，繼續執行業務邏輯 try { return (boolean) joinPoint.proceed(); } catch (Throwable throwable) { logger.error("業務邏輯執行失敗。", throwable); } finally { // 最終保證分佈式鎖的釋放 redisService.releaseDistributedLock(lockKey, LockValue); } } return false; } }
③、最後，在 Controller 中的方法上使用 @GetDistributedLock 自定義註解便可；當某個方法上使用了 自定義註解，那麼這個方法就至關於一個切點，那麼就會對這個方法作環繞（方法執行前和方法執行後）加強處理；
在瀏覽器中輸入網址： http://127.0.0.1:8080/v1/api/user/getDistributedLock 回車後觸發方法執行：
// 自定義註解的使用 @GetDistributedLock(lockKey = "userLock") @GetMapping("/user/getDistributedLock") public boolean getUserDistributedLock() { logger.info("獲取分佈式鎖..."); // 寫具體的業務邏輯 return true; }
經過自定義註解的方式，能夠看到代碼變得更加簡潔、優雅。
場景三：自定義註解 + AOP = 實現日誌的打印
先看看最爲常見的日誌打印的方式，而後再聊聊自定義註解怎麼優雅的實現日誌的打印。
普通日誌的打印方式：
經過看上面的代碼能夠知道，若是每一個方法都須要打印下日誌，那將會存在大量的冗餘代碼；
自定義註解實現日誌打印：
①、首先建立一個標記日誌打印的自定義註解：
/** * @Author: 【 木子雷 】 公衆號 * @PACKAGE_NAME: com.lyl.annotation * @ClassName: PrintLog * @Description: 自定義註解實現日誌打印 * @Date: 2020-11-10 18:05 **/ @Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface PrintLog { }
②、定義一個切面，在切面中對使用了 @PrintLog 自定義註解的方法進行環繞加強通知：
/** * @author: 【 木子雷 】 公衆號 * @PACKAGE_NAME: com.lyl.aop * @ClassName: PrintLogAspect * @Description: 自定義註解結合AOP切面編程優雅的實現日誌打印 * @Date: 2020-11-10 18:11 **/ @Component @Aspect public class PrintLogAspect { private final Logger logger = LoggerFactory.getLogger(this.getClass()); /** * Around 環繞加強通知 * * @param joinPoint 鏈接點，全部方法都屬於鏈接點；可是當某些方法上使用了@PrintLog自定義註解時， * 則其將鏈接點變爲了切點；而後在切點上織入額外的加強處理；切點和其相應的加強處理構成了切面Aspect 。 */ @Around(value = "@annotation(com.lyl.annotation.PrintLog)") public Object handlerPrintLog(ProceedingJoinPoint joinPoint) { // 獲取方法的名稱 String methodName = joinPoint.getSignature().getName(); // 獲取方法入參 Object[] param = joinPoint.getArgs(); StringBuilder sb = new StringBuilder(); for (Object o : param) { sb.append(o + "; "); } logger.info("進入《{}》方法, 參數爲: {}", methodName, sb.toString()); Object object = null; // 繼續執行方法 try { object = joinPoint.proceed(); } catch (Throwable throwable) { logger.error("打印日誌處理error。。", throwable); } logger.info("{} 方法執行結束。。", methodName); return object; } }
③、最後，在 Controller 中的方法上使用 @PrintLog 自定義註解便可；當某個方法上使用了 自定義註解，那麼這個方法就至關於一個切點，那麼就會對這個方法作環繞（方法執行前和方法執行後）加強處理；
@PrintLog @GetMapping(value = "/user/findUserNameById/{id}", produces = "application/json;charset=utf-8") public String findUserNameById(@PathVariable("id") int id) { // 模擬根據id查詢用戶名 String userName = "木子雷 公衆號"; return userName; }
④、在瀏覽器中輸入網址： http://127.0.0.1:8080/v1/api/user/findUserNameById/66 回車後觸發方法執行，發現控制檯打印了日誌：
進入《findUserNameById》方法, 參數爲: 66; findUserNameById 方法執行結束。。
使用自定義註解實現是多優雅，代碼看起來簡介乾淨，越瞅越喜歡；趕快去你的項目中使用吧， 嘿嘿。。。
end 。。。 自定義註解介紹到這本文也就結束了，期待咱們的下次見面。
最後，想問下文章開頭的那兩個問題你們內心是否是已經有了答案呢！嘿嘿。。
❤ 關注 + 點贊 + 收藏 + 評論 喲
若是本文對您有幫助的話，請揮動下您愛發財的小手點下贊呀，您的支持就是我不斷創做的動力；謝謝！
若是想要 Demo 源碼的話，請您 VX搜索【木子雷】公衆號，回覆 「 註解 」 獲取； 再次感謝您閱讀本文！
參考資料
- END -