像专业人士一样在 Spring 上读取配置

引言

众所周知，Spring 提供多种实现相同目标的方法，其中一种便是如何检索配置档案中注册的值。

如果您是 Spring 新手，可能会遇到使用 @Value 注解从 application.properties 或 application.yml 文件中检索值的代码。如果您使用这种方法，请注意它并没有错；但是，您可能会在应用程序中引入不必要的复杂性。

@Value 的问题

使用 @Value 的主要问题在于处理包含其他值的变量时。这说得通吗？不明白？让我们来看一个例子：

假设您有以下配置文件：

<code>mail.user=dev@locahost
mail.password=123
mail.headers.x-from=Ekerdev
mail.headers.x-custom=custom</code>

您需要像这样操作：

@Service
public class CustomService {
    @Value("${mail.user}")
    private String user;

    @Value("${mail.password}")
    private String password;

    @Value("${mail.headers.x-from}")
    private String xFrom;

    @Value("${mail.headers.x-custom}")
    private String xCustom;
}

到目前为止，没有问题。但是现在想象一下，您的应用程序需要在代码中的多个地方使用这些相同的变量。想想我们会得到多少重复代码，对吧？

解决方案

因此，最好的解决方案是使用 @ConfigurationProperties 注解。这使得我们的应用程序更容易将变量注入到类中，我们可以像在 Spring 中使用任何其他依赖项一样使用它，如下面的示例所示：

Spring 3.x 的方案一：

@Configuration
@ConfigurationProperties("mail")
public record MailProperties(
    String user,
    String password,
    Map<String, String> headers
) {}

Spring 3.x 的方案二：

@Configuration
@ConfigurationProperties("mail.headers")
public record MailHeadersProperties(
    String xFrom,
    String xCustom
) {}

@Configuration
@ConfigurationProperties("mail")
public record MailProperties(
    String user,
    String password,
    MailHeadersProperties headers
) {}

Spring 2.x 的方案一：

@Data
@AllArgsConstructor
@ConfigurationPropertiesScan
@ConfigurationProperties("mail")
public class MailProperties {
    private String user;
    private String password;
    private Map<String, String> headers;
}

@SpringBootApplication
@ConfigurationPropertiesScan("your.package.mailproperties") //your.package.mailproperties  替换成你的包路径
public class ExampleApplication {
    public static void main(String[] args) {
        SpringApplication.run(ExampleApplication.class, args);
    }
}

您的服务使用属性如下：

@Service
@RequiredArgsConstructor
public class CustomService {
    private final MailProperties mailProperties;
}

优势

使用 @ConfigurationProperties 的主要优势在于我们不必在代码中查找 @Value 注解，这使得代码更易于阅读。

以上是像专业人士一样在 Spring 上读取配置的详细内容。更多信息请关注PHP中文网其他相关文章！