Spring Boot 各類注解

@RestController和@RequestMapping注解

注: @RestController 和 @RequestMapping 注解是Spring MVC注解(它們不是Spring Boot的特定部分)

我們的Example類上使用的第一個注解是 @RestController 。這被稱為一個構(gòu)造型(stereotype)注解。它為閱讀代碼的人們提供建議。對于Spring,該類扮演了一個特殊角色。在本示例中,我們的類是一個web @Controller ,所以當(dāng)處理進(jìn)來的web請求時,Spring會詢問它。@RequestMapping 注解提供路由信息。它告訴Spring任何來自"/"路徑的HTTP請求都應(yīng)該被映射到 home 方法。 @RestController 注解告訴Spring以字符串的形式渲染結(jié)果,并直接返回給調(diào)用者。

@EnableAutoConfiguration注解

注:你只需要添加一個 @EnableAutoConfiguration 注解。我們建議你將它添加到主 @Configuration 類上。

第二個類級別的注解是 @EnableAutoConfiguration 。這個注解告訴Spring Boot根據(jù)添加的jar依賴猜測你想如何配置Spring。由于 spring-boot-starter-web 添加了Tomcat和Spring MVC,所以auto-configuration將假定你正在開發(fā)一個web應(yīng)用并相應(yīng)地對Spring進(jìn)行設(shè)置。Starter POMs和Auto-Configuration:設(shè)計auto-configuration的目的是更好的使用"Starter POMs",但這兩個概念沒有直接的聯(lián)系。你可以自由地挑選starter POMs以外的jar依賴,并且Spring Boot將仍舊盡最大努力去自動配置你的應(yīng)用。

你可以通過將 @EnableAutoConfiguration 或 @SpringBootApplication 注解添加到一個 @Configuration 類上來選擇自動配置。

如果發(fā)現(xiàn)應(yīng)用了你不想要的特定自動配置類,你可以使用 @EnableAutoConfiguration 注解的排除屬性來禁用它們。

import org.springframework.boot.autoconfigure.*;
import org.springframework.boot.autoconfigure.jdbc.*;
import org.springframework.context.annotation.*;

@Configuration
@EnableAutoConfiguration(exclude={DataSourceAutoConfiguration.class})
public class MyConfiguration {
}

@Configuration

Spring Boot提倡基于Java的配置。盡管你可以使用一個XML源來調(diào)用 SpringApplication.run() ,我們通常建議你使用 @Configuration 類作為主要源。一般定義 main 方法的類也是主要 @Configuration 的一個很好候選。你不需要將所有的 @Configuration 放進(jìn)一個單獨的類。 @Import 注解可以用來導(dǎo)入其他配置類。另外,你也可以使用 @ComponentScan 注解自動收集所有的Spring組件,包括 @Configuration 類。

如果你絕對需要使用基于XML的配置,我們建議你仍舊從一個 @Configuration 類開始。你可以使用附加的 @ImportResource 注解加載XML配置文件。

@Configuration注解該類,等價 與XML中配置beans;用@Bean標(biāo)注方法等價于XML中配置bean

@ComponentScan

你可以自由地使用任何標(biāo)準(zhǔn)的Spring框架技術(shù)去定義beans和它們注入的依賴。簡單起見,我們經(jīng)常使用 @ComponentScan 注解搜索beans,并結(jié)合 @Autowired 構(gòu)造器注入。
如果使用上面建議的結(jié)構(gòu)組織代碼(將應(yīng)用類放到根包下),你可以添加 @ComponentScan 注解而不需要任何參數(shù)。你的所有應(yīng)用程序組件( @Component , @Service , @Repository , @Controller 等)將被自動注冊為Spring Beans。

@SpringBootApplication

很多Spring Boot開發(fā)者總是使用 @Configuration , @EnableAutoConfiguration 和 @ComponentScan 注解他們的main類。由于這些注解被如此頻繁地一塊使用(特別是你遵循以上最佳實踐時),Spring Boot提供一個方便的 @SpringBootApplication 選擇。
該 @SpringBootApplication 注解等價于以默認(rèn)屬性使用 @Configuration , @EnableAutoConfiguration 和 @ComponentScan 。

package com.example.myproject;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication // same as @Configuration @EnableAutoConfiguration @ComponentScan
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

@ConfigurationProperties

屬性注入

@Component
@ConfigurationProperties(prefix="connection")
public class ConnectionSettings {
    private String username;
    private InetAddress remoteAddress;
    // ... getters and setters
}

為了使用@ConfigurationProperties beans,你可以使用與其他任何bean相同的方式注入它們

@Service
public class MyService {
    @Autowired
    private ConnectionSettings connection;
    //...
    @PostConstruct
    public void openConnection() {
        Server server = new Server();
        this.connection.configure(server);
    }
}

正如使用@ConfigurationProperties注解一個類,你也可以在@Bean方法上使用它。當(dāng)你需要綁定屬性到不受你控制的第三方組件時,這種方式非常有用。

為了從Environment屬性配置一個bean,將@ConfigurationProperties添加到它的bean注冊過程:

@Bean
@ConfigurationProperties(prefix = "foo")
public FooComponent fooComponent() {
...
}

和上面ConnectionSettings的示例方式相同,任何以foo為前綴的屬性定義都會被映射到FooComponent上。

Spring Boot將嘗試校驗外部的配置,默認(rèn)使用JSR-303(如果在classpath路徑中)。你可以輕松的為你的@ConfigurationProperties類添加JSR-303 javax.validation約束注解:

@Component
@ConfigurationProperties(prefix="connection")
public class ConnectionSettings {
@NotNull
private InetAddress remoteAddress;
// ... getters and setters
}

@EnableConfigurationProperties

當(dāng)@EnableConfigurationProperties注解應(yīng)用到你的@Configuration時,任何被@ConfigurationProperties注解的beans將自動被Environment屬性配置

你可以通過在@EnableConfigurationProperties注解中直接簡單的列出屬性類來快捷的注冊@ConfigurationProperties bean的定義。

@Configuration
@EnableConfigurationProperties(ConnectionSettings.class)
public class MyConfiguration {
}

@Component和@Bean

@Component被用在要被自動掃描和裝配的類上。@Component類中使用方法或字段時不會使用CGLIB增強(及不使用代理類:調(diào)用任何方法,使用任何變量,拿到的是原始對象)Spring 注解@Component等效于@Service,@Controller,@Repository
@Bean主要被用在方法上,來顯式聲明要用生成的類;用@Configuration注解該類,等價 與XML中配置beans;用@Bean標(biāo)注方法等價于XML中配置bean。

現(xiàn)在項目上,本工程中的類,一般都使用@Component來生成bean。在把通過web service取得的類,生成Bean時,使用@Bean和getter方法來生成bean

@Profiles

Spring Profiles提供了一種隔離應(yīng)用程序配置的方式,并讓這些配置只能在特定的環(huán)境下生效。任何@Component或@Configuration都能被@Profile標(biāo)記,從而限制加載它的時機。

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

以正常的Spring方式,你可以使用一個spring.profiles.active的Environment屬性來指定哪個配置生效。你可以使用平常的任何方式來指定該屬性,例如,可以將它包含到你的application.properties中:

spring.profiles.active=dev,hsqldb
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • Spring Boot 參考指南 介紹 轉(zhuǎn)載自:https://www.gitbook.com/book/qbgb...
    毛宇鵬閱讀 47,256評論 6 342
  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理,服務(wù)發(fā)現(xiàn),斷路器,智...
    卡卡羅2017閱讀 136,511評論 19 139
  • 文章作者:Tyan博客:noahsnail.com | CSDN | 簡書 24. Externalized Co...
    SnailTyan閱讀 2,133評論 1 2
  • 今天上午帶著孩兒在戶外慢跑,這好象是我不上學(xué)之后,第一次比較長距離地跑。按海亮所說,比較輕松、愉悅地跑,不給自己任...
    邵清清靜閱讀 264評論 2 4
  • 今天我們?nèi)デ镉?。昨天我已?jīng)準(zhǔn)備好了零食,期待著秋游那天! 第二天在上學(xué)的路上,我看到啦同學(xué)們,心想“不用猜,...
    謝佳鈺閱讀 399評論 0 1

友情鏈接更多精彩內(nèi)容