如何优雅地校验配置属性非空并抛出运行时异常

胖宇小哥_2232

胖宇小哥_2232

2026-04-16

468人浏览

原创

本文介绍在 Java 静态初始化块中,通过封装工具方法统一校验 Properties 中关键配置项是否缺失或为 null,并自动抛出带上下文的 RuntimeException,避免冗长的手动判空代码,提升配置加载阶段的健壮性与可维护性。

本文介绍在 java 静态初始化块中,通过封装工具方法统一校验 `properties` 中关键配置项是否缺失或为 null,并自动抛出带上下文的 `runtimeexception`,避免冗长的手动判空代码,提升配置加载阶段的健壮性与可维护性。

在 Java 应用(尤其是 Spring Boot 之外的轻量级服务)中,常通过 application.properties 文件加载核心配置,并在静态类中初始化为 public static final 常量。然而,若某项配置未定义或拼写错误,Properties.getProperty() 会静默返回 null,导致后续运行时 NullPointerException,且错误定位困难。

最简洁、可复用且符合 Java 惯例的解决方案,是封装一个校验型工具方法——它不依赖第三方注解库(如 @NotNull + Lombok 或 JSR-303),也不需要反射或 AOP“魔法”,而是以零依赖、高可读、易调试的方式,在加载瞬间暴露问题:

import java.io.IOException;
import java.util.Properties;

public class AppProperties {

    public static final String DIGITAL_ASSETS_UPLOADS_BUCKET;
    public static final String REGION;
    public static final String APP_PEEFIX; // 注意:此处变量名疑似拼写错误(应为 APP_PREFIX),但保留原文以示真实场景
    public static final String ACCOUNT_NUMBER;
    public static final String TEXTRACT_SSM_SNS_NAME;
    public static final String TEXTRACT_SSM_SQS_NAME;

    static {
        Properties prop = new Properties();
        try {
            prop.load(AppProperties.class.getClassLoader()
                    .getResourceAsStream("application.properties"));
        } catch (IOException e) {
            throw new RuntimeException("Failed to load application.properties from classpath", e);
        }

        // ✅ 使用统一校验方法,确保每项必填配置均存在且非空
        DIGITAL_ASSETS_UPLOADS_BUCKET = getRequiredProperty(prop, "aws.bucket.digitalassetsuploads");
        REGION = getRequiredProperty(prop, "aws.region");
        APP_PEEFIX = getRequiredProperty(prop, "cdk.appprefix");
        ACCOUNT_NUMBER = getRequiredProperty(prop, "aws.accountnumber");
        TEXTRACT_SSM_SNS_NAME = getRequiredProperty(prop, "aws.ssm.sns.textract");
        TEXTRACT_SSM_SQS_NAME = getRequiredProperty(prop, "aws.ssm.sqs.textract");
    }

    /**
     * 从 Properties 中获取指定 key 的值;若值为 null,则立即抛出带上下文的 RuntimeException
     */
    private static String getRequiredProperty(Properties props, String key) {
        String value = props.getProperty(key);
        if (value == null || value.trim().isEmpty()) {
            throw new RuntimeException(
                String.format("Missing or empty required property: '%s'. Please check application.properties.", key)
            );
        }
        return value.trim(); // 自动去除首尾空白,避免隐形空字符串问题
    }
}

✅ 关键优势说明:

  • 精准报错:异常消息明确指出缺失的 key,开发者无需逐行 debug;
  • 空字符串防护:trim().isEmpty() 额外拦截 " " 类无效值,比仅判 null 更健壮;
  • 零侵入 & 零依赖:纯 Java 实现,兼容所有 JDK 版本,无需引入额外库;
  • 可扩展性强:如需支持默认值 fallback,可扩展为 getRequiredProperty(props, key, defaultValue);
  • 静态安全:仍保持 static final 语义,确保常量不可变,线程安全。

⚠️ 注意事项:

  • 此方案适用于启动期强约束场景(如基础设施配置)。若某些属性允许运行时动态加载或降级,应改用懒加载 + 双重检查锁等策略;
  • 变量命名建议修正(如 APP_PEEFIX → APP_PREFIX),避免因拼写不一致引发配置键映射失败;
  • 在测试环境中,可通过 ClassLoader#getResourceAsStream 替换为内存 InputStream,实现配置加载逻辑的可测性。

总结而言,所谓“Kotlin 式的简洁”,在 Java 中并非遥不可及——它源于对重复模式的抽象提炼。一个 6 行的 getRequiredProperty 方法,就是你告别冗余 if (x == null) throw ... 的第一步。

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

12177

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

9262

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

7912

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1284

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

1028

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1536

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

3189

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

20431

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1395

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 134.1万人学习