一直在使用Spring提供的IoC容器, 但是始終沒有系統化的梳理一下. 今天在這裡寫下, 也是以備以後參考之用.

Ioc container的核心是BeanFactory介面, 它提供的方法能夠管理任何型別的物件. ApplicationContext是它的子介面, 集成了Spring AOP的特性.

BeanFactory or ApplicationContext?

BeanFactory目前只是Spring為了維持向後相容性而保留的介面, 任何新開發的框架或者程式應該使用ApplicationContext而不是BeanFactory.

那麼ApplicationContext

相比BeanFactory提供了哪些好處呢? 簡單的來說就是很多增強的功能, 更細粒度的干預bean生命週期的定製, AOP, 國際化, 事件支援等, 詳見下表:

所有的bean在使用前都需要在ApplicationContext註冊(register), 常用的有以下幾種形式:

• xml形式定義的;
• 註解定義;
• Java Config
• 手動註冊在Spring容器之外例項化的bean;

Dependency Injection的實現方式

一共有三種方法: 構造器注入, 設值注入和方法注入. 構造器注入在設值注入之前.

• 構造器注入: 注入強制性的依賴.
• 設值注入: 注入可選依賴或配置(例如@ConfigurationProperties
  ); 當設定注入加入了@Required標識, 就會變成一個強制性依賴.
• 方法注入: 通常是在bean構造後對bean進行增強設定.

Constructor-based

構造器注入是推薦的方式, 能夠實現一個immutable的bean, 確保所有的依賴不是null. 並能夠保證呼叫者使用時, 依賴是例項化完成的.

無需提供getter/setter方法.

setter-based

設值注入應被僅用於注入可選依賴, 或者是能夠被賦予預設值的依賴.

使用設值注入的好處是, 能夠在之後通過setter方法進行注入的變更, 在JMX MBeans管理上必須使用此種方式.

方法注入

下面是一個例子:

@EnableWebSecurity
public class SecurityConfig extends WebSecurityConfigurerAdapter {

    @Autowired // 自動注入--方法注入引數auth, 對已建立的AuthenticationManagerBuilder型別的bean進行增強.
    public void configureGlobal(AuthenticationManagerBuilder auth) throws Exception {
        auth.inMemoryAuthentication().withUser("admin").password("admin").roles("USER");
    }
}

依賴解析步驟

如果bean是單例的, 並且被標註為pre-instantiated(預設就是這個)會在容器建立的時候被建立. 否則的話會按需建立.

lazy-initialized beans

通常來講單例bean會在容器建立的時候初始化, 並且會按照依賴關係順次進行初始化, 但是你也可以通過指定lazy-init=true到某個bean上使其在第一次使用的時候才被初始化.

注意: 即使某個bean開啟了lazy-init, 也不一定是延遲初始化的, 因為如果依賴它的bean是單例的, 且沒有開啟延遲初始化, 那麼Spring容器為了保證準確性, 會將這個bean也立即初始化.

Bean作用域(Bean Scopes)

bean一共有七種作用域:

作用域	描述
singleton	預設, 單例, 通常用於無狀態bean, 如dao. service, controller等
prototype	原型, 每次呼叫產生一個新的例項, 通常用在domain object上. 相當於java的new關鍵字, Spring在例項化bean之後, 執行完initialization lifecycle callback, 之後就不在負責這個bean的生命週期了, 完全交給客戶端負責
request	HTTP 請求範圍
session	HTTP Session範圍
application	和ServletContext的生命週期一致, 也就是web應用的範圍
websocket	和一個WebSocket的生命週期一致

request, session, application, websocket作用域

這些作用域需要執行緒與Http Request或者Http Sesson物件繫結. 當使用Spring MVC時, 自動繫結.

使用以下註解在bean上顯式指定:

• @RequestScope
• @SessionScope
• @ApplicationScope

application scope

是ServletContext級別的, 作為一個ServletContext的attribute存取, 這個範圍非常像singleton範圍, 但是有以下兩點主要區別:

• 它是與ServletContext繫結, 不是與ApplicatinContext繫結. 一個ServletContext可以有多個ApplicationContext. 也就是說, application scope的bean是與ApplicationContext平行的, 二者都是ServletContext的一個屬性.
• 它是ServletContext的一個屬性.

代理

一般有兩種型別:

• interface-based proxy, 典型的是JDK內建的動態代理
• 一種是inherated-based proxy, 典型的是CGLIB

interface-based proxy

優點是不需要引入額外的庫依賴, 缺點是想要代理的方法必須是在被代理類實現的介面中定義的.

inherated-based proxy

缺點是需要引入額外依賴, 優點是可以代理所有的共有型別方法.

Bean生命週期(lifecycle)

• initialization callback 使用@PostConstruct
• destruction callback 使用@PreDestroy

以下是一個使用的例子:

public class CachingMovieLister {

    @PostConstruct // 該方法會在bean初始化之後被回撥
    public void populateMovieCache() {
        // populates the movie cache upon initialization...
    }

    @PreDestroy // 該方法會在容器銷燬bean之前被回撥
    public void clearMovieCache() {
        // clears the movie cache upon destruction...
    }

}

Startup and shotdown callbacks

是容器啟動和容器停止的回撥, 發生在所有的bean建立之前和銷燬之前.

優雅的關閉非web應用下的Spring IoC容器

需要為ApplicationContext在JVM裡註冊一個shutdown hook. 這會確保所有自定義的destroy方法被正確呼叫.

ApplicationContextAware and BeanNameAware

是bean用來感知容器存在的介面, 通常不需要實現這個介面, 因為通常bean是不需要顯式感知容器的存在的, 而且這樣做會導致與Spring框架耦合.

使用註解指導依賴注入

@Autowired

@Autowired是按照注入的型別名進行依賴查詢, 當同一個型別有多種實現bean的時候, 產生歧義並報錯.

@[email protected]

當有兩個以上相同型別的bean時, 單獨的@Autowired會產生歧義, 可以用額外的@Qualifier("這裡是bean的名字")註解按bean的名字進行注入.

@Resource

相當於@Autowired+@Qualifire的組合.

自定義@Qualifier

@Qualifier註解支援繼承, 這樣我們就可以擴充套件@Qualifier的語義, 進行更細力度的@Quelifier定義, 例如:

// 擴充套件@Quelifier語義
@Target({ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Qualifier
public @interface Offline {

}

@Configuration
public class MovieConfiguration {

    @Bean
    @Offline // 使用自定義的@Qualifier子類區分bean
    public MovieCatalog firstMovieCatalog() { ... }

    @Bean
    public MovieCatalog secondMovieCatalog() { ... }

    // ...

}

public class MovieRecommender {

    @Autowired
    @Offline // 根據自定義的@Qualifier子類注入bean
    private MovieCatalog offlineCatalog;

    // ...

}

下面是一個更復雜的例子:

@Target({ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Qualifier
public @interface MovieQualifier {

    String genre();

    Format format();

}

public enum Format {
    VHS, DVD, BLURAY
}

public class MovieRecommender {

    @Autowired
    @MovieQualifier(format=Format.VHS, genre="Action")
    private MovieCatalog actionVhsCatalog;

    @Autowired
    @MovieQualifier(format=Format.VHS, genre="Comedy")
    private MovieCatalog comedyVhsCatalog;

    @Autowired
    @MovieQualifier(format=Format.DVD, genre="Action")
    private MovieCatalog actionDvdCatalog;

    @Autowired
    @MovieQualifier(format=Format.BLURAY, genre="Comedy")
    private MovieCatalog comedyBluRayCatalog;

    // ...

}

使用Java Config指導依賴注入

核心是使用@Configuration和@Bean註解.

@Bean

@Bean是一個方法級的註解, 它的返回值將作為一個singleton的bean註冊到spring的IoC容器中.

如果一個@Bean的建立依賴於其他bean的建立, 那麼需要將所有依賴作為方法的引數, 會觸發類似@Autowired的效果.

下面是一個例子:

@Configuration
public class AppConfig {

    @Bean
    public TransferService transferService(AccountRepository accountRepository) {
        return new TransferServiceImpl(accountRepository);
    }

}

這種配置方式特別像contructor-based注入, 可以參照理解

@Configuration

所有的通過@Bean方式手動建立bean, 都建議在@Configuration的類中進行定義.

@Configuration標註的類會在執行時被CGLIB動態代理, 所有對原類方法的呼叫都會被攔截.

這個動態代理做了以下重要的事:

• 通過快取singleton bean, 防止原類中重複例項化同一個名字的singleton bean.

@Import

@Import是用來組合多個@Configuration的定義. 使通過Java Config進行手動bean定義的配置檔案集中到一起.

下面是一個使用@Configuration + @Import進行跨檔案bean組裝的例子:

@Configuration
public class ServiceConfig {

    @Bean
    public TransferService transferService(AccountRepository accountRepository) {
        return new TransferServiceImpl(accountRepository);
    }

}

@Configuration
public class RepositoryConfig {

    @Bean
    public AccountRepository accountRepository(DataSource dataSource) {
        return new JdbcAccountRepository(dataSource);
    }

}

@Configuration
@Import({ServiceConfig.class, RepositoryConfig.class})
public class SystemTestConfig {

    @Bean
    public DataSource dataSource() {
        // return new DataSource
    }

}

public static void main(String[] args) {
    ApplicationContext ctx = new AnnotationConfigApplicationContext(SystemTestConfig.class);
    // everything wires up across configuration classes...
    TransferService transferService = ctx.getBean(TransferService.class);
    transferService.transfer(100.00, "A123", "C456");
}

組合xml, 註解, Java Config形式的依賴注入

只需要在一個@Configuration類上加上@ImportResource註解即可, 以下是一個例子:

@Configuration
@ImportResource("classpath:/com/acme/properties-config.xml")
public class AppConfig {
    // 正常的bean定義
}

Environment abstraction

環境允許通過定義多個profile檔案, 允許在不同環境(開發, 測試, 生產)使用不同的配置.

下面是一個例子:

@Configuration
@Profile("dev")
public class StandaloneDataConfig {

    @Bean
    public DataSource dataSource() {
        return new EmbeddedDatabaseBuilder()
            .setType(EmbeddedDatabaseType.HSQL)
            .addScript("classpath:com/bank/config/sql/schema.sql")
            .addScript("classpath:com/bank/config/sql/test-data.sql")
            .build();
    }
}

@Configuration
@Profile("production")
public class JndiDataConfig {

    @Bean(destroyMethod="")
    public DataSource dataSource() throws Exception {
        Context ctx = new InitialContext();
        return (DataSource) ctx.lookup("java:comp/env/jdbc/datasource");
    }
}

想要啟動一個特定的配置, 在全域性配置中加上如下屬性設定即可:

# 啟用dev profile
spring.profiles.active=dev

除此以外, 我們還可以提供個一個預設的profile:

@Configuration
@Profile("default")
public class DefaultDataConfig {

    @Bean
    public DataSource dataSource() {
        return new EmbeddedDatabaseBuilder()
            .setType(EmbeddedDatabaseType.HSQL)
            .addScript("classpath:com/bank/config/sql/schema.sql")
            .build();
    }
}

上述配置在沒有顯式指定spring.profiles.active時自動啟用.

小結

以上.

參考連結: