知識庫 / Spring RSS 訂閱

<div>
 <a class="article-series-header" href="javascript:void(0);">該文章是系列中的一部分</a>
 <div>
  <div>
   <div>
    • Spring Core 註解 <span>(當前文章)</span>
   </div>
   • Spring Web 註解
   <br>
   • Spring Boot 註解
   <br>
   • Spring Scheduling 註解
   <br>
   • Spring Data 註解
   <br>
   • Spring Bean 註解
   <br>
  </div>
  <!-- end of article series inner -->
 </div>
 <!-- .article-series-links -->
</div>
<!-- end of article series section -->

1. 概述

我們可以利用 Spring DI 引擎中的註解，通過 org.springframework.beans.factory.annotation 和 org.springframework.context.annotation 包來實現。

我們通常將這些註解稱為“Spring 核心註解”，並在本教程中進行回顧。

2. DI 相關注釋

2.1. <em @Autowired

我們可以使用 <em @Autowired> 來標記一個 Spring 將要解析並注入的依賴項。 我們可以使用此註解與構造函數、設置方法或字段注入一起使用。

構造函數注入：

class Car {
    Engine engine;

    @Autowired
    Car(Engine engine) {
        this.engine = engine;
    }
}

Setter 注入：

class Car {
    Engine engine;

    @Autowired
    void setEngine(Engine engine) {
        this.engine = engine;
    }
}

字段注入：

class Car {
    @Autowired
    Engine engine;
}

@Autowired 具有一個 boolean 類型的參數 required，默認值為 true。它調整 Spring 的行為，當找不到合適的 Bean 進行注入時。當 true 時，會拋出異常，否則什麼也不進行注入。

注意，如果使用構造函數注入，所有構造函數參數都必須是必需的。

從 4.3 版本開始，除非我們聲明至少有兩個構造函數，否則我們無需顯式地使用 @Autowired 註解來標註構造函數。

有關更多詳細信息，請參閲我們關於 @Autowired 和構造函數注入的文章。

2.2. <em @Bean@

@Bean 標記了一個工廠方法，用於實例化一個 Spring Bean。

@Bean
Engine engine() {
    return new Engine();
}

Spring 在需要創建返回類型的新的實例時，會調用這些方法。

生成的 Bean 的名稱與工廠方法相同。如果希望將其命名為不同，可以使用 name 或 value 屬性（value 屬性是 name 屬性的別名）進行指定：

@Bean("engine")
Engine getEngine() {
    return new Engine();
}

請注意，所有帶有 @Bean 註解的方法必須位於 @Configuration 類中。

2.3. <em @Qualifier</em>

我們使用 <em @Qualifier</em> 與 <em @Autowired</em> 共同提供在歧義情況下我們想要使用的 Bean ID 或 Bean 名稱。

例如，以下兩個 Bean 實現相同的接口：

class Bike implements Vehicle {}

class Car implements Vehicle {}

如果 Spring 需要注入一個 Vehicle Bean，它可能會遇到多個匹配的定義。 在這種情況下，我們可以使用 @Qualifier 註解顯式指定 Bean 的名稱。

使用構造注入:

@Autowired
Biker(@Qualifier("bike") Vehicle vehicle) {
    this.vehicle = vehicle;
}

使用 setter 注入：

@Autowired
void setVehicle(@Qualifier("bike") Vehicle vehicle) {
    this.vehicle = vehicle;
}

或者：

@Autowired
@Qualifier("bike")
void setVehicle(Vehicle vehicle) {
    this.vehicle = vehicle;
}

使用字段注入：

@Autowired
@Qualifier("bike")
Vehicle vehicle;

欲瞭解更詳細的描述，請閲讀本文。

2.4. @Value

我們可以使用 @Value 將屬性值注入到 Bean 中。它與構造函數注入、setter 注入和字段注入兼容。

構造函數注入：

Engine(@Value("8") int cylinderCount) {
    this.cylinderCount = cylinderCount;
}

<p>Setter injection:</p>

@Autowired
void setCylinderCount(@Value("8") int cylinderCount) {
    this.cylinderCount = cylinderCount;
}

或者：

@Value("8")
void setCylinderCount(int cylinderCount) {
    this.cylinderCount = cylinderCount;
}

字段注入：

@Value("8")
int cylinderCount;

當然，注入靜態值並非有效。因此，我們可以使用 佔位符字符串 在 @Value 中來連接來自 外部來源 的值，例如在 .properties 或 .yaml 文件中。

讓我們假設以下 .properties 文件：

engine.fuelType=petrol

我們可以通過以下方式注入 engine.fuelType 的值：

@Value("${engine.fuelType}")
String fuelType;

我們可以使用 @Value 甚至與 SpEL 結合使用。 更多高級示例請參考我們關於 @Value 的文章。

2.5. <em @DependsOn</em>>

我們可以使用此註解來使 Spring 在註解類執行之前初始化其他 Bean。通常，這種行為是自動的，基於 Bean 之間的顯式依賴關係。

我們只需要此註解，當依賴關係是隱式的，例如 JDBC 驅動程序加載或靜態變量初始化。

我們可以使用 <em @DependsOn</em>> 在依賴類上指定依賴 Bean 的名稱。該註解的 <em value</em> 參數需要一個包含依賴 Bean 名稱的數組：

@DependsOn("engine")
class Car implements Vehicle {}

如果定義了一個帶有 @Bean 標註的 Bean，則工廠方法應使用 @DependsOn 標註：

@Bean
@DependsOn("fuel")
Engine engine() {
    return new Engine();
}

@Configuration
@Lazy
class VehicleFactoryConfig {

    @Bean
    @Lazy(false)
    Engine engine() {
        return new Engine();
    }
}

@Component
@Primary
class Car implements Vehicle {}

@Component
class Bike implements Vehicle {}

@Component
class Driver {
    @Autowired
    Vehicle vehicle;
}

@Component
class Biker {
    @Autowired
    @Qualifier("bike")
    Vehicle vehicle;
}

@Component
@Scope("prototype")
class Engine {}

@Component
@Profile("sportDay")
class Bike implements Vehicle {}

@Import(VehiclePartSupplier.class)
class VehicleFactoryConfig {}

@Configuration
@ImportResource("classpath:/annotations.xml")
class VehicleFactoryConfig {}

@Configuration
@PropertySource("classpath:/annotations.properties")
class VehicleFactoryConfig {}

@Configuration
@PropertySource("classpath:/annotations.properties")
@PropertySource("classpath:/vehicle-factory.properties")
class VehicleFactoryConfig {}

@Configuration
@PropertySources({ 
    @PropertySource("classpath:/annotations.properties"),
    @PropertySource("classpath:/vehicle-factory.properties")
})
class VehicleFactoryConfig {}