Spring Boot 使用配置检查启动应用程序

Question

这是关于Spring Boot 的应用程序。如果有人配置了错误的Yaml file，我想在开始时检查并通知用户。我想问你们中的一些人，

1. 这是实现它的正确方法吗？
2. RuntimeException 是正确的选择吗？
3. 我是否正确使用了lombok 注释？

谢谢

@Component
@ConfigurationProperties
@Data
@NoArgsConstructor
public class ApplicationProperties{

    @Data
    @NoArgsConstructor
    public static class Something {
        private String name;

        @Setter(AccessLevel.NONE)
        private int width;

        @Setter(AccessLevel.NONE)
        private int height;

        public void setWidth(int width) throws Throwable {
            if (0 > width || 100 < width) {
                throw new RuntimeException("The width should be between 0 and 100.");
            }
            this.width = width;
        }

        public void setHeight(int height) throws Throwable {
            if (0 > height || 250 < height) {
                throw new RuntimeException("The height should be between 0 and 250.");
            }
            this.height = height;
        }
    }
}

Answer 1

首先，欢迎来到 SO！让我解释一下如何验证应用程序属性。有一种简单的方法可以使用验证注释来实现这一点。 @ConfigurationProperties 支持 JSR-303 bean 验证：

@ConfigurationProperties("prefix")
public class MyProperties {

    @Max(100)
    @Min(0)
    private Integer width;

    @Max(100)
    @Min(1)
    private Integer height;
}

请注意，如果验证引发异常，此方法将导致应用程序启动失败。

其次，要了解这是否是正确的方法，您必须描述您的用例。我个人会坚持现有标准并使用验证注释流程。

最后，关于您的 lombok 注释。您可以在全局范围内使用 @Getter 和 @Setter 注释，也可以像这样将它们放在您的字段中以指定细粒度的访问权限。

我不是@Data 注释的忠实拥护者，因为它可能会生成一些您可能不需要（或者可能再次取决于您的使用）想要的额外方法。我记得在使用生成的toString 方法时遇到了嵌套实体和循环依赖的一些问题。