SpringBoot系列之服务端解析客户端国际化请求

简介: SpringBoot系列之服务端解析客户端国际化请求

@[toc]

国际化方案

前后端分离的国际化方案,如果每个接口都增加参数,代码量和测试量会很大,最好把语言变量加到请求头并通过拦截器解析。

[外链图片转存中...(img-XHIIgkN6-1676540687983)]

具体过程如下:

  1. 客户端增加请求头 Accept-Language;
  2. 服务端增加拦截器,解析请求头Accept-Language中的语言值,并通过LanguageUtil设置到当前线程的语言环境中;
  3. 服务端需要返回多语言结果的地方,通过LanguageUtil获取当前请求客户端的语言。

除了请求头,也可以通过cookie实现,但是有些客户端不支持cookie,而且cookie存在被篡改的危险,因此更建议使用标准的请求头。

实现代码

通过 SpringMVC 的RequestContextUtilsjava.util.Local,可以很轻松地解析请求头中的语言标识。

SpringMVC提供了多种国际化的实现方式。

[外链图片转存中...(img-nowckmdd-1676540687984)]

下面一步步讲解代码实现。

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发起请求

[外链图片转存中...(img-x7uY2LfJ-1676540687985)]

测试请求的response

en_US

总结

本教程介绍了如何通过客户端的请求头设置服务端的语言环境,从而实现服务端响应内容的国际化。

希望对你有所帮助。

Links

目录
相关文章
|
2月前
|
人工智能 Java 开发者
【Spring】原理解析:Spring Boot 自动配置
Spring Boot通过“约定优于配置”的设计理念,自动检测项目依赖并根据这些依赖自动装配相应的Bean,从而解放开发者从繁琐的配置工作中解脱出来,专注于业务逻辑实现。
|
6月前
|
网络协议 Java
SpringBoot快速搭建TCP服务端和客户端
由于工作需要,研究了SpringBoot搭建TCP通信的过程,对于工程需要的小伙伴,只是想快速搭建一个可用的服务.其他的教程看了许多,感觉讲得太复杂,很容易弄乱,这里我只讲效率,展示快速搭建过程。
661 58
|
1月前
|
前端开发 Java 微服务
《深入理解Spring》:Spring、Spring MVC与Spring Boot的深度解析
Spring Framework是Java生态的基石,提供IoC、AOP等核心功能;Spring MVC基于其构建,实现Web层MVC架构;Spring Boot则通过自动配置和内嵌服务器,极大简化了开发与部署。三者层层演进,Spring Boot并非替代,而是对前者的高效封装与增强,适用于微服务与快速开发,而深入理解Spring Framework有助于更好驾驭整体技术栈。
|
1月前
|
XML JSON Java
【SpringBoot(三)】从请求到响应再到视图解析与模板引擎,本文带你领悟SpringBoot请求接收全流程!
Springboot专栏第三章,从请求的接收到视图解析,再到thymeleaf模板引擎的使用! 本文带你领悟SpringBoot请求接收到渲染的使用全流程!
197 3
|
2月前
|
Java 数据库 数据安全/隐私保护
Spring Boot四层架构深度解析
本文详解Spring Boot四层架构(Controller-Service-DAO-Database)的核心思想与实战应用,涵盖职责划分、代码结构、依赖注入、事务管理及常见问题解决方案,助力构建高内聚、低耦合的企业级应用。
791 1
|
8月前
|
存储 Java 文件存储
微服务——SpringBoot使用归纳——Spring Boot使用slf4j进行日志记录—— logback.xml 配置文件解析
本文解析了 `logback.xml` 配置文件的详细内容,包括日志输出格式、存储路径、控制台输出及日志级别等关键配置。通过定义 `LOG_PATTERN` 和 `FILE_PATH`,设置日志格式与存储路径;利用 `&lt;appender&gt;` 节点配置控制台和文件输出,支持日志滚动策略(如文件大小限制和保存时长);最后通过 `&lt;logger&gt;` 和 `&lt;root&gt;` 定义日志级别与输出方式。此配置适用于精细化管理日志输出,满足不同场景需求。
2121 1
|
7月前
|
前端开发 安全 Java
Spring Boot 便利店销售系统项目分包设计解析
本文深入解析了基于Spring Boot的便利店销售系统分包设计,通过清晰的分层架构(表现层、业务逻辑层、数据访问层等)和模块化设计,提升了代码的可维护性、复用性和扩展性。具体分包结构包括`controller`、`service`、`repository`、`entity`、`dto`、`config`和`util`等模块,职责分明,便于团队协作与功能迭代。该设计为复杂企业级应用开发提供了实践参考。
290 0
|
4月前
|
前端开发 Java 数据库连接
SpringBoot参数校验底层原理和实操。深度历险、深度解析(图解+秒懂+史上最全)
SpringBoot参数校验底层原理和实操。深度历险、深度解析(图解+秒懂+史上最全)
SpringBoot参数校验底层原理和实操。深度历险、深度解析(图解+秒懂+史上最全)
|
4月前
|
机器学习/深度学习 XML Java
【spring boot logback】日志logback格式解析
在 Spring Boot 中,Logback 是默认的日志框架,它支持灵活的日志格式配置。通过配置 logback.xml 文件,可以定义日志的输出格式、日志级别、日志文件路径等。
764 5
|
4月前
|
Java 关系型数据库 数据库连接
Spring Boot项目集成MyBatis Plus操作PostgreSQL全解析
集成 Spring Boot、PostgreSQL 和 MyBatis Plus 的步骤与 MyBatis 类似,只不过在 MyBatis Plus 中提供了更多的便利功能,如自动生成 SQL、分页查询、Wrapper 查询等。
406 3

推荐镜像

更多
  • DNS
  • 下一篇
    oss云网关配置