如何在SpringBoot 中配置提示功能

本篇文章為大家展示了如何在SpringBoot 中配置提示功能，內容簡明扼要并且容易理解，絕對能使你眼前一亮，通過這篇文章的詳細介紹希望你能有所收獲。

實戰

<!-- 引入相關依賴 -->
<dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-configuration-processor</artifactId>
 <optional>true</optional>
</dependency>
@Configuration
@ConfigurationProperties(prefix = "file.upload")
public class FileUploadConfig {
 /** Maximum number of bytes per file */
 private String maxSize = "1024M";

 /** 不允許的文件后綴 */
 private String rejectSuffix;
 //注意：使用的時候必須要有getter/setter，否則不會自動生成該屬性對應的提示
 //此處因為篇幅原因省略 getter/setter
}
@Configuration
@ConfigurationProperties("map.test")
public class MapTestConfig {
 /** 測試Map類型數據的提示 */
 private Map<String, Object> data;
 //注意：使用的時候必須要有getter/setter，否則不會自動生成該屬性對應的提示
 //此處因為篇幅原因省略 getter/setter
}

中文注釋會亂碼，以上故意用中文注釋的地方，會在下面文件中指定對應的描述，看是否會覆蓋。

additional-spring-configuration-metadata.json

{
 "properties": [
 {
 "name": "file.upload.reject-suffix",
 "type": "java.lang.String",
 "defaultValue": "exe,jar",
 "description": "The file suffix is not allowed.",
 "sourceType": "com.lw.metadata.config.FileUploadConfig"
 },
 {
 "name": "map.test.data",
 "type": "java.util.Map",
 "description": "Tips for testing Map type data.",
 "sourceType": "com.lw.metadata.config.MapTestConfig"
 }
 ],
 "hints": [
 {
 "name": "map.test.data.keys",
 "values": [
 {
  "value": "name",
  "description": "The name of the person."
 },
 {
  "value": "sex",
  "description": "The sex of the person."
 }
 ]
 }
 ]
}

maven compile 之后，生成的 additional-spring-configuration-metadata.json 與源碼中的一樣，生成的 spring-configuration-metadata.json 如下：

{
 "groups": [
 {
 "name": "file.upload",
 "type": "com.lw.metadata.config.FileUploadConfig",
 "sourceType": "com.lw.metadata.config.FileUploadConfig"
 },
 {
 "name": "map.test",
 "type": "com.lw.metadata.config.MapTestConfig",
 "sourceType": "com.lw.metadata.config.MapTestConfig"
 }
 ],
 "properties": [
 {
 "name": "file.upload.max-size",
 "type": "java.lang.String",
 "description": "Maximum number of bytes per file",
 "sourceType": "com.lw.metadata.config.FileUploadConfig",
 "defaultValue": "1024M"
 },
 {
 "name": "file.upload.reject-suffix",
 "type": "java.lang.String",
 "description": "The file suffix is not allowed.",
 "sourceType": "com.lw.metadata.config.FileUploadConfig",
 "defaultValue": "exe,jar"
 },
 {
 "name": "map.test.data",
 "type": "java.util.Map<java.lang.String,java.lang.Object>",
 "description": "Tips for testing Map type data.",
 "sourceType": "com.lw.metadata.config.MapTestConfig"
 }
 ],
 "hints": [
 {
 "name": "map.test.data.keys",
 "values": [
 {
  "value": "name",
  "description": "The name of the person."
 },
 {
  "value": "sex",
  "description": "The sex of the person."
 }
 ]
 }
 ]
}

效果

由此可以看到以下現象：

• 代碼中的默認值會自動生成到提示文件中，如：FileUploadConfig#maxSize
  

• 代碼中的注釋會自動生成到提示文件中，如：FileUploadConfig#maxSize
  

• additional-spring-configuration-metadata.json 文件中存在的提示會覆蓋自動生成的對應屬性，若自動生成的沒有此屬性則自動增加。

手動寫提示文件

示例

{
 "groups": [
  {
   "name": "server",
   "type": "org.springframework.boot.autoconfigure.web.ServerProperties",
   "sourceType": "org.springframework.boot.autoconfigure.web.ServerProperties"
  },
  {
   "name": "spring.jpa.hibernate",
   "type": "org.springframework.boot.autoconfigure.orm.jpa.JpaProperties$Hibernate",
   "sourceType": "org.springframework.boot.autoconfigure.orm.jpa.JpaProperties",
   "sourceMethod": "getHibernate()"
  }
 ],
 "properties": [
  {
   "name": "server.port",
   "type": "java.lang.Integer",
   "sourceType": "org.springframework.boot.autoconfigure.web.ServerProperties"
  },
  {
   "name": "server.address",
   "type": "java.net.InetAddress",
   "sourceType": "org.springframework.boot.autoconfigure.web.ServerProperties"
  },
  {
    "name": "spring.jpa.hibernate.ddl-auto",
    "type": "java.lang.String",
    "description": "DDL mode. This is actually a shortcut for the \"hibernate.hbm2ddl.auto\" property.",
    "sourceType": "org.springframework.boot.autoconfigure.orm.jpa.JpaProperties$Hibernate"
  }
 ],
 "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."
    },
    {
     "value": "update",
     "description": "Update the schema if necessary."
    },
    {
     "value": "create",
     "description": "Create the schema and destroy previous data."
    },
    {
     "value": "create-drop",
     "description": "Create and then destroy the schema at the end of the session."
    }
   ]
  }
 ]
}

groups

分組，將配置類分組。

可以按照文件來分組，即：將同一個配置文件的所有屬性放在同一個組

properties

提示主體，必須

deprecation屬性如下：

 注意：Spring Boot 1.3 版本之前，是使用 boolean 類型的 deprecated。

以下示例來源于官方文檔，展示了如何處理這種場景：

@ConfigurationProperties("app.acme")
public class AcmeProperties {

 private String name;

 public String getName() { ... }

 public void setName(String name) { ... }

 @DeprecatedConfigurationProperty(replacement = "app.acme.name")
 @Deprecated
 public String getTarget() {
  return getName();
 }

 @Deprecated
 public void setTarget(String target) {
  setName(target);
 }
}

一旦 getTarget 和 setTarget 方法從公共 API 中刪除，元數據中的自動棄用提示也會消失。 如果要保留提示，則添加具有 error 棄用級別的手動元數據可以確保用戶仍然了解該屬性。在提供替代品時，這樣做特別有用。

hints

輔助提示，非必須

values 屬性如下：

@ConfigurationProperties("sample")
public class SampleProperties {

 private Map<String,Integer> contexts;
 // getters and setters
}
{"hints": [
 {
  "name": "sample.contexts.keys",
  "values": [
   {
    "value": "sample1"
   },
   {
    "value": "sample2"
   }
  ]
 }
]}

提示是對Map內每一對 key-value 的提示。

.keys 和 .values 前綴必須分別關聯 Map 的 keys 和 values。

providers 屬性如下：

 ValueProvider

一般用不到，建議跳過

下表總結了支持的 providers 列表：

 any

符合屬性類型的所有值。

{"hints": [
 {
  "name": "system.state",
  "values": [
   {
    "value": "on"
   },
   {
    "value": "off"
   }
  ],
  "providers": [
   {
    "name": "any"
   }
  ]
 }
]}
class-reference

提供以下參數：

 {"hints": [
 {
  "name": "server.servlet.jsp.class-name",
  "providers": [
   {
    "name": "class-reference",
    "parameters": {
     "target": "javax.servlet.http.HttpServlet"
    }
   }
  ]
 }
]}

handle-as

允許您將屬性的類型替換為更高級的類型。

這通常在屬性具有 java.lang.String 類型時發生，因為您不希望配置類依賴于不在類路徑上的類。

可用的值如下：

任何 java.lang.Enum： 列出屬性的可能值。

java.nio.charset.Charset： 支持自動完成字符集/編碼值（如 utf-8）

java.util.Locale：自動完成區域設置（如：en_US)

org.springframework.util.MimeType：支持自動完成 content-type 值（如：text/plain）

org.springframework.core.io.Resource： 支持自動完成spring的資源抽象以引用文件系統或類路徑上的文件 （如：

classpath:/sample.properties）

注意：如果要提供多個值，用 Collection 或 數組類型

{"hints": [
 {
  "name": "spring.liquibase.change-log",
  "providers": [
   {
    "name": "handle-as",
    "parameters": {
     "target": "org.springframework.core.io.Resource"
    }
   }
  ]
 }
]}

logger-name

logger-name provider 自動完成有效的記錄器名稱和記錄器組。 通常，當前項目中可用的包和類名可以自動完成。 如果組已啟用（默認），并且配置中標識了自定義記錄器組，則應提供該組的自動完成。

支持以下參數：

由于記錄器名稱可以是任意名稱，此 provider 應允許任何值，但可以突出顯示項目的類路徑中不可用的有效包和類名。

以下是 logging.level 屬性。keys 是 logger 名，values 關聯標準的 log levels 或 自定義的 level，

{"hints": [
 {
  "name": "logging.level.keys",
  "values": [
   {
    "value": "root",
    "description": "Root logger used to assign the default logging level."
   },
   {
    "value": "sql",
    "description": "SQL logging group including Hibernate SQL logger."
   },
   {
    "value": "web",
    "description": "Web logging group including codecs."
   }
  ],
  "providers": [
   {
    "name": "logger-name"
   }
  ]
 },
 {
  "name": "logging.level.values",
  "values": [
   {
    "value": "trace"
   },
   {
    "value": "debug"
   },
   {
    "value": "info"
   },
   {
    "value": "warn"
   },
   {
    "value": "error"
   },
   {
    "value": "fatal"
   },
   {
    "value": "off"
   }

  ],
  "providers": [
   {
    "name": "any"
   }
  ]
 }
]}

spring-bean-reference

此 provider 自動完成在當前項目的配置中定義的bean。 支持以下參數：

以下示例表示：spring.jmx.server 屬性定義了使用 MBeanServer

{"hints": [
 {
  "name": "spring.jmx.server",
  "providers": [
   {
    "name": "spring-bean-reference",
    "parameters": {
     "target": "javax.management.MBeanServer"
    }
   }
  ]
 }
]}

spring-profile-name

此 provider 自動完成在當前項目的配置中定義的spring配置文件。

以下示例表示：spring.profiles.active屬性可啟用的配置文件名稱。

{"hints": [
 {
  "name": "spring.profiles.active",
  "providers": [
   {
    "name": "spring-profile-name"
   }
  ]
 }
]}

可重復的元數據項

具有相同“property”和“group”名稱的對象可以在元數據文件中多次出現。 例如，可以將兩個單獨的類綁定到同一前綴，每個類都有可能重疊的屬性名。 雖然多次出現在元數據中的相同名稱不應是常見的，但元數據的使用者應注意確保他們支持該名稱。

自動生成提示文件

通過使用 spring-boot-configuration-processor jar，您可以從用 @ConfigurationProperties 注釋的類中輕松生成自己的配置元數據文件。 jar包含一個java注釋處理器，在編譯項目時調用它。 用此處理器，需要引入 spring-boot-configuration-processor 依賴。

<dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-configuration-processor</artifactId>
 <optional>true</optional>
</dependency>

處理器獲取用@configurationproperties注釋的類和方法。 配置類中字段值的 javadoc 用于填充 description 屬性。

注意：僅僅只應將簡單文本與@configurationproperties字段javadoc一起使用，因為在將它們添加到json之前不會對它們進行處理。

如果類有一個“至少一個參數”的構造函數，則為每個構造函數參數創建一個屬性。 否則，通過標準getter和setter來發現屬性，這些getter和setter對集合類型進行了特殊處理（即使只有getter存在，也會檢測到）。

注解處理器還支持使用@data、@getter和@setter 的 lombok 注解。

注解處理器無法自動檢測 Enum 和 Collections 的默認值。在集合或枚舉屬性具有非空默認值的情況下，應提供手動元數據。

@ConfigurationProperties(prefix="acme.messaging")
public class MessagingProperties {

 private List<String> addresses = new ArrayList<>(Arrays.asList("a", "b")) ;

 private ContainerType = ContainerType.SIMPLE;

 // ... getter and setters

 public enum ContainerType {
  SIMPLE,
  DIRECT
 }
}

為了提示上述屬性的默認值，應該手動添加如下元數據：

{"properties": [
 {
  "name": "acme.messaging.addresses",
  "defaultValue": ["a", "b"]
 },
 {
  "name": "acme.messaging.container-type",
  "defaultValue": "simple"
 }
]}

注意： 如果在項目中使用 AspectJ，則需要確保注解處理器只運行一次。 使用 Maven 時， 可以顯式地配置 maven-apt-plugin插件，并僅在那里向注解處理器添加依賴項。 還可以讓 AspectJ 插件運行于所有的處理且在 maven-compiler-plugin 的 configuration 中禁用注解處理，如下：

<plugin>
 <groupId>org.apache.maven.plugins</groupId>
 <artifactId>maven-compiler-plugin</artifactId>
 <configuration>
  <proc>none</proc>
 </configuration>
</plugin>

綁定屬性

注解處理器自動將內部類視為嵌套屬性。

@ConfigurationProperties(prefix="server")
public class ServerProperties {
 private String name;
 private Host host;
 // ... getter and setters
 public static class Host {
  private String ip;
  private int port;
  // ... getter and setters
 }
}

上述示例生成 server.name、server.host.ip 和 server.host.port 屬性的元數據信息。 可以在字段上使用@NestedconfigurationProperty 注解來指示應將常規（非內部）類視為嵌套類。

注意： 這對集合和映射沒有影響，因為這些類型是自動標識的，并且為每個類型生成一個元數據屬性。

添加額外的元數據

Spring Boot 的配置文件處理非常靈活，通常情況下，可能存在不綁定到 @ConfigurationProperties bean的屬性。 您還可能需要調整現有key的某些屬性，為了支持這種情況并讓您提供自定義的“提示”，注解處理器會自動將 META-INF/additional-spring-configuration-metadata.json 中的提示項合并到主要元數據文件（spring-configuration-metadata.json）中。

如果引用已自動檢測到的屬性，則將覆蓋描述、默認值和棄用信息（如果指定）。 如果當前模塊中沒有標識手動屬性中的聲明，則將其作為新屬性添加。

additional-spring-configuration-metadata.json 文件的格式與 spring-configuration-metadata.json 文件一樣。 附加屬性文件是可選的。如果沒有任何其他屬性，就不要添加文件。

springboot是什么

springboot一種全新的編程規范，其設計目的是用來簡化新Spring應用的初始搭建以及開發過程，SpringBoot也是一個服務于框架的框架，服務范圍是簡化配置文件。

上述內容就是如何在SpringBoot 中配置提示功能，你們學到知識或技能了嗎？如果還想學到更多技能或者豐富自己的知識儲備，歡迎關注億速云行業資訊頻道。