管理软件研发规范.docx
《管理软件研发规范.docx》由会员分享，可在线阅读，更多相关《管理软件研发规范.docx（15页珍藏版）》请在冰点文库上搜索。
管理软件研发规范
管理软件研发规范
目录
1引言1
1.1编写目的1
1.2适用范围1
1.3参考资料1
2原型设计规则1
3技术框架规范2
4开发框架及命名规范2
4.1系统文件结构2
4.2公共基础类说明3
4.3数据库命名规则4
5界面设计规范4
6数据库设计规范5
7数据录入设计规范9
8数据一致性设计9
9系统分布和部署设计10
10系统的备份及安全性设计10
11数据库优化设计11
1引言
1.1编写目的
本规范是东师理想公司管理软件研发各项目组开发人员必须遵循的，可供测试等其他人员参考，本规范只适合本公司内部参照使用。
1.2适用范围
1）针对于软件研发部门。
2）主要适用于管理软件（包含基于数据库管理信息系统）的项目开发。
1.3参考资料
国家教育部制定文件：
《教育信息化管理基本信息规范》
《CELTS-33+高等学校管理信息标准》
行业国标相关文件：
《计算机信息系统安全专用产品分类原则》GA163-1997
《计算机信息系统安全产品部件第一部分：
安全功能检测》GA216.1-1999
《计算机信息系统安全保护等级划分准则》GB17859-1999
《网络代理服务器的安全技术要求》GB/T17900-1999
2原型设计规则
原型设计流程：
１. 列出软件所有功能列表，并标出哪些是重要功能；
２. 先出一个功能的样例模板标准，然后其他功能进行copy；
３. 角色确认；
４. 分业务，提取系统功能；
５. 走流程，丰富页面；
６. 需求及原型确定后，美工和测试部门介入项目。
原型设计原则：
1. 设计时要充分考虑系统类型的特点，管理系统与网站应分别设计；
2. 原型要体现功能、业务流程；
3. 最重要的信息显示最重要的位置；
4. 在一屏页面上尽量显示全重要的业务信息。
3技术框架规范
开发技术方案所有都以开源软件基础上：
◆操作系统：
redhatLinux
◆Web服务器：
Apache、Tomcat、Jboss
◆数据库：
Oracle、Mysql
◆负载均衡：
LVS
◆文件系统：
NFS（AFS/GFS）
◆运维监控软件：
Cacti（Nagios）
◆开发语言及工具包：
Java、Flex
◆开发框架：
Spring、ibatis、struts
◆工作流、Jbpm
◆报表工具：
ireport
◆展现层：
extjs
4开发框架及命名规范
4.1系统文件结构
zjsoa职业教育数字化校园平台的总目录
srcjava源文件
com源文件的根目录
dsideal公司名
controller放置struts中的所有action和form，根据不同的模
块放置到不同的八个包下
collaborate
importproject
integration
person
requirement
review
system
train
framework基础架构包，为上层应用服务
common放实体对象的基类，业务对象都应继承该类
dao基础架构包中一些辅助类，如资源类等
sendmessage放web中的基类，包括action和form的基类
……
service业务服务包，存放所有业务服务的接口，不同的八
个模块分别有各自的服务文件
sql存放所有业务服务接口的实现类
tld放置各模块的辅助类，如资源类、枚举类等，根据
不同的模块放置到不同的八个包下
config.properties文件存放整个系统配置的环境参数
application.properties文件struts中的在jsp中显示的参数变量
log4j.properties文件log4j的参数设置
WebRoot部署的文件夹，根据不同jsp界面的放置八个包下，
一些基本的jsp放到根下，如工具菜单等
Jsproot
xg
jw
sys
dm
base
facetype放置images文件、css文件
blue
green
js放置js文件
jsp一些公用的jsp文件
WEB-INFweb部署必有的文件夹
applicationContext.xml、init.properties文件spring要配置的文件
struts-config.xml文件struts要配置的文件
*.tld文件struts所用到的标签库描述器
web.xml文件web部署要用到的配置文件
validator-rules.xml、validation.xml文件struts中做客户端效验的配置文件
classjava源文件对应生成类的文件夹
lib类库文件夹，包括所有的jar文件
4.2公共基础类说明
4.3数据库命名规则
基于原有基础数据命名规则，重新规划业务数据表命名
T_SYS--系统管理数据子集T_LS—毕业后历史数据子集
T_TB--通用/标准数据子集T_XX--学校管理数据子集T_XG--学生工作数据子集
T_JX--教学管理数据子集T_JG--教职工管理数据子集T_KY--科研管理数据子集
T_ZC--资产与设备管理数据子集T_BG--办公管理数据子集T_CW—财务管理数据子集
业务子集后数据表命名
例如：
学生基本信息表T_XS_STUDENT
数据冗余设计：
提高访问效率
根据访问量大、统计量大需要建立冗余。
系统部署设计：
提高访问速度
容灾备份设计：
异动硬盘、光盘备份。
运行软件备份。
统一字段命名：
1、与外部关联的字段需要和所关联表字段名称一致。
（两个外键）
2、所有业务主键（都是系统序列自动生成的字段）都用_Id需要统一（如教工异动YD_ID、部门主键BM_ID）
3、所有需要手工录入的编码字段都要以国标为准（只有Ｈ、Ｍ结尾），不存在以ＤＭ结尾字段。
（例如部门编码BMH，专业编码ZYH，课程编码KCH）
4、所有引用国标字典表（T_DM_表）都用字段类型都用varchar2。
而且引用国标字段名都要加个M。
（性别码XBM，民族码MZM）
5、所有日期时间都用SJ（如录入时间LRSJ，发生时间FSSJ）：
6、该项数据录入人直接用LRR_JG_ID。
7、照片都放在单独的照片表中（如学生照片表、教工照片表），并且用BLOB字段类型。
目前系统中只存在VARCHAR2、NUMBER、DATE、BLOB四种字段类型。
5界面设计规范
1、首页设计原则：
着重思考首页要向用户显示哪些信息，用户在首页最关注哪些信息，如何让用户在最简单的操作下直接进入最关心、最常用的功能页面。
页面上不能用斜体字。
导航条可以做出高档底纹及渐变两种风格备选。
管理软件有统一标识。
2、页面布局原则：
页面布局是设计人员必须思考的内容，要考虑到人的感官关注点，优化布局设计，美工人员界入时，只是在框架上进行美化而以，不能把设计的主体工作直接交给美工完成。
3、遵循一致的准则：
确立标准并遵循，每个页面尽量保持控件使用，提示信息措辞，还是颜色、窗口布局风格，遵循统一的标准。
4、颜色清晰原则：
统一色调，针对软件类型以及用户工作环境选择恰当色调，在浅色背景上使用深色文字，深色背景上使用浅色文字，蓝色文字以白色背景容易识别，而在红色背景则不易分辨。
5、表达准确原则：
功能名称表达准确，尽量口语化简单易懂、不要用或少用专业术语，杜绝错别字；断句逗号句号顿号分号的用法，提示信息要客气、多用您、请。
比较多的话，应该分段；警告、信息、错误使用对应的表示方法；使用统一的语言描述，例如一个关闭功能按钮，可以描述为退出、返回、关闭，则应该统一规定。
6、面向角色定制设计：
根据用户角色，可以查看该用户所有信息项。
设定提醒方式，自动检测和提醒。
登录后有导航条，首页有即时通讯、待办事宜等。
接收短信、通知、eMail等通知方式。
登录后直接显示当天信息。
7、统一建立页面案例库
6数据库设计规范
1、信息标准的编制思路
数据中心的建设就是要规范全校信息的管理，并建立《学校信息标准集》。
2.、信息标准的编码规则
信息标准的编码需遵循如下的原则：
唯一性
在分类编码标准中，每一个编码对象仅有一个赋予它的代码，一个代码只唯一表示一个编码对象。
可扩性
代码结构必须能适应同类编码对象不断增加的需要，必须为新的编码对象留有足够的备用码，以适应不断扩充的需要。
简单性
代码结构应尽量简单，长度尽量短，以便节省机器存储空间和减少代码的差错率；同时，提高机器处理的效率。
规范性
在一个信息编码标准中，代码的结构、类型以及编写格式必须统一。
合理性
代码结构要与分类体系相适应。
3、信息标准的代码类型
在本项目中信息标准的代码类型主要有以下四种类型：
数字型代码
字母型代码
数字与字母混合型代码
无含义代码：
对编码对象只起标识作用，而无任何其他附加含义的代码。
根据各个具体业务的需要选择合适的代码类型。
4、数据库设计规范
数据中心数据库设计的成果有两大类：
一是学院信息集;二是学院信息代码集。
《学校教育管理信息化标准——信息标准集》就是通过学校信息集和学院信息代码集来体现和执行。
表属性规范表名
现有数据库中表有两种类型，一种为信息集表（以管理对象为主体的信息项，为便于查询，按内容分成若干类，按类以表名前缀的方式分段列出），一种为代码集表，表名全部使用T开头。
表分区名
前缀为P。
分区名必须有特定含义的单词或字串。
字段名
字段名称必须用字母开头，采用汉字名称拼音缩写。
严格遵照《标准编码原则》
主键名
前缀为PK_。
主键名称应是前缀+表名+构成的字段名。
如果复合主键的构成字段较多，则只包含第一个字段。
表名可以去掉前缀。
外键名
前缀为FK_。
外键名称应是前缀+外键表名+主键表名+外键表构成的字段名。
表名可以去掉前缀。
索引规范
普通索引
前缀为IDX_。
索引名称应是前缀+表名+构成的字段名。
如果复合索引的构成字段较多，则只包含第一个字段，并添加序号。
表名可以去掉前缀。
主键索引
前缀为IDX_PK_。
索引名称应是前缀+表名+构成的主键字段名，在创建表时候用USINGINDEX指定主键索引属性。
唯一索引
前缀为IDX_UK_。
索引名称应是前缀+表名+构成的字段名。
外键索引
前缀为IDX_FK_。
索引名称应是前缀+表名+构成的外键字段名。
函数索引
前缀为IDX_FUNC_。
索引名称应是前缀+表名+构成的特征表达字符。
簇索引
前缀为IDX_CLU_。
索引名称应是前缀+表名+构成的簇字段。
视图规范
前缀为V_。
按业务操作命名视图。
实体化视图
前缀为MV_。
按业务操作命名实体化视图。
存储过程
无前缀为PROC_。
按业务操作命名存储过程
触发器
前缀为TRIG_。
触发器名应是前缀+表名+触发器名。
函数
前缀为FUNC_。
按业务操作命名函数
数据包
前缀为PKG_。
按业务操作集合命名数据包。
序列
前缀为SEQ_。
按业务属性命名。
表空间
公用表空间
前缀为TBS_。
根据存储的特性命名，例如：
TBS_PARAMETER。
专用表空间
TBS_<表名称>_NN。
该表空间专门存储指定的某一个表，或某一个的若干个分区的数据
变量
普通变量
前缀为
VAR_。
存放字符、数字、日期型变量。
游标变量
前缀为CUR_。
存放游标记录集。
记录型变量
前缀为REC_。
存放记录型数据。
表类型变量
前缀为TAB_。
存放表类型数据。
数据库链
前缀为DBL_。
表示分布式数据库外部。
7数据录入设计规范
软件设计中尽最大程度满足用户的易用性需要，减少用户不必要的输入，可以批量录入的，一定要完成批量录入功能，要批量录入中，要提供给用户进行确认的功能界面，对准备进行导入的数据进行查阅，完全通过的才可以导入到计算机。
批量导入、批量录入、缺省录入、数据正确性校验。
1、大量的数据录入，全面提供EXCEL导入解决方案，EXCEL中使用下拉、录入相结合的方法，为用户提供快捷的录入途径，配以详细的数据校验机制，对数据的完整、准确提供有力的支撑。
在导入过程中，提出确认功能页面，方便用户对即将导入的数据进行全面的检验，无误后再提交到数据库，修正了以前程序开发中对于用户导入EXCEL模板，一个位置出错就退出，让用户反复导入的问题，出现的错误可以通过确认页面，一次性提交给用户进行解决，极大方便了用户操作。
2、大量的数据录入，提供动态页面批量录入功能，通过JS技术，动态在页面上添加录入框，用户就像在平常填表一样对数据进行录入，大大降低了用户的学习成本，与现实工作实际紧密结合，提升了用户体验。
3、大量使用了自动完成等新技术，使用户录入数据更加方便快捷。
8数据一致性设计
1、数据产生变化时，其他数据关联即时变化，保障数据一致性。
可视化分析数据关联视图，查看数据关联性。
2、对于系统中的数据一致性保持，整体系统全面设计，每个开发小组在开发前必须提交要使用的接口，大家面向接口进行开发，基础的数据在系统中只保存一份，通过接口进行互相调用来保证数据一致性。
3、可以通过统一数据中心，实现分布式数据库之间的数据同步。
9系统分布和部署设计
“分布式”服务器架构方案可解决两方面的安全问题，一类安全问题是由单站点故障、网络故障等自然因素引起的，应用“分布式”服务器架构使数据库服务器与网站服务器从物理上隔离，从而避免由于网站服务器故障引起的数据库瘫痪，再配合异地备份机制可保障数据库中的数据不受攻击。
另一类安全问题来自于本机或网络上的人为攻击，即黑客攻击，目前黑客攻击网络的方式主要有窃听、重发攻击、假冒攻击、越权攻击、破译密文等，针对这类安全隐患，“分布式”服务器架构可采用“身份验证”、“保密通信”、“访问控制”安全技术解决。
1. 身份验证：
为了防止各种假冒攻击，用户需登录到网站，再通过网站服务器登录到分布式数据库，在网站服务器执行真正的数据访问操作之前，要在网页服务器和数据库服务器之间进行双向身份验证，使两者之间的数据传输处于安全通道之中。
2. 保密通信:
客户与服务器、服务器与服务器之间身份验证成功后，就可以进行数据传输了，为了对抗报文窃听和报文重发攻击，需要在通信双方之间建立保密信道，对数据进行加密传输。
保密通信采用底层网络协议提供的安全体制WebService。
3. 访问控制:
为了防止越权攻击，任何用户不能直接操作库存数据。
数据库服务器架构采用身份验证机制与隔离外网机制，身份验证机制使用数据库提供的分角色身份验证机制，从而提供控制数据库的访问；其隔离外网机制是指数据库服务器处于局域网之内不受互联网的黑客与病毒的攻击。
4、支持多服务器、异地镜像部署，实现系统高可用性。
10系统的备份及安全性设计
1、系统的数据备份分为自动备份与手动备份相结合的原则，其中自动备份为系统每天隔6小时自动对数据库进行本机、异机备份，管理员也可以随时手动对数据进行全面备份，备份环节少，操作简单，而且能全面保证数据的安全。
2、WEB程序中SQL注入式攻击是一个不容回避的问题，我们在系统框架设计时，重点考虑这个问题，使用了IBATIS技术，全面使用参数化接收传入数据，同时在录入数据时对数据进行合法性校验，全面保证了注入式安全。
3、容灾冗余备份时，采用磁带库、移动硬盘、光盘等进行备份。
并且采用异地存储，防止发生数据意外丢失。
11数据库优化设计
系统里的信息查询问题，数据库查询、汇总表、集群服务；数据统计系统、系统优化，系统访问速度：
统计分析是每个功能系统要面对的重要功能，但由于查询速度等问题，这件事处理起来并不容易。
我们在这个问题上的解决方案是：
1、统计分析定时统计，集中分析。
每天0点对需要处理的数据进行当天的归总，与之前的数据进行数据合并，这样每次的查询都是针对结合表的查询，速度大大提高。
2、通过数据冗余实现优化。
包括创建冗余字段，减少表之间关联提高访问速度。
3、创建专门的统计汇总表（库），分担了数据库服务器的压力，正常的操作写入到常规库与统计库中，统计库专为特定的统计功能提供服务。
4、工作库与查询库分离处理，避免统计分析对业务库造成性能影响。
1、战略发展做强
2、提高效率
3、部门关系之间
4、绩效考核
黄海：
无线传感网络技术成立一个关于硬件研发的小组，定期提交研究成果。
采购相关设备
张磊：
构件式开发的标准建立，成立一个构件研发组。
每个工作组出一个人。
先确定一个统一的体系结构，设计构件模型。
构件共享目前关键是人与人之间的信任。
产品线：
小张磊：
开发重复、模块库的标准，便于绩效考核。
纪业：
部门协调，明确接口才能保证效率。
加班问题是因为计划没有考虑清楚？
孙海超：
课件制作不能光用网页形式。
王利敏：
提交的测试程序没有达到系统测试的程度。
开发人员对所开发系统没有理解。
所提交的问题都应该是正视对待，不应该区分大问题和小问题。
测试报告直接影响到开发人员绩效。
升级会员 