Spring Boot读取自定义配置文件

当使用Spring Boot进行开发时，我们通常需要读取自定义的配置文件来完成一些配置的工作。这里我们就来详细讲解一下如何在Spring Boot中读取自定义配置文件，并提供两个示例进行说明。

1. 创建配置文件

首先我们需要在Spring Boot项目的src/main/resources目录下创建一个新的配置文件，例如我们为其命名为myconfig.properties。在这个文件中，我们可以定义一些需要自定义配置的属性。例如：

# myconfig.properties

myconfig.setting1=hello
myconfig.setting2=world

2. 配置读取类

接下来我们需要创建一个配置读取类，这个类会负责读取我们定义的配置文件。例如：

package com.example.myapp.config;

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

@Configuration
@ConfigurationProperties(prefix = "myconfig")
@PropertySource("classpath:myconfig.properties")
public class MyConfig {

    @Value("${myconfig.setting1}")
    private String setting1;

    @Value("${myconfig.setting2}")
    private String setting2;

    // getter and setter methods
}

这个类使用了@Configuration和@ConfigurationProperties注解用于将其标记为配置类，并读取以myconfig前缀开头的属性值。@PropertySource注解则用于指定需要读取的配置文件。@Value注解则用于获取具体的属性值。这里我们读取的是myconfig.setting1和myconfig.setting2这两个属性。可以根据实际需要进行修改和扩展。

3. 使用配置类

最后我们需要在Spring Boot应用程序中使用我们的配置类。我们可以通过在需要使用的类中注入MyConfig类的实例来使用其中的属性。例如：

package com.example.myapp.controller;

import com.example.myapp.config.MyConfig;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class MyController {

    @Autowired
    private MyConfig myConfig;

    @GetMapping("/hello")
    public String hello() {
        return myConfig.getSetting1() + " " + myConfig.getSetting2();
    }
}

这个示例中，我们在MyController中注入了MyConfig实例，并在/hello接口中使用其中的属性。

示例1：使用yml文件

除了使用.properties文件来进行配置，我们也可以使用.yml文件来进行配置。例如我们需要将上述myconfig.properties文件转换为myconfig.yml文件进行配置，那么我们可以在src/main/resources中创建myconfig.yml文件，并填充以下内容：

myconfig:
  setting1: hello
  setting2: world

读取这个文件的配置类则需要稍作修改：

package com.example.myapp.config;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;
import org.springframework.context.annotation.PropertySources;

@Configuration
@ConfigurationProperties(prefix = "myconfig")
@PropertySources({
        @PropertySource(value = "classpath:myconfig.properties", ignoreResourceNotFound = true),
        @PropertySource(value = "classpath:myconfig.yml", ignoreResourceNotFound = true)
})
public class MyConfig {

    @Value("${myconfig.setting1}")
    private String setting1;

    @Value("${myconfig.setting2}")
    private String setting2;

    // getter and setter methods
}

这个示例中，我们使用了@PropertySources注解来指定需要读取的配置文件，因为@ConfigurationProperties并不能直接读取yml文件。ignoreResourceNotFound=true表示如果找不到文件，则忽略而不是抛出异常。

示例2：使用Environment

除了在配置类中读取属性值之外，我们还可以使用Spring Boot提供的Environment类来读取自定义配置文件中的属性值。示例如下：

package com.example.myapp.controller;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.EnvironmentAware;
import org.springframework.core.env.Environment;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class MyController implements EnvironmentAware {

    private Environment environment;

    @Override
    public void setEnvironment(Environment environment) {
        this.environment = environment;
    }

    @GetMapping("/hello2")
    public String hello2() {
        return environment.getProperty("myconfig.setting1") + " " +
                environment.getProperty("myconfig.setting2");
    }
}

这个示例中，我们实现了EnvironmentAware接口，并在其中注入了Environment实例，并在/hello2接口中使用getProperty方法获取其中属性的值。

通过以上两个示例，相信大家已经能够轻松地在Spring Boot项目中读取自定义的配置文件了。