Java SpringBoot自定義注解的使用及說明
一、自定義注解的場景與優(yōu)勢
1.1 場景
在開發(fā)過程中,我們常常需要在多個地方實現(xiàn)相同的功能,例如日志記錄、性能監(jiān)控、權(quán)限驗證等。
如果直接在每個業(yè)務(wù)方法中編寫這些功能的代碼,會導(dǎo)致代碼重復(fù)和難以維護。
1.2 優(yōu)勢
使用自定義注解的優(yōu)勢在于:
- 減少重復(fù)代碼 :通過注解的方式,將公共邏輯集中到一個地方,避免在多個地方重復(fù)編寫相同的代碼。
- 增強代碼可讀性 :注解能夠清晰地表達方法的用途和行為,使代碼更具可讀性。
- 便于維護和擴展 :當(dāng)需要修改或擴展功能時,只需修改注解的實現(xiàn)邏輯,而無需在多個地方進行修改。
二、創(chuàng)建自定義注解
2.1 定義注解
使用 @interface 關(guān)鍵字定義注解,并通過 @Retention、@Target 等元注解來指定注解的保留策略和適用目標(biāo)。
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target(ElementType.METHOD) // 指定注解適用的目標(biāo)類型為方法
@Retention(RetentionPolicy.RUNTIME) // 指定注解的保留策略為運行時
@Documented
public @interface LogAnnotation {
String module() default ""; // 模塊名稱
String operation() default ""; // 操作描述
}
2.2 創(chuàng)建注解處理器
通過創(chuàng)建注解處理器(Aspect),利用 AOP(面向切面編程)來攔截帶有自定義注解的方法,并在方法執(zhí)行前后添加自定義邏輯。
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;
@Aspect
@Component
@Order(1) // 指定切面的順序
public class LogAspect {
private static final Logger logger = LoggerFactory.getLogger(LogAspect.class);
@Pointcut("@annotation(LogAnnotation)") // 定義切點,匹配使用了 LogAnnotation 的方法
public void logPointcut() {}
@Before("logPointcut()")
public void doBefore() {
logger.info("方法執(zhí)行前,添加日志記錄邏輯");
}
}
三、使用自定義注解
3.1 在業(yè)務(wù)方法上使用注解
在需要記錄日志的業(yè)務(wù)方法上添加自定義注解,指定模塊名稱和操作描述。
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping("/api")
public class DemoController {
@GetMapping("/test")
@LogAnnotation(module = "測試模塊", operation = "測試方法執(zhí)行")
public String test() {
return "Hello, World!";
}
}
3.2 配置類加載注解
確保 Spring 能夠掃描到自定義注解和注解處理器,可以在主應(yīng)用類或配置類上添加 @ComponentScan 注解,指定掃描的包路徑。
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.ComponentScan;
@SpringBootApplication
@ComponentScan(basePackages = "your.package.name") // 指定掃描的包路徑
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
四、總結(jié)
在 Spring Boot 中創(chuàng)建和使用自定義注解,可以幫助我們實現(xiàn)代碼的復(fù)用、增強代碼的可讀性和可維護性。
通過定義注解、創(chuàng)建注解處理器,并在業(yè)務(wù)方法上使用注解,可以輕松實現(xiàn)諸如日志記錄、性能監(jiān)控、權(quán)限驗證等功能。
以上為個人經(jīng)驗,希望能給大家一個參考,也希望大家多多支持腳本之家。
相關(guān)文章
java動態(tài)代理和cglib動態(tài)代理示例分享
這篇文章主要介紹了java動態(tài)代理和cglib動態(tài)代理示例,JDK1.3之后,Java提供了動態(tài)代理的技術(shù),允許開發(fā)者在運行期間創(chuàng)建接口的代理實例,下面我們使用示例學(xué)習(xí)一下2014-03-03
java發(fā)送http請求并獲取狀態(tài)碼的簡單實例
下面小編就為大家?guī)硪黄猨ava發(fā)送http請求并獲取狀態(tài)碼的簡單實例。小編覺得挺不錯的,現(xiàn)在分享給大家,也給大家做個參考。一起跟隨小編過來看看吧2016-05-05

