0

0

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

聖光之護

聖光之護

发布时间:2026-01-16 21:54:11

|

605人浏览过

|

来源于php中文网

原创

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

本文介绍一种安全、可维护的方式,让 java 枚举能从外部 properties 文件中按需解析并返回实际配置值(如错误消息和编码),避免将 key 字符串误作最终内容。核心思路是分离枚举定义与配置读取逻辑,通过单例存储器实现延迟绑定。

在 Java 开发中,常希望通过枚举统一管理业务错误码(如 ID_REQUIRED),同时将具体提示文案和数字编码外置到 errorcodes.properties 等配置文件中,以支持多语言或运行时热更新。但直接在枚举构造器中传入 key(如 "error.id.required.message")并不会自动解析其对应值——JVM 仅将其作为普通字符串保存,导致调用 getMsg() 时返回的是 key 本身,而非 properties 中定义的 "Id is required to get the details."。

✅ 正确方案:枚举 + 配置存储器解耦

推荐采用「枚举声明语义」+「独立配置加载器」的组合模式,既保留枚举的类型安全与可读性,又实现配置值的动态解析。关键设计原则如下:

  • 枚举不负责 I/O:ErrorCode 仅定义 key 的逻辑映射关系,不加载或持有 Properties;
  • 配置由专用类管理:ErrorCodeStore 作为单例容器,负责加载、缓存并提供 getProperty(key) 能力;
  • 枚举方法委托查询:getMessage() 和 getCode() 内部调用 ErrorCodeStore.getInstance().getValue(key),实现运行时解析。

示例代码实现

首先定义枚举(使用 Lombok 简化构造):

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);
    }
}

再实现配置存储器(线程安全初始化,支持资源流加载):

Petalica Paint
Petalica Paint

用AI为你的画自动上色!

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

final class ErrorCodeStore {
    private static ErrorCodeStore instance;

    private final Properties properties;

    private ErrorCodeStore(Properties properties) {
        this.properties = properties;
    }

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

    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();
    }
}

初始化与使用示例

在应用启动阶段(如 Spring Boot 的 @PostConstruct 或主类 main())完成一次初始化:

public class AppInitializer {
    public static void init() throws IOException {
        try (InputStream is = AppInitializer.class.getResourceAsStream("/errorcodes.properties")) {
            if (is == null) {
                throw new IllegalArgumentException("errorcodes.properties not found in classpath");
            }
            ErrorCodeStore.initFrom(is);
        }
    }
}

随后即可在任意业务逻辑中安全使用:

throw new CustomException(ErrorCode.ID_REQUIRED); 
// → CustomException.getMessage() 返回 "Id is required to get the details."
// → CustomException.getErrorCode() 返回 "110"

⚠️ 注意事项与最佳实践

  • 初始化时机至关重要:必须在任何枚举方法被调用前完成 ErrorCodeStore.initFrom(...),否则会触发 IllegalStateException;
  • 资源管理:InputStream 应显式关闭(如上例中使用 try-with-resources),避免内存泄漏;
  • 空值处理:getValue() 方法中建议对缺失 key 做日志告警或 fallback 处理,便于排查配置遗漏;
  • 非 Spring 环境扩展:若项目使用 Spring,可将 ErrorCodeStore 声明为 @Component,并通过 @Value 或 ResourceBundleMessageSource 进一步集成;
  • 线程安全:当前实现保证单例初始化安全,Properties 本身是线程安全的,适合高并发场景。

该方案兼顾了可测试性(ErrorCodeStore 可 mock)、可维护性(配置与代码分离)和健壮性(明确的生命周期控制),是企业级 Java 项目中处理国际化错误码的推荐实践。

相关专题

更多
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

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

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

2

2026.01.16

热门下载

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

精品课程

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

共23课时 | 2.6万人学习

C# 教程
C# 教程

共94课时 | 6.8万人学习

Java 教程
Java 教程

共578课时 | 46.6万人学习

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

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