一个简单的基于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{

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

    @Override
    public ResultModel beforeBodyWrite(ResultModel body, MethodParameter returnType, MediaType selectedContentType, Class> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
        try {
            // 从request中拿到请求头的多语言参数
            List 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 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字符串就行了。

如果有更好的解决思路欢迎分享，谢谢！