U9C客户化开发命名规范

栏目:u9cloud知识作者:用友来源:用友发布:2024-08-20浏览:1

U9C客户化开发命名规范

适用对象

该规范适用于U9客户化的方案设计人员和开发人员。
要求对U9基本概念及开发过程有一定了解,本文不对相关概念作详细介绍。


命名规范细则

命名通用规范

命名方法概述

Camel命名法:第一个字母小写,随后每个单词的第一个字母大写,如itemInfo;
Pascal命名法:每个单词的第一个字母都大写,如ItemInfo;
匈牙利命名法:加前缀,如btnSave,txtName;

使用规范

U9应用开发命名大都遵循Pascal命名法。
Camel命名法可以应用于以下
1)方法参数,如void GetInfoByCode(string strCode
2)类或者函数中声明的常量,变量
3)私有类成员变量
匈牙利命名法通常用于自定义UI控件名的命名规范。

命名空间规范

概述

命名空间(NameSpace):使用层次模型组织类,其优点是可以防止对象命名上的冲突。

组成要素

公司名.产品线.客户化.行业.一级模块.二级模块
UFIDA.U9.Cust.行业.一级模块.二级模块

要素说明

公司名:UFIDA
产品线:U9
客户化:Cust
行业:

  • CBO-公共
  • AIR - Airlines - 航空业
  • SI - Sugar industry - 糖业 
  • WI -War industry - 军工行业
  • TO-Tobacco - 烟草行业
  • TR - Trading - 贸易行业
  • MP-Medical & Pharmaceuticals - 医药行业
  • AP-Apparel - 服装业
  • IM - Industrial Machinery - 工业机械行业
  • FM - Farm Machinery - 农业机械行业
  • EI - Electronics - 电子行业
  • EE - Electrical Equip - 电气设备行业
  • EN - Energy -  能源行业
  • CH -Chemicals- 化工行业
  • BE - Beverages - 饮品行业
  • FP - Food Production - 食品生产加工业
  • FS - Food Services - 餐饮服务业
  • ISR - Internet Services and Retailing - 网络服务和零售业
  • CO - Construction-建筑
  • BM - Building Materials - 建筑材料
  • ME - Metals - 金属材料制造业
  • GEM - General equipment manufacturing -  通用设备制造业
  • IC - Integrated circuit - 芯片行业、半导体行业
  • ITS - Information Technologys Services - 信息技术服务业
  • MVP - Motor Vehicles & Parts - 汽车及零配件行业
  • TE - Textiles - 纺织业
  • UT- Utilities - 公用设施(电力,电网等)
  • SH - Shipping - 海运
  • RE - Real estate - 房地产
  • RA - Railroads - 铁路
  • TEL - Telecommunications - 电信
  • NM - New Material - 新材料

…-以后扩展
PM -项目
Note:行业的划分和缩写命名待进一步确认;

规则与约束:

1)公司名(UFIDA)、产品线(U9)、客户化(Cust)是固定不变的;
2)行业:公共的用CBO,各行业用自己的缩写,未纳入行业的项目统一用PM;
行业的命名由客开中心统一发布,各分子公司、伙伴不允许私自增加、修改;
3)一级模块、二级模块可根据具体的项目情况自行定义,但要用缩写、命名要有含义;

举例说明:

加多宝营销管控平台:
UFIDA.U9.Cust.BE.
云南英茂农务管理系统:
UFIDA.U9.Cust.SI.
南通化工运输管理系统
UFIDA.U9.Cust.CH.

解决方案规范

概述

解决方案是组织项目的单位,其本身也是发布服务组文件(SG文件)的基本单元。

约束规则

"Cust_"+二级名称
一般后台(App)和前台(UI)分别用解决方案进行管理,也可以在命名后缀中加App或UI以示区别。

示例

当前在销售分销模块增加组件,那么解决方案名称可以称为Cust_SD.ubfsln。(已包含文件后缀名)
二级名称不一定是严格的服务组缩写,也可以是业务相关缩写,如Cust_Order.ubfsln

项目规范

概述

一个解决方案下可有多个项目,模型项目组主要包括实体项目、操作项目、服务项目、UI项目、报表项目、查询项目。

约束规则

项目名+组件类型(BE、BP、SV、UI、Rpt)

项目粒度划分规则

通常一个服务组下只建立一个BE项目,可以通过在项目下增加BE组件的方式来增加该服务组下的实体。
BP、SV类似。

示例

如图红框所示

装配件规范

概述

装配件名即编译生成组件程序集的名称。如装配件名为UFIDA.U9.Cust.OrderBE,那么编译生成的程序集就是UFIDA.U9.Cust.OrderBE.dll

约束规则

"UFIDA.U9.Cust."+项目名

示例

如订货单BE,装配件命名为UFIDA.U9.Cust.OrderBE
如订货单UI,装配件命名为UFIDA.U9.Cust.OrderDocTypeUI 
如果涉及客开模块较多,可以在项目名中加入服务组,如UFIDA.U9.Cust.SCM.OrderDocTypeUI。

组件规范

概述

一个UBF项目中可有多个组件,不同类型的项目包含不同的组件。
BE项目:BE组件
BP项目:BP组件
SV项目:SV组件
UI项目:UIModel组件,UIFrom组件,Ref(参照)组件
报表模板项目:报表模板组件

约束规则

BE组件

主实体名称+"BE"

BP组件

以"BP"结尾即可

SV组件

以"SV"结尾即可

UIModel组件

与实体组件绑定的UIModel:主实体名称+"UIModel"
自定义UIModel:以"UIModel"结尾即可
自定义字段:以Def结尾即可

UIForm组件

与实体组件绑定的UIForm:主实体名称+"UIForm"
自定义UIForm:以"UIForm"结尾即可

参照组件

参照实体名称+业务含义+"Ref"
"业务含义"可以是:
1)Find;该参照用于相应工具栏"查找"按钮事件
2)为某业务场景做的参照,如ForSaleOrder
3)可以没有

报表模板组件

报表模板:报表业务名称+"Rpt"
打印模板:打印业务名称+"Print"

示例

BE组件

如订货单类型组件,只包含一个实体OrderDocType,组件名即为OrderDocTypeBE
如订货单组件,单头(OrderDoc)组合单行(OrderDocLine),组件名即为OrderDocBE
如图红框所示

BP组件

如图红框所示

SV组件

UIModel组件

与实体组件绑定的UIModel,如OrderDocUIModel 
自定义UIModel,如OrderDocToSOUIModel
如图红框所示

UIForm组件

与实体组件绑定的UIForm,OrderDocUIForm
自定义UIForm,如OrderDocToSOUIModel
如图红框所示

参照组件

查找事件相应参照,如OrderDocFindRef
为订货单单独做的参照,如ItemForOrderDocRef
如图红框所示

报表模板组件

报表模板,如任职对比报表AssignmentCompareRpt

打印模板,如OrderDocPrint类型规范

概述

类型主要指后台组件中的模型元素,主要包含实体类型,枚举类型,事件,DTO,异常。

约束规则

BE实体

单据类型主实体:实体名称+"DocType"
单据主实体:实体名称+"Doc"
其他档案实体及非主实体无特殊规则

枚举类型

以"Enum"结尾

事件类型

以"Event"结尾

DTO类型

以"DTO"结尾

异常类型

以"Exception"结尾

示例

BE实体

单据类型主实体,如OrderDocType
单据主实体,如OrderDoc
档案实体,如ItemMaster

枚举类型

如单据状态枚举,DocStatusEnum
如图红框所示

事件类型

如提交事件,SubmitEvent

DTO类型

如条件DTO,ConditionDTO

异常类型

如无效数据异常,InvalidDataException

数据库相关命名

数据表命名:

Cust_二级模块_对应实体名

存储过程命名:

Cust_SP_二级模块_过程名

视图命名:

Cust_ VW_二级模块_视图名

索引命名:

Cust_ IX_二级模块_索引名

插件

BE插件:
命名空间:UFIDA.U9.Cust+行业+二级模块+*.BEPlugIn

配置文件命名规范:UFIDA.U9.Cust.行业+二级模块.*.sub.xml

BP插件:
命名空间:UFIDA.U9.Cust+行业+二级模块+*.BPPlugIn

SV插件:
命名空间:UFIDA.U9.Cust+行业+二级模块+*.SVPlugIn

UI插件:
命名空间:UFIDA.U9.Cust+行业+二级模块+*.UIPlugIn

配置文件命名规范:WebPartExtend_二级模块_功能节点.config

 

菜单装配

页面URL: 

Cust.行业.一级模块.二级模块.主实体名称URI

举例:Cust.QP.Common.PullListsDocURI

U9C客户化开发命名规范

适用对象该规范适用于U9客户化的方案设计人员和开发人员。要求对U9基本概念及开发过程有一定了解,本文不对相关概念作详细介绍。命名规范细...
点击下载文档
标签: # U9C
分享:
确认删除?
回到顶部
客服QQ
  • 客服QQ点击这里给我发消息