怎样在 Spring Boot 中界说和读取 自界说设置

媒介

在Spring Boot中界说和读取自界说设置是一样平常开辟中常见的需求，它允许我们以机动的方式管理应用的设置信息，无论是通过外部设置文件（如application.properties或application.yml）还是通过环境变量。
作为高级步伐员，我们必要把握这一技能，以确保应用的可设置性和可维护性。以下是一个具体的步调阐明，包罗示例代码，展示怎样在Spring Boot中界说和读取自界说设置。
在Spring Boot中，你可以通过以下步调界说和读取自界说设置：

•         在application.properties或application.yml中界说自界说设置项。
  

比方，在application.yml中添加：

2. app:
3.   custom:
4.     my-property: value

复制代码

•         创建一个设置类来绑定这些属性。
  

2. import org.springframework.boot.context.properties.ConfigurationProperties;
3. import org.springframework.context.annotation.Configuration;
5. @Configuration
6. @ConfigurationProperties(prefix = "app.custom")
7. public class CustomProperties {
9.     private String myProperty;
11.     public String getMyProperty() {
12.         return myProperty;
13.     }
15.     public void setMyProperty(String myProperty) {
16.         this.myProperty = myProperty;
17.     }
18. }

复制代码

•         在Spring Bean中注入CustomProperties类来使用设置值。
  

2. import org.springframework.beans.factory.annotation.Autowired;
3. import org.springframework.stereotype.Component;
5. @Component
6. public class MyComponent {
8.     private final CustomProperties customProperties;
10.     @Autowired
11.     public MyComponent(CustomProperties customProperties) {
12.         this.customProperties = customProperties;
13.     }
15.     public void printCustomProperty() {
16.         System.out.println(customProperties.getMyProperty());
17.     }
18. }

复制代码

确保@ConfigurationProperties注解的prefix属性与你在设置文件中界说的前缀相匹配。Spring Boot会主动将设置属性绑定到CustomProperties类的字段上。然后你可以在应用步伐的任何部分通过主动装配的方式来使用这些设置值。
大概：
界说自界说设置属性

2. # application.properties
3. myapp.name=Spring Boot Application
4. myapp.description=This is a demo application for custom configuration
5. myapp.server.port=8081

复制代码

创建设置类

接下来，我们必要创建一个设置类来绑定这些自界说属性。在Spring Boot中，这通常通过@ConfigurationProperties注解实现，它允许我们将设置文件中的属性绑定到JavaBean上。

2. import org.springframework.boot.context.properties.ConfigurationProperties;
3. import org.springframework.context.annotation.Configuration;
5. @Configuration
6. @ConfigurationProperties(prefix = "myapp")
7. public class MyAppConfig {
9.     private String name;
10.     private String description;
11.     private int serverPort;
13.     // 标准的getter和setter方法
14.     public String getName() {
15.         return name;
16.     }
18.     public void setName(String name) {
19.         this.name = name;
20.     }
22.     public String getDescription() {
23.         return description;
24.     }
26.     public void setDescription(String description) {
27.         this.description = description;
28.     }
30.     public int getServerPort() {
31.         return serverPort;
32.     }
34.     public void setServerPort(int serverPort) {
35.         this.serverPort = serverPort;
36.     }
37. }

复制代码

留意，@ConfigurationProperties(prefix = "myapp")注解指定了设置属性的前缀为myapp，如许Spring Boot就能主动将application.properties中全部以myapp开头的属性绑定到MyAppConfig类的相应字段上。 
读取设置

我们可以在应用的任何地方通过依赖注入的方式读取这些设置。比方，在一个Controller中

2. import org.springframework.beans.factory.annotation.Autowired;
3. import org.springframework.web.bind.annotation.GetMapping;
4. import org.springframework.web.bind.annotation.RestController;
6. @RestController
7. public class MyAppConfigController {
9.     private final MyAppConfig myAppConfig;
11.     @Autowired
12.     public MyAppConfigController(MyAppConfig myAppConfig) {
13.         this.myAppConfig = myAppConfig;
14.     }
16.     @GetMapping("/config")
17.     public String getConfig() {
18.         return "Name: " + myAppConfig.getName() + ", Description: " + myAppConfig.getDescription() + ", Server Port: " + myAppConfig.getServerPort();
19.     }
20. }

复制代码

总结

通过上述步调，我们乐成地在Spring Boot中界说了自界说设置属性，并通过@ConfigurationProperties注解将它们绑定到了JavaBean上。末了，我们通过依赖注入的方式在应用中读取这些设置。这种方式不但进步了代码的可读性和可维护性，还使得设置管理变得更加机动和方便。在现实开辟中，公道使用Spring Boot的设置管理功能，可以大大提升应用的机动性和可扩展性。