平台命名规范详解:适配器与功能名命名规则

  • 系统对接顾问

平台命名规范

适配器命名规则

适配器的命名格式如下:平台名+功能(可选)+数据操作方向+Adapter。其中,数据操作方向指的是查询(Query)或写入(Execute)。

平台名命名规则

  1. 特定平台或服务:针对特定平台或服务设计的适配器,命名中应明确指出。例如,接入金蝶平台的适配器可以命名为Kingdee
  2. 功能性命名:如果主要提供特定服务或功能,如数据库操作,名称中应反映该功能。例如,MongoDB适配器可以命名为MongoDb
  3. 中文名称翻译:对接中文名称的平台或服务时,应将名称翻译成英文。例如,支付宝适配器可以命名为Alipay
  4. 中文拼音命名:若无对应英文名称,则使用中文拼音。例如,华为适配器可以命名为Huawei

功能名命名规范

  1. 中文转英文:例如,将列表详情转换为英文时,可以命名为Details
  2. 接口版本区分:对于不同版本的接口,在名称中加入版本号。例如,V1.0版本的列表详情接口可以命名为V1Details,而V2版本则是V2Details.