自定义 Spring 启动器：您如何向 MessageSource 贡献 i18n 消息？

Question

我正在编写一个自定义的 Spring 启动启动器，其他开发人员将放入他们的应用程序中，这个启动器包含开箱即用的控制器和 UI 屏幕。

这些UI屏幕是国际化的，i18n键/值在一个包文件中:< code > com/foo/where/i18n . properties 。

我想确保当我的starter在启动时加载时，这些i18n.properties在应用程序的< code>MessageSource中自动可用，这样我的UI页面就可以工作(通过普通的Spring Controller ViewResolver视图实现呈现)而无需应用程序开发人员自己指定这个文件。

换句话说，他们应该能够将我的启动器添加到他们的运行时类路径中，并且一切都“正常工作”，而无需配置任何内容。

现在，我发现应用程序html" target="_blank">开发人员可以创建自己的< code > src/main/resources/messages . properties 文件，并在< code > application . properties 中手动配置附加消息文件:

spring.messages.basename = messages, com.foo.wherever.i18n

这将起作用。

但是，这需要满足以下两项条件：

1. 他们必须手动配置＜code＞spring.messages。basename＜/code＞属性-它不是自动的。和
2. 他们必须有自己的＜code＞消息。properties＜/code＞文件的应用程序类路径中。如果＜code＞消息。properties＜/code＞文件不存在，＜code＞spring.messages。basename＜/code＞甚至不起作用。即使他们不关心i18n，这仍然是必需的——并不可取

我想我可以移动我的i18n。属性文件转换为类路径：/messages。jar中的properties文件，但这似乎不是一个好的解决方案：如果应用程序开发人员有自己的消息。属性文件只读取其中一个属性，从而丢失消息值。

看起来Spring Boot MessageSourceAutoCon人和应该有一个CompositeMessageSource的概念，它迭代一个或多个MessageSource实例，这些实例在Spring Application ationContext中可用（和令ed），并由DispatcherServlet使用。这将允许任何启动器通过在其自动配置中声明MessageSource来贡献可用消息

有可能做到我要求的吗？对应用程序开发人员来说，最“不干涉”的解决方案是什么？

Answer 1

我意识到这是一个老掉牙的问题，但前几天我遇到了同样的问题，并写了一篇关于我决定如何解决这个问题的博文。我想我应该在这里分享它，因为我从这个线程中得到了一些解决方案的灵感。

简而言之，它采用了 sodik 拦截 MessageSource bean 创建的想法，但我使用的是 BeanPostProcessor，而不是使用 BeanFactoryPostProcessor，而不是替换应用程序上下文中的原始 MessageSource，我只是添加我自己的作为其父级：

@Bean
BeanPostProcessor messageSourceCustomExtender() {
    return new BeanPostProcessor() {
        @Override
        public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {
            return bean;
        }

        @Override
        public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
            if (bean instanceof HierarchicalMessageSource && beanName.equals("messageSource")) {
                ResourceBundleMessageSource parent = new ResourceBundleMessageSource();
                parent.setBasename("custom");

                ((HierarchicalMessageSource) bean).setParentMessageSource(parent);
            }

            return bean;
        }
    };
}

你可以阅读完整的博客文章，其中我解释了一些关于我的解决方案的警告：http://www.thomaskasene.com/2016/08/20/custom-spring-boot-starter-messagesource/

经过一些修补，我意识到使用< code > BeanFactoryPostProcessor 是错误的，因为它将导致过早地创建原始的< code>MessageSource bean，并忽略应用程序属性(最重要的是< code > spring . messages . basename )。这意味着应用程序将无法配置这些属性。请参见下面的BeanFactoryPostProcessor文档摘录。

BeanFactoryPostProcessor可以与bean定义交互并修改bean定义，但不能修改bean实例。这样做可能会导致过早的bean实例化，违反容器并导致意想不到的副作用。如果需要bean实例交互，请考虑实现BeanPostProcessor。

我已经更新了上面的示例以改用 BeanPostProcessor，这会更改 Bean 实例而不是 Bean 定义。

Answer 2

也许这是一个长远的目标，但你可以尝试使用BeanFactoryPostProcessor。

想法如下：

> < li>

将“message source”bean从应用程序上下文中取出。请注意，如果开发人员想要使用自己的实现，并且不使用spring boot自动配置，那么它可能是但不是必须是spring boot的。

将其替换为您自己的实现，该实现尝试解析“您的键”，其余委托给原始消息源。如果您想让开发人员覆盖您的翻译，反之亦然（如果原始消息源不为未知键抛出异常，可能会出现问题）。

但是也许有更好的方法。

Answer 3

我按以下方式设置了它。我目前只支持en_US但它被设置为使用国际化（i18n）处理任意数量的语言。

在此处查看代码要点：github要点上的代码

将这些beans添加到您的Application.java中，以设置您的默认语言环境并配置您的消息属性的位置

服务将从会话中获取默认区域设置，然后从您的 prop 获取消息文本

注入消息svc，然后传递id以从props文件中获取值

转到/资源：

• 创建区域设置文件夹
• 创建一个名为 messages_en_US.properties 的文件

您可以在此处查看有关此主题的更完整的文章：Spring Boot国际化使用消息属性

在此处查看代码要点：github要点上的代码