自定義注解可以標記在方法上或類上,用于在編譯期或運行期進行特定的業務功能處理。在 Java 中,自定義注解使用 @interface 關鍵字來定義,它可以實現如:日志記錄、性能監控、權限校驗等功能。
在 Spring Boot 中實現一個自定義注解,可以通過 AOP(面向切面編程)或攔截器(Interceptor)來實現。
下面我們先使用 AOP 的方式來實現一個打印日志的自定義注解,它的實現步驟如下:
具體實現如下。
在 pom.xml 中添加如下依賴:
<dependencies> <!-- Spring AOP dependency --> <dependency> <groupIdorg.springframework.boot</groupId> <artifactIdspring-boot-starter-aop</artifactId> </dependency></dependencies>
創建一個新的 Java 注解類,通過 @interface 關鍵字來定義,并可以添加元注解以及屬性。
import java.lang.annotation.*;@Target(ElementType.METHOD)@Retention(RetentionPolicy.RUNTIME)public @interface CustomLogAnnotation { String value() default ""; boolean enable() default true;}
在上面的例子中,我們定義了一個名為 CustomLogAnnotation 的注解,它有兩個屬性:value 和 enable,分別設置了默認值。
使用 Spring AOP 來攔截帶有自定義注解的方法,并在其前后執行相應的邏輯。
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()) { // 方法執行前的處理 System.out.println("Before method execution: " + joinPoint.getSignature().getName()); long start = System.currentTimeMillis(); // 執行目標方法 Object result = joinPoint.proceed(); // 方法執行后的處理 long elapsedTime = System.currentTimeMillis() - start; System.out.println("After method execution (" + elapsedTime + "ms): " + customLog.value()); return result; } else { return joinPoint.proceed(); } }}
將自定義注解應用于需要進行日志記錄的方法上,如下代碼所示:
@RestControllerpublic class MyController { @CustomLogAnnotation(value = "This is a test method", enable = true) @GetMapping("/test") public String testMethod() { // 業務邏輯代碼 return "Hello from the annotated method!"; }}
實際工作中我們通常會使用自定義注解來實現如權限驗證,或者是冪等性判斷等功能。
“
冪等性判斷是指在分布式系統或并發環境中,對于同一操作的多次重復請求,系統的響應結果應該是一致的。簡而言之,無論接收到多少次相同的請求,系統的行為和結果都應該是相同的。
”
下面我們使用攔截器 + Redis 的方式來實現一下自定義冪等性注解,它的實現步驟如下:
具體實現如下。
@Retention(RetentionPolicy.RUNTIME) // 程序運行時有效@Target(ElementType.METHOD) // 方法注解public @interface Idempotent { /** * 請求標識符的參數名稱,默認為"requestId" */ String requestId() default "requestId"; /** * 冪等有效時長(單位:秒) */ 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) { // 獲取請求中的唯一標識符 String requestId = obtainRequestId(request, idempotent.requestId()); // 判斷該請求是否已經處理過 if (redisTemplate.opsForValue().get(idempotentKey(requestId)) != null) { // 已經處理過,返回冪等響應 response.getWriter().write("重復請求"); return false; } else { // 將請求標識符存入Redis,并設置過期時間 redisTemplate.opsForValue().set(idempotentKey(requestId), "processed", idempotent.expireTime(), TimeUnit.SECONDS); return true; // 繼續執行業務邏輯 } } return super.preHandle(request, response, handler); } private String idempotentKey(String requestId) { return "idempotent:" + requestId; } private String obtainRequestId(HttpServletRequest request, String paramName) { // 實現從請求中獲取唯一標識符的方法 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("/**"); // 攔截所有接口 }}
最后,在需要進行冪等控制的 Controller 方法上使用 @Idempotent 注解:
Java@RestControllerpublic class TestController { @PostMapping("/order") @Idempotent(requestId = "orderId") // 假設orderId是從客戶端傳來的唯一標識訂單請求的參數 public String placeOrder(@RequestParam("orderId") String orderId, ...) { // 業務處理邏輯 }}
這樣,當有相同的請求 ID 在指定的有效期內再次發起請求時,會被攔截器識別并阻止其重復執行業務邏輯。
自定義注解被廣泛應用于日常開發中,像日志記錄、性能監控、權限判斷和冪等性判斷等功能的實現,使用自定義注解來實現是非常方便的。在 Spring Boot 中,使用 @interface 關鍵字來定義自定義注解,之后再使用 AOP 或攔截器的方式實現自定義注解,之后就可以方便的使用自定義注解了。
本文鏈接:http://www.www897cc.com/showinfo-26-60966-0.html面試官:實際工作中哪里用到了自定義注解?
聲明:本網頁內容旨在傳播知識,若有侵權等問題請及時與本網聯系,我們將在第一時間刪除處理。郵件:2376512515@qq.com
上一篇: Python數據分析中備受歡迎的庫和工具
下一篇: 背會了常見的幾個線程池用法,結果被問翻