当前位置: 移动技术网 > IT编程>开发语言>Java > Spring Boot 配置元数据指南

Spring Boot 配置元数据指南

2019年10月24日  | 移动技术网IT编程  | 我要评论

1. 概览

在编写 spring boot 应用程序时,将配置属性映射到 java bean 上是非常有用的。但是,记录这些属性的最好方法是什么呢?

在本教程中,我们将探讨 spring boot configuration processor关联的 json 元数据文件,该 json 文档记录每个属性的含义、约束等。

2. 配置元数据

作为开发人员,我们开发的大多数应用程序在某种程度上必须是可配置的。但是在通常情况下,我们并不能够真正的理解配置参数的作用,比如它有默认值,又或者是过时的,有时我们甚至不知道该属性的存在。

为了帮助我们理清楚,spring boot 生成了配置元数据的 json 文件,为我们提供关于如何使用属性的有用信息。所以,配置元数据是一个描述性文件,它包含与配置属性交互所需的必要信息。

这个文件的好处是 ide 也能读懂它,从而为我们提供自动完成 spring 属性配置的工作,以及其他配置提示。

3. 依赖

为了生成此配置元数据,我们将使用 .

因此,让我们继续将依赖项添加为可选依赖

<dependency>    
    <groupid>org.springframework.boot</groupid>
    <artifactid>spring-boot-configuration-processor</artifactid>
    <version>2.1.7.release</version>
    <optional>true</optional>
</dependency>

这种依赖关系将为我们提供在构建项目时调用的 java 注解处理器。我们稍后会详细讨论这个问题。

为了防止 @configurationproperties 不应用于我们的项目使用的其他模块,在 maven 中添加依赖项为可选依赖 是最好的做法。

4. 配置属性示例

现在来研究处理器是怎么工作的,我们需要使用 java bean 获取在 spring boot 应用程序中包含一些属性:

@configuration
@configurationproperties(prefix = "database")
public class databaseproperties {
    
    public static class server {
        private string ip;
        private int port;
        
        // standard getters and setters
    }

    private string username;
    private string password;
    private server server;
    
    // standard getters and setters
}

要做到这一点,我们可以使用 @configurationproperties 注解。配置处理器会扫描使用了此注解的类和方法,用来访问配置参数并生成配置元数据。

让我们将这些属性中添加到属性文件中。在示例中,我们把文件命名为 databaseproperties-test.properties

#simple properties
database.username=baeldung
database.password=password

我们还将添加一个测试,以确保我们都做对了:

@runwith(springrunner.class)
@springboottest(classes = annotationprocessorapplication.class)
@testpropertysource("classpath:databaseproperties-test.properties")
public class databasepropertiesintegrationtest {

    @autowired
    private databaseproperties databaseproperties;

    @test
    public void whensimplepropertyqueriedthenreturnspropertyvalue() 
      throws exception {
        assert.assertequals("incorrectly bound username property", 
          "baeldung", databaseproperties.getusername());
        assert.assertequals("incorrectly bound password property", 
          "password", databaseproperties.getpassword());
    }
    
}

我们通过内部类 server 还添加了嵌套属性 database.server.iddatabase.server.port我们应该添加内部类 server 以及一个 server 的属性并且生成他的 getter 和 setter 方法。

在我们的测试中,让我们快速检查一下,确保我们也可以成功地设置和读取嵌套属性:

@test
public void whennestedpropertyqueriedthenreturnspropertyvalue() 
  throws exception {
    assert.assertequals("incorrectly bound server ip nested property",
      "127.0.0.1", databaseproperties.getserver().getip());
    assert.assertequals("incorrectly bound server port nested property", 
      3306, databaseproperties.getserver().getport());
}

好了,现在我们准备好来使用处理器了。

5. 生成配置元数据

我们在前面提到过,配置处理器生成一个文件 – 它是使用注解处理实现的。

所以,在编译我们的项目之后,我们将在目录 target/classes/meta-inf 下看到文件名为 spring-configuration-metadata.json 的文件:

{
  "groups": [
    {
      "name": "database",
      "type": "com.baeldung.autoconfiguration.annotationprocessor.databaseproperties",
      "sourcetype": "com.baeldung.autoconfiguration.annotationprocessor.databaseproperties"
    },
    {
      "name": "database.server",
      "type": "com.baeldung.autoconfiguration.annotationprocessor.databaseproperties$server",
      "sourcetype": "com.baeldung.autoconfiguration.annotationprocessor.databaseproperties",
      "sourcemethod": "getserver()"
    }
  ],
  "properties": [
    {
      "name": "database.password",
      "type": "java.lang.string",
      "sourcetype": "com.baeldung.autoconfiguration.annotationprocessor.databaseproperties"
    },
    {
      "name": "database.server.ip",
      "type": "java.lang.string",
      "sourcetype": "com.baeldung.autoconfiguration.annotationprocessor.databaseproperties$server"
    },
    {
      "name": "database.server.port",
      "type": "java.lang.integer",
      "sourcetype": "com.baeldung.autoconfiguration.annotationprocessor.databaseproperties$server",
      "defaultvalue": 0
    },
    {
      "name": "database.username",
      "type": "java.lang.string",
      "sourcetype": "com.baeldung.autoconfiguration.annotationprocessor.databaseproperties"
    }
  ],
  "hints": []
}

接下来,让我们看看更改 java bean 上的注解如何影响元数据。

5.1. 关于配置元数据的其他信息

首先,让我们将 javadoc 注释添加到server 上.

第二,让我们给出一个 database.server.port 字段的默认值并最后添加 @min@max 注解:

public static class server {

    /**
     * the ip of the database server
     */
    private string ip;

    /**
     * the port of the database server.
     * the default value is 443.
     * the allowed values are in the range 400-4000.
     */
    @min(400)
    @max(800)
    private int port = 443;

    // standard getters and setters
}

如果我们检查 spring-configuration-metadata.json 文件,我们将看到这些额外的信息得到了反映:

{
  "groups": [
    {
      "name": "database",
      "type": "com.baeldung.autoconfiguration.annotationprocessor.databaseproperties",
      "sourcetype": "com.baeldung.autoconfiguration.annotationprocessor.databaseproperties"
    },
    {
      "name": "database.server",
      "type": "com.baeldung.autoconfiguration.annotationprocessor.databaseproperties$server",
      "sourcetype": "com.baeldung.autoconfiguration.annotationprocessor.databaseproperties",
      "sourcemethod": "getserver()"
    }
  ],
  "properties": [
    {
      "name": "database.password",
      "type": "java.lang.string",
      "sourcetype": "com.baeldung.autoconfiguration.annotationprocessor.databaseproperties"
    },
    {
      "name": "database.server.ip",
      "type": "java.lang.string",
      "description": "the ip of the database server",
      "sourcetype": "com.baeldung.autoconfiguration.annotationprocessor.databaseproperties$server"
    },
    {
      "name": "database.server.port",
      "type": "java.lang.integer",
      "description": "the port of the database server. the default value is 443.
        the allowed values are in the range 400-4000",
      "sourcetype": "com.baeldung.autoconfiguration.annotationprocessor.databaseproperties$server",
      "defaultvalue": 443
    },
    {
      "name": "database.username",
      "type": "java.lang.string",
      "sourcetype": "com.baeldung.autoconfiguration.annotationprocessor.databaseproperties"
    }
  ],
  "hints": []
}

我们可以找到 database.server.ipdatabase.server.port 属性的不同之处。事实上,额外的信息是非常有帮助的。开发人员和 ide 都更容易理解每个属性的功能。

我们还应该确保触发构建以获得更新的文件。在eclipse中,如果我们检查自动生成选项时,每个保存操作都将触发生成。在 intellij 中,我们应该手动触发构建。

5.2. 理解元数据格式

让我们仔细看看 json 元数据文件,并讨论其组成。

groups 是用于分组其他属性的较高级别的项,而不指定值本身。在我们的例子中,我们有数据库组,它也是配置属性的前缀。我们还有一个 database 组,它是通过内部类把 ipport 属性作为一个组。

属性是可以为其指定值的配置项。这些属性配置在后缀为 .properties或 .yml* 文件中,并且可以有额外的信息,比如默认值和验证,就像我们在上面的示例中看到的那样。

提示是帮助用户设置属性值的附加信息。例如,如果我们有一组属性的允许值,我们可以提供每个属性的描述。ide 将为这些提示提供自动选择的帮助。

配置元数据上的每个组成都有自己的。来解释配置属性的详细用法。

6. 总结

在本文中,我们介绍了 spring boot 配置处理器及其创建配置元数据的功能。使用元数据可以使与配置参数的交互变得更加容易。

我们给出了一个生成的配置元数据的示例,并详细解释了它的格式和组成。

我们还看到了 ide 上的自动完成支持是多么有帮助。

与往常一样,本文中提到的所有代码片段都可以在我们的 github 存储库

原文:https://www.baeldung.com/spring-boot-configuration-metadata

作者:dionis prifti

译者:遗失的拂晓


9月福利,关注公众号

后台回复:004,领取8月翻译集锦!

往期福利回复:001,002, 003即可领取!

img

如对本文有疑问, 点击进行留言回复!!

相关文章:

验证码:
移动技术网