Java Springboot學習(二) 全注解配置和屬性注入


3. 全注解配置和屬性注入

在入門案例中,我們沒有任何的配置,就可以實現一個SpringMVC的項目了,快速、高效!

但是會有疑問,如果沒有任何的xml,那么我們如果要配置一個Bean該怎么辦?比如我們要配置一個數據庫 連接池,以前會這么玩:

<!-- 配置連接池 -->
<bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource"
init-method="init" destroy-method="close">
    <property name="url" value="${jdbc.url}" />
    <property name="username" value="${jdbc.username}" />
    <property name="password" value="${jdbc.password}" />
</bean>

現在該怎么做呢?

回顧歷史


 

事實上,在Spring3.0開始,Spring官方就已經開始推薦使用java配置來代替傳統的xml配置了,我們不妨來回顧一 下Spring的歷史:

  • Spring1.0時代

    在此時因為jdk1.5剛剛出來,注解開發並未盛行,因此一切Spring配置都是xml格式,想象一下所有的bean都 用xml配置,細思極恐啊,心疼那個時候的程序員2秒

  • Spring2.0時代

    Spring引入了注解開發,但是因為並不完善,因此並未完全替代xml,此時的程序員往往是把xml與注解進行 結合,貌似我們之前都是這種方式。

  • Spring3.0及以后

    3.0以后Spring的注解已經非常完善了,因此Spring推薦大家使用完全的java配置來代替以前的xml,不過似乎 在國內並未推廣盛行。然后當SpringBoot來臨,人們才慢慢認識到java配置的優雅。

 

 

spring全注解配置

spring全注解配置主要靠java類和一些注解,比較常用的注解有:

@Configuration :聲明一個類作為配置類,代替xml文件

@Bean :聲明在方法上,將方法的返回值加入Bean容器,代替 標簽

@value :屬性注入

@PropertySource :指定外部屬性文件,

 

我們接下來用java配置來嘗試實現連接池配置:

首先引入Druid連接池依賴:

<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>druid</artifactId>
    <version>1.1.10</version>
</dependency>

創建一個jdbc.properties文件,編寫jdbc屬性(可以拷貝):

jdbc.driverClassName=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://127.0.0.1:3306/czy
jdbc.username=root
jdbc.password=123

然后編寫代碼:

@Configuration
@PropertySource("classpath:jdbc.properties")
public class JdbcConfig {
  @Value(
"${jdbc.url}")   String url;   @Value("${jdbc.driverClassName}")   String driverClassName;   @Value("${jdbc.username}")   String username;   @Value("${jdbc.password}")   String password;
  @Bean
  public DataSource dataSource() {     DruidDataSource dataSource = new DruidDataSource();     dataSource.setUrl(url);     dataSource.setDriverClassName(driverClassName);     dataSource.setUsername(username);     dataSource.setPassword(password);     return dataSource;   } }

解讀:

@Configuration :聲明我們 JdbcConfig 是一個配置類

@PropertySource :指定屬性文件的路徑是: classpath:jdbc.properties

通過 @Value 為屬性注入值

通過@Bean將 dataSource() 方法聲明為一個注冊Bean的方法,Spring會自動調用該方法,將方法的返回值 加入Spring容器中。默認的對象名id=方法名,可以通過@Bean("自定義名字"),來指定新的對象名

然后我們就可以在任意位置通過 @Autowired 注入DataSource了!


我們在 HelloController 中測試:

@RestController
public class HelloController {
    @Autowired
    private DataSource dataSource;
    @GetMapping("hello")
    public String hello() {
        return "hello, spring boot!" + dataSource;
    }
}        

然后Debug運行並查看:

 

 

 

屬性注入成功了!

 

 

SpringBoot的屬性注入


在上面的案例中,我們實驗了java配置方式。不過屬性注入使用的是@Value注解。這種方式雖然可行,但是不夠 強大,因為它只能注入基本類型值。

在SpringBoot中,提供了一種新的屬性注入方式,支持各種java基本數據類型及復雜類型的注入。

1)我們新建一個類,用來進行屬性注入:

@ConfigurationProperties(prefix = "jdbc")
public class JdbcProperties {
    private String url;
    private String driverClassName;
    private String username;
    private String password;
    // ... 略
    // getters 和 setters
}

 

  • 在類上通過@ConfigurationProperties注解聲明當前類為屬性讀取類
  • prefix="jdbc" 讀取屬性文件中,前綴為jdbc的值。
  • 在類上定義各個屬性,名稱必須與屬性文件中 jdbc. 后面部分一致
  • 需要注意的是,這里我們並沒有指定屬性文件的地址,所以我們需要把jdbc.properties名稱改為 application.properties,這是SpringBoot默認讀取的屬性文件名:

 

 2)在JdbcConfig中使用這個屬性:

@Configuration
@EnableConfigurationProperties(JdbcProperties.class)
public class JdbcConfig {
    @Bean
    public DataSource dataSource(JdbcProperties jdbc) {
        DruidDataSource dataSource = new DruidDataSource();
        dataSource.setUrl(jdbc.getUrl());
        dataSource.setDriverClassName(jdbc.getDriverClassName());
        dataSource.setUsername(jdbc.getUsername());
        dataSource.setPassword(jdbc.getPassword());
        return dataSource;
    }
}
  • 通過 @EnableConfigurationProperties(JdbcProperties.class) 來聲明要使用 JdbcProperties 這個類的對象
  • 然后你可以通過以下方式注入JdbcProperties:
    • @Autowired注入
@Autowired
private JdbcProperties prop;
    • 構造函數注入
private JdbcProperties prop;
    public JdbcConfig(Jdbcproperties prop){
    this.prop = prop;
}
    • 聲明有@Bean的方法參數注入
@Bean
public Datasource dataSource(JdbcProperties prop){
    // ...
}

本例中,我們采用第三種方式。

3)測試結果:

 

大家會覺得這種方式似乎更麻煩了,事實上這種方式有更強大的功能,也是SpringBoot推薦的注入方式。兩者對比關系:

 

 

優勢:

  • Relaxed binding:松散綁定
    • 不嚴格要求屬性文件中的屬性名與成員變量名一致。支持駝峰,中划線,下划線等等轉換,甚至支持對 象引導。比如:user.friend.name:代表的是user對象中的friend屬性中的name屬性,顯然friend也是 對象。@value注解就難以完成這樣的注入方式。
    • meta-data support:元數據支持,幫助IDE生成屬性提示(寫開源框架會用到)。

 

 

更優雅的注入


事實上,如果一段屬性只有一個Bean需要使用,我們無需將其注入到一個類(JdbcProperties)中。而是直接在需 要的地方聲明即可:

 

@Configuration
public class JdbcConfig {

    @Bean
// 聲明要注入的屬性前綴,SpringBoot會自動把相關屬性通過set方法注入到DataSource中
    @ConfigurationProperties(prefix = "jdbc")
    public DataSource dataSource() {
        DruidDataSource dataSource = new DruidDataSource();
        return dataSource;
    }
}    

 

我們直接把 @ConfigurationProperties(prefix = "jdbc") 聲明在需要使用的 @Bean 的方法上,然后SpringBoot 就會自動調用這個Bean(此處是DataSource)的set方法,然后完成注入。使用的前提是:該類必須有對應屬性的 set方法!

我們將jdbc的url改成:/lxs,再次測試:

 

 

 

4. 自動配置原理


通過剛才的案例看到,一個整合了SpringMVC的WEB工程開發,變的無比簡單,那些繁雜的配置都消失不見了,這 是如何做到的?

 

 

 

 

我們重點關注@SpringBootApplication注解

 

@SpringBootApplication


 

點擊進入,查看源碼:

 

 

 這里重點的注解有3個:

  • @SpringBootConfiguration
  • @EnableAutoConfiguration
  • @ComponentScan

@SpringBootConfiguration

我們繼續點擊查看源碼:

 

 

 通過這段我們可以看出,在這個注解上面,又有一個 @Configuration 注解。這個注解的作用就是聲明當前類是一 個配置類,然后Spring會自動掃描到添加了 @Configuration 的類,並且讀取其中的配置信息。

 

@ComponentScan

我們跟進源碼:

 

 

 並沒有看到什么特殊的地方。我們查看注釋:

 

 大概的意思:

配置組件掃描的指令。提供了類似與 標簽的作用

通過basePackageClasses或者basePackages屬性來指定要掃描的包。如果沒有指定這些屬性,那么將從聲 明這個注解的類所在的包開始,掃描包及子包

 

而我們的@SpringBootApplication注解聲明的類就是main函數所在的啟動類,因此掃描的包是該類所在包及其子 包。因此,一般啟動類會放在一個比較前的包目錄中。

 

@EnableAutoConfiguration

關於這個注解,官網上有一段說明:

 

 

 簡單翻譯以下:

 

 總結,SpringBoot內部對大量的第三方庫進行了默認配置,我們引入對應庫所需的依賴,那么默認配置就會生效。

 

 

默認配置原理


@EnableAutoConfiguration會開啟SpringBoot的自動配置,並且根據你引入的依賴來生效對應的默認配置, springboot如何做到的?

 

其實在我們的項目中,已經引入了一個依賴:spring-boot-autoconfigure,其中定義了大量自動配置類:

 

 

還有:

 

 

非常多,幾乎涵蓋了現在主流的開源框架,例如:

  • redis
  • jms
  • amqp
  • jdbc
  • jackson
  • mongodb
  • jpa
  • solr
  • elasticsearch
  • ...等等

我們來看一個我們熟悉的,例如SpringMVC,查看mvc 的自動配置類:

 

 

打開WebMvcAutoConfiguration:

 

 

我們看到這個類上的4個注解:

@Configuration :聲明這個類是一個配置類
@ConditionalOnClass({ Servlet.class, DispatcherServlet.class, WebMvcConfigurer.class })
// 這里的條件是OnClass,也就是滿足以下類存在:Servlet、DispatcherServlet、WebMvcConfigurer,
// 其中 Servlet只要引入了tomcat依賴自然會有,后兩個需要引入SpringMVC才會有。這里就是判斷你是否引入了相 關依賴,引入依賴后該條件成立,當前類的配置才會生效!
@ConditionalOnMissingBean(WebMvcConfigurationSupport.class)
這個條件與上面不同,OnMissingBean,是說環境中沒有指定的Bean這個才生效。其實這就是自定義配置的
入口,也就是說,如果我們自己配置了一個WebMVCConfigurationSupport的類,那么這個默認配置就會失
效!

接着,我們查看該類中定義了什么:

視圖解析器:

 

 

處理器適配器(HandlerAdapter):

 

 

還有很多,這里就不一一截圖了。

 

總結

 


SpringBoot為我們提供了默認配置,而默認配置生效的條件一般有兩個:

  • 引入了相關依賴
  • 沒有自定義配置類

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM