BS项目开发基本规则.docx
《BS项目开发基本规则.docx》由会员分享，可在线阅读，更多相关《BS项目开发基本规则.docx（25页珍藏版）》请在冰点文库上搜索。
BS项目开发基本规则
工程开发根本标准
中国物品编码中心
2007年12月
.
O
版本变更历史
时间
版本
描述
作者
2007年12月1日
新建
毛凤明
审核人：
审核日期：
批准人：
批准日期：
一、引言
一.1目的
规定需求、设计、开发人员在平时设计、开发工作过程中必须遵守的根本工作规那么。
一.2背景
本规那么由中国物品编码中心开发部经过长期的开发分析总结，参考公司的标准制定。
在对工程开发分析总结过程中发现需求、设计、开发人员在平时工作对于工程中一些根本性的标准不清楚或粗心大意忽略，形成了不良的开发习惯，严重影响到标准化开展。
为控制开发人员不良习惯，部门将以本文根本规那么作为工程开发过程中首先执行的标准。
本文阅读对象：
工程经理、需求人员、UI人员、架构设计人员、系统分析人员、程序开发人员、测试人员。
一.3要求
本文为公司工程开发的根本指导性标准，根据工程的不同，允许有特殊情况产生，但必须在需求文档中特别标出或在单独的文档中说明，并由工程经理审批。
二、界面根本规那么
二.1网页标题
⏹网页必须有正确恰当的标题。
⏹防止默认设置、标题错误、与版本不一致。
二.2首页动画
⏹如果首页为Flash动画展示，在页面上一定要设置直接进入网站内容页面的快捷方式。
⏹进入不同的语言版本，快捷方式的文字描述要使用相对应的语言。
⏹针对flash动画制作要求，当flash动画较大时〔一般情况下大于300K〕，必须显示下载进度条提示。
⏹翻开较大的flash文件时没有显示下载进度条。
二.3无效链接
⏹对应的链接标题要设置正确的链接。
⏹防止链接页面无法正确显示。
⏹防止链接到的页面与对应链接内容不相符。
二.4分辨率
⏹网站在任何分辨率都能正常显示。
⏹不要出现在不同的分辨率下网页框架发生变形、图片缩放比例不一样、字体变化等情况。
⏹主要表现在800*600和1024*768两种分辨率。
二.5版面整体性
网站所有的页面显示效果一致、不存在缺省产品页面、无图片或排版撑破页面的现象。
在媒体播放页必须有相应的插件官方下载地址，并保证地址有效能正常下载。
二.6状态栏提示错误
要求制作完成的网站任何一个页面的状态栏都不会出现错误提示信息，比方“网页错误〞的提示信息等。
二.7内容完整性
网站任何一个有效页面，都不允许版面上出现图片打不开、文字内容不能正常显示等情况。
对于空白的内容页面应该给出相应的提示信息。
对于客户自己维护的网站信息，不包含在本项检查范围内。
标准及说明：
⏹图片打不开
⏹文字内容不能正常显示
⏹空白页面没有提示信息
二.8文字内容
在一个语言版本中，不应该出现其他语言的文字描述〔版本转换标识除外〕或者非内容需要的其他语言文字、各种操作提示文字都应该符合语言版本；比方在英文版本，不应该单独出现中文的文字描述。
网站页面设计制作范围内没有文字拼写错误。
二.9界面一致性
⏹图标
✧软件标识性图标：
程序快捷方式图标、系统托盘图标、开始菜单图标、系统状态栏图标、窗口标题栏图标。
✧软件功能性图标：
一般是指某个软件产品的产品界面工具栏中具有功能标识的图形符号。
如果以直观方式显示图像即可清晰地表达图标的含义，那么不必使用其它复杂方式。
⏹版权信息：
书写格式－版权所有.2006-2007中国物品编码中心
⏹版本号：
✧中文版书写格式遵循：
版本版本号；字体粗体；版本与版本号之间保持一个全角空格间距。
正确例如：
版本
✧英文版书写格式遵循：
Version版本号；字体粗体；版本与版本号之间保持一个全角空格间距。
正确例如：
Version
二.10鼠标响应
三、表现层设计规那么
三.1界面设计总规那么
⏹适宜性原那么
⏹先易后美原那么
⏹及时性原那么
⏹常用性原那么
⏹一致性原那么
三.2界面通用布局规那么
⏹功能菜单通常采用“常用→主要→次要〞的顺序位置排列，符合windows风格。
对重要的功能按钮和使用频繁的按钮应放在界面的显目位置。
⏹操作功能按钮键在界面中摆放不下时，可以用图标显示，并对图标应单独加文字说明，浮标中显示按钮文本名称。
⏹对页面中的数据表格，一般规定为每页显示20行，特殊情况下〔如页面中安排有多个表格〕，可根据页面大小考虑适当变动。
⏹页面的最显眼位置的按钮应是客户最有可能进行下一步操作的按钮。
三.3列表页面设计规那么（参考）
⏹必备内容：
导航块、搜索块、描述块、数据列表块、分页操作块、本页其他操作及多行数据公用操作块。
⏹布局要求：
整体布局如下列图：
导航块布置在页面左上方，用于显示当前页面的导航位置；如下列图中的：
搜索块在导航块下方，备注块上方，且页面居中，包括搜索和重置按钮，用于提供搜索信息并执行搜索操作；如下列图中的：
备注块布置在搜索块下方，数据块上方，且页面居中，通常用于描述页面中的特殊图标或者操作疑难等需要额外解释的局部；如下列图中的：
数据列表块布置在备注块下方，分页块上方，且页面居中，用于显示搜索到的数据；如上图中的：
分页操作块布置数据列表块下方，且页面居中，用于显示数据页统计信息和执行分页操作。
如上图中的：
本页其他操作及多行数据公用操作块多为按钮，布置在分页块下方和数据列表的右上方，且页面居右，且如果有批量操作一定要有全选&反选操作。
如上图中的：
当有数据时出现的效果如下列图：
对于列表，一般可以对应需求设定对应的排序，排序根本在行头操作如下列图：
当搜索无数据时，应出现下列图效果页面：
三.4新增页面设计规那么
对于如下列图所示类型的页面
界面用词规那么
⏹新增：
对数据进行的增加操作，标准用法为：
【新增】，不可以用“增加〞、“添加〞等。
⏹修改：
在列表页面对数据进行修改的操作，标准用法为：
【修改】，不可以用“编辑〞、“变更〞等。
⏹搜索：
对于数据查询的操作，标准用法为：
【搜索】，不可以用“查询〞、“查找〞、“查看〞、“浏览〞等。
⏹保存：
在数据编辑页面对数据进行保存的操作，用：
【保存】，不用“提交〞、“确认〞、“确定〞等。
⏹确定：
在详细信息页面或对一些信息确实认、出错的提示等，应用【确定】，不可以用“确认〞、“提交〞等。
⏹取消：
可对数据项进行修改的页面,返回进入该页面之前的列表页或上一页，那么使用【取消】。
尽量不用“放弃〞、“撤消〞、“返回〞等。
同时【取消】也可与【保存】、【确定】等配合使用。
⏹重置：
对系统设置或已有预置数据的实体数据项，如果想回复到原始默认状态，请使用【重置】，而不用“复原〞、“回复〞等，点击该按钮要求页面不能跳转，不能刷新。
⏹返回：
不能对数据项进行修改的搜索页面，需要返回上一页面时，用【返回】。
尽量不用“放弃〞、“撤消〞、“取消〞等。
⏹在详细信息修改页面至少有的按钮：
【保存】【重置】【返回】
⏹【保存】假设是窗口在当前页翻开，那么点击后，返回并刷新前一页（来源页）的列表页面。
假设是新弹出窗口，那么关闭弹出窗口；假设弹出窗口的操作对来源页面产生了影响，那么要在关闭弹出窗口时刷新来源页面（父页面），假设没有产生影响，那么不必刷新。
⏹【重置】重置（清空）当前页面的填入信息。
⏹【返回】不保存操作信息，返回到来源窗口。
⏹跟业务操作相关的按钮可以以动名词的方式命名。
⏹所有需要审核的信息，统一状态为“待审核〞、“通过〞、“未通过〞。
如果页面里有搜索条件，需要把审核状态作为搜索项时，审核状态搜索项采用下拉框，而且下拉框选项为：
“所有〞、“待审核〞、“通过〞、“未通过〞，而且也必须按此顺序显示。
⏹搜索结果列表中一般有“操作〞列，该列涉及到的审核功能有“审核通过〞“审核不通过〞功能，这两个功能链接不要屏蔽或失效处理。
⏹如果条件允许的情况下建议为表单每个元素附加一个根本描述，对于必须填写的工程必须用*标记：
如下列图,
三.5界面数据处理规那么
特殊字符
⏹存储：
保证能够按照原字符〔不允许转换〕正确的存储到数据库。
包含在Sql语句中时，必须使用SqlCommandParameters方式进行存储，不允许采用直接执行Sql语句的方式。
因为这些特殊字符〔如：
单撇，双横杠，双斜撇〕在Sql语句中有注释的含义，如果Sql语句中包含这些符号又没有经过相应的转换处理〔单撇转换成双撇〕，程序执行时必将出错，而且不易发现。
⏹显示：
保证在页面显示后的效果是原字符。
在不会导致转换的页面控件〔如：
TextBox、DropDownList〕中显示时，可直接显示，不用进行转换。
反之，必须进行相应的转换。
例如：
直接将<符号和>符号显示在页面或Table中，必须将其转换为<和>。
否那么，导致页面混乱。
⏹查询：
除特殊情况外，一律使用字符原始含意进行查询，消除其具有的Sql语句匹配功能。
如：
%符号在Sql语句中具有全部匹配的功能，在使用该符号时必须将其转换为[%]。
⏹必须进行处理的特殊字符：
空格、回车换行、小于号、大于号、百分号、单撇、双横杠、双斜撇。
特殊字符集参考
数字、英文、日期
⏹英文
✧英文字母必须使用半角字符。
✧英文单词间用半角空格分隔。
⏹数字
✧表示数值范围时，用“~〞连接，请注意在字符“~〞前后都有一个半角空格，如：
0~20。
✧数字带有国际单位和表示量的数词时，两个数字都要加上数词和单位。
正确的使用方法：
132kg~234kg，67%~89%。
错误的使用方法：
132~234kg，67~89%。
✧千分位分隔符。
✧小数点对齐。
✧编号类数字左对齐，数据类数字右对齐。
⏹日期与时间
✧日期的格式：
书写遵循xxxx〔年〕-xx〔月〕-xx〔日〕格式，实际应用中无包括“（）〞在内的文字，“（）〞内的内容只用于说明。
✧正确例如：
2005-12-29、2005-02-05
✧错误例如：
12/29/05、2005年12月29日、2005-2-5、
✧时间的格式：
书写遵循xx〔点〕:
xx〔分〕:
xx〔秒〕格式。
时间使用24小时制。
实际应用中无包括“（）〞在内的文字，“（）〞内的内容只用于说明。
✧正确例如：
23:
35:
18
✧错误例如：
11:
35:
18PM、23点35分18秒
✧日期、时间混用格式：
遵循xxxx-xx-xxHH:
MM:
SS格式，日期与时间之间保持两个半角空格间距。
✧正确例如：
2005-12-2923:
35:
18
✧错误例如：
12/29/200523:
35:
18、2005年12月29日 23点35分18秒
✧当出现选择时间段操作时的处理方法：
统一采用上图所示布局，开始日期和结束日期的文字描述，随后是文本框，之后是日期选项按钮。
其中文字描述方法只能采用以下两种之一，并且按下面的设计成对出现：
开始日期、结束日期
起始日期、终止日期
时间段的逻辑关系是开始日期的0：
0：
0开始到结束日期的23：
59：
59为止。
如：
开始日期：
2007-5-21结束日期：
2007-5-25
那么实际时间段为：
大于等于2007-5-210:
0:
0到小于等于2007-5-2523:
59:
59
当用户只设定了开始日期时，表示从设置开始日期起的所有时间范围；
当用户只设定了结束日期时，表示从设置结束日期前的所有时间范围；
⏹汉字
✧进入输入时，一个汉字字符等同于一个英文〔数字〕字符，统一用“字符〞表示。
✧输出显示时，一字汉字字符宽度等同于两个英文〔数字〕字符，统一用“字符显示宽度〞表示。
⏹文本保存规划
✧假设是普通文本框，输入的内容在存入数据库时其开头、结尾不保存空格。
✧假设是多行文本域，输入的内容按照原输入保住到数据库。
四、数据存储规那么
四.1程序存储规那么
✧数据表必须实体化
✧数据操作必须调用存储过程来完成相应操作，不能直接出现InsertSql语句。
✧数据层不包含任何业务逻辑关系，仅提供数据存取等根本数据库操作方法
✧错误处理，需捕获错误如果翻开数据库联接的需关闭数据库联接，可直接抛出错误异常，便于调试处理。
四.2存储过程规那么
✧任何存储过程尽量不包含业务逻辑规那么
✧一个存储过程尽量只操作一个表
✧存储过程不能使用游标
✧存储过程以P_Insert_table_1，P_update_table_1这样的模式命名
五、业务逻辑设计规那么
五.1日志记录
日志采用log4net记录，异常错误需记录异常信息便于调试。
五.2错误处理
错误处理，业务层不能直接抛出系统错误，须用Try（）Catch{}Finally{}
语句处理系统错误，重新对用户显示友善的自定义错误，须记录错误便于排错。
五.3权限控制
任何模块必须构造对应的权限模块，所有的业务逻辑操作必须判断操作权限。
权限失败的操作，尽量记录错误。
六、界面控件使用原那么
六.1界面控件使用原那么〔参考〕
尽量使用标准控件，少用、不用复合型组合控件。
✧少用包含大量javascript脚本的控件
✧无源代码控件不用
七、页面逻辑规那么
七.1登陆页面处理规那么
⏹用户输入验证信息，单击【登录】，系统进入信息验证页面，进行身份验证
⏹处理流程：
⏹系统做校验时必须分两步进行判断，严禁使用如下类似可以造成SQL攻击的SQL语句：
“select*from用户帐号表whereusername=’〞+用户输入的登录名+“‘andpassword=’“+用户输入的密码+“‘“
应用首先判断数据库中是否有与用户输入的登录名相同的记录，如果有那么取值该用户的密码，然后用此密码和用户输入的密码进行比照。
否那么提示相关错误信息，对于登录失败的错误统一为“帐号信息错误!
〞。
七.2退出页面处理规那么
⏹用户在系统任意页面单击【退出】，系统提示用户“确定要退出么？
〞。
⏹用户单击【确定】，对于办公类软件关闭系统所有相关页面IE窗口。
对于网站类系统将URL跳转到前台首页。
七.3注销页面处理规那么
⏹登录到系统后用户选择【注销】，系统提示用户“确定要注销么？
〞。
⏹用户选择【确定】，系统关闭系统所有相关页面，翻开登录页面。
七.4修改密码页面处理规那么
⏹用户单击【修改密码】，系统进入修改密码页面。
⏹单击【保存】，进行验证。
✧旧密码不正确：
页面显示红色提示信息：
“旧密码不正确！
〞，光标定位在旧密码输入框。
✧新密码为空：
页面显示红色提示信息：
“密码不能为空，请输入！
〞，光标定位在新密码输入框。
✧密码位数不正确：
页面显示红色提示信息“新密码位数错误，请重新输入！
〞，光标定位在新密码输入框。
✧密码格式不正确：
页面显示红色提示信息“新密码格式错误，请重新输入！
〞，光标定位在新密码输入框。
✧新密码与确定密码不同：
页面显示红色提示信息“两次输入的新密码不同，请重新输入！
〞，光标定位在新密码输入框。
⏹验证通过，系统将新密码保存，并提示“密码修改成功〞。
七.5搜索列表页处理规那么
⏹删除：
如果删除的数据项为当前页显示的最后一条，那么删除数据项后显示上一页的数据。
如果有特殊情况以文档中的用例为准。
⏹搜索：
根据搜索条件无论是否能够搜索到数据，列表页都必须显示数据项列标题和分页信息。
常规列表页面每页显示20条记录，带图片的列表页面每页显示15条记录。
⏹选择：
当标题行中的全选标记被选中时，页面中显示的所有数据项均被选中；当标题行中的全选标记被反选时，页面显示的所有数据项均取消选择；当标题行中的全选标记被选中后，取消某个或多个数据项的选择时，全选标记被取消选中状态，其它被选择的数据项仍处于选中状态；当页面中的所有数据项均被单独选择时，标题行中的全选标记被选择。
⏹排序：
在列表页面，列表信息默认按信息发布或审核有效后的时间倒序显示。
列表的标题名称除“操作〞外，应根本都可以排序。
⏹默认不出现搜索结果集，当单击【搜索】按钮后，方出现搜索结果集。
如果有特殊情况以文档中的用例为准。
七.6树型页面处理规那么
进入时默认展示第一层结构，对树型结构内容进行修改时，无论是新增、修改还是删除，变动应立即在树型结构中反映。
七.7分类选项的处理规那么
分类选项分两种选择说明：
如上图所示，搜索数据项较少时，下拉框前面是有标题说明时处理方法如下：
搜索条件中的某分类数据项的默认项，使用“所有〞。
⏹一般情况下将“请选择〞，“不限〞等内容均统一改成为“所有〞
⏹请选择行业类别改成“所有行业“
另一种方法：
当搜索数据项较多时，每个数据项前都有标题，空间利用率低，所以可以采用不带标题说明的方法处理：
⏹搜索条件中的某分类数据项的默认项，使用“所有XXXX〞。
XXXX使用能够说明下拉框内容的文字描述。
⏹一般情况下将“请选择〞，“不限〞等内容均统一改成为“所有XXXXX〞
注意：
以上要求仅在搜索条件的时候有效，当发布信息时，默认内容以文档的数据项约束为准！
七.8信息删除的处理规那么
⏹在所有信息的管理页面中，信息列表中要有“删除〞操作项，在列表下面的操作块中要有“批量删除〞按钮。
⏹假设有回收站功能，那么所有“删除〞后的信息要放到回收站中。
在信息列表的操作块中要有“彻底删除〞按钮。
⏹回收站中的列表项“操作〞中要有“复原〞、“彻底删除〞操作项。
在列表信息下面要有批量“复原〞、“彻底删除〞，“清空回收站〞按钮。
⏹“彻底删除〞功能是将选中的对象完全从系统中删除，数据库中不再保存任何信息。
⏹“复原〞功能是选中需要复原的对象，将数据恢复到数据被删除前的状态。
⏹“清空回收站〞功能是无需选择情况对象，直接将回收站的所有数据彻底删除。
⏹注意：
以具体工程为准,仅做参考。
八、操作处理规那么
八.1信息提示规那么
信息提示的原那么，对于任何动作都应该给提示操作的结果，重要的动作需要提供再次确认信息，信息提示设计采用下列图显示：
以下情况需提示：
⏹对初始页面，页面中的列表或实体中内容为空时，比方“消息列表〞未进行订阅操作，那么应在相应区域显示提示信息：
“尚无XXX…〞。
⏹在异步调用处理时，如果由于性能、数据量等因素造成等待时间达2秒以上时，应有等待提示有等待提示，提示信息：
“正在处理，请等待。
〞〔等待时间自行掌握〕
⏹保存、添加、修改操作完成后，应给出提示信息，使用“〔新增或修改〕XXX成功〔失败〕〞给用户反应。
括号里的内容根据当前操作按钮来命名。
如下列图：
⏹对信息进行审核操作的提示，当有发邮件的情况时：
✧审核成功，提示“审核通过，通知用户邮件已发出〞。
✧审核不成功，提示“审核不通过，通知用户邮件已发出〞。
⏹搜索结果为空的提示
✧前台采用统一提示“非常抱歉，没有您想要的搜索结果，建议您换用其他搜索条件〞。
✧搜索条件为空时，提示“请输入搜索条件〞，不执行搜索动作。
注意：
中文版程序中，提示内容要求为中文半角,包括标点符号。
即提示语言要与其语言版本相对应。
⏹对于需要选中对象后进行处理的情况，如果没有选择某类对象，系统提示“请选择XXXX后进行操作〞
⏹对可能造成数据无法恢复的操作必须提供确认信息，给用户放弃选择的时机。
采用弹出窗口，提示如下：
✧删除：
点击确定按钮后，系统提示“您确认要删除当前所选记录吗？
〞。
如下列图：
✧彻底删除：
点击确定按钮后，系统提示“您确认要删除当前所选记录吗？
删除后数据将不可恢复!
〞
✧当鼠标移到列表数据时，鼠标当前所在数据位置底色将发生改变，以区别当前操作记录。
颜色根据标准页面设计而定。
✧删除后提示成功信息：
“数据成功删除!
〞，如果数据正在使用不能删除那么提示：
“数据正在使用，不能删除!
〞
⏹提示语出现的方式标准：
✧一般为在进行某项操作之前，而要出现的预警性的提示，比方删除操作，使用弹出窗口的形式。
✧假设执行某操作后，需要对数据进行约束验证、结果提示等结论性提示，一般使用在当前页的某一区域进行显示提示性的文字。
八.2对页面传递的参数必须进行有效性验证。
比方：
上图中的URL是：
:
//localhost:
81/Product/ProductInfo.aspx?
item_id=133
当在参数“ID＝〞后台输入字符时，应该提示错误信息如：
而不能出现系统自带的异常错误处理信息。
再如：
当两个管理员进入后台查询同一个列表数据，一个管理员删除一条数据时，另外一个管理员对该条数据进行操作〔修改、删除、审核等〕时，应提示该数据不存在或其他提示信息。
同样不能出现系统自带的异常错误处理信息。
八.3其他
✧对于类别加一个别名，用于前台控件调用。
比方新闻类别里加一个别名字段。
✧在列表项中应该用明显颜色区分可点击内容和不可点击内容〔〕，以便操作者可以迅速识别可操作功能。
九、数据约束规那么
九.1违反非空约束
⏹场景：
对输入框的数据项，约束为“是否必填〞；对选择框的数据项，约束为“是否必选〞。
⏹模式：
YYYY为必填项，请填写。
⏹例：
用户名为必填项，请填写。
⏹模式：
YYYY为必选项，请选择。
⏹例：
信息分类为必选项，请选择。
九.2违反组合约束
⏹场景：
输入内容的组成元素所能选择的范围，如：
不区分大小写（A-Z,a-z,0-9,-,_），必须包含“@〞和“.〞。
⏹模式：
YYYY中应该包含Y1，Y2…字符，请重新填写。
例：
Email中应该包含@和.字符，请重新填写。
⏹模式：
YYYY中不允许包含Y1，Y2…字符，请重新填写。
例：
管理员名称中不允许包含@和中文字符，请重新填写。
九.3违反长度约束
⏹场景：
输入内容中包含组成元素个数的上限或下限，如：
不超过255个字符。
⏹模式：
YYYY应该至少Y1个字符，请重新填写。
例：
用户名应该至少6个字符，请重新填写。
⏹模式：
YYYY不允许超过Y2个字符，请重新填写。
例：
用户名不允许超过20个字符，请重新填写。
⏹模式：
YYYY，Y1－Y2个字符，请重新填写。
例：
用户名，6－20个字符，请重新填写。
九.4违反范围约束
⏹场景：
输入内容值的合法范围，如：
0－200。
⏹模式：
XXXX超出范围，请重新填写。
例：
年龄超出范围，请重新填写。
九.5违反格式约束
⏹场景：
输入内容的组成元素间所应该满足的结构性要求，如：
日期格式：
yyyy-mm-dd；时间格式：
hh:
mm:
ss。
⏹模式：
YYYY的格式为：
RRRR，请重新填写。
例：
出生日期的格式为：
yyyy-mm-dd，请重新填写。
时间 的格式为：
的格式为：
hh:
mm:
ss，请重新填写。
九.6违反唯一约束
⏹场景：
数据项的值在同类实体中是否允许相同，如：
网站ID。
⏹模式：
XXXXRRRR已经存在，请重新填写。
例：
“GTIN〞AABBCC已经存在，请重新填写。
九.7违反关联约束
⏹场景：
其他数据项的值对当前数据项值的要求，如：
不能早于开始日期，必须大于当前日期2005-7-22。
⏹模式：
XXXX应该ZZZZ，请重新填写。
例：
开始日期应该早于终止日期，请重新填写。
例：
总统套房的订房数量应该不超过其空房数量〔5间〕，请重新填写。
⏹模式：
您尚未XXXX，请ZZZZ后再ZZZZ。
例：
您尚未注册，请注册成功后再购置商品。
⏹模式：
XXXX仍有RRRR，您不能ZZZZ。
例：
本部门仍有员工，您不能删除本部门。
注释：
XXXX是表示操作名称，YYYY表示被操作的对象，ZZZZ表示系统建议用户所采取的操作，一般为动宾式，RRRR为约束值。
十、操作约束规那么
十.1违反存在约束
⏹场景
升级会员 