Java 自定義注解的魅力
①、引用自維基百科的內(nèi)容:Java注解又稱Java標(biāo)注,是JDK5.0版本開(kāi)始支持加入源代碼的特殊語(yǔ)法 元數(shù)據(jù) 。
Java語(yǔ)言中的類、方法、變量、參數(shù)和包等都可以被標(biāo)注。和Javadoc不同,Java標(biāo)注可以通過(guò)反射獲取標(biāo)注內(nèi)容。在編譯器生成類文件時(shí),標(biāo)注可以被嵌入到字節(jié)碼中。Java虛擬機(jī)可以保留標(biāo)注內(nèi)容,在運(yùn)行時(shí)可以獲取到標(biāo)注內(nèi)容。 當(dāng)然它也支持自定義Java標(biāo)注。
②、引用自網(wǎng)絡(luò)的內(nèi)容:Java 注解是在 JDK5 時(shí)引入的新特性,注解(也被稱為 元數(shù)據(jù) )為我們?cè)诖a中添加信息提供了一種形式化的方法,使我們可以在稍后某個(gè)時(shí)刻非常方便地使用這些數(shù)據(jù)。
元注解是什么?元注解 的作用就是負(fù)責(zé)注解其他注解。Java5.0定義了4個(gè)標(biāo)準(zhǔn)的meta-annotation(元注解)類型,它們被用來(lái)提供對(duì)其它 annotation類型作說(shuō)明。
標(biāo)準(zhǔn)的元注解:@Target@Retention@Documented@Inherited在詳細(xì)說(shuō)這四個(gè)元數(shù)據(jù)的含義之前,先來(lái)看一個(gè)在工作中會(huì)經(jīng)常使用到的 @Autowired 注解,進(jìn)入這個(gè)注解里面瞧瞧: 此注解中使用到了@Target、@Retention、@Documented 這三個(gè)元注解 。
@Target({ElementType.CONSTRUCTOR, ElementType.METHOD, ElementType.PARAMETER, ElementType.FIELD, ElementType.ANNOTATION_TYPE})@Retention(RetentionPolicy.RUNTIME)@Documentedpublic @interface Autowired { boolean required() default true;}@Target元注解:
@Target注解,是專門(mén)用來(lái)限定某個(gè)自定義注解能夠被應(yīng)用在哪些Java元素上面的,標(biāo)明作用范圍;取值在java.lang.annotation.ElementType 進(jìn)行定義的。
public enum ElementType { /** 類,接口(包括注解類型)或枚舉的聲明 */ TYPE, /** 屬性的聲明 */ FIELD, /** 方法的聲明 */ METHOD, /** 方法形式參數(shù)聲明 */ PARAMETER, /** 構(gòu)造方法的聲明 */ CONSTRUCTOR, /** 局部變量聲明 */ LOCAL_VARIABLE, /** 注解類型聲明 */ ANNOTATION_TYPE, /** 包的聲明 */ PACKAGE}
根據(jù)此處可以知道 @Autowired 注解的作用范圍:
// 可以作用在 構(gòu)造方法、方法、方法形參、屬性、注解類型 上@Target({ElementType.CONSTRUCTOR, ElementType.METHOD, ElementType.PARAMETER, ElementType.FIELD, ElementType.ANNOTATION_TYPE})@Retention元注解:
@Retention注解,翻譯為持久力、保持力。即用來(lái)修飾自定義注解的生命周期。
注解的生命周期有三個(gè)階段:
Java源文件階段; 編譯到class文件階段; 運(yùn)行期階段;同樣使用了RetentionPolicy 枚舉類型對(duì)這三個(gè)階段進(jìn)行了定義:
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文件中,但在運(yùn)行時(shí)不會(huì)被虛擬機(jī)保留,這是一個(gè)默認(rèn)的行為) */ 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文件中,而且在運(yùn)行時(shí)會(huì)被虛擬機(jī)保留,因此它們能通過(guò)反射被讀取到) * @see java.lang.reflect.AnnotatedElement */ RUNTIME}
再詳細(xì)描述下這三個(gè)階段:
①、如果被定義為 RetentionPolicy.SOURCE,則它將被限定在Java源文件中,那么這個(gè)注解即不會(huì)參與編譯也不會(huì)在運(yùn)行期起任何作用,這個(gè)注解就和一個(gè)注釋是一樣的效果,只能被閱讀Java文件的人看到;
②、如果被定義為 RetentionPolicy.CLASS,則它將被編譯到Class文件中,那么編譯器可以在編譯時(shí)根據(jù)注解做一些處理動(dòng)作,但是運(yùn)行時(shí)JVM(Java虛擬機(jī))會(huì)忽略它,并且在運(yùn)行期也不能讀取到;
③、如果被定義為 RetentionPolicy.RUNTIME,那么這個(gè)注解可以在運(yùn)行期的加載階段被加載到Class對(duì)象中。那么在程序運(yùn)行階段,可以通過(guò)反射得到這個(gè)注解,并通過(guò)判斷是否有這個(gè)注解或這個(gè)注解中屬性的值,從而執(zhí)行不同的程序代碼段。
注意:實(shí)際開(kāi)發(fā)中的自定義注解幾乎都是使用的 RetentionPolicy.RUNTIME 。
@Documented元注解:@Documented注解,是被用來(lái)指定自定義注解是否能隨著被定義的java文件生成到JavaDoc文檔當(dāng)中。
@Inherited元注解:@Inherited注解,是指定某個(gè)自定義注解如果寫(xiě)在了父類的聲明部分,那么子類的聲明部分也能自動(dòng)擁有該注解。
@Inherited注解只對(duì)那些@Target被定義為 ElementType.TYPE 的自定義注解起作用。
自定義注解實(shí)現(xiàn):在了解了上面的內(nèi)容后,我們來(lái)嘗試實(shí)現(xiàn)一個(gè)自定義注解:
根據(jù)上面自定義注解中使用到的元注解得知:
①、此注解的作用范圍,可以使用在類(接口、枚舉)、方法上;
②、此注解的生命周期,被編譯器保存在class文件中,而且在運(yùn)行時(shí)會(huì)被JVM保留,可以通過(guò)反射讀取;
自定義注解的簡(jiǎn)單使用:上面已經(jīng)創(chuàng)建了一個(gè)自定義的注解,那該怎么使用呢?下面首先描述下它簡(jiǎn)單的用法,后面將會(huì)使用其結(jié)合攔截器和AOP切面編程進(jìn)行實(shí)戰(zhàn)應(yīng)用;
在了解了上面注解的知識(shí)后,我們乘勝追擊,看看它的實(shí)際應(yīng)用場(chǎng)景是腫么樣的,以此加深下我們的理解;
實(shí)現(xiàn)的 Demo 項(xiàng)目是以 SpringBoot 實(shí)現(xiàn)的,項(xiàng)目工程結(jié)構(gòu)圖如下:
使用自定義注解 結(jié)合 攔截器 優(yōu)雅的實(shí)現(xiàn)對(duì)API接口響應(yīng)的包裝。
在介紹自定義實(shí)現(xiàn)的方式之前,先簡(jiǎn)單介紹下普遍的實(shí)現(xiàn)方式,通過(guò)兩者的對(duì)比,才能更加明顯的發(fā)現(xiàn)誰(shuí)最優(yōu)雅。
普通的接口響應(yīng)包裝方式:現(xiàn)在項(xiàng)目絕大部分都采用的前后端分離方式,所以需要前端和后端通過(guò)接口進(jìn)行交互;目前在接口交互中使用最多的數(shù)據(jù)格式是 json,然后后端返回給前端的最為常見(jiàn)的響應(yīng)格式如下:
{ #返回狀態(tài)碼 code:integer, #返回信息描述 message:string, #返回?cái)?shù)據(jù)值 data:object}
項(xiàng)目中經(jīng)常使用枚舉類定義狀態(tài)碼和消息,代碼如下:
/** * @author 【 木子雷 】 公眾號(hào) * @Title: ResponseCode * @Description: 使用枚舉類封裝好的響應(yīng)狀態(tài)碼及對(duì)應(yīng)的響應(yīng)消息 * @date: 2019年8月23日 下午7:12:50 */public enum ResponseCode { SUCCESS(1200, '請(qǐng)求成功'), ERROR(1400, '請(qǐng)求失敗'); 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; }}
同時(shí)項(xiàng)目中也會(huì)設(shè)計(jì)一個(gè)返回響應(yīng)包裝類,代碼如下:
import com.alibaba.fastjson.JSONObject;import java.io.Serializable;/** * @author 【 木子雷 】 公眾號(hào) * @Title: Response * @Description: 封裝的統(tǒng)一的響應(yīng)返回類 * @date: 2019年8月23日 下午7:07:13 */@SuppressWarnings('serial')public class Response<T> implements Serializable { /** * 響應(yīng)數(shù)據(jù) */ private T date; /** * 響應(yīng)狀態(tài)碼 */ private Integer code; /** * 響應(yīng)描述信息 */ 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); }}
最后就是使用響應(yīng)包裝類和狀態(tài)碼枚舉類 來(lái)實(shí)現(xiàn)返回響應(yīng)的包裝了:
@GetMapping('/user/findAllUser')public Response<List<User>> findAllUser() { logger.info('開(kāi)始查詢所有數(shù)據(jù)...'); List<User> findAllUser = new ArrayList<>(); findAllUser.add(new User('木子雷', 26)); findAllUser.add(new User('公眾號(hào)', 28)); // 返回響應(yīng)進(jìn)行包裝 Response response = new Response(findAllUser, ResponseCode.SUCCESS.code(), ResponseCode.SUCCESS.message()); logger.info('response: {} n', response.toString()); return response;}
在瀏覽器中輸入網(wǎng)址: http://127.0.0.1:8080/v1/api/user/findAllUser 然后點(diǎn)擊回車,得到如下數(shù)據(jù):
{ 'code': 1200, 'date': [{ 'age': 26, 'name': '木子雷'},{ 'age': 28, 'name': '公眾號(hào)'} ], 'message': '請(qǐng)求成功'}
通過(guò)看這中實(shí)現(xiàn)響應(yīng)包裝的方式,我們能發(fā)現(xiàn)什么問(wèn)題嗎?
答:代碼很冗余,需要在每個(gè)接口方法中都進(jìn)行響應(yīng)的包裝;使得接口方法包含了很多非業(yè)務(wù)邏輯代碼;
有沒(méi)有版本進(jìn)行優(yōu)化下呢? en en 思考中。。。。。 啊,自定義注解 + 攔截器可以實(shí)現(xiàn)呀!
自定義注解實(shí)現(xiàn)接口響應(yīng)包裝:①、首先創(chuàng)建一個(gè)進(jìn)行響應(yīng)包裝的自定義注解:
/** * @author 【 木子雷 】 公眾號(hào) * @PACKAGE_NAME: com.lyl.annotation * @ClassName: ResponseResult * @Description: 標(biāo)記方法返回值需要進(jìn)行包裝的 自定義注解 * @Date: 2020-11-10 10:38 **/@Target({ElementType.TYPE, ElementType.METHOD})@Retention(RetentionPolicy.RUNTIME)@Documentedpublic @interface ResponseResult {}
②、創(chuàng)建一個(gè)攔截器,實(shí)現(xiàn)對(duì)請(qǐng)求的攔截,看看請(qǐng)求的方法或類上是否使用了自定義的注解:
/** * @author 【 木子雷 】 公眾號(hào) * @PACKAGE_NAME: com.lyl.interceptor * @ClassName: ResponseResultInterceptor * @Description: 攔截器:攔截請(qǐng)求,判斷請(qǐng)求的方法或類上是否使用了自定義的@ResponseResult注解, * 并在請(qǐng)求內(nèi)設(shè)置是否使用了自定義注解的標(biāo)志位屬性; * @Date: 2020-11-10 10:50 **/@Componentpublic class ResponseResultInterceptor implements HandlerInterceptor { /** * 標(biāo)記位,標(biāo)記請(qǐng)求的controller類或方法上使用了到了自定義注解,返回?cái)?shù)據(jù)需要被包裝 */ public static final String RESPONSE_ANNOTATION = 'RESPONSE_ANNOTATION'; /** * 請(qǐng)求預(yù)處理,判斷是否使用了自定義注解 */ @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {// 請(qǐng)求的接口方法if (handler instanceof HandlerMethod) { final HandlerMethod handlerMethod = (HandlerMethod) handler; final Class<?> clazz = handlerMethod.getBeanType(); final Method method = handlerMethod.getMethod(); // 判斷是否在類對(duì)象上加了注解 if (clazz.isAnnotationPresent(ResponseResult.class)) {// 在請(qǐng)求中設(shè)置需要進(jìn)行響應(yīng)包裝的屬性標(biāo)志,在下面的ResponseBodyAdvice增強(qiáng)中進(jìn)行處理request.setAttribute(RESPONSE_ANNOTATION, clazz.getAnnotation(ResponseResult.class)); } else if (method.isAnnotationPresent(ResponseResult.class)) {// 在請(qǐng)求中設(shè)置需要進(jìn)行響應(yīng)包裝的屬性標(biāo)志,在下面的ResponseBodyAdvice增強(qiáng)中進(jìn)行處理request.setAttribute(RESPONSE_ANNOTATION, method.getAnnotation(ResponseResult.class)); }}return true; }}
③、創(chuàng)建一個(gè)增強(qiáng)Controller,實(shí)現(xiàn)對(duì)返回響應(yīng)進(jìn)行包裝的增強(qiáng)處理:
/** * @author 【 木子雷 】 公眾號(hào) * @PACKAGE_NAME: com.lyl.interceptor * @ClassName: ResponseResultHandler * @Description: 對(duì) 返回響應(yīng) 進(jìn)行包裝 的增強(qiáng)處理 * @Date: 2020-11-10 13:49 **/@ControllerAdvicepublic class ResponseResultHandler implements ResponseBodyAdvice<Object> { private final Logger logger = LoggerFactory.getLogger(this.getClass()); /** * 標(biāo)記位,標(biāo)記請(qǐng)求的controller類或方法上使用了到了自定義注解,返回?cái)?shù)據(jù)需要被包裝 */ public static final String RESPONSE_ANNOTATION = 'RESPONSE_ANNOTATION'; /** * 請(qǐng)求中是否包含了 響應(yīng)需要被包裝的標(biāo)記,如果沒(méi)有,則直接返回,不需要重寫(xiě)返回體 * * @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();// 查詢是否需要進(jìn)行響應(yīng)包裝的標(biāo)志ResponseResult responseResult = (ResponseResult) sr.getAttribute(RESPONSE_ANNOTATION);return responseResult == null ? false : true; } /** * 對(duì) 響應(yīng)體 進(jìn)行包裝; 除此之外還可以對(duì)響應(yīng)體進(jìn)行統(tǒng)一的加密、簽名等 * * @param responseBody 請(qǐng)求的接口方法執(zhí)行后得到返回值(返回響應(yīng)) */ @Override public Object beforeBodyWrite(Object responseBody, MethodParameter methodParameter, MediaType mediaType, Class<? extends HttpMessageConverter<?>> aClass, ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse) {logger.info('返回響應(yīng) 包裝進(jìn)行中。。。');Response response;// boolean類型時(shí)判斷一些數(shù)據(jù)庫(kù)新增、更新、刪除的操作是否成功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 { // 判斷像查詢一些返回?cái)?shù)據(jù)的情況,查詢不到數(shù)據(jù)返回 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自定義注解即可; 在瀏覽器中輸入網(wǎng)址: http://127.0.0.1:8080/v1/api/user/findAllUserByAnnotation 進(jìn)行查看:
// 自定義注解用在了方法上@ResponseResult@GetMapping('/user/findAllUserByAnnotation')public List<User> findAllUserByAnnotation() { logger.info('開(kāi)始查詢所有數(shù)據(jù)...'); List<User> findAllUser = new ArrayList<>(); findAllUser.add(new User('木子雷', 26)); findAllUser.add(new User('公眾號(hào)', 28)); logger.info('使用 @ResponseResult 自定義注解進(jìn)行響應(yīng)的包裝,使controller代碼更加簡(jiǎn)介'); return findAllUser;}
至此我們的接口返回響應(yīng)包裝自定義注解實(shí)現(xiàn)設(shè)計(jì)完成,看看代碼是不是又簡(jiǎn)潔,又優(yōu)雅呢。
總結(jié):本文針對(duì)此方案只是進(jìn)行了簡(jiǎn)單的實(shí)現(xiàn),如果有興趣的朋友可以進(jìn)行更好的優(yōu)化。
場(chǎng)景二:自定義注解 + AOP = 實(shí)現(xiàn)優(yōu)雅的使用分布式鎖分布式鎖的最常見(jiàn)的使用流程:
先看看最為常見(jiàn)的分布式鎖使用方式的實(shí)現(xiàn),然后再聊聊自定義注解怎么優(yōu)雅的實(shí)現(xiàn)分布式鎖的使用。
普通的分布式鎖使用方式:
通過(guò)上面的代碼可以得到一個(gè)信息:如果有很多方法中需要使用分布式鎖,那么每個(gè)方法中都必須有獲取分布式鎖和釋放分布式鎖的代碼,這樣一來(lái)就會(huì)出現(xiàn)代碼冗余;
那有什么好的解決方案嗎? 自定義注解使代碼變得更加簡(jiǎn)潔、優(yōu)雅;
自定義注解優(yōu)雅的使用分布式鎖:①、首先實(shí)現(xiàn)一個(gè)標(biāo)記分布式鎖使用的自定義注解:
/** * @author 【 木子雷 】 公眾號(hào) * @PACKAGE_NAME: com.lyl.annotation * @ClassName: GetDistributedLock * @Description: 獲取redis分布式鎖 注解 * @Date: 2020-11-10 16:24 **/@Target(ElementType.METHOD)@Retention(RetentionPolicy.RUNTIME)@Documentedpublic @interface GetDistributedLock { // 分布式鎖 key String lockKey(); // 分布式鎖 value,默認(rèn)為 lockValue String lockValue() default 'lockValue'; // 過(guò)期時(shí)間,默認(rèn)為 300秒 int expireTime() default 300;}
②、定義一個(gè)切面,在切面中對(duì)使用了 @GetDistributedLock 自定義注解的方法進(jìn)行環(huán)繞增強(qiáng)通知:
/** * @author: 【 木子雷 】 公眾號(hào) * @PACKAGE_NAME: com.lyl.aop * @ClassName: DistributedLockAspect * @Description: 自定義注解結(jié)合AOP切面編程優(yōu)雅的使用分布式鎖 * @Date: 2020-11-10 16:52 **/@Component@Aspectpublic class DistributedLockAspect { private final Logger logger = LoggerFactory.getLogger(this.getClass()); @Autowired RedisService redisService; /** * Around 環(huán)繞增強(qiáng)通知 * * @param joinPoint 連接點(diǎn),所有方法都屬于連接點(diǎn);但是當(dāng)某些方法上使用了@GetDistributedLock自定義注解時(shí), * 則其將連接點(diǎn)變?yōu)榱饲悬c(diǎn);然后在切點(diǎn)上織入額外的增強(qiáng)處理;切點(diǎn)和其相應(yīng)的增強(qiáng)處理構(gòu)成了切面Aspect 。 */ @Around(value = '@annotation(com.lyl.annotation.GetDistributedLock)') public Boolean handlerDistributedLock(ProceedingJoinPoint joinPoint) {// 通過(guò)反射獲取自定義注解對(duì)象GetDistributedLock getDistributedLock = ((MethodSignature) joinPoint.getSignature()).getMethod().getAnnotation(GetDistributedLock.class);// 獲取自定義注解對(duì)象中的屬性值String lockKey = getDistributedLock.lockKey();String LockValue = getDistributedLock.lockValue();int expireTime = getDistributedLock.expireTime();if (redisService.tryGetDistributedLock(lockKey, LockValue, expireTime)) { // 獲取分布式鎖成功后,繼續(xù)執(zhí)行業(yè)務(wù)邏輯 try {return (boolean) joinPoint.proceed(); } catch (Throwable throwable) {logger.error('業(yè)務(wù)邏輯執(zhí)行失敗。', throwable); } finally {// 最終保證分布式鎖的釋放redisService.releaseDistributedLock(lockKey, LockValue); }}return false; }}
③、最后,在 Controller 中的方法上使用 @GetDistributedLock 自定義注解即可;當(dāng)某個(gè)方法上使用了 自定義注解,那么這個(gè)方法就相當(dāng)于一個(gè)切點(diǎn),那么就會(huì)對(duì)這個(gè)方法做環(huán)繞(方法執(zhí)行前和方法執(zhí)行后)增強(qiáng)處理;
在瀏覽器中輸入網(wǎng)址: http://127.0.0.1:8080/v1/api/user/getDistributedLock 回車后觸發(fā)方法執(zhí)行:
// 自定義注解的使用@GetDistributedLock(lockKey = 'userLock')@GetMapping('/user/getDistributedLock')public boolean getUserDistributedLock() { logger.info('獲取分布式鎖...'); // 寫(xiě)具體的業(yè)務(wù)邏輯 return true;}
通過(guò)自定義注解的方式,可以看到代碼變得更加簡(jiǎn)潔、優(yōu)雅。
場(chǎng)景三:自定義注解 + AOP = 實(shí)現(xiàn)日志的打印先看看最為常見(jiàn)的日志打印的方式,然后再聊聊自定義注解怎么優(yōu)雅的實(shí)現(xiàn)日志的打印。
普通日志的打印方式:
通過(guò)看上面的代碼可以知道,如果每個(gè)方法都需要打印下日志,那將會(huì)存在大量的冗余代碼;
自定義注解實(shí)現(xiàn)日志打印:①、首先創(chuàng)建一個(gè)標(biāo)記日志打印的自定義注解:
/** * @Author: 【 木子雷 】 公眾號(hào) * @PACKAGE_NAME: com.lyl.annotation * @ClassName: PrintLog * @Description: 自定義注解實(shí)現(xiàn)日志打印 * @Date: 2020-11-10 18:05 **/@Target(ElementType.METHOD)@Retention(RetentionPolicy.RUNTIME)@Documentedpublic @interface PrintLog {}
②、定義一個(gè)切面,在切面中對(duì)使用了 @PrintLog 自定義注解的方法進(jìn)行環(huán)繞增強(qiáng)通知:
/** * @author: 【 木子雷 】 公眾號(hào) * @PACKAGE_NAME: com.lyl.aop * @ClassName: PrintLogAspect * @Description: 自定義注解結(jié)合AOP切面編程優(yōu)雅的實(shí)現(xiàn)日志打印 * @Date: 2020-11-10 18:11 **/@Component@Aspectpublic class PrintLogAspect { private final Logger logger = LoggerFactory.getLogger(this.getClass()); /** * Around 環(huán)繞增強(qiáng)通知 * * @param joinPoint 連接點(diǎn),所有方法都屬于連接點(diǎn);但是當(dāng)某些方法上使用了@PrintLog自定義注解時(shí), * 則其將連接點(diǎn)變?yōu)榱饲悬c(diǎn);然后在切點(diǎn)上織入額外的增強(qiáng)處理;切點(diǎn)和其相應(yīng)的增強(qiáng)處理構(gòu)成了切面Aspect 。 */ @Around(value = '@annotation(com.lyl.annotation.PrintLog)') public Object handlerPrintLog(ProceedingJoinPoint joinPoint) {// 獲取方法的名稱String methodName = joinPoint.getSignature().getName();// 獲取方法入?yún)bject[] param = joinPoint.getArgs();StringBuilder sb = new StringBuilder();for (Object o : param) { sb.append(o + '; ');}logger.info('進(jìn)入《{}》方法, 參數(shù)為: {}', methodName, sb.toString());Object object = null;// 繼續(xù)執(zhí)行方法try { object = joinPoint.proceed();} catch (Throwable throwable) { logger.error('打印日志處理error。。', throwable);}logger.info('{} 方法執(zhí)行結(jié)束。。', methodName);return object; }}
③、最后,在 Controller 中的方法上使用 @PrintLog 自定義注解即可;當(dāng)某個(gè)方法上使用了 自定義注解,那么這個(gè)方法就相當(dāng)于一個(gè)切點(diǎn),那么就會(huì)對(duì)這個(gè)方法做環(huán)繞(方法執(zhí)行前和方法執(zhí)行后)增強(qiáng)處理;
@PrintLog@GetMapping(value = '/user/findUserNameById/{id}', produces = 'application/json;charset=utf-8')public String findUserNameById(@PathVariable('id') int id) { // 模擬根據(jù)id查詢用戶名 String userName = '木子雷 公眾號(hào)'; return userName;}
④、在瀏覽器中輸入網(wǎng)址: http://127.0.0.1:8080/v1/api/user/findUserNameById/66 回車后觸發(fā)方法執(zhí)行,發(fā)現(xiàn)控制臺(tái)打印了日志:
進(jìn)入《findUserNameById》方法, 參數(shù)為: 66; findUserNameById 方法執(zhí)行結(jié)束。。
使用自定義注解實(shí)現(xiàn)是多優(yōu)雅,代碼看起來(lái)簡(jiǎn)介干凈,越瞅越喜歡;趕快去你的項(xiàng)目中使用吧, 嘿嘿。。。
以上就是Java 自定義注解的魅力的詳細(xì)內(nèi)容,更多關(guān)于Java 自定義注解的資料請(qǐng)關(guān)注好吧啦網(wǎng)其它相關(guān)文章!
相關(guān)文章:
1. 以PHP代碼為實(shí)例詳解RabbitMQ消息隊(duì)列中間件的6種模式2. Python如何進(jìn)行時(shí)間處理3. python web框架的總結(jié)4. 詳解Python模塊化編程與裝飾器5. Python通過(guò)format函數(shù)格式化顯示值6. html小技巧之td,div標(biāo)簽里內(nèi)容不換行7. python裝飾器三種裝飾模式的簡(jiǎn)單分析8. Python 如何將integer轉(zhuǎn)化為羅馬數(shù)(3999以內(nèi))9. Python實(shí)現(xiàn)迪杰斯特拉算法過(guò)程解析10. python使用ctypes庫(kù)調(diào)用DLL動(dòng)態(tài)鏈接庫(kù)
