应用系统命名指南

1、基于EOS平台开发应用系统命名规范版本 青岛大学信息工程学院修订历史日期版本描述作者 2009-02-08 草案 目录1.简介 1.1目的1.2范围1.3定义、首字母缩写和缩写1.4参考资料1.5概述2.一般用例建模准则2.1一般风格2.2 关系的使用2.3 和 关系的使用。2.3.1 关系的使用。2.3.2 关系的使用。2.4参与者泛化关系的使用2.5交互图的使用2.6活动图的使用 3.如何描述用例 3.1参与者准则 3.1.1每个具体用例至少涉及一个参与者3.1.2直观、描述性的参与者名称3.1.3参与者名称的一致使用3.2用例名称3.3用例简短描述3.3.1至少 1 个段落3.3.2示例

2、（可选）3.4祈使语气的一致使用：需要3.5词汇表术语的使用3.6“操作”术语的使用 3.6.1定义系统负责在何处提供操作选项3.6.2术语在整个用例中的一致使用3.7参与者和系统行为的独立段落3.8备选流和子流3.9前置条件和后置条件3.10对于缺少的详细信息使用占位符（待定） 3.11补充规范的定义和引用3.12使用 UI 原型设计进行交叉检查3.13异常流（可选） 3.13.1发生什么异常？ 1. 简介 1.1 目的 此组准则的目的是确保应用系统命名的一致性。1.2 范围 这些准则可以按原样使用，或者进行定制，以满足大部分项目的需求。1.3 定义、首字母缩写和缩写 EOS： 上海普元公司

3、提供的面向构件的中间件平台，作为本项目应用软件的技术平台构件： 本规范所提到的构件及构件包的概念，均指EOS中的构件与构件包。FBFRAME： 基础业务框架1.4 参考资料 EOS项目开发规范.doc2. 系统的描述 一项目可包含多个子系统，为了区分出各个子系统课分别命名，名称为中文全称名称加附在括号内的3个小写字母表示的缩写名称。缩写名称，主要用于在构件名称中标识构件包和数据库表命名，对应于用例模型中的包。如：财富管理系统（wms）资金管理系统（cms）定价管理系统（pms）3. 统一英文缩写或名词约定列表本项目中，无论数据库设计、程序文件命名、文档文件命名，对于同一概念，如果需要使用缩写，

4、统一使用如下定义。词语/缩写英文描述中文描述EOS普元面向构件中间件平台DocDocument文档SrcSource Code源码FeaFeature功能点，指经过设计后分解的功能ReqRequirement需求点，指需求调研后形成的用户需求Query查询，在定义程序文件名称时，“查询”功能使用的英文为Query，例如AccountQuery.jspAdd增加，在定义程序文件名称时，“增加”功能使用的英文名称为”Add”，例如AccountAdd.jspUpdate编辑，在定义程序文件名称时，“修改”功能使用的英文名称为“Update”，例如AccountUpdate.jspDeleteDel

5、ete删除，在定义程序文件名称时，“删除”功能使用的英文名称为“Delete”，例如Account Delete.jspList结果列表使用英文名称，例如AccountList.jspReturnReturn返回，系统中表示返回的英文缩写Success系统中表示成功的英文单词均使用SuccessFault系统中表示失败的英文单词均使用FaultErrorError系统中表示错误的英文缩写业务字典系统中与业务相关的代码及对代码的描述，例如，用Authlevel表示用户认证等级，而0：所有用户，1：登录用户，2：产品绑定用户等。EOS提供了对业务字典的管理，通过EOS业务字典功能，为系统实现提供的

6、大量构件，方便开发。4. 开发目录编排与命名4.1 文档目录 遵循RUP的组织方式，强制配置。4.2 文档规范文档命名规范：系统全称+“_”+中文文档名。如：财富管理系统（WMS）概要设计说明书.doc文档编写要求：Word XP（项目组必须统一文档工具的版本）所绘图形要求提供原始文件在Word中的插图尽可能使用JPG格式，以降低WORD文档的大小文档一旦初步定稿之后，评审者采用修正模式修改文档4.3 需求/功能编排规范 软件需求采用用例模型，用例名称的命名为：系统缩写名称+“_”+若干英文单词组成的业务描述,对应于用例, 名称单词第一个字母用大写其余使用英文小写。如：创建计划wms_Crea

7、tePlan)用例定义与EOS构件包命名一致：子系统UC包名客户管理（crm）客户信息管理crm_CustInfo客户关系维护crm_CustAssign大客户管理crm_VipCust客户服务crm_CustServ项目公共构件库注：系统管理部分的权限管理和机构管理在EOS提供的构件包基础上修改，并作为项目中的一部分4.4 程序目录命名EOS Server文件目录及说明说明：1、对于业务逻辑、展现逻辑和数据实体文件，是由EOS提供发布时自动上传注册，不需要手工COPY文件到相应目录2、上图中除标注外的其余目录均为非必要目录4.5 JBOSS Server 文件目录及说明5. 数据库命名规范表

8、命名规范l 表名构成：系统缩写+_+对象名称（英文单词或英文缩写）+数据库对象后缀，例如业务标准系统的某个表名：BSS_ACCOUNT_TDl 表名全部使用大写l 表名建议不要太长（15个字符以内），如果太长，请使用单词的缩写l 对象名称不能使用汉字l 对象名称不能使用中文拼音或中文拼音的首字母l 对象名称尽可能不使用阿拉伯数字l 必须保证你的对象名称没有和保留词、数据库系统或者常用访问方法冲突l 绝对不要在对象名称的字符之间留空格l 如果对象的名称仅有一个单词，则不使用缩写对象名称对象类别命名规则（加前缀）表业务数据表BSS_对象名_TD代码表BSS_对象名_TC关联表BSS_对象名_TJ系

9、统定义表BSS_对象名_TS键和索引主键BSS_对象名_PK外键BSS_对象名_FK索引BSS_对象名_IX视图BSS_对象名_VIEW包BSS_对象名_PACK存储过程BSS_对象名_PROC函数BSS_对象名_FUNC触发器BSS_对象名_TRI字段命名规范l 字段名全部大写l 不同单词之间使用“_”l 不同表的同一个业务字段类型、长度、字段名称保持统一，例如，客户编号可能存在于多个表中，要求采用同样的字段名，并且类型、长度一致l 字段名建议不要太长（15个字符以内），如果太长，请使用单词的缩写属性默认类型定义（Oracle参考）属性类别类型长度备注人的姓名Varchar220电话号码Va

10、rchar230部门Varchar290单位/机构名称Varchar2100地址Varchar2100判断字CHAR10：否 1：是时间、日期DATE意见、理由、描述、简介、备注Varchar22000CLOB大于4000请采用CLOB类型图片BLOB金额NUMBER8,2比例NUMBER3,2设计规范一般必须满足三个数据库设计范式l 范式一：表结构中不能含有任何重复的数据字段。违反该范式的例子：求职人员表：求职人员编号求职人员姓名联系电话1联系电话2C001张三C002李四问题：若增加一个“联系电话3”则要修改表结构，原来的应用程序也将重新修改。 正确处理：求职人员表： 求职人员编号求职人员

11、姓名C001张三C002李四求职人员联系表：求职人员编号序号联系电话C00101C00102C00201C00202l 范式二：要求每一列均函数性地依赖于主关键字。违反该范式的例子：物业分布表：分布点编号所在地址所在城市H001蒲汇塘路上海H002漕宝路上海H003汉中路上海主要服务表：服务编码服务收费P0170.99P0221.00P03502.54服务记录表：分布点编号服务编码所在地址任务描述日期H002P02漕宝路树木修剪1997/11/15H002P03漕宝路上油1997/12/01H003P01汉中路熔炉1997/12/03问题：服务记录表是以“分布点编号”和“服务编码”作为主关键字

12、。“所在地址”和“任务描述”两列不完全函数性地依赖于主关键字。显然服务期间地址通常是不变的，不管在什么地方执行任务，特定任务的描述应该是一样的。正确处理：主要服务表：服务编码服务收费任务描述P0170.99熔炉P0221.00树木修剪P03502.54上油服务记录表：分布点编号服务编码日期H002P021997/11/15H002P031997/12/01H003P011997/12/03l 范式三：表中记录符合第二范式且不存在传递依赖，当表中含有一定其他列的非主列时，存在传递依赖。违反该范式的例子：学生考试成绩表学号课程考试日期成绩累计平均S001CIS0911997/10/178481S0

13、02MGT1001997/10/177277S003CIS0911997/10/179390问题：“学号”，“课程”和“考试日期”为主关键字。“累计平均”列代表该学生所有课程成绩的平均，这列传递依赖于“学号”列，因此不符合第三范式。正确处理：学生个人信息表学号姓名累计平均S001张三91S002李四80S003王五78学生考试成绩表学号课程考试日期成绩S001CIS0911997/10/1784S002MGT1001997/10/1772S003CIS0911997/10/1793特殊情况可不用设计范式*存储计算值到数据库中。*将历史信息分割到其他表中。存储计算值：通常，一个设计良好的关系数据

14、库不存储任何计算数据如总和，平均值，最大值和最小值。这些数据通常在运行时利用基本数据来计算。然而，有些场合把计算值储存起来可能更简单，更快，更明智。比如：旅客表：旅客编号姓名Z001张三.L004李四.W008王五飞行情况表：旅客编号飞行次数飞行日期飞行里程Z001111998/01/027832.L00418001998/02/037743.W008271998/04/03743问题：“飞行情况表”会很快增加，渐渐达到几万行。旅客若打电话询问自己飞行有多少公里，希望立刻得到回答，然而查询“飞行情况表”并把所有单个里程加起来可能要花费几秒的时间。这时就需要把总和信息存储起来，以供快速查询。正确

15、处理：旅客编号姓名旅客里程Z001张三73873.L004李四92923.W008王五8727为保持总公里数的相对实时性，可以每晚运行一个加总程序更新总和，这样做可至少带来两个好处：其一：总公里数可快速获取。其二：更好地平衡负载。繁重的加总工作放在晚上处理。为了更快更新，从而得到更准确的数据，需要使用类似触发器的方法来得到最新的数据。查找历史：假设维护一个信用卡支付系统，顾客通常打电话来了解自己最近的收支情况。偶尔他们想知道几个月前的收支情况。在这个应用中最主要的表如下：业务交易表：交易编码客户编码使用日期金额T0001C20211997/11/1414.88.T1012C30001997/1

16、1/965.90问题：该表会很快增长到几百万行，查找一个客户的所有记录需要几秒钟。事实上顾客和服务人员对这反应时间都有抱怨。改进方法一：由于客户一般只查询最近月份的交易信息，可以另加两个同样的缓冲表，每月底，进行一次数据移动即可（把最近月份的数据删除）。改进方法二：可利用其“分区”的概念，通过复制机制，将一个数据库复制到另外一个数据库中。其他l 保证数据完整性n 使用事务提交概念n 使用触发器等手段n 设置外键l 数据库维护（整理，备份，恢复）l 数据库访问操作必须考虑网络多用户使用冲突问题l 对较大系统，需要考虑数据安全性，数据分布，数据复制，数据仓库等等l 必须考虑数据库访问速度，对于数据

17、量较大的表，一定要加索引有关一般信息和更多的用例准则，请参阅 Rational Unified Process。3.1 参与者准则 有关一般信息和更多的参与者准则，请参阅 Rational Unified Process。3.1.1 每个具体用例至少涉及一个参与者 每个具体用例是否都至少涉及一个参与者？如果不是，就存在问题了。不与参与者交互的用例是多余的，应该将它删除或确定相应的参与者。在某些情况中，会有多个参与者参与到用例交互中。请确保检查在一个用例中使用多个参与者是否是有效的（请参阅“参与者泛化关系”）。3.1.2 直观、描述性的参与者名称 参与者是否是具有直观、描述性的名称？用户和客户都

18、能理解这些名称吗？参与者的名称与他们的角色对应，这一点很重要。如果不是，则更改它们。您应当参考用例模型来确保为用例中的每个参与者使用了正确的参与者名称。3.1.3 参与者名称的一致使用 用例规范需要使用一致的参与者名称撰写。需要注意确保参与者命名是清晰明确的。不要笼统地使用“参与者”，而应当使用实际的名称来唯一地确定或定义参与者。参与者名称可以视为是参与到一组系统交互中的角色。3.2 用例名称 用例名称应是唯一、直观和解释性的名称，从而可以清晰明确地定义从用例获取的值的可观察结果。检查用例名称的一种好方法是调查客户、业务代表、分析人员和开发人员是否都能理解用例的名称和描述。请记住：您需要从参与

19、者的角度定义值的可观察结果。每个用例名称需要描述用例支持的行为。名称中需要包含要执行的操作和要操作的关键元素。通常，这是一种简单的“动词名词”组合。用例应当从触发用例的参与者的角度进行命名。示例包括：“注册课程”、“选择授课课程”。3.3 用例简短描述 3.3.1 至少 1 个段落 用例中需包含用例的简短描述。此描述的长度至少应当为 1 个段落，并且不超出 3 个段落。描述中需包含用例的关键目的、价值陈述和概念的说明。3.3.2 示例（可选） 如果简短的示例“故事”能够增加价值，则可以在简短描述中包含它来帮助进一步地描述环境。此示例通常需遵循基本流，同时在有帮助时包含数据值。3.4 祈使语气的

20、一致使用：需要 用例中的系统需求需使用祈使语气撰写。相对于“应当”和“必须”，通常更倾向于使用“需要”来一致地描述需求。并且应避免使用暗示需求是可选或未定义的需求的消极词汇，例如，“应该”、“可能”、“等”。3.5 词汇表术语的使用 用例中使用的所有业务术语在项目的词汇表中进行定义。如果用例中存在词汇表中未包含的业务术语，则术语需要：1. 添加到词汇表中，同时包含简短描述（最多 1 个段落）。2. 在用例中进行更改，以反映词汇表中定义的正确业务术语。3.6 “操作”术语的使用 3.6.1 定义系统负责在何处提供操作选项 用例需要明确地说明系统负责在何处提供用作供参与者选择的可用选项的操作。在多

21、数情况下，可用选项应当作为基本流的组成部分而提供，并在对应的备选流的第一个语句中作为入口点引用。3.6.2 术语在整个用例中的一致使用 诸如“新建”、“修改”、“取消”、“删除”、“确定”和“打印”之类的术语在整个用例的使用需保持一致：相同的逻辑操作不能使用不同的术语指代。特别需要注意确保在备选流中使用的操作术语与在基本流中使用的操作术语匹配。3.7 参与者和系统行为的独立段落 每次参与者和系统之间的交互改变焦点（在参与者和系统之间）时，下一个行为段需使用新的段落描述。先描述参与者，然后再描述系统。句子必须以“ 需 xxxxx”或“系统需 xxxx”开始。始终使用全称来正确地表示参与者名称，而不是使用缩写。3.8 备选流和子流 每个备选流和子流清晰明确地定义进入流中的所有可能的入口点，并结束于从流中退出的所有可能的出口点。备选流还将明确地说明出口点和参与者继续到下一步的位置 是返回到基本流中的特定步骤还是结束。在事件流由于存在复杂的行为而变得混乱时，或者在单个流的长度超出实际的打印页面时，可以使