Shulou(Shulou.com)06/02 Report--

This article mainly introduces springboot how to use additional-spring-configuration-metadata.json custom tips, the article is very detailed, has a certain reference value, interested friends must read it!

An official article explains the role of Configuration Metadata in great detail. Interested partners can check it out (configure metadata).

Configuration Metadata

Appendix B. Configuration MetadataSpring Boot jars include metadata files that provide details of all supported configuration properties. The files are designed to let IDE developers offer contextual help and "code completion" as users are working with application.properties or application.yml files.The majority of the metadata file is generated automatically at compile time by processing all items annotated with @ ConfigurationProperties. However, it is possible to write part of the metadata manually for corner cases or more advanced use cases.

Introduction: after configuring the additional-spring-configuration-metadata.json file, it is very effective to complete the prompt under the application.properties or application.yml file in the developer's IDE tool to read the configuration written by yourself.

Use 1. Metadata format

The configuration metadata file is located under jar. META-INF/spring-configuration-metadata.json they use the simple JSON format, where items are classified under "groups" or "properties", and other values prompt for classification under "hints", as shown in the following example:

{"groups": [{"name": "server", "type": "org.springframework.boot.autoconfigure.web.ServerProperties", "sourceType": "org.springframework.boot.autoconfigure.web.ServerProperties"}.], "properties": [{"name": "server.port" "type": "java.lang.Integer", "sourceType": "org.springframework.boot.autoconfigure.web.ServerProperties"}.], "hints": [{"name": "spring.jpa.hibernate.ddl-auto" "values": [{"value": "none", "description": "Disable DDL handling."}, {"value": "validate" "description": "Validate the schema, make no changes to the database."}]} 2.properties prompt to write

Of course, we need to write META-INF/additional-spring-configuration-metadata.json to extend it.

Let's simply create a starter to prompt using additional-spring-configuration-metadata.json.

Create an additional-spring-configuration-metadata.json under the resources/META-INF directory

The contents are roughly as follows:

{"properties": [{"name": "swagger.basePackage", "type": "java.lang.String", "description": "document scan package path." }, {"name": "swagger.title", "type": "java.lang.String", "defaultValue": "platform system interface details", "description": "title such as: user module system interface details." }, {"name": "swagger.description", "type": "java.lang.String", "defaultValue": "online documentation", "description": "Service File introduction." }, {"name": "swagger.termsOfServiceUrl", "type": "java.lang.String", "defaultValue": "https://www.test.com/"," description ":" terms of Service URL. " }, {"name": "swagger.version", "type": "java.lang.String", "defaultValue": "V1.0", "description": "version." }]}

Please refer to the following properties table for configuration understanding.

The full name of the name type destination nameString attribute. The name is in the form of cycle separation in lowercase (for example, server.address). This property is mandatory. The full signature of the data type of the typeString property (for example, java.lang.String), but is also a complete generic type (for example, java.util.Map). You can use this property to guide the types of values that users can enter. To maintain consistency, specify the type of primitive by using its wrapper counterpart (for example, boolean becomes java.lang.Boolean). Note that this class may be a complex type that is converted from the value of the Stringas binding. If the type is unknown, it can be omitted. A short description of the group that descriptionString can display to the user. If no description is available, it can be omitted. The recommendation is described as a short paragraph, and the first line provides a concise summary. The last line in the description should end with a period (.). The class name of the source from which the sourceTypeString contributes this attribute. For example, if the property comes from the annotated class @ ConfigurationProperties, this property will contain the fully qualified name of the class. If the source type is unknown, it can be omitted. The defaultValueObject default value, which is used if no attribute is specified. If the type of the property is an array, it can be an array of values. If the default value is unknown, it can be omitted.

Deprecation the JSON object contained in the attributes of each properties element can contain the following attributes:

Name type destination levelString deprecation level, which can be warning (default) or error. When a property has a warning deprecation level, it should still be bound in the environment. However, when it has an error deprecation level, the property is no longer managed and unconstrained. ReasonString A brief description of the reason why the attribute was deprecated. If there is no available reason, it can be omitted. The recommendation is described as a short paragraph, and the first line provides a concise summary. The last line in the description should end with a period (.). ReplacementString replaces the full name of the attribute for this deprecated attribute. If this property is not replaced, it can be omitted.

The corresponding @ ConfigurationProperties class is as follows:

@ Data@ConfigurationProperties (SwaggerProperties.PREFIX) public class SwaggerProperties {public static final String PREFIX = "swagger"; / * * document scan package path * / private String basePackage = ""; / * title: user module system interface details * / private String title = "platform system interface details"; / * * Service file introduction * / private String description = "online documentation" / * terms of Service URL * / private String termsOfServiceUrl = "https://www.test.com/"; / * version * / private String version =" V1.0 ";}

You can now try the prompt in the application.properties file.

The above is all the content of this article entitled "how to use additional-spring-configuration-metadata.json Custom Tips for springboot". Thank you for reading! Hope to share the content to help you, more related knowledge, welcome to follow the industry information channel!

Welcome to subscribe "Shulou Technology Information " to get latest news, interesting things and hot topics in the IT industry, and controls the hottest and latest Internet news, technology news and IT industry trends.