软件项目详细设计文档模板.doc

(完整word)软件项目详细设计文档模板
研发生产中心
文档编号

版本
A1
密级
商密A
项目名称
Xx系统
项目来源

QR—RD-022（Ver1.2)

XXX系统
详细设计说明书

(内部资料 请勿外传)

编 写：

日 期：

检 查:

日 期：

审 核：

日 期：

批 准：

日 期：

XX公司

版权所有 不得复制

文档变更记录
序号
变更（+/-)说明
作者
版本号
日期
批准
1

2

目 录
1. 引言 4
1.1 编写目的和范围 4
1。2 术语表 4
1。3 参考资料 4
1。4 使用的文字处理和绘图工具 4
2. 全局数据结构说明 5
2.1 常量 5
2。2 变量 5
2.3 数据结构 5
3。 模块设计 5
3.1 用例图 5
3.2 功能设计说明 5
3.2。1 模块1 5
3。2。2 模块2 6
4. 接口设计 7
4。1 内部接口 7
4。2 外部接口 7
4.2.1 接口说明 7
4.2.2 调用方式 8
5. 数据库设计 8
6. 系统安全保密设计 8
6.1 说明 8
6。2 设计 8
6。2.1 数据传输部分 8
6.2.2 IP过滤分部 8
6。2。3 身份验证部分 8
7. 系统性能设计 9
8. 系统出错处理 9

1. 引言
1.1 编写目的和范围
说明写这份详细设计说明书的目的.
本详细设计说明书编写的目的是说明程序模块的设计考虑,包括程序描述、输入/输出、算法和流程逻辑等,为软件编程和系统维护提供基础.本说明书的预期读者为系统设计人员、软件开发人员、软件测试人员和项目评审人员。
1.2 术语表
定义系统或产品中涉及的重要术语，为读者在阅读文档时提供必要的参考信息.
序号
术语或缩略语
说明性定义
1
PM
Project Manager，项目经理
2

1.3 参考资料
列出有关资料的名称、作者、文件编号或版本等。参考资料包括：
a．需求说明书、架构设计说明书等;
b．本项目的其他已发表的文件；
c．引用文件、资料、软件开发标准等。
资料名称
作者
文件编号、版本
资料存放地点

1.4 使用的文字处理和绘图工具
文字处理软件：word office
绘图工具: Visio
2. 全局数据结构说明
本章说明本程序系统中使用的全局数据常量、变量和数据结构。
2.1 常量
static String SERVER_ADDRESS 服务器地址
boolean loginFlag 登录状态
2.2 变量
BlueUserInfo 用户账户结构体

2.3 数据结构
包括数据结构名称,功能说明，具体数据结构说明（定义、注释、取值)等。
3. 模块设计
3.1 用例图

3.2 功能设计说明
3.2.1 登录模块
模块1主要分为以下几个子模块：子模块1、子模块2和子模块N.
3.2.1.1 设计图

3.2.1.2 功能描述
此模块的主要功能是登录验证功能,保证程序的安全性问题。用户需要验证用户和密码是否正确才能进行下一部操作。
3.2.1.3 输入数据
变量名
类型
说明
userName
String
用户名(必填）
password
String
密码（必填)
STOPSPLASH
int
开场动画标志位
SPLASHTIME
long
消息发送延迟时间
LOGINBUTTON
int
登录按钮是否能够点击标志位
3.2.1.4 输出数据

字段
说明
code
结果，0表示失败，1表示成功，2表示该养殖场地不存在，3表示该Rfid已存在
userName
用户名
PassWord
密码
userRoleld
用户权限，1代表系统用户,2 代表人事部，3代表育苗场，4代表生产部,5代表加工厂,6 代表市场部，7代表捕捞管理员
表现形式为:
code=1

3.2.1.5 流程图

3.2.1.6 源程序文件说明

3.2.1.7 函数说明
对密码进行MD5加密：md5(密码)
将用户的账号密码暂时保存等下次登录时可以不用再次输入：saveUserInfo(Activity名，用户名,密码）
3.2.1.8 限制条件
必须在有网的条件下能使用登录功能。
3.2.2 人员管理
3.2.2.1 设计图

3.2.2.2 功能描述
通过手持设备扫描员工的RFID号,并在员工工号的输入框手动输入员工工号，并将两条数据上传到服务器中的数据库。将员工工号与RFID号相互绑定.
3.2.2.3 输入数据
变量名
属性
说明
number
string
员工的员工号(必填)
rfid
string
员工的RFID号（必填）如：E2005032530B0187144085E3
在检测数据的有效性是像是判断数据是否为空，当向服务器发送消息时服务器会对数据进行有效性检测，显示判断员工的员工号是否存在,员工的RFID号是否已被其他工作人员应将绑定。
这些数据的获取离不开具有RFID扫描功能的手持设备，对员工的RFID卡进行扫描获取RFID号。才实现此功能
3.2.2.4 输出数据
变量名
属性
说明
number
string
员工的员工号
rfid
string
员工的RFID号
flag
int
数据存储状态的标志位
3.2.2.5 业务算法和流程

3.2.2.6 数据设计

给出本程序中的局部数据结构说明，包括数据结构名称，功能说明，具体数据结构说明（定义、注释设计、取值）等。相关数据库表，数据存储设计（具体说明需要以文件方式保存的数据文件名、数据存储格式、数据项及属性等。）
3.2.2.7 源程序文件说明
package com.blueocean.BlueOceanSource。ui;

import android。app.Activity;
import android。content。Context；
import android。os。Bundle；
import android.text.TextUtils;
import android.util.Log；
import android。view。View；
import android。widget.Button；
import android.widget。EditText;
import android.widget。TextView；
import android.widget。Toast;
import cn.pda.hf。Util；
import com.blueocean.BlueOceanSource.R;
import com。blueocean.BlueOceanSource。entity.BlueOceanEmployee;
import com。blueocean.BlueOceanSource.service。BlueOceanEmployeeService；
import com。blueocean.BlueOceanSource。service.UploadService；
import com。blueocean.BlueOceanSource。utility。RfidScan；//引入RFID扫描的开发包

/＊*
* Created by zhouxingguo on 2015/7/15。
＊/
public class EmployeeActivity extends Activity ｛

private Button scan;
private Button saveMessage；//保存员工信息
private EditText inputNumber;//员工编号、卡号
private TextView inputRfid；//员工RFID信息
private String number;//获取得到的卡号、编号
private String rfid;//获取得到的RFID
private RfidScan rfidScan；
private String rfidget;

@Override
public void onCreate（Bundle savedInstanceState) ｛
super。onCreate（savedInstanceState)；
setContentView(R.layout.activity_employee)；
Util。initSoundPool(this);
init（）；//获取RFID号和员工工号并保存到本地数据库

｝

//初始化控件
private void init() {
inputNumber = （EditText） findViewById（R。id。input_employee_number);
inputRfid = (TextView) findViewById(R.id。input_employee_rfid）；
saveMessage = （Button) findViewById（R。id.save_message_employee)；
scan=(Button)findViewById（R.id.scan_rfid）；
MyListener listener = new MyListener(this)；
saveMessage.setOnClickListener（listener)；
scan.setOnClickListener(listener)；// datareceive = getIntent().getExtras(）;
// dataflag=datareceive。getInt（”dataflag”)；
// //0代表从主界面跳转，1代表从扫描接口跳转
// if(dataflag==0)｛
// inputRfid。setText("请扫描员工卡号”);
// ｝else if(dataflag==1）{
// rfidget = datareceive。getString（"rfid”）;//0代表从员工录入跳转，1代表从快递跳转
// inputRfid。setText（rfidget);
// }

｝

private class MyListener implements View.OnClickListener {

private Context context;

public MyListener（Context context） ｛
this.context = context;
｝

＠Override
public void onClick（View view) {

switch （view。getId(）) ｛

case R。id.scan_rfid：

rfidScan=new RfidScan()；
rfidget=rfidScan。scan（）;
if（rfidget!=null){
inputRfid。setText(rfidget）;
｝
else{
Toast.makeText(getApplicationContext（),R.string.scan_rfid_fail, Toast.LENGTH_SHORT）.show（）；
｝

break;

case R.id。save_message_employee://保存员工信息按钮到数据库，保存成功之后清空editText

//要保证输入的信息不能全部为空
if （！TextUtils.isEmpty（inputNumber。getText(）） &＆ !TextUtils.isEmpty（inputRfid.getText（）)) ｛
number = inputNumber.getText（)。toString（)。trim（)；
rfid = inputRfid。getText（）。toString()。trim（）；
BlueOceanEmployeeService employeeService = new BlueOceanEmployeeService(context);
BlueOceanEmployee boe = new BlueOceanEmployee(）；
int flag = 0;//0表示保存到本地数据库， 1表示本地数据库数据待删除
boe。setFlag（flag)；
boe.setNumber(number);
boe。setRfid（rfid）；
employeeService。insert（boe）；

inputNumber。setText(””）；
inputRfid.setText（””）;
Toast.makeText(getApplicationContext（), R.string.bind_success， Toast.LENGTH_LONG).show()；

//开辟一个新线程上传数据
new Thread（networkTask）。start（);
Toast。makeText（getApplicationContext(）, R.string。save_success_toast， Toast。LENGTH_LONG)。show();

} else {
Toast。makeText(getApplicationContext（)， R.string。employee_rfid_number_not_null， Toast。LENGTH_LONG).show（)；

}
break；

｝
}
｝

Runnable networkTask = new Runnable() ｛

@Override
public void run（） ｛
// TODO
// 在这里进行 http request。网络请求相关操作
UploadService uploadService = new UploadService（)；
uploadService。upload(getApplicationContext(））；
}
}；

｝
3.2.2.8 函数说明
大扫描RFID就成功时发出提示音:Util.initSoundPool（activity名称）；
程序的主体：init（）；
开启数据上传线程：networkTask
3.2.2.9 限制条件
要实现此功能必须要具备可以扫描RFID功能的手持设备,不然无法扫描员工的RFID号。
3.2.3 池塘管理
3.2.3.1 设计图

3.2.3.2 功能描述
此模块主要实现的功能是扫描池塘的RFID，并手动输入池塘编号，并将其保存到本地数据库.并等到有网的条件下，将此条信息上传到服务器端的数据库。实现池塘RFID号与池塘编号的绑定。
3.2.3.3 输入数据
变量名
属性
说明
number
string
池塘编号(必填)如：育苗池1
rfid
string
池塘的RFID号(必填） ：E2005032530B0187144085E3
在检测数据有效性时,需要检测数据是否为空。
这些数据的获取离不开具有RFID扫描功能的手持设备,对池塘的RFID卡进行扫描获取RFID号。才实现此功能
3.2.3.4 输出数据
变量名
属性
说明
number
string
池塘编号
rfid
string
池塘的RFID号
flag
Int
数据存储标志位
3.2.3.5 业务算法和流程

3.2.3.6 数据设计
给出本程序中的局部数据结构说明，包括数据结构名称，功能说明，具体数据结构说明（定义、注释设计、取值）等。相关数据库表,数据存储设计（具体说明需要以文件方式保存的数据文件名、数据存储格式、数据项及属性等。）
3.2.3.7 源程序文件说明
package com。blueocean.BlueOceanSource.ui；

import android.app。Activity;
import android。content.Context;
import android。os.Bundle;
import android.text。TextUtils;
import android.util.Log；
import android.view.View;
import android。widget。Button；
import android。widget。EditText;
import android。widget.TextView；
import android.widget.Toast；
import cn。pda.hf.Util；
import com.blueocean。BlueOceanSource。R；
import com.blueocean。BlueOceanSource。entity。BlueOceanPond;
import com。blueocean.BlueOceanSource。service。BlueOceanPondService;
import com。blueocean。BlueOceanSource.service。UploadService;
import com.blueocean.BlueOceanSource。utility.RfidScan;

/＊＊
＊ Created by zhouxingguo on 2015/7/15.
＊/
public class PondActivity extends Activity ｛

private Button scanPond;//点击扫描池塘
private Button bindPond;//绑定池塘编号和RFID信息
private EditText pondNumber;//池塘编号、卡号
private TextView pondRfid;//池塘RFID信息

private String number；//获取得到的卡号、编号
private String rfid;//获取得到的RFID

private RfidScan rfidScan；
private String rfidget;

@Override
public void onCreate（Bundle savedInstanceState) ｛
super.onCreate（savedInstanceState);
setContentView(R。layout.activity_pond)；
Util.initSoundPool(this);
init(）；

}

//初始化控件
private void init（) ｛
pondNumber = (EditText） findViewById（R.id。input_pond_number）；
pondRfid = (TextView） findViewById（R。id。input_pond_rfid）；
scanPond=（Button)findViewById（R。id.scan_pond_rfid);
bindPond = （Button) findViewById(R。id。bind_pond）;

MyListener listener = new MyListener（this);
scanPond.setOnClickListener(listener）；
bindPond.setOnClickListener(listener)；

｝

private class MyListener implements View.OnClickListener ｛

private Context context；

public MyListener(Context context) ｛
this。context = context;
｝

@Override
public void onClick（View view） {

Log。d（"aa",”进入点击"）;
switch （view。getId()） {

case R.id。scan_pond_rfid：

rfidScan=new RfidScan();
rfidget=rfidScan。scan（）;
if（rfidget!=null){
pondRfid.setText(rfidget);
｝
else{
Toast.makeText(getApplicationContext（),R.string。scan_rfid_fail， Toast.LENGTH_SHORT)。show（)；
｝

break;

case R。id.bind_pond：//保存员工信息按钮到数据库,保存成功之后清空editText

//要保证输入的信息不能全部为空
if （!TextUtils.isEmpty（pondNumber.getText（）) ＆＆ ！TextUtils。isEmpty（pondRfid。getText(））) ｛
number = pondNumber。getText()。toString(）。trim();
rfid = pondRfid.getText（）.toString（）。trim()；
BlueOceanPondService pondService = new BlueOceanPondService(context）;
BlueOceanPond boe = new BlueOceanPond（）；
int flag = 0；//0表示保存到本地数据库， 1表示本地数据库数据待删除
boe。setFlag(flag）；
boe。setNumber(number）;
boe。setRfid(rfid）;
pondService。insert(boe）；
pondNumber。setText（””);
pondRfid。setText("");
Toast。makeText（getApplicationContext（）, R。string.bind_success， Toast。LENGTH_LONG)。show();
//开辟一个新线程上传数据
new Thread(networkTask)。start（)；

｝
else｛
Toast。makeText（getApplicationContext(）， R.string.pond_rfid_number_not_null， Toast.LENGTH_LONG）.show（）;
｝

break；

}
｝
}

Runnable networkTask = new Runnable() {

＠Override
public void run(） ｛
// TODO
// 在这里进行 http request.网络请求相关操作
UploadService uploadService = new UploadService（）;
uploadService.upload（PondActivity。this);
}
};

｝
3.2.3.8 函数说明
当扫描RFID就成功时发出提示音：Util.initSoundPool(activity名称)；
程序的主体:init();
开启数据上传线程：networkTask

3.2.3.9 限制条件
要实现此功能必须要具备可以扫描RFID功能的手持设备，不然无法扫描员工的RFID号.
3.2.4 育苗管理
3.2.4.1 设计图

3.2.4.2 功能描述
本功能主要是对员工对育苗池的操作进行记录,显示扫描员工RFID、池塘RFID。还要扫描海产品的批次二维码,当员工对池塘进行操作时，需要记录操作类型,并且记录池塘的温度。经这些信息记录到本地数据库。
3.2.4.3 输入数据
变量名
属性
说明
rfidgetUser
string
员工的RFID （必填) 如:E2005032530B0187144085E3
rfidgetPool
string
池塘的RFID号(必填） 如:E2005032530B017318305B53
Batch
String
批次二维码(必填） http://suyuan。
=18FC90BE5B8124AF983421D29BFC4352
getEvenType
String
操作类型(必填) ，包括：喂食、换水、测温、入池、投放
temp
String
温度（非必填)如：10℃
time
String
时间(必填)如：201603110922
在检测数据有效性时，需要检测rfidgetUser与rfidgetPool两个输入变量是否为空。
这些数据的获取离不开具有RFID扫描功能及二维码扫描的手持设备，对池塘的RFID卡进行扫描并获取RFID号并且对池塘上的产品批次二维码进行扫描，获取产品批次二维码.
3.2.4.4 输出数据
变量名
属性
说明
rfidgetUser
string
员工的RFID
rfidgetPool
string
池塘的RFID号
Data
String
批次二维码，如:

getEvenType
String
操作类型
temp
String
温度:10
flag
int
数据存储标志位
3.2.4.5 业务算法和流程

3.2.4.6 数据设计
给出本程序中的局部数据结构说明，包括数据结构名称，功能说明，具体数据结构说明（定义、注释设计、取值）等。相关数据库表,数据存储设计（具体说明需要以文件方式保存的数据文件名、数据存储格式、数据项及属性等.)
3.2.4.7 源程序文件说明
package com.blueocean。BlueOceanSource.ui;
import android.app.Activity；
import android.content。BroadcastReceiver；
import android.content.Context;
import android.content。Intent；
import android。content.IntentFilter；
import android。os.Bundle;
import android。os.Handler;
import android.text.TextUtils；
import android。util。Log；
import android.view。View;
import android.view。inputmethod.EditorInfo;
import android.widget.AdapterView;
import android.widget.ArrayAdapter；
import android.widget。Button;
import android.widget。EditText;
import android.widget。Spinner；
import android.widget.TextView;
import android。widget。Toast；

import com.blueocean。BlueOceanSource.R;
import com。blueocean。BlueOceanSource。entity.BlueOceanEvent;
import com。blueocean.BlueOceanSource.service.BlueOceanEventService；
import com。blueocean.BlueOceanSource。service.UploadService;
import com。blueocean.BlueOceanSource。utility。DateDefined；
import com。blueocean。BlueOceanSource.utility。RfidScan;

import java。util。ArrayList;
import java.util.List；

import cn。pda。hf.Util;
import cn。pda.scan。ScanThread；

/＊＊保苗阶段activity
* Created by zhouxingguo on 2015/7/15。
*/
public class YouthActivity extends Activity {
private Button scanUser；//扫描员工rfid
private Button scanPond;//扫描池塘RFID
private Button saveButton；//保