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

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註解內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet!