理解Spring Boot配置属性注入@ConfigurationProperties和@Value

介绍： 在Spring Boot应用程序中，配置属性的注入是一项重要的功能，它允许我们将配置文件中的属性值注入到我们的代码中，以便在运行时进行配置和定制。Spring Boot提供了两种主要的注解来实现这一目的：@ConfigurationProperties和@Value。这两个注解有不同的用途和功能，本文将详细介绍它们的使用方法和示例代码。

一、@ConfigurationProperties注解 @ConfigurationProperties注解用于将配置文件中的属性值绑定到Java对象上。它提供了一种将一组相关属性绑定到一个属性对象上的便捷方式。使用@ConfigurationProperties注解的步骤如下：

1. 在应用的配置类上添加@ConfigurationProperties注解，并指定配置属性的前缀。例如，如果配置文件中的属性前缀是myapp，则注解可以定义为@ConfigurationProperties(prefix = "myapp")。
2. 在配置类中定义一个与配置文件属性对应的属性对象，并使用@Component或@ConfigurationProperties注解进行注入。属性对象的字段应与配置文件中的属性名称相匹配。
3. 在属性对象的字段上，可以使用各种注解（如@Value、@NotNull、@Valid等）对属性进行验证和处理。

示例代码如下：

 在配置文件中定义属性：

1.  
   myapp.name=My Application
2.  
   myapp.version=1

应用的配置类MyAppProperties

1.  
   @Component
2.  
   @ConfigurationProperties(prefix = "myapp")
3.  
   public class MyAppProperties {
4.  
   private String name;
5.  
   private int version;
6.  
   // 省略 getter 和 setter 方法
7.  
   }

 一旦配置文件中的myapp.name和myapp.version属性值被自动绑定到MyAppProperties对象的对应字段上，您可以通过引用MyAppProperties对象来访问这些属性值。以下是示例代码：

1.  
   @Component
2.  
   @ConfigurationProperties(prefix = "myapp")
3.  
   public class MyAppProperties {
4.  
   private String name;
5.  
   private int version;
6.  
    
7.  
   // 省略 getter 和 setter 方法
8.  
    
9.  
   public void printProperties() {
10.  
    System.out.println("Application Name: " name);
11.  
    System.out.println("Application Version: " version);
12.  
    }
13.  
    }

在上述示例中，MyAppProperties类定义了name和version属性，并提供了相应的getter和setter方法。您可以在其他组件或服务中注入MyAppProperties对象，并调用其方法来访问属性值。

在其他类需要用到配置环境中属性值中注入配置属性：

1.  
   @Service
2.  
   public class MyService {
3.  
    
4.  
   @Autowired
5.  
   private MyAppProperties myAppProperties;
6.  
    
7.  
   public void doSomething() {
8.  
   String appName = myAppProperties.getName();
9.  
   int appVersion = myAppProperties.getVersion();
10.  
    // 执行其他操作
11.  
    }
12.  
    }

在上述示例中，MyService类通过构造函数注入了MyAppProperties对象，并可以使用getter方法来获取name和version属性的值。

另外，您还可以直接在MyAppProperties类中定义其他方法，用于操作和处理这些属性值。

1.  
   @Component
2.  
   @ConfigurationProperties(prefix = "myapp")
3.  
   public class MyAppProperties {
4.  
   private String name;
5.  
   private int version;
6.  
    
7.  
   // 省略 getter 和 setter 方法
8.  
    
9.  
   public void printProperties() {
10.  
    System.out.println("Application Name: " name);
11.  
    System.out.println("Application Version: " version);
12.  
    }
13.  
     
14.  
    public String getFormattedVersion() {
15.  
    return "Version " version;
16.  
    }
17.  
    }

在上述示例中，printProperties()方法用于打印属性值，getFormattedVersion()方法用于返回格式化后的版本号。

二、@Value注解 @Value注解用于直接注入单个属性值，它提供了更灵活的属性注入方式。使用@Value注解的方法如下：

1. 将@Value注解直接应用于属性字段、构造函数参数或方法参数上。
2. 在注解中使用${}占位符指定要注入的属性值，或者使用SpEL（Spring Expression Language）表达式进行解析。

示例代码如下：

1.  
   @Component
2.  
   public class MyComponent {
3.  
   @Value("${myapp.name}")
4.  
   private String appName;
5.  
    
6.  
   @Value("${myapp.version}")
7.  
   private int appVersion;
8.  
    
9.  
   // 省略其他代码
10.  
    }

在上述示例中，${myapp.name}和${myapp.version}是从配置文件中解析的属性值，它们将被注入到appName和appVersion字段中。

需要注意的是，@Value注解也可以应用于方法参数上，用于接收运行时传递的属性值。

总结： @ConfigurationProperties注解和@Value注解是Spring Boot中常用的属性注入方式。@ConfigurationProperties适用于一组相关属性的注入，提供了对象绑定和验证的便捷方式。而@Value注解适用于单个属性的注入，提供了更灵活的属性注入方式。根据具体的需求和场景，选择合适的注解进行属性注入。

在实际开发中，可以根据项目需求选择适合的注解，并合理利用配置属性来定制和配置应用程序。

这篇好文章是转载于：学新通技术网