Java SpringBoot自定義注解的使用及說明
一、自定義注解的場景與優(yōu)勢
1.1 場景
在開發(fā)過程中,我們常常需要在多個(gè)地方實(shí)現(xiàn)相同的功能,例如日志記錄、性能監(jiān)控、權(quán)限驗(yàn)證等。
如果直接在每個(gè)業(yè)務(wù)方法中編寫這些功能的代碼,會(huì)導(dǎo)致代碼重復(fù)和難以維護(hù)。
1.2 優(yōu)勢
使用自定義注解的優(yōu)勢在于:
- 減少重復(fù)代碼 :通過注解的方式,將公共邏輯集中到一個(gè)地方,避免在多個(gè)地方重復(fù)編寫相同的代碼。
- 增強(qiáng)代碼可讀性 :注解能夠清晰地表達(dá)方法的用途和行為,使代碼更具可讀性。
- 便于維護(hù)和擴(kuò)展 :當(dāng)需要修改或擴(kuò)展功能時(shí),只需修改注解的實(shí)現(xiàn)邏輯,而無需在多個(gè)地方進(jì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) // 指定注解的保留策略為運(yùn)行時(shí)
@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)") // 定義切點(diǎn),匹配使用了 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)建和使用自定義注解,可以幫助我們實(shí)現(xiàn)代碼的復(fù)用、增強(qiáng)代碼的可讀性和可維護(hù)性。
通過定義注解、創(chuàng)建注解處理器,并在業(yè)務(wù)方法上使用注解,可以輕松實(shí)現(xiàn)諸如日志記錄、性能監(jiān)控、權(quán)限驗(yàn)證等功能。
以上為個(gè)人經(jīng)驗(yàn),希望能給大家一個(gè)參考,也希望大家多多支持腳本之家。
相關(guān)文章
Spring中一個(gè)少見的引介增強(qiáng)IntroductionAdvisor
這篇文章主要為大家介紹了Spring中一個(gè)少見的引介增強(qiáng)IntroductionAdvisor實(shí)戰(zhàn)詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2023-08-08
Spring控制反轉(zhuǎn)和依賴注入超詳細(xì)講解
控制反轉(zhuǎn)(IoC)與依賴注入(DI)是密切相關(guān)的概念,它們通常一起出現(xiàn)在討論Spring框架時(shí),這篇文章主要介紹了Spring控制反轉(zhuǎn)和依賴注入的相關(guān)資料,文中通過代碼介紹的非常詳細(xì),需要的朋友可以參考下2025-10-10
淺談SpringBoot Bean加載優(yōu)先級(jí)的問題
這篇文章主要介紹了淺談SpringBoot Bean加載優(yōu)先級(jí)的問題,具有很好的參考價(jià)值,希望對大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2021-11-11
Java數(shù)據(jù)結(jié)構(gòu)及算法實(shí)例:考拉茲猜想 Collatz Conjecture
這篇文章主要介紹了Java數(shù)據(jù)結(jié)構(gòu)及算法實(shí)例:考拉茲猜想 Collatz Conjecture,本文直接給出實(shí)現(xiàn)代碼,代碼中包含詳細(xì)注釋,需要的朋友可以參考下2015-06-06
如何在MyBatis中實(shí)現(xiàn)DataSource
今天給大家整理了如何在MyBatis中實(shí)現(xiàn)DataSource,文中有非常詳細(xì)的代碼示例,對正在學(xué)習(xí)java的小伙伴們很有幫助,需要的朋友可以參考下2021-06-06
解決創(chuàng)建springboot后啟動(dòng)報(bào)錯(cuò):Failed?to?bind?properties?under‘spri
在Spring?Boot項(xiàng)目中,application.properties和application.yml是用于配置參數(shù)的兩種文件格式,properties格式簡潔但不支持層次結(jié)構(gòu),而yml格式支持層次性,可讀性更好,在yml文件中,要注意細(xì)節(jié),比如冒號(hào)后面需要空格2024-10-10
java整數(shù)與byte數(shù)組的轉(zhuǎn)換實(shí)現(xiàn)代碼
這篇文章主要介紹了java整數(shù)與byte數(shù)組的轉(zhuǎn)換實(shí)現(xiàn)代碼的相關(guān)資料,需要的朋友可以參考下2017-07-07
SpringBoot集成ElasticSearch實(shí)現(xiàn)搜索功能
本文主要介紹了Spring Boot 集成ElasticSearch實(shí)現(xiàn)搜索功能,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2025-03-03

