【Spring】yaml自定义参数添加提示功能

返回首页

1. 说明

编写SpringBoot项目时是不是羡慕spring以及第三方插件的自动提示功能。其实实现很简单，且听我道来。

2. 依赖

对于maven和gradle依赖写法不一样，为了避免依赖，均列在下面

// gradle中引入依赖 
dependencies {
   
    annotationProcessor 'org.springframework.boot:spring-boot-configuration-processor'
 }

<!-- maven中引入依赖 -->
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-configuration-processor</artifactId>
  <optional>true</optional>
</dependency>

3. 处理流程（以自定义swagger配置为例）

3.1 定义自定义参数SwaggerProperties

注意：这里的提示是需要写的，这是后面yaml中自定义参数的提示内容

@Data
@ConfigurationProperties(prefix = "seed.swagger")
public class SwaggerProperties {
   
    /**
     * 是否启用，默认：启用
     */
    private boolean enable = true;
    /**
     * 名称,默认：seed接口管理
     */
    private String title = "Seed接口管理";
    /**
     * 简介
     */
    private String description;
    /**
     * 作者，默认：叶甯
     */
    private String author = "叶甯";
    /**
     * 版本，默认：1.0.0
     */
    private String version = "1.0.0";
    /**
     * 全局鉴权参数，默认：Authorization
     */
    private String security = "Authorization";

    /**
     * 定义分组
     */
    private List<GroupConfig> groupConfig = new ArrayList<>();

    /**
     * 分组配置
     */
    @Data
    @NoArgsConstructor
    public static class GroupConfig {
   
        /**
         * 分组名称
         */
        private String group;
        /**
         * 扫描包地址
         */
        private List<String> packagesToScan = new ArrayList<>