Spring Boot Config 配置类文件

在Spring Boot应用开发中，配置文件是非常重要的一部分。它允许我们对应用程序的行为进行配置，而不需要修改代码。Spring Boot提供了一种简单而强大的方式来管理配置文件，即通过配置类。

什么是配置类

配置类是一个带有@Configuration注解的Java类，它用于定义应用程序的配置。通过在配置类中添加相关注解和方法，我们可以将配置信息注入到Spring Boot应用程序中。

配置类允许我们在应用程序的不同环境中使用不同的配置。我们可以为开发环境、测试环境和生产环境等定义不同的配置类，并根据需要进行切换。

创建配置类

要创建一个配置类，我们需要遵循以下步骤：

  1. 创建一个新的Java类，并添加@Configuration注解。
@Configuration
public class AppConfig {
}
  1. 在配置类中定义需要的配置信息。
@Configuration
public class AppConfig {

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

    @Value("${app.version}")
    private String appVersion;

    @Bean
    public AppInfo appInfo() {
        return new AppInfo(appName, appVersion);
    }
}

在上面的示例中，我们使用了@Value注解来注入来自配置文件的值。${app.name}和${app.version}是配置文件中的属性，它们将被注入到appName和appVersion字段中。

  1. 创建一个需要配置信息的Bean。
public class AppInfo {

    private String name;
    private String version;

    public AppInfo(String name, String version) {
        this.name = name;
        this.version = version;
    }

    // getters and setters
}

在这个示例中，我们创建了一个AppInfo类，它有两个属性：name和version。我们将在配置类中创建一个AppInfo类型的Bean，并将注入的配置信息传递给它。

使用配置类

一旦我们创建了配置类，我们可以在其他组件中使用它。例如，我们可以在控制器中注入AppInfo并使用它来提供应用程序的信息。

@RestController
public class AppController {

    private final AppInfo appInfo;

    public AppController(AppInfo appInfo) {
        this.appInfo = appInfo;
    }

    @GetMapping("/info")
    public String getAppInfo() {
        return "App Name: " + appInfo.getName() + ", Version: " + appInfo.getVersion();
    }
}

在上面的代码中，我们使用构造函数注入了AppInfo实例，并在getAppInfo()方法中使用它来返回应用程序的信息。

配置文件

配置类依赖于配置文件来提供配置信息。在Spring Boot中，我们可以使用多种格式的配置文件，包括application.properties和application.yml。

下面是一个示例application.properties文件：

app.name=MyApp
app.version=1.0.0

在上面的配置文件中，我们定义了app.name和app.version两个属性，并分别设置了它们的值。

配置文件的优先级

Spring Boot允许我们在不同的环境中使用不同的配置文件。当应用程序启动时，它会根据特定的规则确定使用哪个配置文件。

以下是配置文件的优先级顺序：

  1. bootstrap.properties或bootstrap.yml（仅在使用Spring Cloud时使用）
  2. application-{profile}.properties或application-{profile}.yml
  3. application.properties或application.yml

例如，如果我们有一个名为application-dev.properties的配置文件和一个名为application.properties的配置文件，那么在开发环境中将使用前者。

总结

通过使用配置类，我们可以轻松地管理和切换应用程序的配置信息。在配置类中定义配置信息，并使用@Value注解将其注入到其他组件中。配置文件为配置类提供了值。我们还了解了配置文件的优先级顺序，以便根据需要为应用程序指定不同的配置。

参考文献：

  • [Spring Boot Configuration](
  • [Spring Boot Reference