如何自定义错误码

使用说明

系统支持对错误码信息进行多语言国际化配置。通过配置错误码，实现根据用户使用的不同语言，将错误码信息进行不同的展示。

自定义错误码

1. 参考登录经典应用设计器中操作，登录经典版应用设计器。
2. 在页面左下方，单击“配置”。
   图1 选择配置
   

3. 在自定义错误码页签，单击“新建”，进入新建错误码页面。

   也可以单击“导入”，选择系统中已创建的错误码进行导入。

4. 设置错误码参数，单击“保存”。
   图2 新建错误码
   
   • 名称：自定义的错误码，建议以字母开头，长度不超过64个字节，包括命名空间。
   • 类别：新建错误码所属的分类。
   • Http状态码：选择Http协议状态码。
   • 语言：根据需要，选择所需的语言类型。单击“新增”，可添加多语言错误码。若待添加的语言不存在，可单击语言后的。在提示信息中，单击“翻译工作台”，跳转至翻译工作台配置页面进行添加。
   • 格式：错误码的信息描述，支持使用{Number}表示变量名。例如 ，{0} 表示第一个输出变量，{1} 表示第二个输出变量，以此类推。

如何使用自定义错误码

自定义错误码创建完成后，可在脚本中使用。在脚本中，调用抛出错误信息的error函数I18nError('ErrorCodeName','变量1','变量2')。该函数中，输入参数为错误码名称"t__testErrorCode"和错误码信息中所携带的变量（"val1"和"val2"）。

1. 创建脚本。
   1. 在经典版应用设计器中，将鼠标放在某个文件夹上，单击加号，选择“脚本”。
      图3 选择脚本
      
   2. 设置脚本的名称，模板选择“空脚本”，单击“添加”。
      图4 创建一个空脚本
      
   3. 在脚本编辑器中，输入如下代码。

      // test custom error func , get diff language error by user lang
      import * as error from 'error';
      export class TestDemo {
          @action.method({ label: 'test', description: 'error code', input: 'No input', output: 'No output' })
          public test() {
              //使用I18nError函数设定错误码和错误码信息携带变量
               throw new error.I18nError('t__testErrorCode', ["val1", "val2"]);
          }
      }

      其中，“t__testErrorCode”为自定义错误码名称，请根据实际情况配置。

   4. 单击，保存脚本后，单击，启用脚本。

2. 按照如何开放API接口中操作，绑定上述开发的脚本，进行测试。
   图5 自定义错误信息测试