maximo开发规范文档.docx
《maximo开发规范文档.docx》由会员分享，可在线阅读，更多相关《maximo开发规范文档.docx（11页珍藏版）》请在冰点文库上搜索。
格尔木光伏管理项目
开发规范
北京恒信启华信息技术股份有限公司
2013年11月
版本跟踪
修改人
日期
描述
版本号
张猛
2013/11/06
创建
VI.0
目录
1.项冃规范 4
1.1文件编码 4
2.数据库规范 5
3.系统提小信息 6
4.报表的命名规则 7
5.工作流配置规范 8
6.代码规范 9
6.1命名规范（NamingSpecification） 9
7.SVN操作注意事项 11
1.项目规范
1.1.文件编码
为了国际化的需求，项目中，所有的文件编码为UTF-8,不得使用其他形式编码，以防止乱码的出现。
在EclipseIDE中，window→preferences→workspace→Textfileencoding中，选择Other并在下拉框中选择UTF-8。
2.数据库规范
格尔木光伏项目统一规定：
>根据功能要求客户化的table统一使用CUXXX命名，CU=CUSTOMUSE,表示非系统标准的table;
>在原有的table中增加的字段，统一使用CUXXX命名，CU=CUSTOMUSE,表示非系统标准的filed;
3.系统提示信息
不允许在java代码中直接填写中文输出信息。
需要在MAXMESSAGES建立提示信息。
在代码中调用信息编号
4.报表的命名规则
列表类：
应用程序名.报表名称」ist
统计类：
应用程序名.报表名称.Stat
工单完成率，
表单类：
应用程序名一报表名称.form
工作票，操作票，采购合同一类的
5.工作流配置规范
类型
英文命名方法
英文示例
中文描述
中文描述示例
角色
流程关键字+角色名称首字母（若通用角色，可不加流程关键字）
安健环负责人，则为AJHFZR（AJH为流程名称）
流程关键字+角色名称（若通用角色，可不加流程关键字）
安健环负责人
操作
对象（简写）+操作简述首字母
提交至负责人操作，则为AJHTJFZR
描述（需包含流程关键字）
提交安健环工单至负责人
状态
状态名称首字母
所有状态表示工作流完成状态：
已批准，已结束，已取消
已批准
APPR
内部值+描述（如无内部值，只需描述）
等待批准
6.代码规范
6.1.命名规范（NamingSpecification）
命名规范使程序更易读，从而更易于理解。
它们也可以提供一些有关标识符功能的信息,以助于理解代码，例如，不论它是一个常量，包，还是类。
通用惯例：
1.使用完整的，能够望文生义的英文
2.使用跟该领域相关的术语
3.大小写混合使用，以增加可读性
4.名称尽量不要超过15个字符
5.不要只用大小写的差异来区分两个变量名称，这样容易造成混淆
表：
命名约定
代码包：
ydy.qhny
依据组织结构，亚东亚。
青海能源筹备处
标识符
命名约定
示例
Packages
Package的名字由一个小写单词组成。
命名方式为：
ydy.qhny.app.模块名称［.子包名】。
习惯用法：
如果package提供一系列的抽象接口，则提供缺省实现的子包名为defaults
ydy.qhny.app.Assetydy.qhny.app.WorkOrderydy.qhny.webclient.beans.asset
模块的内部服务命名为internal
Classes
类名都是一个名词，采用大小写混合的方式，每个单词的首字母大写，尽量使类名简洁而富于描述
项目组统一规定：
Extend标准的class：
CU+原来的class名称；
自定义字段类：
FldXXX.java；
自定义对象类：
XXX.java;
类名：
classCUWO
classCUAsset
classRepairOrder
Interfaces
默认以大写字母I开头表示定义的型别为interface,I之后为具体的Interface命名，其规则与类名相同，但除采用名词性的单词之外，也可以使用形容词性的单词。
这里不硬性规定接口名称必须以I开头
IDataAccessObjectIStorable
Method
方法名是一个动词或者动词短语，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。
不应该单纯为了缩减代码长度而减少method名字的长度，作为命名应首要考虑可读性，应尽量以功能描述性短句作为命名。
runThread（）
getBackgroundColorQ
BooleanMethods
布尔方法名是一个具有疑问语气的短语，采用大小写混合的方式，如果对单独条件判断，建议采用is前缀，如果表示查询一个对象集合中是否还有指定的对象，建议采用has前缀
isReady（）
isValidating（Parserp）hasElement（Objecto）
变量/参数
变量名是一个名词，所有变量、对象实例均采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。
变量名不应以下划线或美元符号开头，尽管这在语法上是允许的。
作为命名应首要考虑可读性，应尽量采用可读性强的短语。
有时对于在代码块中频繁出现的某些类型的变量可以使用一些约定的简写来表示，比如x,y,z可以用于表示坐标等。
StringfirstNamefloatcreditCharge
常量
常量的名字应该全部采用大写，单词之间用下划线分割，并且指出完整含义。
staticfinalintMIN_WIDTH=4
staticfinalintMAX_WIDTH=999
7.SVN操作注意事项
假定开发者已经具备部分SVN操作基础，进行Eclipse上的SVN操作需注意如下事项：
a）切勿对整个项冃进行Commit操作！
对SVN上顶级项目目录只能进行CheckOut操作。
尤其在多人协作时，尽量只修改自己撰写的文件或目录。
b）务必理解本地删除和提交Delete操作之间的区别，务必理解Update、Commit,Revert操作代表的含义。
c）只对需要修改的代码或目录进行Commito
d）进行Commit之前，先进行Update操作，如果未Update进行Commit,就有可能更新失败，当然要注意备份已经修改的内容。
e）当Update未修改的文件或目录时，可能发生冲突，一个可靠的解决方式是，本地删除冲突文件或目录（切勿提交），重新Update。
注意如果是对已更改的文件或目录进行Update,则可能会发生覆盖或冲突，所以平常一定要注意备份更改。
f）请养成良好习惯，在当天的开发工作最后完成Commit,以便服务集成部署。
g）提交时机：
并非每个细小的修改都要进行提交，但要把握好提交的频率，当代码功能达到稳定的时候，就需要进行提交。
h）提交的时候一定要添加备注，并且是有意义的备注；
i）动态生成的目录勿提交到SVN,例如classes目录，Eclipse项目自动生成的目录；文件
同理，编译后的文件无需提交到SVN库，例如*.Class文件，某些动态生成的源码也无需提交。
j）避免提交trap、无用文件，例如doc编辑时生成的临时文件。
k）当需要在Eclipse中对比本地源码和SVN库上的源码，使用Team Synchronizewith
Repository,列出有差异的文件后既可打开对比。
l）注意当需要无版本控制的项目文件时，使用Export功能,直接复制的项目有可能有SVN
的隐藏文件。
升级会员 