【Spring】配置文件的使用

在Spring框架中，application.properties（或application.yml）文件用于配置Spring应用程序的各种属性。我们可以通过多种方式来使用这些配置，包括使用@Value和@ConfigurationProperties注解来绑定配置到Java对象。

下面是对不同配置类型的说明，以及如何在代码中使用它们的示例。

1. 配置变量（单个属性）

可以在application.properties文件中定义简单的属性。例如：

app.name=MyApplication
app.version=1.0.0

然后，可以通过@Value注解注入这些属性：

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Component
public class AppConfig {
    
    @Value("${app.name}")
    private String appName;

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

    // 其他方法
}

2. 配置对象（使用@ConfigurationProperties）

当需要将一组相关的属性映射到一个Java对象中时，可以使用@ConfigurationProperties注解。

首先，在application.properties中定义一组属性：

app.db.url=jdbc:mysql://localhost:3306/mydb
app.db.username=root
app.db.password=secret

接下来，创建一个配置类：

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

@Component
@ConfigurationProperties(prefix = "app.db")
public class DatabaseProperties {
    
    private String url;
    private String username;
    private String password;

    // Getters and Setters
    public String getUrl() {
        return url;
    }

    public void setUrl(String url) {
        this.url = url;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }
}

3. 配置集合

如果有一组相同类型的属性，可以将它们配置为集合。在application.properties中这样定义：

app.servers[0]=server1.example.com
app.servers[1]=server2.example.com
app.servers[2]=server3.example.com

然后，可以在一个配置对象中使用List来接收这些配置：

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

import java.util.List;

@Component
@ConfigurationProperties(prefix = "app")
public class AppConfig {
    
    private List<String> servers;

    // Getter and Setter
    public List<String> getServers() {
        return servers;
    }

    public void setServers(List<String> servers) {
        this.servers = servers;
    }
}

4. 配置Map

如果需要将配置映射为Map, 可以这样做：

在application.properties中：

app.features.feature1.enabled=true
app.features.feature1.name=Feature 1
app.features.feature2.enabled=false
app.features.feature2.name=Feature 2

然后，可以使用Map来接收这些配置信息：

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

import java.util.Map;

@Component
@ConfigurationProperties(prefix = "app.features")
public class FeaturesProperties {
    
    private Map<String, Feature> features;

    // Getter and Setter
    public Map<String, Feature> getFeatures() {
        return features;
    }

    public void setFeatures(Map<String, Feature> features) {
        this.features = features;
    }

    public static class Feature {
        private boolean enabled;
        private String name;

        // Getters and Setters
        public boolean isEnabled() {
            return enabled;
        }

        public void setEnabled(boolean enabled) {
            this.enabled = enabled;
        }

        public String getName() {
            return name;
        }

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

总结

• @Value适合读取单个简单属性。
• @ConfigurationProperties适用于一组相关的属性，可以是集合或Map，能更好地组织属性。
• 配置文件的内容可以灵活地根据需要进行管理和访问，使得Spring应用程序的配置更为集中和清晰。