首頁 > 軟體

springboot中一些比較常用的註解總結

2021-06-11 19:00:07

springboot常用註解

1、@SpringBootApplication

這個註解是Spring Boot最核心的註解,用在 Spring Boot的主類上,標識這是一個 Spring Boot 應用,用來開啟 Spring Boot 的各項能力。實際上這個註解是@Configuration,@EnableAutoConfiguration,@ComponentScan三個註解的組合。由於這些註解一般都是一起使用,所以Spring Boot提供了一個統一的註解@SpringBootApplication。

2、@EnableAutoConfiguration

允許 Spring Boot 自動設定註解,開啟這個註解之後,Spring Boot 就能根據當前類路徑下的包或者類來設定 Spring Bean。
如:當前類路徑下有 Mybatis 這個 JAR 包,MybatisAutoConfiguration 註解就能根據相關引數來設定 Mybatis 的各個 Spring Bean。
@EnableAutoConfiguration實現的關鍵在於引入了AutoConfigurationImportSelector,其核心邏輯為selectImports方法,邏輯大致如下:
 ● 從組態檔META-INF/spring.factories載入所有可能用到的自動設定類;
 ● 去重,並將exclude和excludeName屬性攜帶的類排除;
 ● 過濾,將滿足條件(@Conditional)的自動設定類返回;

3、@Configuration

用於定義設定類,指出該類是 Bean 設定的資訊源,相當於傳統的xml組態檔,一般加在主類上。如果有些第三方庫需要用到xml檔案,建議仍然通過@Configuration類作為專案的設定主類——可以使用@ImportResource註解載入xml組態檔。

4、@ComponentScan

元件掃描。讓spring Boot掃描到Configuration類並把它加入到程式上下文。
@ComponentScan註解預設就會裝配標識了@Controller,@Service,@Repository,@Component註解的類到spring容器中。

5、@Repository

用於標註資料存取元件,即DAO元件。
使用@Repository註解可以確保DAO或者repositories提供異常轉譯,這個註解修飾的DAO或者repositories類會被ComponetScan發現並設定,同時也不需要為它們提供XML設定項。

6、@Service

一般用於修飾service層的元件

7、@RestController

用於標註控制層元件(如struts中的action),表示這是個控制器bean,並且是將函數的返回值直 接填入HTTP響應體中,是REST風格的控制器;它是@Controller和@ResponseBody的合集。

8、@ResponseBody

表示該方法的返回結果直接寫入HTTP response body中
一般在非同步獲取資料時使用,在使用@RequestMapping後,返回值通常解析為跳轉路徑,加上@responsebody後返回結果不會被解析為跳轉路徑,而是直接寫入HTTP response body中。比如非同步獲取json資料,加上@responsebody後,會直接返回json資料。

9、@Component

泛指元件,當元件不好歸類的時候,我們可以使用這個註解進行標註。

10、@Bean

相當於XML中的,放在方法的上面,而不是類,意思是產生一個bean,並交給spring管理。

11、@AutoWired

預設是byType方式。把設定好的Bean拿來用,完成屬性、方法的組裝,它可以對類成員變數、方法及建構函式進行標註,完成自動裝配的工作。
當加上(required=false)時,就算找不到bean也不報錯。

12、@Qualifier

當有多個同一型別的Bean時,可以用@Qualifier("name")來指定。與@Autowired配合使用

13、@Resource(name="name",type="type")

沒有括號內內容的話,預設byName,通過名稱找不到再去通過型別去查詢。與@Autowired幹相似的事。

14、@RequestMapping

RequestMapping是一個用來處理請求地址對映的註解;提供路由資訊,負責URL到Controller中的具體函數的對映,可用於類或方法上。用於類上,表示類中的所有響應請求的方法都是以該地址作為父路徑。

15、@RequestParam

用在方法的引數前面。例:

@RequestParam String a =request.getParameter("a")。

16、@PathVariable

路徑變數。引數用到入參,與大括號裡的名字一樣要相同。如:

RequestMapping("user/get/mac/{macAddress}")
 
public String getById(@PathVariable String id){
 
  ....
 
}

17、@Profiles

Spring Profiles提供了一種隔離應用程式設定的方式,並讓這些設定只能在特定的環境下生效。
任何@Component或@Configuration都能被@Profile標記,從而限制載入它的時機。

@Configuration
 
@Profile("prod")
 
public class ProductionConfiguration {
 
    // ...
 
}

18、@ConfigurationProperties

Spring Boot可使用註解的方式將自定義的properties檔案對映到實體bean中,比如config.properties檔案。

@Data
 
@ConfigurationProperties("rocketmq.consumer")
 
public class RocketMQConsumerProperties extends RocketMQProperties {
 
    private boolean enabled = true;
 
    private String consumerGroup;
 
    private MessageModel messageModel = MessageModel.CLUSTERING;
 
    private ConsumeFromWhere consumeFromWhere = ConsumeFromWhere.CONSUME_FROM_LAST_OFFSET;
 
    private int consumeThreadMin = 20;
 
    private int consumeThreadMax = 64;
 
    private int consumeConcurrentlyMaxSpan = 2000;
 
    private int pullThresholdForQueue = 1000;
 
    private int pullInterval = 0;
 
    private int consumeMessageBatchMaxSize = 1;
 
    private int pullBatchSize = 32;
 
}

19、@Conditional

這是 Spring 4.0 新增的新註解,用來標識一個 Spring Bean 或者 Configuration 組態檔,當滿足指定的條件才開啟設定。

相關注解:( 

1)、@ConditionalOnBean
        組合 @Conditional 註解,當容器中有指定的 Bean 才開啟設定。

2)、@ConditionalOnMissingBean
        組合 @Conditional 註解,和 @ConditionalOnBean 註解相反,當容器中沒有指定的 Bean 才開啟設定。

3)、@ConditionalOnClass
        組合 @Conditional 註解,當容器中有指定的 Class 才開啟設定。

4)、@ConditionalOnMissingClass
        組合 @Conditional 註解,和 @ConditionalOnMissingClass 註解相反,當容器中沒有指定的 Class 才開啟設定。

5、@ConditionalOnWebApplication
        組合 @Conditional 註解,當前專案型別是 WEB 專案才開啟設定。

當前專案有以下 3 種型別。 

enum Type {
 
    /**
     * Any web application will match.
     */
    ANY,
 
    /**
     * Only servlet-based web application will match.
     */
    SERVLET,
 
    /**
     * Only reactive-based web application will match.
     */
    REACTIVE
 
}

6)、@ConditionalOnNotWebApplication
        組合 @Conditional 註解,和 @ConditionalOnWebApplication 註解相反,當前專案型別不是 WEB 專案才開啟設定。

7)、@ConditionalOnProperty
        組合 @Conditional 註解,當指定的屬性有指定的值時才開啟設定。

8)、@ConditionalOnExpression
        組合 @Conditional 註解,當 SpEL 表示式為 true 時才開啟設定。

9)、@ConditionalOnJava
        組合 @Conditional 註解,當執行的 Java JVM 在指定的版本範圍時才開啟設定。

10)、@ConditionalOnResource
        組合 @Conditional 註解,當類路徑下有指定的資源才開啟設定。

11)、@ConditionalOnJndi
        組合 @Conditional 註解,當指定的 JNDI 存在時才開啟設定。

12)、@ConditionalOnCloudPlatform
        組合 @Conditional 註解,當指定的雲平臺啟用時才開啟設定。

13)、@ConditionalOnSingleCandidate
        組合 @Conditional 註解,當指定的 class 在容器中只有一個 Bean,或者同時有多個但為首選時才開啟設定。

20、@ConfigurationProperties

用來載入額外的設定(如 .properties 檔案),可用在 @Configuration 註解類,或者 @Bean 註解方法上面。

21、@EnableConfigurationProperties

一般要配合 @ConfigurationProperties 註解使用,用來開啟對 @ConfigurationProperties 註解設定 Bean 的支援。

22、@AutoConfigureAfter

用在自動設定類上面,表示該自動設定類需要在另外指定的自動設定類設定完之後。

如 Mybatis 的自動設定類,需要在資料來源自動設定類之後。

@AutoConfigureAfter(DataSourceAutoConfiguration.class)
public class MybatisAutoConfiguration {

23、@AutoConfigureBefore

這個和 @AutoConfigureAfter 註解使用相反,表示該自動設定類需要在另外指定的自動設定類設定之前。

24、@Import

這是 Spring 3.0 新增的新註解,用來匯入一個或者多個 @Configuration 註解修飾的類,這在 Spring Boot 裡面應用很多。

25、@ImportResource

這是 Spring 3.0 新增的新註解,用來匯入一個或者多個 Spring 組態檔,這對 Spring Boot 相容老專案非常有用,因為有些設定無法通過 Java Config 的形式來設定就只能用這個註解來匯入。

到此這篇關於springboot中一些比較常用的註解總結的文章就介紹到這了,更多相關springboot註解內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com!


IT145.com E-mail:sddin#qq.com