重新认识Spring Boot（八）Spring Boot 基础（下）-配置文件

男娘i 2022-11-21 04:20 181阅读 0赞

**目录**

1、使用配置文件

2、演示如何使用application.yml文件

2.1、创建application.yml文件

2.2、配置application.yml文件

2.3、编写测试

2.4、新建一个GetPersonInfoProperties类

2.5、获取配置项的personinfo 的值

3、演示如何使用application.peroperties文件

3.1、编写配置项

3.2、编写类文件处理配置项

3.3、编写测试、获取配置项的值

4、用appliction.yml和appliction.properties配置多环境

4.1、application.yml进行配置

4.2、application.properties文件进行配置

5、Spring Boot 的 starter

5.1、了解 starter

5.2、使用 Starter

--------------------

前言

参考书是 龙中华 《Spring Boot 实战派》

相关链接：

[https://blog.csdn.net/u013840066/article/details/104070447][https_blog.csdn.net_u013840066_article_details_104070447]

--------------------

# 1、使用配置文件 #

Spring Boot支持使用 properties 和yaml 两种配置方式，

两者功能类似，都能完成 Spring Boot配置 但是properties优先级要高于YAML（.yml为后缀）。

YAML语言的好处是：采用了树状结构，一目了然，但是要注意几点：

1、在properties文件中的以“.”分隔的key变成树状结构，比如

![20201030161509532.png][]

会变成

![20201030161530116.png][]

2、在key后面的冒号一定要跟一个空格 比如：

port: 8080

3、如果把原有的application.properties删除 建议执行一下命令

maven -X clean install

YAML格式不支持注解@PropertySource导入配置

--------------------

# 2、演示如何使用application.yml文件 #

## 2.1、创建application.yml文件 ##

新建项目，然后把application.properties改为properties.yml。（如果不存在application.properties,可以直接创建YAML文件）

## ![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MTk4MTgx_size_16_color_FFFFFF_t_70][] ##

--------------------

## 2.2、配置application.yml文件 ##

可以进行部分参数配置，比如：

server:
      port: 8081
      servlet:
         session:
           timeout: 30ms
      tomcat:
        uri-encoding: UTF-8
    
    age: 19
    name: shuaiqiguodagou
    personinfo:
      name: shuaiqiguoergou
      age: 32
    
    #代码解释如下:
    #server 定义服务器的配置
    #Port 定义要访问的端口是8081 默认是8080
    #timeout 30 定义session的超时时间是30s
    #uri-encoding UTF-8 定义URI编码是UTF-8格式

## 2.3、编写测试 ##

代码：

package com.zqj.helloworld;
    
    import org.junit.jupiter.api.Test;
    import org.junit.runner.RunWith;
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.boot.test.context.SpringBootTest;
    import org.springframework.test.context.junit4.SpringRunner;
    
    @SpringBootTest
    @RunWith(SpringRunner.class)
    class HelloWorldApplicationTests {
    
    	/**
    	 * 获取配置文件中的age
    	 */
    	@Value("${age}")
    	private int age;
    
    	/**
    	 * 获取配置文件中的name
    	 */
    	@Value("${name}")
    	private String name;
    
    	/**
    	 * @Test : 标识注解一个测试方法
    	 *
    	 */
    	@Test
    	public void getParams(){
    		System.out.println(age);
    		System.out.println(name);
    	}
    
    }

结果：

![20201030172411868.png][]

代码解释如下：

<table> 
 <tbody> 
  <tr> 
   <td>@SpringBootTest</td> 
   <td>用于测试的注解，可指定入口类或者测试环境等</td> 
  </tr> 
  <tr> 
   <td>@RunWith(SpringRunner.class)</td> 
   <td>在Spring测试环境中进行测试</td> 
  </tr> 
  <tr> 
   <td>@Test</td> 
   <td>表示一个测试方法</td> 
  </tr> 
  <tr> 
   <td>@Value</td> 
   <td>获取配置文件中的值</td> 
  </tr> 
 </tbody> 
</table>

--------------------

## 2.4、新建一个GetPersonInfoProperties类 ##

1、定义实体类，已装载配置文件的信息，并用于处理配置文件中 以“personInfo”为前缀的配置项的值

@Component
    @ConfigurationProperties(prefix = "personinfo")
    public class GetPersonInfoProperties {
    
       private String name;
    
       private int age;
    
        public String getName() {
            return name;
        }
    
        public void setName(String name) {
            this.name = name;
        }
    
        public int getAge() {
            return age;
        }
    
        public void setAge(int age) {
            this.age = age;
        }
    }

代码解释如下：

<table> 
 <tbody> 
  <tr> 
   <td>@Component</td> 
   <td>声明此类是Spring管理类，常用在无法用@Service、@Repository描述的Spring管理类上，相当于通用的注解</td> 
  </tr> 
  <tr> 
   <td>@ConfigurationProperties</td> 
   <td>把同类配置信息自动封装为一个实体类，其属性prefix代表配置文件中配置项的前缀，如配置文件中定义的“personinfo”</td> 
  </tr> 
 </tbody> 
</table>

当然 还可以把@ConfigurationProperties直接定义在@bean的注解里，这时Bean实体类就不需要@Component和@ConfigurationProperties直接了。在调用时一样调用，比如：（这个我无法测试通过，有大佬可以讲解一下）

@Bean
        @ConfigurationProperties(prefix = "personinfo")
        public GetPersonInfoProperties getPersonInfoProperties(){
            return new GetPersonInfoProperties();
        }

## 2.5、获取配置项的personinfo 的值 ##

通过测试方法进行注入GetPersonInfoProperties类，并获取配置项“personinfo”的name和age

@RunWith(SpringRunner.class)
    @SpringBootTest
    public class HelloWorldApplicationTests {
    
    
    	@Autowired
    	private GetPersonInfoProperties getPersonInfoProperties;
    
    	@Test
    	public void getPersonInfoTest(){
    		System.out.println(getPersonInfoProperties.getName()+"____"+getPersonInfoProperties.getAge());
    	}
    }

（如果出现报错，需要引用配置依赖）

<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-configuration-processor</artifactId>
    			<optional>true</optional>
    		</dependency>

结果为：（和YAML文件配置一样）

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MTk4MTgx_size_16_color_FFFFFF_t_70 1][]

--------------------

# 3、演示如何使用application.peroperties文件 #

## 3.1、编写配置项 ##

在propertie文件中添加配置项和值，用于测试

com.zqj.name=${name:帅气过二狗}
    com.zqj.age=18
    com.zqj.address[0]=北京
    com.zqj.address[1]=成都
    com.zqj.address[2]=纳溪

## 3.2、编写类文件处理配置项 ##

@Data
    @Component
    @ConfigurationProperties(prefix = "com.zqj")
    public class CoExample {
    
        private String namme;
    
        private int age;
    
        private List<String> address;
    
        /**
         * 代码解释如下：
         * @Component : 声明此类是Spring管理的类 常用在无法用@service @repository 描述的Spring 管理类上 相当于通用的注解
         * @ConfigurationProperties: 注入applicaion.properties配置的配置项
         * @Data： 自动生成实体类相关方法
         */
    }

## 3.3、编写测试、获取配置项的值 ##

@SpringBootTest
    @RunWith(SpringRunner.class)
    class PropertiesDemoApplicationTests {
    
    	@Autowired
    	private CoExample coExample;
    
    	@Test
    	public void getInfosTest(){
    		System.out.println(coExample.getName()+"_"+coExample.getAge()+"_"+coExample.getAddress());
    	}
    
    }

**注意：如果出现中文乱码：需要都在菜单栏中“”File->Settings->Editor->File Encoding"中将Properties Files(\*.properties)下面的Default Encoding  for properties file 设置为 UTF-8 ,并勾选 Transparent native-to-asciiconversion 复选框 如果不行 。可以删除该文件，再重新创建**

**比如这样：**

![20201103204156383.png][]

需要进行修改：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MTk4MTgx_size_16_color_FFFFFF_t_70 2][]

删除properties文件并新建

删除前：

![20201103204405404.png][]

新创后：

![20201103204540127.png][]

最后的运行结果为：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MTk4MTgx_size_16_color_FFFFFF_t_70 3][]

--------------------

# 4、用appliction.yml和appliction.properties配置多环境 #

##   4.1、application.yml进行配置 ##

首先创建三个YAML文件(application.yml、application-dev.yml、application-prod.yml) 分别指 主配置文件、测试(开发）环境、生产环境）

分别对YAML文件进行配置

1、application-dev.yml

server:
      port: 8080
      servlet:
        session:
          timeout: 30
      tomcat:
        uri-encoding: UTF-8
    
    myenvironment:
      name: 开发环境

2、application-prod.yml

server:
      port: 8080
      servlet:
        session:
          timeout: 30
      tomcat:
        uri-encoding: UTF-8
    
    myenvironment:
      name: 生产环境

3、配置主配置文件

注意：active 命令是表示当前设定生效的dev文件，如果要进行发布需要将active的值改为"prod"

spring:
      profiles:
        active: dev

运行：获取myenviroment的值。

@RunWith(SpringRunner.class)
    @SpringBootTest
    public class MultiYmlDemoApplicationTests {
    
    	@Test
    	public void contextLoads() {
    	}
    	@Value("${myenvironment.name}")
    	private String name;
    	@Test
    	public void getMyEnvironment() {
    		System.out.println(name);
    
    	}
    }

最后得到是“开发环境”

--------------------

# #

## 4.2、application.properties文件进行配置 ##

配置方式和YAML一样，创建：application.properties、application-dev.properties、application-prod.properties

然后在配置文件中进行选择：

spring.profiles.active=dev

最后 可以在运行JAR包的时候指定配置文件。如果要启动pro配置文件

可以进行运行如下：

java -jar projectNam.jar --spring.properties.active=pro

--------------------

# 5、Spring Boot 的 starter #

##   5.1、了解 starter ##

Spring boot 为了简化配置，提供了非常多的 Starter ，先打包好与常用模块的所有JAR 包 ，并完成自动配置，然后组装成Starter（如把WEB相关的 Spring MVC 、容器等打包后组装成 Spring-boot-starter-web ）这使得开发业务代码时不需要过多的关注框架的配置，而是只需要关心业务逻辑即可。

常见的Spring Boot Starter 近50种。常用的有如下：

<table> 
 <tbody> 
  <tr> 
   <td>starter</td> 
   <td> <p>说明</p> </td> 
  </tr> 
  <tr> 
   <td>Spring-boot-starter-web</td> 
   <td>用于构建web，包含RESTful风格框架，Spring MVC 和模式嵌入的TOMCAT容器</td> 
  </tr> 
  <tr> 
   <td>Spring-boot-starter-test</td> 
   <td>用于测试</td> 
  </tr> 
  <tr> 
   <td>Spring-boot-starter-data-jpa</td> 
   <td>带有hibernate的Spring Data Jpa</td> 
  </tr> 
  <tr> 
   <td>Spring-boot-starter-jdbc</td> 
   <td>传统的jdb,轻量级应用可以使用，学习成本低，但最还是用JPA或者mybatis</td> 
  </tr> 
  <tr> 
   <td>Spring-boot-starter-Thymeleaf</td> 
   <td>支持Thymeleaf模板</td> 
  </tr> 
  <tr> 
   <td>Spring-boot-starter-mail</td> 
   <td>支持 java mail&nbsp; 或者 Spring mail 发送邮件</td> 
  </tr> 
  <tr> 
   <td>Spring-boot-starter-integration</td> 
   <td>Spring 框架创建的一个API&nbsp; 面向企业应用集成（EAI）</td> 
  </tr> 
  <tr> 
   <td>Spring-boot-starter-mobile</td> 
   <td>Spring MVC 的扩展，用来简化手机上的Web应用程序开发</td> 
  </tr> 
  <tr> 
   <td>Spring-boot-starter-validation</td> 
   <td> <p>Bean validation 是一个数据验证的规范，hibernate Validator是一个数据验证的框架</p> </td> 
  </tr> 
  <tr> 
   <td>Spring-boot-starter-websocket</td> 
   <td>相对于非持久的协议HTTP，WebSocket是一个持久化的协议</td> 
  </tr> 
  <tr> 
   <td>Spring-boot-starter-Security</td> 
   <td>进行身份验证和授权</td> 
  </tr> 
  <tr> 
   <td> <p>Spring-boot-starter-data-rest</p> </td> 
   <td>使用Spring Data REST 公布简单REST服务</td> 
  </tr> 
  <tr> 
   <td>Spring-boot-starter-oas</td> 
   <td>为服务添加 HATEOAS服务</td> 
  </tr> 
 </tbody> 
</table>

如果要查看全部的Starter，可以[访问官网][Link 1]

--------------------

## 5.2、使用 Starter ##

比如 要使用JPA操作数据库 ，只要添加依赖即可。

如果依赖没有版本号，则Spring Boot 会根据自己的版本号进行自动关联，也可以自行加上version元素。

<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-jpa</artifactId>
    		</dependency>

结尾：

做了两年开发，发现对Spring Boot 的认知上缺少了很多东西。因此想重新认识 Spring Boot 框架 仅此而已。

[https_blog.csdn.net_u013840066_article_details_104070447]: https://blog.csdn.net/u013840066/article/details/104070447
[20201030161509532.png]: /images/20221120/079b28433c864a0c9d9a333adcb59b3c.png
[20201030161530116.png]: /images/20221120/37324e3f1112499f8f719931ef993e10.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MTk4MTgx_size_16_color_FFFFFF_t_70]: /images/20221120/08582b498839432fa363b20cb0f883d0.png
[20201030172411868.png]: /images/20221120/0c6bb26c87ad42de96edfd9a4de81a1e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MTk4MTgx_size_16_color_FFFFFF_t_70 1]: /images/20221120/8ad0894b92a744979e59b3df596d5875.png
[20201103204156383.png]: /images/20221120/8f57cd8517b346ef998a4bb2956e35c8.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MTk4MTgx_size_16_color_FFFFFF_t_70 2]: /images/20221120/fdc768aba8c545bea527f6f6f722fe55.png
[20201103204405404.png]: /images/20221120/d615df886e73463d8b1b0755d073a3fe.png
[20201103204540127.png]: /images/20221120/64dabef0cae34c8886f594859cdd340e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MTk4MTgx_size_16_color_FFFFFF_t_70 3]: /images/20221120/74de3b7824924ceab9ce29f586d60b43.png
[Link 1]: https://docs.spring.io/spring-boot/docs/2.1.13.RELEASE/reference/htmlsingle/