0

0

如何在枚举中动态加载 properties 文件中的实际值(而非键名)

霞舞

霞舞

发布时间:2026-01-16 21:02:01

|

960人浏览过

|

来源于php中文网

原创

如何在枚举中动态加载 properties 文件中的实际值(而非键名)

本文介绍一种安全、可维护的方式,让 java 枚举能根据 properties 文件中的键名自动解析出对应的实际字符串值(如错误消息和错误码),避免直接将键名误作值使用。

在 Java 开发中,常通过 enum 统一管理业务错误码与提示信息,并期望从外部配置(如 errorcodes.properties)中动态加载其真实内容。但若直接将属性键(如 "error.id.required.message")传入枚举构造器并赋值给字段,运行时得到的只是键名本身——而非 properties 中定义的值(如 "Id is required to get the details.")。这是因为枚举实例在类加载时即完成初始化,而此时 Properties 尚未加载,也无法在构造器中执行动态查表逻辑。

✅ 正确方案:分离配置加载与枚举语义

核心思想是 让枚举保持不可变性与语义清晰性,将配置读取与键值解析职责委托给专用的单例存储类。以下是推荐实现:

1. 定义枚举(仅声明键名,不持有实际值)

import lombok.RequiredArgsConstructor;

@RequiredArgsConstructor(access = lombok.AccessLevel.PACKAGE)
public enum ErrorCode {
    ID_REQUIRED("error.id.required.message", "error.id.required.code"),
    ID_INVALID("error.id.invalid.message", "error.id.invalid.code");

    private final String messageKey;
    private final String codeKey;

    public String getMessage() {
        return ErrorCodeStore.getInstance().getValue(messageKey);
    }

    public String getCode() {
        return ErrorCodeStore.getInstance().getValue(codeKey);
    }
}
✅ 优势:枚举仍保持 final、线程安全、可序列化;getMessage()/getCode() 方法延迟解析,确保返回真实配置值。

2. 创建配置存储单例(ErrorCodeStore)

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

import lombok.RequiredArgsConstructor;

@RequiredArgsConstructor(access = lombok.AccessLevel.PRIVATE)
final class ErrorCodeStore {
    private static ErrorCodeStore instance;

    public static ErrorCodeStore getInstance() {
        if (instance == null) {
            throw new IllegalStateException("ErrorCodeStore not initialized. Call initFrom() first.");
        }
        return instance;
    }

    private final Properties properties;

    public static ErrorCodeStore initFrom(InputStream in) throws IOException {
        Properties props = new Properties();
        props.load(in);
        instance = new ErrorCodeStore(props);
        return instance;
    }

    String getValue(String key) {
        String value = properties.getProperty(key);
        if (value == null || value.trim().isEmpty()) {
            // 可选:记录警告或抛出异常,避免静默失败
            return key; // fallback to key itself for debugging
        }
        return value.trim();
    }
}

⚠️ 注意事项:

Transor
Transor

专业的AI翻译工具,支持网页、字幕、PDF、图片实时翻译

下载
  • initFrom() 必须在应用启动早期调用(如 Spring 的 @PostConstruct 或 main() 中),且 InputStream 需显式关闭(示例中为简洁省略,生产环境建议使用 try-with-resources);
  • getValue() 提供 fallback 行为(返回原 key),便于快速定位缺失配置;
  • ErrorCode 与 ErrorCodeStore 需位于同一包内,以保障 PACKAGE 访问权限的正确性。

3. 初始化与使用示例

public class ErrorDemo {
    public static void main(String[] args) throws IOException {
        // ✅ 在使用前初始化配置存储
        try (InputStream is = ErrorDemo.class.getResourceAsStream("/errorcodes.properties")) {
            if (is == null) {
                throw new IllegalArgumentException("errorcodes.properties not found in classpath");
            }
            ErrorCodeStore.initFrom(is);
        }

        // ✅ 现在可安全获取真实值
        System.out.println(ErrorCode.ID_REQUIRED.getMessage()); // 输出: Id is required to get the details.
        System.out.println(ErrorCode.ID_REQUIRED.getCode());    // 输出: 110
    }
}

4. 集成到自定义异常中(如 CustomException)

public class CustomException extends RuntimeException {
    private final String errorCode;
    private final String errorMessage;

    public CustomException(ErrorCode code) {
        super(code.getMessage()); // 使用动态解析的消息
        this.errorCode = code.getCode();
        this.errorMessage = code.getMessage();
    }

    // getters...
}

调用 throw new CustomException(ErrorCode.ID_REQUIRED) 即可输出正确的 errorCode: "110" 和 errorMessage: "Id is required to get the details."。

✅ 总结

  • ❌ 不要在枚举构造器中尝试“预加载” properties 值——违反枚举设计原则且不可靠;
  • ✅ 使用“键名枚举 + 配置存储单例”的组合模式,兼顾类型安全、可读性与灵活性;
  • ✅ 初始化时机至关重要:确保 ErrorCodeStore 在任何枚举方法被调用前完成加载;
  • ✅ 生产环境中建议增加配置校验(如启动时检查所有 key 是否存在)、日志告警及更健壮的 fallback 策略。

该方案已被广泛应用于 Spring Boot、Micrometer 等主流框架的国际化与错误码管理场景,具备高可扩展性与低耦合度。

相关专题

更多
java
java

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

834

2023.06.15

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

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

738

2023.07.05

java自学难吗
java自学难吗

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

734

2023.07.31

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

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

397

2023.08.01

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

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

398

2023.08.02

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

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

446

2023.08.02

java有什么用
java有什么用

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

430

2023.08.02

java在线网站
java在线网站

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

16926

2023.08.03

高德地图升级方法汇总
高德地图升级方法汇总

本专题整合了高德地图升级相关教程,阅读专题下面的文章了解更多详细内容。

9

2026.01.16

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Kotlin 教程
Kotlin 教程

共23课时 | 2.6万人学习

C# 教程
C# 教程

共94课时 | 6.8万人学习

Java 教程
Java 教程

共578课时 | 46.7万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号