SpringBoot项目—读取自定义配置文件

SpringBoot项目 —— 读取配置文件及自定义配置文件
springBoot 读取配置文件自定义数据
springBoot 读取配置文件 —— 详细

二、读取自定义配置文件

1、快速步骤

1. 创建自定义配置文件

1. SpringBoot项目只默认支持 properties 配置文件
2. 若想使用 yml 配置文件，
    2.1 可以重写对应工厂方法，这里不做具体说明；
    2.2 或者使用 @Value 在配置类所有属性上指定对应读取的值

2. 将配置绑定到实体类

@Configuration //将配置文件与实体类绑定
@PropertySource(value = "classpath:/config/userinfo.properties") //指明配置文件的位置
@ConfigurationProperties(prefix = "userinfo") //指明配置文件的名称

3. 在调用类中注册实体类

@Autowired
UserInfoConfig userInfoConfig;

2、具体实例

1.创建配置文件

1.1 使用properties文件，在resources/config 目录下创建配置文件 userinfo.properties:

userinfo.name=xiaoming
userinfo.age=25
userinfo.city=HangZhou

1.2 使用yml文件，在resources/config 目录下创建配置文件 userinfo.yml:

userinfo:
	name: xiaoming
	age: 25
	city: HangZhou

2. 将配置绑定到实体类

UserInfo.java

2.1 对应 properties 文件

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

/**
 * 用户信息类
 */
@Data
@Configuration   //将配置文件与实体类绑定
@PropertySource(value = "classpath:/config/userInfo.properties")  //指明配置文件的位置
@ConfigurationProperties(prefix = "userinfo")  //指明配置文件的名称
public class UserInfoConfig {

    private String name;
    
    private int age;
    
    private String city;

}

2.2 对应 yml 文件

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

/**
 * 用户信息类
 */
@Data
@Configuration   //将配置文件与实体类绑定
@PropertySource(value = "classpath:/config/userinfo.yml")  //指明配置文件的位置
@ConfigurationProperties(prefix = "userinfo")  //指明配置文件的名称
public class UserInfoConfig {

    @Value("${name}")
    private String name;

    @Value("${age}")
    private int age;

    @Value("${city}")
    private String city;

}

3. 控制器中注册实体类

UserInfoController.java

import com.gui.hello.domain.UserInfo;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController //结果返回json
@RequestMapping("/userinfo")
public class UserInfoController {

    @Autowired
    UserInfoConfig userInfoConfig;

    @RequestMapping("/hello")
    public String hello(){
        return "我的名字叫" + userInfoConfig.getName() 
        + "，我今年" + userInfoConfig.getAge()
        + "岁了，我住在" + userInfoConfig.getCity();
       //执行结果：我的名字叫 xiaoming ，我今年 25 岁了，我住在 HangZhou 
    }
}

4、运行结果