104-SpringBoot基础3-配置

3. java配置应用

在入门案例中，我们没有任何的配置，就可以实现一个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>

3.1 Spring 配置历史

事实上，在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，不过似乎在国内并未推广盛行。然后当Spring Boot来临，人们才慢慢认识到java配置的优雅。

有句古话说的好：拥抱变化，拥抱未来。所以我们也应该顺应时代潮流，做时尚的弄潮儿，一起来学习下java配置的玩法。

3.2. 注解配置 `Value`

java配置主要靠java类和一些注解，比较常用的注解有：

@Configuration：声明一个类作为配置类，代替xml文件
@Bean：声明在方法上，将方法的返回值加入Bean容器，代替 <bean> 标签
@Value：属性注入
@PropertySource：指定外部属性文件，

我们接下来用java配置来尝试实现连接池配置：

在 pom.xml 文件中添加Druid连接池依赖如下

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

使用数据操作工具创建数据库 springboot_test

然后在项目中创建 src\main\resources\jdbc.properties 文件，内容如下

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

编写 src\main\java\com\itheima\config\JdbcConfig.java 如下

package com.itheima.config;
import com.alibaba.druid.pool.DruidDataSource;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;
import javax.sql.DataSource;

@Configuration  // 声明 JdbcConfig 是一个配置类
@PropertySource("classpath:jdbc.properties")  // 指定属性文件的路径是: classpath:jdbc.properties
public class JdbcConfig {
    @Value("${jdbc.url}")  // 通过 @Value 为属性注入值
    String url;
    @Value("${jdbc.driverClassName}")
    String driverClassName;
    @Value("${jdbc.username}")
    String username;
    @Value("${jdbc.password}")
    String password;
    @Bean              // 通过@Bean将 dataSource() 方法声明为一个注册Bean的方法，Spring会自动调用该方法，将方法的返回值加入Spring容器中。然后我们就可以在任意位置通过 @Autowired 注入DataSource了！
    public DataSource dataSource(){
        DruidDataSource dataSource = new DruidDataSource();
        dataSource.setDriverClassName(driverClassName);
        dataSource.setUrl(url);
        dataSource.setUsername(username);
        dataSource.setPassword(password);
        return dataSource;
    }
}

在 HelloController 中注入DataSource进行测试，改造代码如下：

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

然后打断点，Debug运行并查看：属性注入成功了！

3.3. Spring Boot的属性注入

想使用 spring boot 提供的属性注入方式，需要按照 spring boot 的语法规则。spring boot 的属性文件名称和 spring 不一样，默认的文件名必须是：application.properties或application.yml

在上面的案例中，我们实验了java配置方式。不过属性注入使用的是 @Value 注解。这种方式虽然可行，但是不够强大，因为它只能注入基本类型值。

在 Spring Boot 中，提供了一种新的属性注入方式，支持各种java基本数据类型及复杂类型的注入。

新建 src\main\java\com\itheima\config\JdbcProperties.java，用于进行属性注入：

package com.itheima.config;
import org.springframework.boot.context.properties.ConfigurationProperties;
@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

【注意】如果出现如下提示，项目也可以运行；

如果要去掉上述的提示，则可以在 pom.xml 文件中添加如下依赖：

<dependency>
    <groupId> org.springframework.boot </groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
    <!--不传递依赖-->
    <optional>true</optional>
</dependency>

将 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注入
1
2
@Autowired private JdbcProperties prop

构造函数注入

private JdbcProperties prop;
public JdbcConfig(Jdbcproperties prop){
    this.prop = prop;
}

声明有@Bean的方法参数注入
1
2
3
4
@Bean public Datasource dataSource(JdbcProperties prop){ // ... }
本例中，我们采用第三种方式。

测试结果；与前面的测试一样的。
大家会觉得这种方式似乎更麻烦了，事实上这种方式有更强大的功能，也是Spring Boot推荐的注入方式，下一节会讲。与@Value对比关系：
- 优势：
  - Relaxed binding：松散绑定。
    不严格要求属性文件中的属性名与成员变量名一致。支持驼峰，中划线，下划线等等转换，甚至支持对象引导。
    比如：user.friend.name：代表的是user对象中的friend属性中的name属性，显然friend也是对象。
    @value注解就难以完成这样的注入方式。
  - meta-data support：元数据支持，帮助IDE生成属性提示（写开源框架会用到）。

3.4. 更优雅的注入

事实上，如果一段属性只有一个Bean需要使用，我们无需将其注入到一个类（JdbcProperties，将该类上的所有注解去掉）中。而是直接在需要的地方声明即可；再次修改 JdbcConfig 类为如下代码：

@Configuration
public class JdbcConfig {
    @Bean
    // 声明要注入的属性前缀，Spring Boot会自动把相关属性通过set方法注入到DataSource中
    @ConfigurationProperties(prefix = "jdbc")
    public DataSource dataSource() {
        return new DruidDataSource();
    }
}

我们直接把 @ConfigurationProperties(prefix = "jdbc") 声明在需要使用的 @Bean 的方法上，然后Spring Boot就会自动调用这个Bean（此处是DataSource）的set方法，然后完成注入。使用的前提是：该类必须有对应属性的set方法！

我们将 jdbc.properties 文件中的 jdbc.url 中的数据库名改成：/heima，再次测试：

3.5. Yaml配置文件

配置文件除了可以使用 application.properties 类型，还可以使用后缀名为：.yml 或者 .yaml 的类型，也就是：application.yml 或者 application.yaml

基本格式：

jdbc:
    driverClassName: com.mysql.jdbc.Driver
    url: jdbc:mysql://127.0.0.1:3306/springboot_test
    username: root
    password: root

把 application.properties 修改为 application.yml 进行测试。

如果两个配置文件都有，会把两个文件的配置合并，如果有重复属性，以 properties 中的为准。
如果是配置数组、list、set等结构的内容，那么在yml文件中格式为：
1
2
3
key: - value1 - value2

3.6. 多个Yaml配置文件

当一个项目中有多个yml配置文件的时候，可以以 application-**.yml 命名；在 application.yml 中配置项目使用激活这些配置文件即可。

创建 application-abc.yml 文件如下：
1
2
itcast: url: http://www.itcast.cn
创建 application-def.yml 文件如下：
1
2
itheima: url: http://www.itheima.com
在 application.yml 文件中添加如下配置：
1
2
3
4
#加载其它配置文件 spring: profiles: active: abc,def
多个文件名只需要写application-之后的名称，在多个文件之间使用,隔开。

4. SpringBoot配置信息的查询

4.1 查阅SpringBoot的官方文档

上面提及过，SpringBoot的配置文件，主要的目的就是对配置信息进行修改的，但在配置时的key从哪里去查询呢？我们可以查阅SpringBoot的官方文档

文档URL：https://docs.spring.io/spring-boot/docs/2.0.1.RELEASE/reference/htmlsingle/#common-application-properties

常用的配置摘抄如下：

# QUARTZ SCHEDULER (QuartzProperties)
spring.quartz.jdbc.initialize-schema=embedded # Database schema initialization mode.
spring.quartz.jdbc.schema=classpath:org/quartz/impl/jdbcjobstore/tables_@@platform@@.sql # Path to the SQL file to use to initialize the database schema.
spring.quartz.job-store-type=memory # Quartz job store type.
spring.quartz.properties.*= # Additional Quartz Scheduler properties.

# ----------------------------------------
# WEB PROPERTIES
# ----------------------------------------

# EMBEDDED SERVER CONFIGURATION (ServerProperties)
server.port=8080 # Server HTTP port.
server.servlet.context-path= # Context path of the application.
server.servlet.path=/ # Path of the main dispatcher servlet.

# HTTP encoding (HttpEncodingProperties)
spring.http.encoding.charset=UTF-8 # Charset of HTTP requests and responses. Added to the "Content-Type" header if not set explicitly.

# JACKSON (JacksonProperties)
spring.jackson.date-format= # Date format string or a fully-qualified date format class name. For instance, `yyyy-MM-dd HH:mm:ss`.

# SPRING MVC (WebMvcProperties)
spring.mvc.servlet.load-on-startup=-1 # Load on startup priority of the dispatcher servlet.
spring.mvc.static-path-pattern=/** # Path pattern used for static resources.
spring.mvc.view.prefix= # Spring MVC view prefix.
spring.mvc.view.suffix= # Spring MVC view suffix.

# DATASOURCE (DataSourceAutoConfiguration & DataSourceProperties)
spring.datasource.driver-class-name= # Fully qualified name of the JDBC driver. Auto-detected based on the URL by default.
spring.datasource.password= # Login password of the database.
spring.datasource.url= # JDBC URL of the database.
spring.datasource.username= # Login username of the database.

# JEST (Elasticsearch HTTP client) (JestProperties)
spring.elasticsearch.jest.password= # Login password.
spring.elasticsearch.jest.proxy.host= # Proxy host the HTTP client should use.
spring.elasticsearch.jest.proxy.port= # Proxy port the HTTP client should use.
spring.elasticsearch.jest.read-timeout=3s # Read timeout.
spring.elasticsearch.jest.username= # Login username.

4.2 查看源码配置

Java

#Java

104-SpringBoot基础3-配置

https://flepeng.github.io/021-Java-01-course-104-SpringBoot基础3-配置/

作者

Lepeng

发布于

2020年2月2日

许可协议

104-SpringBoot基础3-配置原理上一篇

104-SpringBoot基础2-创建项目下一篇

104-SpringBoot基础3-配置

3. java配置应用

3.1 Spring 配置历史

3.2. 注解配置 Value

3.3. Spring Boot的属性注入

3.4. 更优雅的注入

3.5. Yaml配置文件

3.6. 多个Yaml配置文件

4. SpringBoot配置信息的查询

4.1 查阅SpringBoot的官方文档

4.2 查看源码配置

3.2. 注解配置 `Value`