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

國際化方案

前后端分離的國際化方案,如果每個(gè)接口都增加參數(shù),代碼量和測試量會很大,最好把語言變量加到請求頭并通過攔截器解析。

i18n

具體過程如下:

  1. 客戶端增加請求頭 Accept-Language;
  2. 服務(wù)端增加攔截器,解析請求頭Accept-Language中的語言值,并通過LanguageUtil設(shè)置到當(dāng)前線程的語言環(huán)境中;
  3. 服務(wù)端需要返回多語言結(jié)果的地方,通過LanguageUtil獲取當(dāng)前請求客戶端的語言。

除了請求頭,也可以通過cookie實(shí)現(xiàn),但是有些客戶端不支持cookie,而且cookie存在被篡改的危險(xiǎn),因此更建議使用標(biāo)準(zhǔn)的請求頭。

實(shí)現(xiàn)代碼

通過 SpringMVC 的RequestContextUtilsjava.util.Local,可以很輕松地解析請求頭中的語言標(biāo)識。

SpringMVC提供了多種國際化的實(shí)現(xiàn)方式。

i18n3

下面一步步講解代碼實(shí)現(xiàn)。

pom.xml

使用SpringBoot搭建項(xiàng)目,并且引入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

配置當(dāng)前服務(wù)的端口。

server.port=8303

LanguageUtil.java

使用ThreadLocal保存當(dāng)前線程的環(huán)境語言。

/**
 * @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

實(shí)現(xiàn)HandlerInterceptor接口,攔截并解析請求頭中的環(huán)境語言,并設(shè)置到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:請求前調(diào)用");

        //請求頭 當(dāng)前語言
        // 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:請求后調(diào)用");
    }

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

}

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中獲取當(dāng)前線程設(shè)置的環(huán)境語言,測試效果。


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發(fā)起請求

使用IDEA的Rest Client發(fā)起請求

測試請求的response

en_US

總結(jié)

本教程介紹了如何通過客戶端的請求頭設(shè)置服務(wù)端的語言環(huán)境,從而實(shí)現(xiàn)服務(wù)端響應(yīng)內(nèi)容的國際化。

希望對你有所幫助。

Links

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

推薦閱讀更多精彩內(nèi)容

  • 會話(Session)跟蹤是Web程序中常用的技術(shù),用來跟蹤用戶的整個(gè)會話。常用的會話跟蹤技術(shù)是Cookie與Se...
    chinariver閱讀 5,666評論 1 49
  • Swift1> Swift和OC的區(qū)別1.1> Swift沒有地址/指針的概念1.2> 泛型1.3> 類型嚴(yán)謹(jǐn) 對...
    cosWriter閱讀 11,140評論 1 32
  • IOC 控制反轉(zhuǎn)容器控制程序?qū)ο笾g的關(guān)系,而不是傳統(tǒng)實(shí)現(xiàn)中,有程序代碼之間控制,又名依賴注入。All 類的創(chuàng)建,...
    irckwk1閱讀 977評論 0 0
  • 文丨紅瑀 【系列連載】生活在臺灣(目錄) 臺灣有四大族群-閩南人、客家人、外省人與原住民,單單閩南人就占了約70%...
    紅瑀閱讀 1,796評論 30 26
  • 穢語癥閱讀 154評論 0 0