物流系统详细设计文档文档格式.docx
《物流系统详细设计文档文档格式.docx》由会员分享，可在线阅读，更多相关《物流系统详细设计文档文档格式.docx（58页珍藏版）》请在冰点文库上搜索。
2.3客户端
Client:
IE7/8、Firefox2、Opera9
2.4网络及硬件
数据中心可以放在公司机房，要求申请互联网IP地址。
或者放在有关电信机房采用主机托管模式。
网络中心数据服务器：
P42.6、2G内存以上，配SQLSERVER2008
网络中心应用服务器:
P42.6、2G内存以上，配Jrun4.0中间件客户机：
普通PC，配:
IE6以上浏览器，网络连接
3编程命名规范
3.1概述
设计、开发人员应严格遵守此套开发规范和标准，并落实到自己的设计与代码程序中。
命名规范将包括：
编程命名规范，业务对象命名规范，数据库命名规范，Web站点结构命名规范等。
编码规范将包括：
C#编程规范，第三方模块使用规范等。
本命名规范主要针对使用VisualS规范，即编程命名规范部分。
3.2变量命名的总原则
变量命名的总原则时一个通用性的原则。
3.2.1一般性原则
1、变量名称应当准确完整的描述变量的含义
2、名称应当反映业务上的问题而不是技术上或是编程上的解决方法
3、名称的长度应当足够长
4、名称的最后一部分应当有限定符
5、应当用Count，Index或Nbr代替Num、No
3.2.2对特定类型数据的命名
1、循环技术变量的名称应当有含义（如果循环语句的长度超过了两行或者存在着嵌套循环，尽量避免使用l,j,k之类的变量，应该使用有意义的变量）
2、临时变量的命名应当有意义
3、所有布尔型变量的命名能够直接从名称上看出为真的条件
4、命名的常量应当代表了抽象的实体而非他们所代表的值
5、从变量命名中应当可以看出变量的作用域是局部变量，模块变量或者全局变量
6、变量的名称中不同的单词首字母要大写，以方便阅读
3.2.3关于短名称的使用
1、如果不是绝对必须，尽量避免使用短的名称
2、如果变量中单词的所写只能缩短一两个字符则使用单词的完全拼写
3、所有单词的缩写规则应当一致
3.2.4其他应当避免的命名问题
1、名称具有误导性
2、两个不同的命名具有相似的含义
3、不同的命名拼写很相似，仅差一两个字符
4、在变量名称中不应当使用数字
5、完全和变量含义不相关的命名
3.3VISUALSTDIO.NET
3.3.1大写样式
使用下面的三种大写标识符约定Pascal大小写将标识符的首字母和后面连接的每个单词的首字母都大写。
可以对三字符或更多字符的标识符使用Pascal大小写。
Camel大小写标识符的首字母小写，而每个后面连接的单词的首字母都大写。
大写标识符中的所有字母都大写。
仅对与由两个或者更少字母组成的标志符使用f该约定。
下表汇总了大写规则，并提供了不同类型的标识符的示例。
标识符
大小写
示例
类
Pascal
AppDomain
枚举类型
ErrorLevel
枚举值
FatalError
事件
ValueChange
异常类
WebException（注意总是以
Exception后缀结尾）
只读的静态字段
RedValue
接口
IDisposable（注意总是以|前缀开始）
方法
ToString
命名空间
System.Drawing
参数
Camel
TypeName
属性
BackColor
受保护的实例字段
redValue很少使用
公共实例字段
RedValue很少使用
3.3.2区分大小写
为了避免混淆和保证跨语言交互操作，请遵循下列规则：
1、不要使用要求区分大小写的名称。
对于区分大小写和不区分大小写的语言，组件都必须完全可以使用。
不区分大小写的语言无法区分同一上下文中仅大小写不同的两个名称。
因此，在创建组件或类中必须避免这种情况。
2、不要创建仅是名称大小写有区别的两个命名空间。
3、不要创建具有仅是大小写有区别的参数名称的函数。
4、不要创建具有仅是大小写有区别的类型名称的命名空间。
5、不要创建具有仅是大小写有区别的属性名称的类型。
6、不要创建具有仅是大小写有区别的方法名称的类型。
3.3.3命名空间命名指南
命名空间的一般性规则是使用公司名称，后跟技术名称和可选的功能与设计，如下所示：
CompanyName.TechnologyName[.Feature][.Design]
3.3.4类命名指南
1、使用名词或名词短语命名类
2、使用Pascal大小写
3、不要使用类型前缀，如在类名称上对类使用C前缀。
例如，使用类名称FileStream，而不是CFileStream。
4、不要使用下划线字符（_）。
5、有时候需要提供以字母|开始的类名称，虽然该类不是接口。
只要|是作为类名称组成部分的整个单词的第一个字母，这便是适当的。
6、在适当的地方，使用复合单词命名派生的类。
派生类名称的第二个部分应当时基类的名称。
3.3.5接口命名指南
1、用名词或名词短语，或者描述行为的形容词命名接口。
2、使用Pascal大小写。
3、给接口名称加上字母|前缀，以指示该类型为接口。
4、在定义类|接口对使用相似的名称。
两个名称的区别应该只是接口名称上有字母|前缀。
5、不要使用下划线字符（_）。
3.3.6枚举类型命名指南
1、对于Enum类型和值名称使用Pascal大小写。
2、不要在Enum类型名称上使用Enum后缀。
3、对大多数Enum类型使用单数名称，但是对作为位域的Enum类型使用复数名称。
4、总是将FlagAttribute添加到位域Enum类型。
3.3.7参数命名指南
1、使用描述性参数名称。
参数名称应当具有足够的描述性，以便参数的名称及其类型可用于在大多数情况下确定它的含义。
2、对参数名称使用Camel大小写。
3、使用描述参数的含义的名称，而不要使用描述参数的类型的名称。
开发工具将提供有关参数的类型的有意义的信息。
因此，通过描述意义，可以更好地使用参数名称。
少用基于类型的参数名称，仅在适合使用他们的地方使用它们。
4、不要使用保留的参数。
保留的参数时专用参数，如果需要，可以在未来的版本中公开它们。
相反，如果在类库的未来版本中需要更多的数据，请为方法添加新的重载。
5、不要给参数名称加匈牙利语类型表示法的前缀。
3.3.8方法命名指南
1、使用动词或动词短语命名方法。
3.3.9属性命名指南
1、使用名词或名词短语命名属性。
3、不要使用匈牙利语表示法。
4、考虑用于属性的基础类型相同的名称创建属性。
4模块功能详细设计
4.1系统管理员
4.1.1订单管理
4.1.1.1查询订单功能
功能名称
查询订单功能
功能编号
功能描述
由系统管理员根据需要查询订单
操作流程：
1、系统管理员进入订单查询页面
2、系统管理员选择查询订单操作
3、系统管理员填写需要查询的订单ID进行查询
4、系统管理员确认查询操作
5、系统显示操作信息
5.1若操作成功显示查询信息
5.2若操作失败提示失败信息
业务流程：
1、系统管理员在页面选择请求
2、捕获页面请求，跳转到查询
订单页面
3、选择需要查询的订单并选
择查询功能
4、系统显示查询结果
流程图：
页面输入
系统管理员：
（必须输入：
需查询的订单ID）
页面输出
成功、失败提示
对应类
Class
对应方法
方法输入
方法输出
DataSet（订单信息）
查询条件
订单ID和选中的相等
方法描述
从表中提取出与选中订单ID相对应的信息
接口设计
权限管理-查询订单权限-查询订单
数据库表
订单信息表
表字段
订单编号，发件人姓名，发件人地址，派送员姓名，货物名称
对外操作
从“订单信息”中查询出需要查询的订单的信息
例外说明
订单ID没有输入，系统无法查询。
4.1.1.2修改订单功能
修改订单功能
由派送点业务员根据需要修改订单
1、派送点业务员进入订单管理页面
2、派送点业务员选择修改订单操作
3、派送点业务员填写订单ID修改信息，并提交修改
4、系统显示操作信息
4.1若操作成功提示成功信息
4.2若操作失败提示失败信息
1、派送点业务员在页面选择修改订单请求
2、捕获页面请求，跳转到修改订单页面
3、填写订单ID修改信息，并提交修改
4、提示操作结果
需修改的订单ID和修改信息）
Boolean：
true：
操作成功
false：
操作失败
将数据表中与订单ID相对应的信息进行更新
权限管理-修改订单权限-修改订单
订单ID,订单时间,订单生成城市,运货车辆ID,货物情况,下车扫描员姓,下车扫描员ID,上车扫描员姓名,上车扫描员ID
将修改的内容存入“订单信息”表中
已存在的订单ID没有输入，系统无法修改。
4.1.1.3删除订单功能
删除订单功能
由订单删除员根据需要删除订单
1、系统管理员进入订单删除页面
2、系统管理员选择删除订单操作
3、系统管理员选择需要删除的订单并选择删除
4、系统显示信息
1、系统管理员在页面选择
删除订单请求
2、捕获页面请求，跳转到删除订单页面
3、选择需要删除的订单并
选择删除功能
4、获得页面数据，连接数据
库，在库中删除一条订单的
信息
5、提示操作结果
需删除的订单ID）
无
将数据表中与选中订单ID的记录删除
权限管理-删除订单权限-删除订单
将选择删除的订单在“订单ID”表中删除
4.1.2财务报表管理模块
4.1.2.1增加财务报表功能
增加财务报表
由总公司管理员根据需要增加财务报表
操作流程:
1、由总公司管理员进入财务报表管理界面
2、总公司管理员选择增加财务报表
3、系统显示信息
3.1若操作成功提示成功信息
3.2若操作失败提示失败信息
1、总公司管理员在页面选择增加财务报表请求
2、捕获页面请求，跳转到增加财务报表页面
3、填写增加财务报表信息
4、获得页面数据，连接数据库，在数据库中添加一条财务报表信息
总公司管理
员登陆后台
管理系统
添加财务报表
数据合
法
？
Y
报表添加成
功
结束
系统提示添
加失败
N
总公司管理员：
财务报表的起始城市和终点城市）
失败提示、添加成功信息
BLL.PriceTable
DAL.PriceTable
对应方法：
AddPriceTable（）
方法输入：
Model.MonthPriceTable
方法输出：
True：
False：
查询条件：
方法描述：
方法中将财务报表的信息添加到数据库中。
接口设计：
权限管理
增加财务报表权限
数据库表：
月财务报表信息
表字段：
月份,收入,人力成本,车辆损耗,行政成本,其他损耗,盈利
对表操作：
对表月财务报表进行增加将完整的信息存入表财务报表信息中
例外说明：
必须输入的信息没有输入或者增加已存在的信息，系统提示错误。
4.1.2.2删除财务报表功能
删除财务报表
由总公司管理员根据需要删除财务报表
2、总公司管理员选择删除财务报表
5、总公司管理员在页面选择删除财务报表请求
6、捕获页面请求，跳转到删除财务报表页面
7、删除财务报表信息
8、获得页面数据，连接数据库，在数据库中删除一条财务报表信息
删除成功
系统提示删
除失败
所要删除的月份）
BLLPriceTable,
delPriceTable（）
Month
方法中将财务报表的信息从数据库中删除。
删除报表权限
删除路线
将财务报表起始城市和终点城市所对应的财务报表从表财务报表信息中删除
必须输入的信息没有输入或者删除不存在的信息，系统提示错误。
4.1.2.3查询财务报表功能：
查询财务报表
由总公司管理员根据需要查询财务报表
1、由用户进入财务报表管理界面
2、用户选择查询财务报表
9、总公司管理员在页面选择查询财务报表请求
10、捕获页面请求，跳转到查询财务报表页面
11、添加查询财务报表信息
12、获得页面数据，连接数据库，在数据库中查询一条财务报表信息
查询成功
所要查询的月份）
checkPriceTable（）
方法从数据库中查询财务报表的信息。
查询报表权限
查询报表
对表财务报表信息中查询出财务报表信息
必须输入的信息没有输入或者查询不存在的信息，系统提示错误。
4.1.2.4修改财务报表功能
修改财务报表
由总公司管理员根据需要修改财务报表
2、用户选择修改财务报表
13、总公司管理员在页面选择修改财务报表请求
14、捕获页面请求，跳转到查询财务报表页面
15、修改财务报表信息
16、获得页面数据，连接数据库，在数据库中修改一条财务报表信息
月份，收入，人力成本，车辆损耗，行政成本
失败提示、修改成功信息，修改后的信息
changePriceTable（）
方法从数据库中修改财务报表的信息。
修改报表权限
对表财务报表信息中修改财务报表信息
必须输入的信息没有输入或者修改不存在的信息，系统提示错误。
4.1.3路线价格管理模块
4.1.3.1修改区域间路线价格功能
修改区域间路线价格
由总公司管理员根据需要修改区域间路线价格
1、由用户进入区域间路线价格管理界面
2、用户选择修改区域间路线价格
17、总公司管理员在页面选择修改区域间路线价格请求
18、捕获页面请求，跳转到查询区域间路线价格页面
19、修改区域间路线价格信息
20、获得页面数据，连接数据库，在数据库中修改一条区域间路线价格信息
修改区域间价格
区域名称，价格
BLLBigPrice,
DAL.BigPrice
changeBigPrice（）
Month,Price
方法从数据库中修改区域内路线价格的信息。
区域内路线价格信息
区域，价格
对表区域间路线价格信息中修改价格信息
4.1.3.2修改区域内路线价格功能
修改区域内路线价格
由总公司管理员根据需要修改区域内路线价格
1、由用户进入区域内路线价格管理界面
2、用户选择修改区域内路线价格
21、总公司管理员在页面选择修改区域内路线价格请求
22、捕获页面请求，跳转到查询区域内路线价格页面
23、添加修改区域内路线价格信息
24、获得页面数据，连接数据库，在数据库中修改一条区域内路线价格信息
修改区域内价格
BLLAreaPrice,
DAL.AreaPrice
changeAreaPrice（）
MonthPrice
对表区域内路线价格信息中修改价格信息
必须输入的信息没有输入或者查询不存在的信息系统提示错误
4.1.4交接单管理
4.1.4.1增加交接单
查看交接单功能
由派送点业务员根据需要查看交接单
1、配送点业务员进入交接单删除页面
2、配送点业务员选择查看交接单操作
3、配送点业务员填写需要查看的交接单ID进行查询
4、配送点业务员确认查询操作
1、配送点业务员在页面选择请求
配送点页面
升级会员 