配置错误码

使用说明

调用接口出错后，用户可根据每个接口对应的错误码来定位错误原因。AstroZero支持用户自定义错误码，并支持对错误码描述进行多语言国际化配置，实现根据语言的不同将错误码描述信息进行不同的展示。

本节介绍的是如何在管理中心配置错误码，用户还可以在应用开发工作台中配置错误码（相关操作请参考自定义错误码）。两者的区别是在应用开发工作台中配置的错误码，可在打包发布应用时，将错误码一起打包发布出去。例如将应用打包发布到运行环境，错误码也会同步打包到运行环境，不需要在运行环境重复创建。在管理中心设置的错误码，无法随应用发布出去。

创建错误码

1. 参考登录管理中心中操作，登录AstroZero管理中心。
2. 在左侧导航栏中，选择“系统管理 > 错误码”。
3. 在自定义错误码页面，单击“新建”。
   在错误码页面，显示如下两个页签：

   • 自定义错误码：展示用户自定义的错误码，支持增加、删除和修改自定义的错误码。
   • 系统错误码：展示AstroZero预置的错误码，可查看预置的错误码和错误原因，但不能删除。

4. 配置错误码参数，单击“保存”。
   图1 自定义错误码
   

   表1 错误码参数说明

   参数	参数说明
   名称	新建错误码的名称，如“Error001”。 系统会根据“名称”和“语言”匹配错误码进行展示，请保证“名称”+“语言”唯一。
   类别	错误码所属的分类。
   Http状态码	Http协议状态码。
   语言	请根据实际需求从下拉列表中选择语言类型。 单击“新增”，可创建多语言错误码。 单击语言后的，会显示“请在翻译工作台中添加支持的语言”。单击“翻译工作台”跳转到对应页面，在翻译工作台中可添加系统支持的语言。
   格式	错误码信息描述，长度不能超过255个字节。在描述中，可以用{Number}表示变量名。例如，{0}表示第一个输出变量，{1}表示第二个输出变量，以此类推。 例如：配置为“这个是{0}的报错：{1}！”。

如何使用错误码

在应用开发时，可以根据需要在应用开发工作台导入租户下其他的错误码。导入后，可在应用开发工作台中使用该错误码。以在“A”应用为例，介绍如何导入错误码。

1. 参考如何登录经典应用设计器中操作，进入“A”应用开发界面。
2. 在“A”应用开发界面左侧菜单栏下方，选择“配置”，在打开的页签选择“自定义错误码”。
3. 单击“导入”，选择账号下已有的错误码进行导入。
4. 在脚本、服务编排中，使用错误码。
   • 在脚本里使用错误码
     这里通过新建脚本将上文创建的错误码抛出，在脚本中增加抛出错误信息的context函数setI18nError('错误码名称','变量1','变量2')。

     1. 在应用开发界面创建一个新脚本。

        鼠标放在“A”应用开发界面的某一文件夹旁会出现加号，单击加号，选择“脚本”。选择“创建一个新脚本”，输入脚本名称，单击“添加”。

     2. 在脚本编辑器中录入如下代码，并单击上方按钮区域，保存脚本。

        import*as context from'context';
        context.setI18nError('命名空间__Error001','测试用例','脚本使用错误码的用例解读')

     3. 测试执行脚本。
        单击编辑器上方的，在页面底部单击测试窗口右上角的。单击“输出参数”页签，显示如图2所示，可查看到抛出的错误码信息。

        图2 运行脚本后显示界面
        
     4. 单击脚本编辑页面上方的，启用脚本。
   • 在服务编排里使用错误码
     在“全局上下文”新建公式变量，使用表达式SETI18NERROR(ErrorCodeName','变量1','变量2')方式引入错误码。

     图3 服务编排里使用错误码
     

     

     目前BPM中，错误码由BPM调用的脚本和服务编排抛出。