JeeSite 4.x

Spring Boot 最好的快速开发平台

国际化(i18n)、多语言、本地化使用文档

特点

1、支持登录时,指定语言,或登录后进行语言切换(param_lang=en)
2、支持 Cookie 存储语言设置,没有 Cookie 的情况使用 Session 存储,支持移动端
3、支持 properties 文件、数据库存储译文,方便译文数据进行管理。
4、可翻译:固定数据(如:页面标题、标签、消息提示)、动态数据(如:菜单数据、字典数据等)
5、中文免写 zh_CN 译文,如:text(‘你好’),找不到对应 key 直接原样输出 “你好”
6、支持 key 和译文参数,如:text(‘今天第{0}天’, 3),输出 “今天第3天”
7、支持 key 加前缀,方便区分模块,如:text(‘$user.你好’),输出 “你好”
8、使用中文Code,易于使用,易于分析源码,易于开发人员产品维护

注意此功能是专业版功能,只有专业版才能使用。

语言文件

后端语言文件

固定数据语言

不会变化的文字翻译,如:某个提示信息,字段 label,列表标题,按钮文字等,这些译文需要放到 properties 里。

文件目录结构,支持模块化分类语言文件结构,如下:

/src/main/resources/i18n/模块编码/i18n_语言编码.properties

例如:msg 模块 en 译文配置:

/src/main/resources/i18n/msg/i18n_en.properties

文件内容:

  • 文件内容采用 key=value 方式存储,如:你好=Hello
  • 若Key中包含空格,可使用“\”转义,如:提\ 交=Submit
  • 带参数的译文,如:今天第\ {0}\ 天。= Today is the {0} day.

在系统字典中维护新增加的语言:sys_lang_type,字典编码为语言编码;

动态数据语言

业务或管理员可通过数据库进行修改或配置的一些文字译文,如菜单名称,字典名称,字典值等。

这些可通过 system 账号登录,进入菜单 “系统管理 -> 系统设置 -> 国际化管理” 添加译文。

前端语言文件

根据需求自己扩展语言文件,例如:

<script src="${ctxStatic}/modules/i18n/i18n_${lang()}.js" ></script>

举例内容如下:

window.jeesiteMessage = $.extend({}, window.jeesiteMessage, {
    '你好' : 'Hello',
    '今天第 {0} 天' : ' Today is the {0} day.'
});

语言调用方法

Java

1、获取语言名称:Global.getLang()

返回:en、zh_CN

2、获取语言编码译文:Global.getText(code)

例如:Global.getText(“你好”)

3、获取语言编码译文,支持参数:Global.getText(code, params…)

例如:Global.getText(“今天第{0}天”, 3)

4、在集成 BaseController 和 BaseService 的类里可直接通过

例如:text(code) 或 text(code, params…)

Beetl视图

1、获取语言名称:${lang()}

返回:en、zh_CN

2、获取语言编码译文:${text(code)}

例如:${text(“你好”)}

3、获取语言编码译文,支持参数:${text(code, params…)}

例如:${text(“今天第{0}天”, 3)}

JavaScript

1、获取语言名称:window.lang || ‘zh_CN’

返回:en、zh_CN

2、获取语言编码译文:text(code)

例如:text(“你好”)

3、获取语言编码译文,支持参数: text(code, params…)

例如:text(“今天第{0}天”, 3)

常用语言编码

java.util.Locale :

public static final Locale ENGLISH = createConstant("en", "");
public static final Locale FRENCH = createConstant("fr", "");
public static final Locale GERMAN = createConstant("de", "");
public static final Locale ITALIAN = createConstant("it", "");
public static final Locale JAPANESE = createConstant("ja", "");
public static final Locale KOREAN = createConstant("ko", "");
public static final Locale CHINESE = createConstant("zh", "");
public static final Locale SIMPLIFIED_CHINESE = createConstant("zh", "CN");
public static final Locale TRADITIONAL_CHINESE = createConstant("zh", "TW");
public static final Locale FRANCE = createConstant("fr", "FR");
public static final Locale GERMANY = createConstant("de", "DE");
public static final Locale ITALY = createConstant("it", "IT");
public static final Locale JAPAN = createConstant("ja", "JP");
public static final Locale KOREA = createConstant("ko", "KR");
public static final Locale CHINA = SIMPLIFIED_CHINESE;
public static final Locale PRC = SIMPLIFIED_CHINESE;
public static final Locale TAIWAN = TRADITIONAL_CHINESE;
public static final Locale UK = createConstant("en", "GB");
public static final Locale US = createConstant("en", "US");
public static final Locale CANADA = createConstant("en", "CA");
public static final Locale CANADA_FRENCH = createConstant("fr", "CA");

语言代码表:http://www.lingoes.cn/zh/translator/langcode.htm

词条抽取工具

感谢 SoleMan 分享,词条抽取工具,可快速将 字典、菜单、源文件 中的译文编码抽取出来。

字典抽取:

INSERT IGNORE INTO js_sys_lang (id, module_code, lang_code, lang_text, lang_type, create_by, create_date, update_by, update_date, remarks)
select distinct md5(dict_label) as id, 'core' as module_code, dict_label as lang_code, '' as lang_text, 'en' as lang_type, 'system' as create_by, now() as create_date, 'system' as update_by, now() as update_date, 'dict' as remarks
from js_sys_dict_data;

菜单抽取:

INSERT IGNORE INTO js_sys_lang (id, module_code, lang_code, lang_text, lang_type, create_by, create_date, update_by, update_date, remarks)
select distinct md5(menu_name) as id, 'core' as module_code, menu_name as lang_code, '' as lang_text, 'en' as lang_type, 'system' as create_by, now() as create_date, 'system' as update_by, now() as update_date, 'menu' as remarks
from js_sys_menu;

源文件抽取(找到未国际化的汉字):

package com.jeesite.test;

import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.util.LinkedHashSet;
import java.util.Set;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import com.jeesite.common.io.FileUtils;
import com.jeesite.common.lang.StringUtils;

/**
 * 根据文件类型提取词条(找到未国际化的汉字)
 * @author wujie, soleman, jeesite
 */
public class I18nEntryExtractor {

	private static Set<String> unfinishedOut = new LinkedHashSet<>();
	private static Set<String> unfinishedSet = new LinkedHashSet<>();

	/**
	 * 根据文件类型提取词条
	 */
	public static void main(String[] args) throws Exception {
		String[] types = new String[] { ".java", ".html", ".js" };
		String rootPath = FileUtils.getProjectPath();
		System.out.println("Root Path: " + rootPath);
		extracted(rootPath + "/src/main/java", types);
		extracted(rootPath + "/src/main/resources/views", types);
	}

	private static void extracted(String mainPath, String[] types) throws Exception {
		Set<String> sets = new LinkedHashSet<>();

		Files.walk(Paths.get(mainPath))
			.filter(file -> StringUtils.endsWithAny(file.toString(), types))
			.sorted((f1, f2) -> {
				return StringUtils.substringAfterLast(f1.toString(), ".")
						.compareTo(StringUtils.substringAfterLast(f2.toString(), "."));
			})
			.forEach(file -> {
				// System.out.println("# Processing file " + file.toString());
				try {
					Files.lines(file).forEach(line -> {
						// 过滤掉注释和注解
						String regex = "^[\\s\t]*(//|\\*|@).*";
						if (!line.matches(regex)) {
							extractChineseEntry(file.getFileName().toString(), line, sets);
						}
					});
				} catch (IOException e) {
					e.printStackTrace();
				}
				if (!unfinishedSet.isEmpty()) {
					unfinishedOut.add("**************" + file.toString() + "**************");
					unfinishedOut.addAll(unfinishedSet);
					unfinishedOut.add("\n");
					unfinishedSet.clear();
				}
			});

		sets.forEach(entry -> {
			System.out.println(entry);
		});
		System.out.println("# Total: " + sets.size());
		
		Thread.sleep(1000);
		unfinishedOut.forEach(System.err::println);
		unfinishedOut.clear();
	}

	/**
	 * 正则提取汉字
	 */
	public static void extractChineseEntry(String file, String line, Set<String> sets) {
		// 提取单引号或双引号内的中文词条
		String regex = "(?:['\"]([^'\"]*?[\u4e00-\u9fa5]+?[^'\"]*?)['\"])";
		Matcher matcher = Pattern.compile(regex).matcher(line);
		while (matcher.find()) {
			if (!StringUtils.contains(line, "text(")) {
				unfinishedSet.add(line);
			}
			sets.add(matcher.group(1));
		}
	}
	
}

关注 JeeSite 公众号,了解最新动态