浅谈Spring Boot属性配置和自定义属性配置攻略

Spring Boot属性配置

Spring Boot通过提供大量的默认属性值来简化应用程序的配置。这些属性可以在application.properties文件中定义，也可以在application.yml文件中定义。在这两种文件类型中，属性都按照键值对的形式定义，具体的格式和语法规则可以参见官方文档。

1. application.properties

在application.properties文件中，我们可以配置一些Spring Boot应用程序的默认属性，例如：

# 数据源配置
spring.datasource.url=jdbc:mysql://localhost:3306/sample_db
spring.datasource.username=admin
spring.datasource.password=admin123

# 日志级别配置
logging.level.root=info
logging.level.com.example=debug

# 服务端口配置
server.port=8080

上述示例中，我们配置了MySQL数据库连接信息、日志级别和服务端口等属性。可以看出，Spring Boot的属性配置非常简洁明了。

2. application.yml

与application.properties不同，application.yml文件采用了层级结构的方式，例如：

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/sample_db
    username: admin
    password: admin123

logging:
  level:
    root: info
    com.example: debug

server:
  port: 8080

在本例中，我们使用和application.properties相同的属性配置信息。但是使用yml文件，属性配置信息更加清晰、易于维护。

自定义属性配置

除了默认属性之外，我们还可以定义自己的属性。自定义属性的定义方式与默认属性类似，但需要注意一些语法细节和配置规则。

1. 属性定义

首先，在我们的Spring Boot应用程序中定义属性，需要使用@ConfigurationProperties注释进行标注。例如：

@ConfigurationProperties(prefix = "greeting")
public class GreetingProperties {
    private String name;
    private String title;

    // standard getters and setters
}

在这个类中，我们定义了name和title两个属性，这些属性的前缀是greeting。我们还需要为这些属性提供标准的getter和setter方法。

这里需要注意的是，在@ConfigurationProperties注释中，我们指定了属性的前缀greeting。这个前缀将作为我们自定义属性的命名空间，所有以此前缀开头的属性名称都将被自动绑定到这个类的属性中。这个命名空间也会被添加到Spring Boot应用程序的默认属性中。

2. 属性配置

在定义属性之后，我们需要在我们的应用程序中使用这些属性。我们可以使用两种方式在应用程序中注入自定义属性：JavaConfig 和 XMLConfig。

a. JavaConfig

在JavaConfig中，可以使用@EnableConfigurationProperties和@ConfigurationPropertiesScan将自定义属性注入Spring Boot应用程序中。

@Configuration
@EnableConfigurationProperties(GreetingProperties.class)
public class ApplicationConfig {
    // Application configuration
}

在这个例子中，通过@EnableConfigurationProperties注释，我们将使用GreetingProperties类中的属性。所有以greeting为前缀的属性都将被GreetingProperties类所管理。

另外，@ConfigurationPropertiesScan注释可以自动扫描Spring Boot应用程序中的所有@ConfigurationProperties类。例如：

@Configuration
@ConfigurationPropertiesScan
public class ApplicationConfig {
    // Application configuration
}

这个例子中，我们不需要在@EnableConfigurationProperties中指定要使用的属性类，而是使用@ConfigurationPropertiesScan来扫描所有的@ConfigurationProperties类。所有以greeting为前缀的属性都会被自动绑定到GreetingProperties类中。

b. XMLConfig

在XMLConfig中，可以使用<context:property-placeholder>标签将自定义属性注入Spring Boot应用程序中。例如：

<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans.xsd
       http://www.springframework.org/schema/context
       http://www.springframework.org/schema/context/spring-context.xsd">

    <context:property-placeholder location="classpath:greeting.properties"/>

    <!-- Application configuration -->
</beans>

在这个例子中，我们使用<context:property-placeholder>标签指定了属性文件的位置。所有以greeting为前缀的属性都将被绑定到GreetingProperties类中。

3. 属性使用

在自定义属性定义和配置完成之后，我们可以在应用程序中使用这些属性。例如：

@Component
public class GreetingService {
    private GreetingProperties greetingProperties;

    public GreetingService(GreetingProperties greetingProperties) {
        this.greetingProperties = greetingProperties;
    }

    public String greet() {
        return greetingProperties.getTitle() + ", " + greetingProperties.getName() + "!";
    }
}

在这个例子中，我们使用了@Component注释，将GreetingService类注入到Spring Boot应用程序中。在GreetingService构造函数中，我们注入了一个GreetingProperties对象，并从该对象中使用自定义属性值执行操作。在本例子中，我们将返回title和name属性的前缀与值。

4. 示例

接下来我们通过两个示例来演示自定义属性的定义、配置和使用。

a. 示例一

假设我们的应用程序需要连接一个外部服务，并且我们需要在不同的环境中使用不同的连接字符串。我们可以在我们的配置属性文件中定义一个自定义属性来处理这个问题。

首先，在application.properties文件中定义一个自定义属性：

# 生产环境
myapp.datasource.url.production=jdbc:mysql://localhost:3306/myapp_prod_db
# 测试环境
myapp.datasource.url.testing=jdbc:mysql://localhost:3306/myapp_test_db

上面的代码中，我们定义了两个属性，一个用于生产环境，另一个用于测试环境。

接下来，在我们的Java代码中定义一个新的类来管理这些属性：

@ConfigurationProperties(prefix = "myapp.datasource")
public class DataSourceProperties {
    private String url;

    // standard getters and setters
}

注意，我们使用了myapp.datasource这个前缀来定义这些属性。

现在，在我们的Java代码中使用自定义属性：

@Service
public class MyService {
    private final DataSourceProperties dataSourceProperties;

    public MyService(DataSourceProperties dataSourceProperties) {
        this.dataSourceProperties = dataSourceProperties;
    }

    public String findUsers() {
        // connect to database using dataSourceProperties.getUrl()
        return "users";
    }
}

现在我们的应用程序将在不同的环境中使用不同的连接字符串。

b. 示例二

假设我们要在应用程序中使用外部的API，并且我们希望我们的API密钥能够在不同的环境中使用不同的值。我们可以配置自定义属性来处理它。

首先，在application.properties文件中定义一个自定义属性：

# 生产环境
myapp.api.key.production=PRODUCTION_API_KEY
# 测试环境
myapp.api.key.testing=TESTING_API_KEY

注意，我们将属性命名为myapp.api.key。