SpringBoot 实现国际化

文章目录

• 专栏文章
• 前言
• 1. 编写国际化资源文件
• • 1.1. 在resources目录下创建i18n目录
  • 1.2. 在i18n下创建默认的资源文件messages.properties
  • 1.3. 创建中文资源文件：messages_zh.properties
  • 1.4. 创建英文资源文件：messages_en.properties
  • 1.5. 编写配置的语句
  • 2. 实现WebMvcConfigurer配置
  • 3. spring工具类 方便在非spring管理环境中获取bean
  • 4. 配置自定义区域信息解析器
  • 5. 配置MessageUtils工具类
  • 6. 使用工具类输出
  • 7. 总结

    专栏文章

    1.springboot前后端分离项目集成Security框架和JWT完成用户校验

    2.SpringBoot 前后端分离 集成图形验证码

    3.SpringBoot 跨域问题之CorsFilter

    前言

    国际化（Internationalization 简称 I18n，其中“I”和“n”分别为首末字符，18 则为中间的字符数）是指软件开发时应该具备支持多种语言和地区的功能。换句话说就是，开发的软件需要能同时应对不同国家和地区的用户访问，并根据用户地区和语言习惯，提供相应的、符合用具阅读习惯的页面和数据，例如，为中国用户提供汉语界面显示，为美国用户提供提供英语界面显示。

    1. 编写国际化资源文件

    1.1. 在resources目录下创建i18n目录

    1.2. 在i18n下创建默认的资源文件messages.properties

    1.3. 创建中文资源文件：messages_zh.properties

    1.4. 创建英文资源文件：messages_en.properties

    1.5. 编写配置的语句

    一共写三版：默认显示、中文显示、英文显示，这里就默认显示中文。

    2. 实现WebMvcConfigurer配置

    import org.springframework.context.MessageSource;import org.springframework.context.annotation.Bean;import org.springframework.context.support.ReloadableResourceBundleMessageSource;import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;import org.springframework.web.servlet.LocaleResolver;/** * @author 方磊 */public class WebMvcConfiguration implements WebMvcConfigurer {    /**     * 将自定义的区域信息解析器以组件的形式添加到容器中     * @return     */    @Bean    public LocaleResolver localeResolver(){        return new MyLocalResolver();    }        /**     * 系统国际化文件配置     * @return MessageSource     */    @Bean    public MessageSource messageSource() {        ReloadableResourceBundleMessageSource messageSource = new ReloadableResourceBundleMessageSource();        messageSource.setBasename("classpath:i18n/messages");        return messageSource;    }}

    3. spring工具类 方便在非spring管理环境中获取bean

    import com.fang.ordering.common.utils.StringUtils;import org.springframework.aop.framework.AopContext;import org.springframework.beans.BeansException;import org.springframework.beans.factory.NoSuchBeanDefinitionException;import org.springframework.beans.factory.config.BeanFactoryPostProcessor;import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;import org.springframework.context.ApplicationContext;import org.springframework.context.ApplicationContextAware;import org.springframework.stereotype.Component;/** * spring工具类 方便在非spring管理环境中获取bean * * @author fanglei */@Componentpublic final class SpringUtils implements BeanFactoryPostProcessor, ApplicationContextAware{    /** Spring应用上下文环境 */    private static ConfigurableListableBeanFactory beanFactory;    private static ApplicationContext applicationContext;    @Override    public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException    {        SpringUtils.beanFactory = beanFactory;    }    @Override    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException    {        SpringUtils.applicationContext = applicationContext;    }    /**     * 获取对象     *     * @param name     * @return Object 一个以所给名字注册的bean的实例     * @throws BeansException     *     */    @SuppressWarnings("unchecked")    public static  T getBean(String name) throws BeansException    {        return (T) beanFactory.getBean(name);    }    /**     * 获取类型为requiredType的对象     *     * @param clz     * @return     * @throws BeansException     *     */    public static  T getBean(Class clz) throws BeansException    {        T result = (T) beanFactory.getBean(clz);        return result;    }    /**     * 如果BeanFactory包含一个与所给名称匹配的bean定义，则返回true     *     * @param name     * @return boolean     */    public static boolean containsBean(String name)    {        return beanFactory.containsBean(name);    }    /**     * 判断以给定名字注册的bean定义是一个singleton还是一个prototype。 如果与给定名字相应的bean定义没有被找到，将会抛出一个异常（NoSuchBeanDefinitionException）     *     * @param name     * @return boolean     * @throws NoSuchBeanDefinitionException     *     */    public static boolean isSingleton(String name) throws NoSuchBeanDefinitionException    {        return beanFactory.isSingleton(name);    }    /**     * @param name     * @return Class 注册对象的类型     * @throws NoSuchBeanDefinitionException     *     */    public static Class getType(String name) throws NoSuchBeanDefinitionException    {        return beanFactory.getType(name);    }    /**     * 如果给定的bean名字在bean定义中有别名，则返回这些别名     *     * @param name     * @return     * @throws NoSuchBeanDefinitionException     *     */    public static String[] getAliases(String name) throws NoSuchBeanDefinitionException    {        return beanFactory.getAliases(name);    }    /**     * 获取aop代理对象     *     * @param invoker     * @return     */    @SuppressWarnings("unchecked")    public static  T getAopProxy(T invoker)    {        return (T) AopContext.currentProxy();    }    /**     * 获取当前的环境配置，无配置返回null     *     * @return 当前的环境配置     */    public static String[] getActiveProfiles()    {        return applicationContext.getEnvironment().getActiveProfiles();    }    /**     * 获取当前的环境配置，当有多个环境配置时，只获取第一个     *     * @return 当前的环境配置     */    public static String getActiveProfile()    {        final String[] activeProfiles = getActiveProfiles();        return StringUtils.isNotEmpty(activeProfiles) ? activeProfiles[0] : null;    }    /**     * 获取配置文件中的值     *     * @param key 配置文件的key     * @return 当前的配置文件的值     *     */    public static String getRequiredProperty(String key)    {        return applicationContext.getEnvironment().getRequiredProperty(key);    }}

    4. 配置自定义区域信息解析器

    import org.springframework.util.StringUtils;import org.springframework.web.servlet.LocaleResolver;import javax.servlet.http.HttpServletRequest;import javax.servlet.http.HttpServletResponse;import java.util.Locale;/** * 自定义区域信息解析器 * @author 方磊 */public class MyLocalResolver implements LocaleResolver {        @Override   public Locale resolveLocale(HttpServletRequest request) {        // 获取请求中的语言参数来链接        String language = request.getParameter("language");        Locale locale = Locale.getDefault();        if (!StringUtils.isEmpty(language)) {            String[] strings = language.split("_");            locale = new Locale(strings[0], strings[1]);        }        return locale;    }        @Override    public void setLocale(HttpServletRequest request, HttpServletResponse response, Locale locale) {    }}

    5. 配置MessageUtils工具类

    import com.fang.ordering.common.utils.spring.SpringUtils;import org.springframework.context.MessageSource;import org.springframework.context.i18n.LocaleContextHolder;/** * 获取i18n资源文件 * * @author fanglei */public class MessageUtils{    /**     * 根据消息键和参数 获取消息 委托给spring messageSource     *     * @param code 消息键     * @param args 参数     * @return 获取国际化翻译值     */    public static String message(String code, Object... args)    {        MessageSource messageSource = SpringUtils.getBean(MessageSource.class);        return messageSource.getMessage(code, args, LocaleContextHolder.getLocale());    }}

    6. 使用工具类输出

    7. 总结

    实现：LocalResolver 、WebMvcConfigurer

    • LocalResolver ：默认的解析器，用于设置当前会话的默认国际化语言。
    • WebMvcConfigurer：拦截器，用来对请求的语言参数进行获取，采用默认的LocaleChangeInterceptor 作为拦截器来指定切换国际化语言的参数名。