SpringMVC源码研究之LocaleResolver

短命女 2022-02-24 21:10 388阅读 0赞

> Java Web项目中，国际化算得上一个通用需求了。SpringMVC也是提供了自己的解决方案。

### 1. 概述 ###

本文主要关注SpringMVC中提供的国际化功能实现，额外提一句的是，以下涉及到的源码，其起始时间很多都是2003年初，阅读的时候很有种穿越时空的感觉。

### 2. 相关接口 ###

先来看看SpringMVC与国际化相关的接口定义

public interface LocaleResolver { 
    	Locale resolveLocale(HttpServletRequest request);
    	void setLocale(HttpServletRequest request, HttpServletResponse response, Locale locale);
    }

作为定义于spring-webmvc.jar根package下的接口，其位置已经非常明显地宣称其地位。接口定义依然是遵循了短小精简的最佳实践，一共两个方法——获取Locale以及设置Locale；

接下来我们再来看看接口相关的继承链：  
![LocaleResolver接口][LocaleResolver]  
从以上继承链中，我们可以发现一个有意思的存在—— `LocaleContextResolver`，以及与之相关的`LocaleContext`（通过查阅官方文档可以发现该接口定义了一种策略——决定当前真正的Locale，这就使得在`LocaleContextResolver`和Locale之间又创建了一个中间层，留出了更大的灵活度和扩展性）；

而且我们查看上面的继承链就能发现，除了创建于2003年的`AcceptHeaderLocaleResolver`之外，其他实现类都直接实现的是`LocaleContextResolver`，而非`LocaleResolver` 。

### 3. 应用 ###

在通览了相关接口以及继承链之后，接下来我们来看看是一次请求处理过程中，SpringMVC是如何实现i18n的。接下来我们将单次请求中的时间线以业务逻辑处理为界限，划分为前后两个部分——准备阶段和收尾阶段。

##### 3.1 准备阶段 #####

顺着 [SpringMVC源码研究之DispatcherServlet处理请求][SpringMVC_DispatcherServlet] 中提及的堆栈信息，我们可以发现如下堆栈信息：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xxemtjeDM_size_16_color_FFFFFF_t_70]  
这里可以看到如下几个关键信息：

1.  这里的返回值涉及到两个固定值`CookieLocaleResolver.LOCALE_REQUEST_ATTRIBUTE_NAME`和`CookieLocaleResolver.TIME_ZONE_REQUEST_ATTRIBUTE_NAME`，request将以它们为KEY从自身的Attributes中取走相应的实现类。而有取必然得先有存放，这里相关的存放位置可以在上图中的`CookieLocaleResolver.parseLocaleCookieIfNecessary()`方法实现中找到，感兴趣的读者可以自行查阅。
2.  SpringMVC中负责处理请求的 `DispatcherServlet.processRequest()`（继承自基类`FrameworkServlet`）专门定义了`buildLocaleContext()`方法来供子类来自定义扩展，而开发人员直接接触到`DispatcherServlet`正是覆写了此方法来提供自定义的`LocaleContext`逻辑。（见下图，其中`localeResolver`字段的初始化参见 [SpringMVC源码研究之DispatcherServlet初始化][SpringMVC_DispatcherServlet 1]）  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xxemtjeDM_size_16_color_FFFFFF_t_70 1]
3.  同样是在`DispatcherServlet.processRequest()`方法中，SpringMVC定义了`initContextHolders(request, localeContext, requestAttributes);`方法来做`LocaleContextHolder`类的准备工作。（`LocaleContextHolder` 使用`ThreadLocal` 来提供一系列针对Locale和TimeZone的静态工具方法。）

相关代码的完整逻辑链如下：

// 定义于FrameworkServlet.java, 且此方法被final修饰
    // 这是只列出与Locale相关的内容
    protected final void processRequest(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { 
    	...
    	LocaleContext previousLocaleContext = LocaleContextHolder.getLocaleContext();
    	LocaleContext localeContext = buildLocaleContext(request);
    	...
    	initContextHolders(request, localeContext, requestAttributes);
    	try { 
    		// 抽象方法
    		// DispatcherServlet 正是通过覆写此方法来加入更多的自定义逻辑
    		doService(request, response);
    	}
    	catch(...)  { 
    		...
    	}
    	finally { 
    		resetContextHolders(request, previousLocaleContext, previousAttributes);
    		...
    	}
    }

##### 3.2 收尾阶段 #####

回调完业务代码逻辑之后，SpringMVC开始根据请求返回的结果进行相应的处理，以将结果返回给客户端，其中涉及到Locale的代码如下所示：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xxemtjeDM_size_16_color_FFFFFF_t_70 2]  
上图中的堆栈信息已经非常清晰地表明了，SpringMVC将通过回调`localeResolver.resolveLocale()`，并将获取到的值设置到`response`中以返回给客户端。如此一套完整的i18n处理逻辑就算是闭环了。

##### 3.3 相关辅助类 #####

1.  `RequestContextUtils.getLocale()`
2.  `LocaleContextHolder.getLocale()` 由以上分析我们可以知道，其赋值时机早于我们的业务代码执行时机，所以在业务代码Controller层及相关的Service等层可以放心地调用此方法。

### 4. 实例 ###

以下为SpringMVC中与i18n相关的配置，至于相关的模板引起这里就不赘述了，网上相关文档太多，读者可以参考本文末尾提供的相关链接。

<mvc:interceptors>
    	<bean class="org.springframework.web.servlet.i18n.LocaleChangeInterceptor">
    		<property name="paramName" value="lang"></property>
    	</bean>
    </mvc:interceptors>
     
    
    
    <bean id="localeResolver" class="org.springframework.web.servlet.i18n.CookieLocaleResolver">
    	<property name="cookieName" value="lang" />
    	<property name="cookieMaxAge" value="604800" />
    	<property name="defaultLocale" value="zh_CN" />
    	<property name="cookiePath" value="/" />				
    </bean> 
    
    
    <bean id="messageSource" class="org.springframework.context.support.ReloadableResourceBundleMessageSource">
    	
    	<property name="useCodeAsDefaultMessage" value="false"/>
    	
    	<property name="cacheSeconds" value="60"/>
    	
    	<property name="basenames">
    		<list>
    			<value>classpath:config/i18n/messages</value>
    		</list>
    	</property>
    	<property name="defaultEncoding" value="UTF-8"/>
    </bean>

### 5. 参考 ###

1.  《精通Spring 4.x 企业应用开发实战》 P201，P630
2.  [SpringMVC源码研究之DispatcherServlet处理请求][SpringMVC_DispatcherServlet]
3.  [Spring MVC之LocaleResolver详解][Spring MVC_LocaleResolver]
4.  [SpringMVC+Freemarker+jQuery实现多语言（国际化）切换][SpringMVC_Freemarker_jQuery]

[LocaleResolver]: /images/20220225/2c9d093cc8954d188a8830e4a0b33aef.png
[SpringMVC_DispatcherServlet]: https://blog.csdn.net/lqzkcx3/article/details/78584358
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xxemtjeDM_size_16_color_FFFFFF_t_70]: /images/20220225/8088077fd3934b529fc0d22f04893945.png
[SpringMVC_DispatcherServlet 1]: https://blog.csdn.net/lqzkcx3/article/details/78160961
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xxemtjeDM_size_16_color_FFFFFF_t_70 1]: /images/20220225/f82db18dbc184646b4be7714080772d7.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xxemtjeDM_size_16_color_FFFFFF_t_70 2]: /images/20220225/e8c7a2f11ba248aab6a353d4663d1a79.png
[Spring MVC_LocaleResolver]: https://blog.csdn.net/zxfryp909012366/article/details/82955256
[SpringMVC_Freemarker_jQuery]: https://blog.csdn.net/m0_37845840/article/details/79317620