1 总体规范

1. 【强制】为了可以利用翻译平台支持程序提示语的翻译，切忌在一个工程中包含多个苍穹应用的提示语，不同苍穹应用的提示语应该放在不同的工程中。

2. 【强制】为了正常使用多语言产品，在提交中文元数据文件时，禁止提交非中文的元数据文件。

3. 【推荐】图片的多语言：原则上图片和文字需要做分离，这样在实现多语言时只要把文字抽取出来翻译。如果文字嵌入图片中则需要整个图片重新设计多语言。

2 多语言字段

2.1 单据设计文本类型处理

1.【强制】多语言环境下，单据设计时注意事项：文本类型的字段，有需要显示不同国家语言文字的，则应选择多语言文本控件。

2.【推荐】多语言字段勾选“通用语言“属性，可解决的问题：即使在其他语言下没有维护该语言的译文，以该语言登录云苍穹后，此字段显示为中文而不是空：

2.2 多语言字段设计规范

【推荐】多语言表的字段长度设置：字段长度根据业务实际情况设置，一般设置为500。

【强制】如果启用了通用语言的选项，对应的物理表中会增加一个字段，此字段的类型与多语言表中的字段保持一致

【强制】多语言表主键的字段类型为VARCHAR

2.3通用多语言自定义SQL

【推荐】代码使用orm查询会自动处理通用语言字段，对于直接用sql查询多语言字段值，需要判断该字段是否开启了通用语言，然后若当前语言环境对应的值为NULL则取通用字段上的值。

3 预插数据

3.1 预插数据规范

【强制】预插数据中不能填写分号，如果填写了分号，在制作多语言包时，分号会被识别为两个语句而截断，导致生成的语句在执行时报错。

【强制】在使用标准产品补丁进行多语言表的数据操作时，仅限于对简体中文数据进行新增、更新或删除操作，非简体中文数据由多语言产品补丁进行处理。

4 程序提示语

4.1中文词条与KEY写法规范

1. 【强制】程序提示语中的中文词条写法注意。

（1）中文词条要纯正，不要汉语然后夹杂着英文符号。

（2）词条的开头和结尾除非特殊原因最好不要留空格。

2. 【强制】中文词条中不要包含\n、\r这样的转义字符，也不要包含html标签。

比如，下面的中文词条："保存成功。\n请检查这条记录。"其中包含了\n转义字符，在中文场景下加载正常，前端显示的时候会换行，然而，在其他语种下，会直接在界面上显示\n而不是换行，这是因为多语言处理的时候经过了很多步骤，包括抽取、加载、工具转换、记录进入数据库、加载记录等过程，最后加载出来的转义字符会有多余的\。如果确实需要这样的换行效果，可以使用占位符。也就是把转义字符与其他中文拆开后再连接起来。另外，html包含了<>这样的特殊字符，在后续处理的过程中会报错，所以也需要把html标签与其它中文拆开后再连接起来，改造方法与转义字符的相同。

3.【推荐】代码中只包含需要翻译的中文内容。不要包含任何的格式、转移字符、特殊符号等。有可能导致译文显示错乱。

4.【强制】资源文件中的KEY唯一（不区分大小写）
* 有些数据库对大小写不敏感，会导致潜在问题。

反例：

4.2词条拼接处理规范

1. 【强制】提示语必须是完整的句子，句子中的变量需要使用占位符替换。

通常遇到的使用场景如下：

场景1：当代码中的提示语中只包含一个需要替换的变量时，可以使用%s进行替换。

正例：

中文示例：第5条行程。

代码示例：ResManager.loadKDString("第%s条行程。", "CslScheme_6", "fi-bcm-formplugin", count)

说明：中文内容中的“5”是代码根据实际情况动态变化的，并且在这条语句中只存在一个变量需要动态替换。因此可以使用%s进行替换。

场景2：当在提示语中需要按照顺序位置替换多个参数内容时，可以使用%1$s，%2$s按顺序使用。

正例：

中文示例：第2行“价格”不能为空。

代码示例：

ResManager.loadKDString("第%1$s行“%2$s”不能为空。", "SrcPurListMustInput_1", "scm-src-common",i+1,displayName))

说明：要使用%1$s，%2$s，%3$s等这种带参数位置的占位符，而不要使用%s，因为中文的语序跟其他语种的语序可能不同，这会导致翻译不准确或者翻译错误。在这个中文示例中，“2”和“价格”会随着录入人员实际录入的情况不同而发生变化。因此需要使用2个参数来进行变量替换。这时就需要使用%1$s和%2$s来进行替换。在代码示例中i+1用来替换行数，displayName用来替换具体字段内容。

场景3：当进行页面提示时，如果使用到了表单中某一字段控件的名称时，建议通过元数据来获取该名称，并通过占位符的方式进行页面提示。这样可以保证提示语内容与字段描述一致，同时字段描述修改时，不会影响代码中提示语内容，代码无需修改。

正例：

MainEntityType dataEntityType = EntityMetadataCache.getDataEntityType("页面编码");
Map<String, IDataEntityProperty> fields = dataEntityType.getAllEntities().get("页面编码").getFields();
String username = fields.get("字段标识").getDisplayName().toString()getView().showTipNotification(ResManager.loadKDString("%s已绑定环境，不允许新增环境。","Test_0","工程标识"，username);

说明：%s代替字段控件的名称

2. 【推荐】使用带参数位置的格式化形式，ResManager.loadKDString就可以满足格式化转换其他语言的需要。

正例：

代码示例：

ResManager.loadKDString("第%1$s行%2$s不能为空。", "SrcPurListMustInput_1", "scm-src-common", i,  displayName);

反例：

代码示例：

ResManager.loadKDString(String.format("第%1$s行%2$s不能为空。", i,  displayName), "SrcPurListMustInput_1", "scm-src-common");

可以使用String.format，但必须位于ResManager.loadKDString外层。

3. 更多拼接问题示例

（1）不成对双引号或单引号(含全角和半角)

反例：

ResManager.loadKDString("and函数的最终结果必须是“通过“或”不通过”。", "AndCompareCalculate_1", SYSTEM_TYPE)));

正例：

ResManager.loadKDString("and函数的最终结果必须是“通过”或“不通过”。", "AndCompareCalculate_1", SYSTEM_TYPE)));

（2）句首为冒号、顿号、逗号、全角句号、右方括号、右圆括号(含全角和半角)

反例：

errorMsg.append(number).append(ResManager.loadKDString("：存在下级资料，不允许个性化。", "BaseDataIndividualizer_6", SYSTEM_TYPE));

正例：

errorMsg.append(ResManager.loadKDString("%s：存在下级资料，不允许个性化。", "BaseDataIndividualize_6", SYSTEM_TYPE,number));

（3）句末为左圆括号、左方括号(含全角和半角)

反例：

String logStr = ResManager.loadKDString("初始化共享中心：", "WorkDateUtil_0", "ssc-task-formplugin") + centerId + ResManager.loadKDString("的工作日历（", "WorkDateUtil_1", "ssc-task-formplugin") + startDateCopy + ", " + endDateCopy + ResManager.loadKDString("），上午工作数量：", "WorkDateUtil_2", "ssc-task-formplugin")
                    + morning_workDateList.size() + ResManager.loadKDString("，下午工作数量：", "WorkDateUtil_3", "ssc-task-formplugin") + afternoon_workDateList.size() + ResManager.loadKDString("，工作日历分录dateentry：", "WorkDateUtil_4", "ssc-task-formplugin") + days;

正例：

String logStr = ResManager.loadKDString("初始化共享中心：%1$s的工作日历（%2$s，%3$s），上午工作数量：%4$s，下午工作数量：%5$s，工作日历分录dateentry：%6$s", "BaseContent_1",SYSTEM_TYPE,centerId ,startDateCopy ,endDateCopy,morning_workDateList.size() , afternoon_workDateList.size(),days);

（4）句子末尾为"从"、"但是"、"或者是、"第"

反例：

errorMsg.append(ResManager.loadKDString("优先级和时效分录第", "TaskRuleChildSave_4", "ssc-task-opplugin")).append(listSeq)
         .append(ResManager.loadKDString("行：优先级越高，设置的时效应该越小", "TaskRuleChildSave_5", SYSTEM_TYPE));

正例：

errorMsg.append(ResManager.loadKDString("优先级和时效分录第%s行：优先级越高，设置的时效应该越小。", "TaskRuleChildSave_4", SYSTEM_TYPE,listSeq));

4.3静态常量处理规范

1.【强制】程序提示语静态常量写法。

kd.bos.permission.formplugin.AdministratorEditPlugin

以上JAVA类的中文静态常量：

private static final String MSG_CANCEL_EDITNEWADMIN = "新增管理员未保存，是否放弃保存？";
private static final String MSG_CURADMIN_SAVEORNOT  = "当前管理员未保存，是否放弃保存？";

用转换工具处理后变成：

private static final String MSG_CANCEL_EDITNEWADMIN = ResManager.loadKDString("新增管理员未保存，是否放弃保存？", "AdministratorEditPlugin_0", "bos-permission-formplugin");
private static final String MSG_CURADMIN_SAVEORNOT  = ResManager.loadKDString("当前管理员未保存，是否放弃保存？", "AdministratorEditPlugin_1", "bos-permission-formplugin");

这样的处理，在运行时不会根据不同的登录语言返回相应的译文。

this.getView().showConfirm(MSG_CANCEL_EDITNEWADMIN, MessageBoxOptions.OKCancel,new ConfirmCallBackListener(eventInfo, this));

解决方案：增加一个获取提示语的方法：

private String getMsgCancleEditNewAdmin(){
return "新增管理员未保存，是否放弃保存？";
}

原来使用静态常量的地方修改为调用获取提示语的方法

this.getView().showConfirm(getMsgCancleEditNewAdmin(), MessageBoxOptions.OKCancel,
              new ConfirmCallBackListener(eventInfo, this));

程序提示语转换工具加工后的代码为

private String getMsgCancleEditNewAdmin(){ return ResManager.loadKDString("新增管理员未保存，是否放弃保存？", "AdministratorEditPlugin_0", "bos-permission-formplugin");
 
}

2. 【推荐】不能使用static来修饰中文静态常量，要按照推荐的方式对代码进行修改。开发完成后，可以使用多语言检查工具来进行硬编码代码检查。保证代码不存在中文硬编码问题。

4.4枚举类型处理规范

1. 【推荐】枚举类也存在与静态变量类似的问题，建议改动办法如下：

比如有这样的一个枚举类：

public enum StateEnum {
    PASS("1", "通过"),
    NOT_PASS("2", "不通过");

    private String code;
    private String name;

    StateEnum(String code, String name) {
        this.code = code;
        this.name = name;
    }

    public String getCode() {
        return code;
    }

    public String getName() {
        return name;
    }
}

用转换工具处理后，变成：

public enum StateEnum {
    PASS("1",ResManager.loadKDString("通过", "StateEnum_0", "helloworld")),
    NOT_PASS("2",ResManager.loadKDString("不通过", "StateEnum_1", "helloworld"));

    private String code;
    private String name;

    StateEnum(String code, String name) {
        this.code = code;
        this.name = name;
    }

    public String getCode() {
        return code;
    }

    public String getName() {
        return name;
    }
}

但枚举类按照Java规范也只会初始化加载一次。如果切换语言，则不会根据当前登录或显示语言加载相应的译文。

改动办法：新增一个类（类名请命名为：MultiLangEnumBridge，否则多语言检查工具会阻拦）：

public class MultiLangEnumBridge {
    private String description;
    private String resourceID;
    private String systemType;
 
    public MultiLangEnumBridge() {}
 
    public MultiLangEnumBridge(String description, String resourceID, String systemType) {
        this.description = description;
        this.resourceID = resourceID;
        this.systemType = systemType;
    }
 
    /**
     * 获取提示语
     * 
     * @return
     */
    public String loadKDString() {
        return ResManager.loadKDString(this.getDescription(), this.getResourceID(), this.getSystemType());
    }
 
    public String getDescription() {
        return description;
    }
 
    public void setDescription(String description) {
        this.description = description;
    }
 
    public String getResourceID() {
        return resourceID;
    }
 
    public void setResourceID(String resourceID) {
        this.resourceID = resourceID;
    }
 
    public String getSystemType() {
        return systemType;
    }
 
    public void setSystemType(String systemType) {
        this.systemType = systemType;
    }
}

枚举类的修改：把枚举类中的中文字符，使用类MultiLangEnumBridge来进行初始化，并且调用它里面的方法获取当前译文，示例代码改造如下：

public enum StateEnum {
    PASS("1", new MultiLangEnumBridge("通过", "StateEnum_0", "helloworld")),
    NOT_PASS("2", new MultiLangEnumBridge("不通过", "StateEnum_1", "helloworld"));

    private String code;

    private MultiLangEnumBridge bridge = null;

    StateEnum(String code, MultiLangEnumBridge bridge) {
        this.code = code;
        this.bridge = bridge;
    }

    public String getCode() {
        return code;
    }

    //不是在初始化时加载译文，而是在每次取值时调用方法获取译文
    public String getName() {
        return this.bridge.loadKDString();
    }
}

这样，根据枚举编码获取名称，可以按照当前登录语种返回对应的译文：

StateEnum.PASS.getName();

请按照以上规范改造包含中文的枚举类，如果采用其他修改办法可能会导致多语言检查工具阻拦。

2.【推荐】Java枚举类按照上面的规范进行修改就可以保证译文的正常显示。否则译文可能无法正常翻译和显示。可以使用平台提供的公共MultiLangEnumBridge类，在bos-dataentity.jar下kd.bos.dataentity.resource.promptenum.MultiLangEnumBridge。

4.5提示语编码规范

1.【强制】程序提示语为支持多语言，必须不能使用硬编码，而是要使用多语言资源文件。请注意，资源文件也就是.properties文件的编码一定要设置为UTF-8，否则可能会出现乱码。

如已有程序提示语硬编码，可通过多语言代码转换工具（见文末附件）进行处理。

双击ChineseHardCodeScanTool/ ChineseHardCodeScanUI.bat打开多语言代码转换工具。选择源代码根目录和日志输出目录。然后点击‘确定’，开始检索替换处理。

如果处理过程有异常，请根据日志修改源代码。处理成功后，会在源代码根目录产生一个目录resources，在resources目录下会创建一个简体中文资源文件，工程编码_zh_CN.properties，编码格式为UTF-8。同时把Java代码中的硬编码自动替换成如下的形式：

ResManager.loadKDString("自定义职能数量已超出限制：", "OrgBizFormPlugin_0", "bos-org-formplugin")

代码中生成的内容与properties文件中的内容是一一对应的。

如果是使用gradle进行构建，则需要修改配置文件build.gradle。

修改copytolib任务，增加一段

     processResources{
   from('src/main/java') {
    include '**/*.properties'
    }
   }

2.【推荐】推荐使用多语言代码转换工具（见文末附件），对代码和properties进行修改。尽量不要手动修改带代码和properties文件。手动修改可能会导致参数不一致，或是因为编辑工具的编码不同，导致properties文件的编码格式不是标准的UTF-8格式。从而导致苍穹的翻译中心无法正确获取程序提示语，译文无法正常生成。

如果代码中的中文进行了修改，运行转换工具后，变更的中文也会自动更新到properties文件中。不需要开发人员手动替换。

4.6硬编码校验方法

【推荐】程序提示硬编码改造完成后，可使用多语言检查工具（见文末附件）进行检查。以便确保代码符合多语言开发规范。

说明：中文检查工具可以向金蝶云苍穹国际产品申请。具体使用方法可以参照检查工具中的说明即可。

4.7苍穹调度作业使用规范

1.【强制】在使用苍穹调度任务时，如果涉及到程序提示语的使用。需要在任务中手动设置调度任务的语种。

场景1：在苍穹业务的开发中，业务开发人员可能会涉及到苍穹调度任务的开发和使用。并且也会使用到程序提示语。这时就需要特别注意，调用任务在执行时没有通过所在的上下文来获取语种，而是默认为中文语种，从而导致任务获取的程序提示语也是中文的。因此需要在初始化调度任务时，指定当前登录的语言。

2.【推荐】在调度任务中使用setRunByLang(Lang.get())来设置运行语言。

 JobInfo  job = new  JobInfo();
 Job. setRunByLang(Lang.get());

4.8语言不能参与逻辑判断

【强制】在开发时，避免使用具体语言（中文）的内容进行代码判断或逻辑校验。
【推荐】使用固定不变的值来进行逻辑判断。例如标识符、编码、键值等。

反例：
正例：

4.9提示语使用范围
【强制】在使用程序提示语时，仅可以使用所属GIT工程范围内资源文件中的提示语。
【强制】对于不再使用的程序提示语，及时从资源文件中删除。

5、元数据

5.1 元数据拼接规范

【强制】页面展示中，不允许出现词条拼接。

反例：

（1）数字控件（整数、小数等）+标签（标签内容为中文）
（2）步进器+标签（标签内容为中文）
（3）标签（标签文本内容为数字）+标签（标签内容为中文）
（4）卡片字段（标签文本内容为数字）+标签（标签内容为中文）

正例：

6 获取系统语言

【推荐】在苍穹系统中，当业务需要获取语言的信息时，推荐使用苍穹提供的方法。

获取苍穹系统中所有的启用语言和默认语言

InteServiceHelper.getEnabledLang();

该方法会返回所有启用语言的对象列表。如果需要获取系统默认语言，可以在语言列表中判断isDefault属性值是否为true。

获取当前登录语言

Lang lang = Lang.get();

获取苍穹系统中所有多语言字段的启用语言

InteServiceHelper.getMultiLangEnabledLang();

使用场景：

系统启用语言：用户登录时，可以选择不同的语言登录。

当前登录语言：用户选择一个语言登录后，页面可以优先按这种语言显示。

系统默认语言：当前登录语言未翻译时，页面可以按系统默认语言显示。大多数国际化企业，将默认语言设置为英语。

多语言字段的启用语言：用户可以单独为多语言字段录入更多的语言值，而无需增加登录语言。

7 调用接口语言

【推荐】在调用苍穹OpenAPI接口时，需要根据实际业务场景来设置接口语言信息。

可以参考官方说明：https://developer.kingdee.com/article/453557180919091968?productLineId=29&isKnowledge=2

8、前端文件

【推荐】开发前端自定义控件时，需要进行多语言实现。JavaScript、HTML等文件中不允许出现中文或中文符号。多语言实现参考：https://vip.kingdee.com/school/detail/238388113520005120?productLineId=29&lang=zh-CN。

多语言开发规范

多语言开发规范

恭喜您！