应用平台开发规范
本章节介绍应用工程、脚本、服务编排、前端的开发规范,错误码的定义规范,高性能的编码规范,系统参数的命名规范,以及业务权限的配置规范。
规范类型 |
描述 |
---|---|
应用工程构建规范 |
应用工程是指使用AppCube开发的App和BO,应用工程规范包括App、BO的命名规范、目录结构规范,工程配置规范和工程服务规范。 相关规范的说明请参见应用工程构建规范。 |
脚本开发规范 |
脚本(简称Script)用于开发原子功能API。脚本不能被外部直接通过Rest接口调用,只能用于业务编排。 对脚本要进行合理的抽象和封装,以便在不同的服务编排中复用。 相关规范的说明请参见脚本开发规范。 |
服务编排开发规范 |
服务编排(又称Flow)主要场景是用于定制扩展。项目开发人员使用服务编排来把资产API、第三方API等原子API编排起来,快速实现新的业务逻辑。 服务编排不允许直接被前台页面或第三方系统调用,需要通过Custom API暴露成标准Rest接口再给外部调用。 原则上单个服务编排使用的图元不超过20个。对于图元超出20个且部分业务逻辑可被复用的部分建议拆分成子服务编排供主服务编排调用。 相关规范的说明请参见服务编排开发规范。 |
前端开发规范 |
前端开发规范包括标准页面的样式规范,以及高级页面的Widget开发规范。 相关规范的说明请参见前端开发规范。 |
错误码定义规范 |
调用接口出错后,用户可根据每个接口对应的错误码来定位错误原因。AppCube支持用户自定义错误码,并支持对错误码描述进行多语言国际化配置,实现根据语言的不同将错误码描述信息进行不同的展示。 错误码定义规范包括错误码使用原则、命名规范,以及定义规范。 相关规范的说明请参见错误码定义规范。 |
高性能编码规范 |
业务功能开发的过程中,如果不按照相关规范进行开发,可能会由于开发编码不规范,导致业务性能低下,用户体验差。对此,本节总结高性能规范,旨在帮助用户提高业务接口的性能。 相关规范的说明请参见高性能编码规范。 |
系统参数命名规范 |
当前支持在AppCube管理中心、BO和APP界面,创建系统参数。 相关规范的说明请参见系统参数命名规范。 |
业务权限配置规范 |
在创建FUNCTION类型的权限资源时,只能选择已有的业务权限,而不是根据名称自动创建业务权限。 AppCube的业务权限,仅能在定义接口时由开发者在AppCube管理中心(用户管理 > 业务权限凭证)创建,删除同样如此,权限BO仅关联已有业务权限,不包含自动创建、删除平台业务权限的逻辑。 相关规范的说明请参见业务权限配置规范。 |