springboot-配置文件

什么是配置文件

配置文件就是包含配置的文件(哈哈哈哈废话文学),比如说mysql链接地址,线程池最大线程数,总而言之就是记录一些可能会用到的配置文件。

springboot的配置文件

springboot支持两种配置文件

• properties
• yaml 墙裂推荐

为什么选择压妹儿

server:
	port: 8080

因为采用树状结构,一目了然

注意:

• key的冒号后面一定要跟一个空格,例如port: 8080
• yaml格式不支持使用注解@PropertySource注解
• yaml配置文件结尾是.yml

application.yml

1. 在resource目录下新建application.yml文件
   

# 修改项目启动端口
server:
  port: 8081
  servlet:
    session:
      timeout: 30
  tomcat:
    uri-encoding: UTF-8

# 自定义配置信息
authorInfo:
  name: "fangfang"
  age: 22
  addr: "Shan Xi Lin Fen"

解释说明:

1. server 定义服务器配置
2. port: 定义访问端口
3. timeout: 30 定义session超时时间30s
4. uri-encoding: 定义tomcat的uri编码是UTF-8

读取配置信息

通过 @value("${}")来读取配置信息

package com.lu.springboot.bootdemo;

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
class BootDemoApplicationTests {

    @Value("${authorInfo.name}")
    private String name;
    @Value("${authorInfo.age}")
    private int age;
    @Value("${authorInfo.addr}")
    private String addr;


    @Test
    void contextLoads() {
        System.out.println(String.format("我叫%s,我来自%s,今年%d岁了!",name,addr,age));
    }


}

说明:

1. @SpringBootTest 表示是一个springboot的测试类
2. @Test 表示是一个测试方法
3. @Value 获取配置信息

用类装载配置信息

方式1直接装载

1. 新建一个配置配置类

2. 设置类信息

package com.lu.springboot.bootdemo.entity;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

@Component
@ConfigurationProperties(prefix = "author-info")
public class AuthorInfoProperties {
    private String name;
    private String addr;
    private int age;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getAddr() {
        return addr;
    }

    public void setAddr(String add) {
        this.addr = add;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }
}

说明:

• @Component 标注这是一个组件类
• @ConfigurationProperties 表示从配置信息读取,自动封装成一个实体类

发现报错,需要添加依赖

3. 添加maven依赖

<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-configuration-processor</artifactId>
	<version>2.5.5</version>
</dependency>

4. 测试使用

package com.lu.springboot.bootdemo;

import com.lu.springboot.bootdemo.entity.AuthorInfoProperties;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import java.util.Optional;

@SpringBootTest
public class PropertiesTest {
    // 自动装配
    @Autowired
    AuthorInfoProperties authorInfoProperties;

    @Test
    void contextLoads(){
        Optional.ofNullable(authorInfoProperties).ifPresent(info -> {
            System.out.println(info.getName());
            System.out.println(info.getAddr());
            System.out.println(info.getAge());
        });
    }
}

fangfang
Shan Xi Lin Fen
22

方式2 @Bean加载方式

package com.lu.springboot.bootdemo.entity;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class PropertiesConfiguration {
    @Bean
    @ConfigurationProperties(prefix = "author-info")
    public AuthorInfoProperties getAuthorInfoProperties(){
        return new AuthorInfoProperties();
    }
}

使用和方式1一样这里就不做详细概述了

application.properties

虽然properties用的不多,但是我们也有必要了解如何使用

author-info.addr="Shan Xi Lin Fen"
author-info.age=22
author-info.name="fang fang"

读取过程和上面相同

多环境配置

• application-dev.yml测试环境配置文件
• application-prod.yml生产环境配置文件
• application.yml主配置文件

application-dev.yml

# 开发环境配置文件


server:
  port: 8080
  

application-prod.yml

# 生产环境配置文件
server:
  port: 8090

application.yml

# 主配置文件

# 采用开发环境
spring:
  profiles:
    active: dev
    # 采用生产环境
#    active: prod

• 通过 spring.profiles.avtive 来选择环境
• 或者启动时配置 java -jar --spring.profiles.active=dev

springboot的starter

springboot 提供了很多开箱即用的starter.按需调用

使用starter

假设使用websocket
添加maven依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-websocket</artifactId>
    <version>2.5.5</version>
</dependency>

然后使用即可