
自定義注解可以標(biāo)記在方法上或類上,用于在編譯期或運(yùn)行期進(jìn)行特定的業(yè)務(wù)功能處理。在 Java 中,自定義注解使用 @interface 關(guān)鍵字來定義,它可以實(shí)現(xiàn)如:日志記錄、性能監(jiān)控、權(quán)限校驗(yàn)等功能。
在 Spring Boot 中實(shí)現(xiàn)一個(gè)自定義注解,可以通過 AOP(面向切面編程)或攔截器(Interceptor)來實(shí)現(xiàn)。
下面我們先使用 AOP 的方式來實(shí)現(xiàn)一個(gè)打印日志的自定義注解,它的實(shí)現(xiàn)步驟如下:
具體實(shí)現(xiàn)如下。
在 pom.xml 中添加如下依賴:
<dependencies> <!-- Spring AOP dependency --> <dependency> <groupIdorg.springframework.boot</groupId> <artifactIdspring-boot-starter-aop</artifactId> </dependency></dependencies>創(chuàng)建一個(gè)新的 Java 注解類,通過 @interface 關(guān)鍵字來定義,并可以添加元注解以及屬性。
import java.lang.annotation.*;@Target(ElementType.METHOD)@Retention(RetentionPolicy.RUNTIME)public @interface CustomLogAnnotation { String value() default ""; boolean enable() default true;}在上面的例子中,我們定義了一個(gè)名為 CustomLogAnnotation 的注解,它有兩個(gè)屬性:value 和 enable,分別設(shè)置了默認(rèn)值。
使用 Spring AOP 來攔截帶有自定義注解的方法,并在其前后執(zhí)行相應(yīng)的邏輯。
import org.aspectj.lang.ProceedingJoinPoint;import org.aspectj.lang.annotation.Around;import org.aspectj.lang.annotation.Aspect;import org.springframework.stereotype.Component;@Aspect@Componentpublic class CustomLogAspect { @Around("@annotation(customLog)") public Object logAround(ProceedingJoinPoint joinPoint, CustomLogAnnotation customLog) throws Throwable { if (customLog.enable()) { // 方法執(zhí)行前的處理 System.out.println("Before method execution: " + joinPoint.getSignature().getName()); long start = System.currentTimeMillis(); // 執(zhí)行目標(biāo)方法 Object result = joinPoint.proceed(); // 方法執(zhí)行后的處理 long elapsedTime = System.currentTimeMillis() - start; System.out.println("After method execution (" + elapsedTime + "ms): " + customLog.value()); return result; } else { return joinPoint.proceed(); } }}將自定義注解應(yīng)用于需要進(jìn)行日志記錄的方法上,如下代碼所示:
@RestControllerpublic class MyController { @CustomLogAnnotation(value = "This is a test method", enable = true) @GetMapping("/test") public String testMethod() { // 業(yè)務(wù)邏輯代碼 return "Hello from the annotated method!"; }}實(shí)際工作中我們通常會(huì)使用自定義注解來實(shí)現(xiàn)如權(quán)限驗(yàn)證,或者是冪等性判斷等功能。
“
冪等性判斷是指在分布式系統(tǒng)或并發(fā)環(huán)境中,對(duì)于同一操作的多次重復(fù)請(qǐng)求,系統(tǒng)的響應(yīng)結(jié)果應(yīng)該是一致的。簡(jiǎn)而言之,無論接收到多少次相同的請(qǐng)求,系統(tǒng)的行為和結(jié)果都應(yīng)該是相同的。
”
下面我們使用攔截器 + Redis 的方式來實(shí)現(xiàn)一下自定義冪等性注解,它的實(shí)現(xiàn)步驟如下:
具體實(shí)現(xiàn)如下。
@Retention(RetentionPolicy.RUNTIME) // 程序運(yùn)行時(shí)有效@Target(ElementType.METHOD) // 方法注解public @interface Idempotent { /** * 請(qǐng)求標(biāo)識(shí)符的參數(shù)名稱,默認(rèn)為"requestId" */ String requestId() default "requestId"; /** * 冪等有效時(shí)長(zhǎng)(單位:秒) */ int expireTime() default 60;}@Componentpublic class IdempotentInterceptor extends HandlerInterceptorAdapter { @Autowired private RedisTemplate<String, Object> redisTemplate; @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { Method method = ((HandlerMethod) handler).getMethod(); Idempotent idempotent = method.getAnnotation(Idempotent.class); if (idempotent != null) { // 獲取請(qǐng)求中的唯一標(biāo)識(shí)符 String requestId = obtainRequestId(request, idempotent.requestId()); // 判斷該請(qǐng)求是否已經(jīng)處理過 if (redisTemplate.opsForValue().get(idempotentKey(requestId)) != null) { // 已經(jīng)處理過,返回冪等響應(yīng) response.getWriter().write("重復(fù)請(qǐng)求"); return false; } else { // 將請(qǐng)求標(biāo)識(shí)符存入Redis,并設(shè)置過期時(shí)間 redisTemplate.opsForValue().set(idempotentKey(requestId), "processed", idempotent.expireTime(), TimeUnit.SECONDS); return true; // 繼續(xù)執(zhí)行業(yè)務(wù)邏輯 } } return super.preHandle(request, response, handler); } private String idempotentKey(String requestId) { return "idempotent:" + requestId; } private String obtainRequestId(HttpServletRequest request, String paramName) { // 實(shí)現(xiàn)從請(qǐng)求中獲取唯一標(biāo)識(shí)符的方法 return request.getParameter(paramName); }}在 Spring Boot 配置文件類中,添加攔截器配置:
@Configurationpublic class WebConfig implements WebMvcConfigurer { @Autowired private IdempotentInterceptor idempotentInterceptor; @Override public void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(idempotentInterceptor) .addPathPatterns("/**"); // 攔截所有接口 }}最后,在需要進(jìn)行冪等控制的 Controller 方法上使用 @Idempotent 注解:
Java@RestControllerpublic class TestController { @PostMapping("/order") @Idempotent(requestId = "orderId") // 假設(shè)orderId是從客戶端傳來的唯一標(biāo)識(shí)訂單請(qǐng)求的參數(shù) public String placeOrder(@RequestParam("orderId") String orderId, ...) { // 業(yè)務(wù)處理邏輯 }}這樣,當(dāng)有相同的請(qǐng)求 ID 在指定的有效期內(nèi)再次發(fā)起請(qǐng)求時(shí),會(huì)被攔截器識(shí)別并阻止其重復(fù)執(zhí)行業(yè)務(wù)邏輯。
自定義注解被廣泛應(yīng)用于日常開發(fā)中,像日志記錄、性能監(jiān)控、權(quán)限判斷和冪等性判斷等功能的實(shí)現(xiàn),使用自定義注解來實(shí)現(xiàn)是非常方便的。在 Spring Boot 中,使用 @interface 關(guān)鍵字來定義自定義注解,之后再使用 AOP 或攔截器的方式實(shí)現(xiàn)自定義注解,之后就可以方便的使用自定義注解了。
本文鏈接:http://m.www897cc.com/showinfo-26-60966-0.html面試官:實(shí)際工作中哪里用到了自定義注解?
聲明:本網(wǎng)頁內(nèi)容旨在傳播知識(shí),若有侵權(quán)等問題請(qǐng)及時(shí)與本網(wǎng)聯(lián)系,我們將在第一時(shí)間刪除處理。郵件:2376512515@qq.com