ResourceBundle.Control 是 Java 资源加载链中唯一可定制“查找、解析、缓存”行为的核心钩子,需在无法热更新 properties、需支持 YAML/JSON、或需精确控制缓存时自定义;必须重写 getCandidateLocales、getFormats、newBundle 三个方法,并合理实现缓存与编码处理。

ResourceBundle.Control 是什么,什么时候必须自定义它
当你发现 ResourceBundle.getBundle() 总是加载不到你改过的 .properties 文件,或者想支持 .yml/.json 格式的资源文件,又或者需要控制缓存时间(比如开发时热更新),这时候就得用 ResourceBundle.Control。它不是用来“增强功能”的装饰器,而是 Java 资源加载链里唯一能插手“怎么找文件”“怎么解析内容”“缓存多久”的钩子。
常见错误现象:
– 修改了 messages_zh_CN.properties,重启前一直用旧值
– 用 getBundle("messages", Locale.CHINA) 却加载了 messages.properties 而非预期的 messages_zh_CN.properties
– 想让资源支持 UTF-8 BOM 或带注释的 YAML,但默认只认 ISO-8859-1 编码的 .properties
继承 ResourceBundle.Control 时必须重写的三个方法
别只重写 getCandidateLocales() 就以为搞定了——Java 的资源查找流程会依次调用这三个方法,漏掉任一都可能跳过你的逻辑:
-
getCandidateLocales(String baseName, Locale locale):决定按什么顺序尝试匹配文件名,比如要不要先试messages_zh_CN再试messages_zh,甚至加个messages_dev -
getFormats(String baseName):返回支持的后缀列表,如Arrays.asList("xml", "properties");注意返回空或 null 会导致整个 bundle 加载失败 -
newBundle(String baseName, Locale locale, String format, ClassLoader loader, boolean reload):真正读取并解析资源的地方;reload == true表示本次是强制刷新(比如开发模式下),你要在这里重新读磁盘、跳过缓存
关键细节:
– newBundle() 必须返回非 null 的 ResourceBundle 实例,否则流程中断
– 不要在这个方法里做耗时操作(如远程拉配置),它在每次 getBundle() 调用时都执行
– 如果你返回的是自定义子类(比如 YamlResourceBundle),它必须继承 ResourceBundle 并实现 handleGetObject()
立即学习“Java免费学习笔记(深入)”;
缓存控制:setCacheDuration() 和 reload 参数的真实作用
很多人以为调用 ResourceBundle.clearCache() 就能立刻生效,其实它只清本地线程/ClassLoader 级缓存,而 ResourceBundle.Control 的缓存策略才是源头。
正确做法是:在 newBundle() 中根据 reload 参数决定是否绕过缓存;同时用 Control.INSTANCE 的子类覆盖 getCacheDuration() 方法:
- 返回
-1:永不缓存(每次调用都走newBundle()) - 返回
0:缓存但不过期(等同于默认行为) - 返回正数(毫秒):比如
5_000表示最多缓存 5 秒,超时后下次访问自动触发newBundle(..., true)
性能影响:
– 设为 -1 在生产环境会显著拖慢国际化调用,尤其高频页面
– getCacheDuration() 返回值对同一个 baseName + locale + format 组合全局生效,不能按 key 动态调整
– 注意 JVM 参数 -Djava.util.ResourceBundle.control=xxx 会全局覆盖,慎用
自定义格式支持:.yml / .json 的实际落地难点
支持 YAML 或 JSON 不是改个后缀就行。Java 默认只内置 PropertiesResourceBundle 和 ListResourceBundle,其他格式必须自己解析并构造 key → value 映射。
实操建议:
- 不要在
newBundle()里直接用new ObjectMapper()—— 它没做线程安全封装,高并发下容易出错;改用预构建的静态实例 - YAML 的嵌套结构(如
error.login.failed)需扁平化为单层 key,否则bundle.getString("error.login.failed")找不到 - JSON 不支持注释,但 .properties 支持
#行;如果你的团队习惯写中文注释,转 JSON 后这部分信息就丢了 - 编码问题最常踩坑:YAML/JSON 文件保存为 UTF-8 无 BOM,但某些编辑器(如老版 Notepad)默认加 BOM,
InputStreamReader会把它当非法字符抛MalformedInputException
真正难的不是读文件,而是让所有已有代码无感切换——比如 Spring 的 MessageSource 底层也调 ResourceBundle.getBundle(),只要你的 Control 注册得早,它就自动生效;但如果项目混用了 ClassPathResource 直接读流,那这部分就得单独适配。










