BizTalk开发系列(十九) BizTalk命名规范

更多内容请查看：BizTalk动手实验系列目录

                      BizTalk 开发系列

　目前BizTalk项目的开发人员比较少，但是在开发过程中还是需要命名规范的约束。根据以往BizTalk项目的经验，整理了BizTalk命名规范。包括：BizTalk Application, Schema, Map, Pipeline, Orchestration Logic Port, Physical Port等。并提供了相关的示例方便大家参考。

 

《BizTalk命名规范》

通用：

• 项目中能用英文单词的用单词，否则用拼音。
• BizTalk项目中的Schema , Map, Orchestration , Pipeline文件的完全合格名称默认为项目的命名空间加点号加文件的类名。如无特别说明不做相应修改。
• BizTalk项目中的文件名称默认和类名称一致，如无特别说明BizTalk项目中的项目成员名称不能与C#保留字一样。例如：schema.xsd、XmlContent 和 RootNodes

1．Biztalk应用程序命名

格式：项目组名称.项目名称.应用程序名称

示例：BTSGroup.EAI.General

2．Schema命名

• 常规Schema/平面文件Schema

格式：Sch_业务名_ 描述

示例：Sch_PO_Src.xsd

说明：Schema的文件名称（不包括后缀）应与Schema的文件类名一致。

根节点名称不能使用.NET关键字或保留字，例如 System

• 信封Schema

格式：Sch_Envelop_描述

示例：Sch_Envelop_PO

• 命名空间

格式：　http://schemas.项目名称.项目组名称/时间/业务/描述

示例： http://schemas.eai.btsgroup//2008/po/posource

说明： 在描述里面可以使用"-"

• Schema节点、元素、属性

说明：只允许使用 字母、数字、下划线

 

3．Mapping命名

格式：Map_业务名称_描述

示例：Map_PO_Src2Trg.btm

说明：Map的文件名称（不包括后缀）应与Map的文件类名一致。

4．自定义PipeLine命名

格式：

接收管道 : Pip_R_描述.btp

发送管道 : Pip_S _描述.btp

示例：

接收管道： Pip_R_AddNS.btp

发送管道：Pip_S_RemoveNS.btp

说明：Pipeline的文件名称（不包括后缀）应与Pipeline的文件类名一致。

5．Orchestration命名

• Orchestration文件/类型命名

格式：

主流程 :Orc_Main_ 描述.odx 如: Orc_Main_Business.odx

子流程 : Orc_Sub_ 描述.odx 如: Orc_Sub_Starter.odx

示例：

主流程 :Orc_Main_POProcess.odx

子流程 : Orc_Sub_Initialization.odx

说明：Orchestration的文件名称（不包括后缀）应与Orchestration的文件类名一致。

• Message命名

格式：业务名_ 描述Msg

示例：POProcess_POMsg

• Multity Message命名

格式：Multi_业务名称_描述

示例: Multi_POProcess_PO

说明：如果是单部分消息则参数取名为 "Body"

• 变量命名

格式：用途描述及类型

示例: tempXmlDoc

• 相关集与相关集类型命名

格式:

相关集类型命名 : Corn_业务名称_描述Type

相关集命名 : Corn_业务名称_描述

示例:

相关集类型: Corn_Starter_GenType

相关集: Corn_Starter_Gen

• 端口类型命名

格式:

逻辑接收端口类型命名 : 业务_描述 _RecType

逻辑发送端口类型命名 : 业务_描述_SendType

示例：

PO_GetDB_PType

PO_InsDB_PType

• 逻辑端口命名

格式:

逻辑接收端口命名 : 描述

逻辑发送端口命名 : 描述

示例:

PublishPO

• 物理端口命名

格式:

物理接收端口命名 : RecPort+描述

物理接收端口位置命名 : RecLocn_描述

物理发送端口命名 : SendPort _描述

物理发送端口组命名: 用途描述单词 + SendPortGroup 如: InsertDB_SendPortGroup

示例:

RecPort_POData

RecLocn_MSIDB

SndPort_MSIDB

• 流程形状名称命名

采用动宾名称 ,动词根据形状名称命名,判断形状和表达式形状除外。常规使用描述即可。

示例：Send POMsg