一个简单的基于Spring @ControllerAdvice的Java后端的@ResponseBody i18n的实现

公司项目原先的架构中,接口是通过一个通用的类转换成 Json 后返回数据的,这个返回的类如下

public class ResultModel {
    private boolean success;
    private String message;
    private T data;
    private String status;

    public boolean isSuccess() {
        return success;
    }

    public void setSuccess(boolean success) {
        this.success = success;
    }

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }

    public T getData() {
        return data;
    }

    public void setData(T data) {
        this.data = data;
    }

    public String getStatus() {
        return status;
    }

    public void setStatus(String status) {
        this.status = status;
    }
}

然后原先是没有i18n的需求,因此message都是直接写死在代码中。
如果要改成i18n,对于一个后端来说,我肯定需要知道客户端是什么语言,然后才能返回特定语言的文字。
因此第一时间想到的是在请求头添加语言信息,然后在 controller 方法调用结束后修改 resultModel 的message。
我需要在两个时间点写一些代码:

  • request请求之后
  • controller方法调用返回之后,被写到输出流之前

第一时间想到的是 Spring 的 Interceptor ,然后去翻了一遍官方文档。很遗憾, Interceptor的 postHandle方法并不能作用于用 @ResponseBody 修饰的方法,如图:


image.png

根据官方文档所说,我发现了可以用 ResponseBodyAdvice 实现我的需求。
然后就可以开始撸了,我的思路是:

  1. 将i18n字符串资源文件存于 properties 内。
  2. 用一个工具类管理各个语言的字符串资源
  3. web端保存一个指定语言的 cookie
  4. 在 ResponseBodyAdvice 中对 ResultModel 的 message 尝试替换,如果能在资源文件中找到,那么就替换字符串

上代码

ConvertResultMsgAdvice.java
@ControllerAdvice("com.hc.trr")
public class ConvertResultMsgAdvice implements ResponseBodyAdvice<ResultModel>{

    @Override
    public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
        //暂时全部放行
        return true;
    }

    @Override
    public ResultModel beforeBodyWrite(ResultModel body, MethodParameter returnType, MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
        try {
            // 从request中拿到请求头的多语言参数
            List<String> cookies = request.getHeaders().get("Cookie");
            if(cookies != null && cookies.size() > 0){
                String pattern = "^language=(^*.;*.);";
                Pattern r = Pattern.compile(pattern);
                for(String cookie: cookies){
                    Matcher m = r.matcher(cookie);
                    if(m.find()){
                        String language = m.group(1);
                        // 修改mgs参数,返回
                        String message = result.getMessage();;

                        message = I18nResourcesUtil.getStringBaseOnLanguage(language, message);
                        body.setMessage(message);
                    }
                }
            }

        } catch (Exception e) {
            return body;
        }

        return body;
    }
}
I18nResourcesUtil.java
public class I18nResourcesUtil {
    //存放多语言字符串资源的map,key为语言名称,map为读取到的properties
    private final static Map<String, Properties> languagesMap = new HashMap<>();

    // 加载多语言配置文件
    static{
        //获取类加载路径
        String stringsDir = new Object() {
            private String getPath() {
                return this.getClass().getResource("/strings").getPath();
            }
        }.getPath();
        File dir = new File(stringsDir);
        File[] stringFiles = dir.listFiles();
        try {
            if(stringFiles != null && stringFiles.length != 0){
                for(File file: stringFiles){
                    String language = file.getName().substring(0, file.getName().indexOf("."));
                    InputStream in = new BufferedInputStream(new FileInputStream(file.getAbsolutePath()));
                    Properties p = new Properties();
                    p.load(new InputStreamReader(in, "utf-8"));
                    languagesMap.put(language, p);
                }
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    /**
     * 根据语言获取i18n字符串
     * @param language
     * @param string
     * @return 如果没找到语言对应字符串,就去找默认语言,如果还找不到,就返回传进来的字符串
     */
    public static String getStringBaseOnLanguage(String language, String string){
        String i18nStr = string;
        Properties p = languagesMap.get(language);
        if(p != null){
            i18nStr = p.getProperty(string);
        }else{
            p = languagesMap.get("zh");
            if (p != null) {
                i18nStr = p.getProperty(string);
            }
        }
        return i18nStr;
    }
}
资源路径
image.png

最后把原先 resultModel 中写死的字符串,替换成properties中的key字符串就行了。

如果有更好的解决思路欢迎分享,谢谢!

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,009评论 5 474
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,808评论 2 378
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 148,891评论 0 335
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,283评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,285评论 5 363
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,409评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,809评论 3 393
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,487评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,680评论 1 295
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,499评论 2 318
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,548评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,268评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,815评论 3 304
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,872评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,102评论 1 258
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,683评论 2 348
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,253评论 2 341

推荐阅读更多精彩内容