介紹
Spring Boot通過MessageSource接口來實現國際化,它可以加載不同的消息資源文件,通常是.properties格式。通過定義不同的語言文件(例如:messages_en.properties、messages_zh.properties等),可以根據用戶的語言環境來自動選擇對應的文件,提供不同的翻譯和文本來實現業務的國際化操作。
效果
英文
{"msg": "success","code": 200,"data": null
}
中文
{"msg": "操作成功","code": 200,"data": null
}
其他語言也可以自行配置
配置文件
spring:messages:# 國際化資源文件路徑basename: i18n/messages
messages表示匹配以messages開頭的文件
創建語言文件
message.properties
公共的語言文件
system.error.tip=請聯系管理員操作
messages_en_US.properties
英文語言文件
system.user.tip.name=Please enter the user name
system.user.tip.password=Please enter the user password
messages_zh_CN.properties
中文語言文件
system.user.tip.name=請輸入用戶名
system.user.tip.password=請輸入用戶密碼
多語言情況下請保持語言文件的格式和字段
攔截器配置
這個攔截器主要識別前端傳遞的語言字符串并根據字符串返回對應的語言
/*** 該類是一個自定義的攔截器,用于從HTTP請求的頭部獲取語言參數,并根據該參數設置當前請求的語言。* 它繼承自Spring的`LocaleChangeInterceptor`,并重寫了`preHandle`方法來實現自定義的語言切換邏輯。*/
public class CustomLocaleChangeInterceptor extends LocaleChangeInterceptor {// 設置請求頭中獲取語言的字段名private static final String LANG_HEADER = "lang";/*** 這個方法會在每個請求處理之前被調用,用來獲取請求頭中的語言設置,* 如果存在有效的語言參數,就會設置當前請求的語言環境。* @param request 當前的HTTP請求對象* @param response 當前的HTTP響應對象* @param handler 當前請求的處理器(一般是控制器方法)* @return 如果返回true,表示繼續執行后續的處理器鏈,否則會中斷請求的處理*/@Overridepublic boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {// 從請求頭中獲取指定的語言字段("lang")String lang = request.getHeader(LANG_HEADER);// 如果lang參數存在且不為空if (lang != null && !lang.isEmpty()) {// 按照"-"分割語言和地區信息String[] parts = lang.split("_");// 設置語言環境// parts[0]是語言(例如:en、zh)// parts[1]是地區(例如:US、CN),如果沒有地區則使用空字符串LocaleContextHolder.setLocale(new Locale(parts[0], parts.length > 1 ? parts[1] : ""));}// 返回true放行return true;}
}
還有一種方法可以從瀏覽器自帶的:Accept-Language:zh-CN,zh;q=0.9 來獲取但是各瀏覽器的參數有所不同所以沒采用,好處就是可以自動識別用戶的語言。
I18n配置類
/*** 資源文件配置加載* 該配置類用于設置國際化資源文件的加載和管理。它配置了語言環境解析器以及自定義的攔截器。* 通過此配置,Spring Web應用能夠根據用戶的請求來切換不同的語言環境(Locale)。*/
@Configuration
public class I18nConfig implements WebMvcConfigurer {/*** 定義一個 LocaleResolver bean,用于處理當前用戶會話中的語言環境。* * LocaleResolver 用于解析當前請求的語言環境,通常會根據Session中的信息來判斷。* 在這里我們使用的是 SessionLocaleResolver,它會將用戶選擇的語言存儲在Session中,* 這樣用戶在后續請求中可以保持相同的語言環境。** @return 返回配置好的 LocaleResolver*/@Beanpublic LocaleResolver localeResolver() {// 創建一個 SessionLocaleResolver 實例SessionLocaleResolver slr = new SessionLocaleResolver();// 設置默認的語言環境為簡體中文 (zh_CN)// 當用戶沒有明確設置語言時,應用默認使用簡體中文slr.setDefaultLocale(Locale.SIMPLIFIED_CHINESE);return slr;}/*** 配置國際化攔截器,用于監聽用戶請求中的語言切換參數。** 該方法會添加一個自定義的攔截器 CustomLocaleChangeInterceptor,目的是監聽用戶請求中的語言切換請求,* 并更新當前會話的語言環境。** @param registry 攔截器注冊器*/@Overridepublic void addInterceptors(InterceptorRegistry registry) {// 注冊自定義的語言環境切換攔截器// 該攔截器會監聽請求中是否包含語言參數(例如:?lang=zh_CN),// 如果有,就會根據該參數改變當前用戶的語言環境。registry.addInterceptor(new CustomLocaleChangeInterceptor());}
}
封裝Bean工具類
該代碼來著若依管理系統
/*** spring工具類,方便在非Spring管理環境中獲取bean* 提供一些用于獲取Spring上下文中的Bean,環境配置,AOP代理對象等功能的方法。* 該類實現了 BeanFactoryPostProcessor 和 ApplicationContextAware 接口,* 用于在非Spring管理環境中操作Spring容器中的bean。** @author ruoyi*/
@Component
public final class SpringUtils implements BeanFactoryPostProcessor, ApplicationContextAware
{/** Spring應用上下文環境的BeanFactory */private static ConfigurableListableBeanFactory beanFactory;/** Spring應用上下文環境 */private static ApplicationContext applicationContext;/*** 實現 BeanFactoryPostProcessor 接口的 postProcessBeanFactory 方法* 用于在Spring容器啟動時獲取Spring容器中的BeanFactory。** @param beanFactory Spring的BeanFactory* @throws BeansException 如果發生異常*/@Overridepublic void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException{SpringUtils.beanFactory = beanFactory; // 保存 BeanFactory 實例}/*** 實現 ApplicationContextAware 接口的 setApplicationContext 方法* 用于在Spring容器啟動時獲取Spring應用上下文環境。** @param applicationContext Spring的應用上下文* @throws BeansException 如果發生異常*/@Overridepublic void setApplicationContext(ApplicationContext applicationContext) throws BeansException{SpringUtils.applicationContext = applicationContext; // 保存應用上下文實例}/*** 根據bean名稱獲取Spring容器中的Bean實例** @param name bean的名稱* @return 返回與給定名稱相對應的bean實例* @throws org.springframework.beans.BeansException 如果沒有找到bean實例*/@SuppressWarnings("unchecked")public static <T> T getBean(String name) throws BeansException{return (T) beanFactory.getBean(name); // 獲取bean}/*** 根據給定的bean類型獲取Spring容器中的Bean實例** @param clz bean的類型* @return 返回與給定類型相對應的bean實例* @throws org.springframework.beans.BeansException 如果沒有找到bean實例*/public static <T> T getBean(Class<T> clz) throws BeansException{T result = (T) beanFactory.getBean(clz); // 根據類型獲取beanreturn result;}/*** 檢查BeanFactory中是否包含指定名稱的Bean定義** @param name bean的名稱* @return 如果包含該bean,返回true,否則返回false*/public static boolean containsBean(String name){return beanFactory.containsBean(name); // 檢查bean是否存在}/*** 判斷指定名稱的bean是singleton類型還是prototype類型* 如果指定名稱的bean沒有定義,將拋出NoSuchBeanDefinitionException異常。** @param name bean的名稱* @return 如果是singleton類型返回true,prototype類型返回false* @throws org.springframework.beans.factory.NoSuchBeanDefinitionException 如果沒有找到該bean*/public static boolean isSingleton(String name) throws NoSuchBeanDefinitionException{return beanFactory.isSingleton(name); // 判斷bean類型}/*** 獲取指定名稱bean的類型* 如果沒有找到bean,將拋出NoSuchBeanDefinitionException異常。** @param name bean的名稱* @return 返回指定bean的類型* @throws org.springframework.beans.factory.NoSuchBeanDefinitionException 如果沒有找到該bean*/public static Class<?> getType(String name) throws NoSuchBeanDefinitionException{return beanFactory.getType(name); // 獲取bean的類型}/*** 獲取指定名稱bean的別名* 如果該bean有別名,則返回所有別名,否則返回空數組。** @param name bean的名稱* @return 返回該bean的所有別名* @throws org.springframework.beans.factory.NoSuchBeanDefinitionException 如果沒有找到該bean*/public static String[] getAliases(String name) throws NoSuchBeanDefinitionException{return beanFactory.getAliases(name); // 獲取bean的別名}/*** 獲取當前bean的AOP代理對象* 通過AOP上下文獲取代理對象,并返回代理對象或原始bean實例。** @param invoker 需要代理的bean實例* @return 返回代理對象或者原始對象*/@SuppressWarnings("unchecked")public static <T> T getAopProxy(T invoker){Object proxy = AopContext.currentProxy(); // 獲取當前的AOP代理if (((Advised) proxy).getTargetSource().getTargetClass() == invoker.getClass()){return (T) proxy; // 如果是代理類,返回代理對象}return invoker; // 否則返回原始對象}/*** 獲取當前的激活環境配置* 如果有多個激活環境配置,返回所有的配置。** @return 返回當前的所有激活環境配置*/public static String[] getActiveProfiles(){return applicationContext.getEnvironment().getActiveProfiles(); // 獲取當前環境配置}/*** 獲取配置文件中的某個key對應的值* 從環境配置中獲取指定的屬性值,如果沒有找到該key,會拋出異常。** @param key 配置文件中的key* @return 返回配置文件中指定key對應的值*/public static String getRequiredProperty(String key){return applicationContext.getEnvironment().getRequiredProperty(key); // 獲取配置項的值}
}
封裝語言工具類
/*** 獲取i18n資源文件*/
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());}}
接口使用
@RequestMapping("/user")
public R user() {return R.success(I18NUtils.message("system.user.tip.name"));
}
前端請求
lang:en_US
返回英文
lang:zh_CN
返回中文
在請求頭中攜帶
傳入參數
語言文件
system.user.tip.name=請輸入用戶名:{0}
后端使用
System.out.println(I18NUtils.message("system.user.tip.name","admin"));
輸出結果
請輸入用戶名:admin