SpringBoot系列之服務端解析客戶端國際化請求

國際化方案

先後端分離的國際化方案，若是每一個接口都增長參數，代碼量和測試量會很大，最好把語言變量加到請求頭並經過攔截器解析。

具體過程以下：

1. 客戶端增長請求頭 Accept-Language；
2. 服務端增長攔截器，解析請求頭Accept-Language中的語言值，並經過LanguageUtil設置到當前線程的語言環境中；
3. 服務端須要返回多語言結果的地方，經過LanguageUtil獲取當前請求客戶端的語言。

除了請求頭，也能夠經過cookie實現，可是有些客戶端不支持cookie，並且cookie存在被篡改的危險，所以更建議使用標準的請求頭。

實現代碼

經過 SpringMVC 的RequestContextUtils和java.util.Local，能夠很輕鬆地解析請求頭中的語言標識。

SpringMVC提供了多種國際化的實現方式。

下面一步步講解代碼實現。

pom.xml

使用SpringBoot搭建項目，而且引入Lombok用於簡化JavaBean。

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>2.1.3.RELEASE</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>
	<groupId>net.ijiangtao.tech.framework.spring.ispringboot.demo</groupId>
	<artifactId>demo-i18n</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<name>demo-i18n</name>
	<description>Demo  Spring Boot  project for i18n</description>

	<properties>
		<java.version>1.8</java.version>
	</properties>

	<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>

		<dependency>
			<groupId>org.projectlombok</groupId>
			<artifactId>lombok</artifactId>
			<optional>true</optional>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
		</dependency>
	</dependencies>

	<build>
		<plugins>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
			</plugin>
		</plugins>
	</build>

</project>

複製代碼

application.properties

配置當前服務的端口。

server.port=8303
複製代碼

LanguageUtil.java

使用ThreadLocal保存當前線程的環境語言。

/** * @author ijiangtao.net */
public class LanguageUtil {

    public static final String ZH_CN = "zh_CN";

    public static final String EN_US = "en_US";

    public static final String DEFAULT_LANGUAGE = ZH_CN;

    private String lang;

    private static final ThreadLocal<LanguageUtil> context = new ThreadLocal<LanguageUtil>() {
        @Override
        protected LanguageUtil initialValue() {
            return new LanguageUtil();
        }
    };

    public LanguageUtil() {
        lang = DEFAULT_LANGUAGE;
    }

    public static LanguageUtil getCurrentContext() {
        return (LanguageUtil) context.get();
    }

    public static String getCurrentLang() {
        return getCurrentContext().lang;
    }

    public static void setCurrentLang(String lang) {
        getCurrentContext().lang = lang;
    }

    public static void remove() {
        context.remove();
    }
}
複製代碼

LanguageInterceptor.java

實現HandlerInterceptor接口，攔截並解析請求頭中的環境語言，並設置到LanguageUtil中。

import lombok.extern.slf4j.Slf4j;
import net.ijiangtao.tech.framework.spring.ispringboot.demo.i18n.util.LanguageUtil;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.LocaleResolver;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.support.RequestContextUtils;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.Locale;

@Slf4j
public class LanguageInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        log.info("preHandle:請求前調用");

        //請求頭 當前語言
        // Accept-Language: zh-CN
        // Accept-Language: en-US
        LocaleResolver localeResolver = RequestContextUtils.getLocaleResolver(request);
        Locale local= localeResolver.resolveLocale(request);

        log.info("local={} , localDisplayName={}",local.toString(),local.getDisplayName());

        LanguageUtil.setCurrentLang(local.toString());
        log.info("LanguageUtil.getCurrentLang() = {}",LanguageUtil.getCurrentLang());

        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        log.info("postHandle:請求後調用");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        log.info("afterCompletion:請求調用完成後回調方法，即在視圖渲染完成後回調");
    }

}

複製代碼

InterceptorConfig.java

配置攔截器並使之生效。

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;

@Configuration
public class InterceptorConfig extends WebMvcConfigurationSupport {

    @Override
    public void addInterceptors(InterceptorRegistry registry){
        registry.addInterceptor(new LanguageInterceptor())
                .addPathPatterns("/**")
                .excludePathPatterns("/noi18n")
                .excludePathPatterns("/onelang");
    }

}

複製代碼

LanguageController.java

從LanguageController中獲取當前線程設置的環境語言，測試效果。

import net.ijiangtao.tech.framework.spring.ispringboot.demo.i18n.util.LanguageUtil;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.ResponseBody;

/** * * @author ijiangtao.net */
@Controller
public class LanguageController {

    @GetMapping("/lang/current")
    @ResponseBody
    public String currentLanguage(){
        return LanguageUtil.getCurrentLang();
    }
}

複製代碼

測試

使用IDEA的Rest Client發起請求

測試請求的response

en_US
複製代碼

總結

本教程介紹瞭如何經過客戶端的請求頭設置服務端的語言環境，從而實現服務端響應內容的國際化。

但願對你有所幫助。

Links

• 完整示例代碼(github)