软件项目详细设计模板

1、XXX系统详细设计说明书编检审批（内部资料请勿外传）期:期:期:期:版权所有不得复制文档变更记录序号变更（+/-）说明作者版本号日期批准121. 引言1.1编写目的和范围说明写这份详细设计说明书的目的。本详细设计说明书编写的目的是说明程序模块的设计考虑，包括程序描述、 输入/输出、算法和流程逻辑等，为软件编程和系统维护提供基础。本说明书的 预期读者为系统设计人员、软件开发人员、软件测试人员和项目评审人员。1.2术语表定义系统或产品中涉及的重要术语， 为读者在阅读文档时提供必要的参考信丿 111、0序号术语或缩略语说明性定义|1PMProject Ma nager,项目经理21.3参考资料列出有

2、关资料的名称、作者、文件编号或版本等。参考资料包括:a. 需求说明书、架构设计说明书等；b. 本项目的其他已发表的文件；c. 引用文件、资料、软件开发标准等。资料名称作者文件编号、版本资料存放地占八、1.4使用的文字处理和绘图工具文字处理软件：word office绘图工具：Visio2. 全局数据结构说明本章说明本程序系统中使用的全局数据常量、变量和数据结构2.1常量static String SERVER_ADDRESS 服务器地址boolea n log inF lag登录状态2.2变量BlueUserl nfo用户账户结构体2.3数据结构包括数据结构名称，功能说明，具体数据结构说明（定

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输入数据3.2.1.4输出数据字段明字段说明变量名类型说明userNameStri ng用户名（必填）passwordStri ng密码（必填）STOPSPLASHint开场动画标志位SPLASHTIMElong消息发送延迟时间LOGINBUTTONint登录按钮是否能够点击 标志位code结

4、果，0表示失败，1表示成功，2表示该养殖场地 不存在，3表示该Rfid已存在userName用户名PassWord密码userRoleld用户权限，1代表系统用户，2代表人事部，3代表 育苗场，4代表生产部，5代表加工厂，6代表市场 部，7代表捕捞管理员表现形式为:code=1321.5流程图321.6源程序文件说明321.7函数说明对密码进行 MD5加密：md5（密码）将用户的账号密码暂时保存等下次登录时可以不用再次输入：saveUserlnfo（Activity 名，用户名，密码）3.2.1.8限制条件必须在有网的条件下能使用登录功能。3.2.2人员管理3.2.2.1设计图3.2.2.2功

5、能描述通过手持设备扫描员工的RFID号，并在员工工号的输入框手动输入员工工 号，并将两条数据上传到服务器中的数据库。将员工工号与RFID号相互绑定3.2.2.3输入数据变量名属性说明nu mberstri ng员工的员工号（必填）rfidstri ng员工的RFID号（必填）如：E200在检测数据的有效性是像是判断数据是否为空， 当向服务器发送消息时服务 器会对数据进行有效性检测，显示判断员工的员工号是否存在，员工的RFID号是否已被其他工作人员应将绑定。这些数据的获取离不开具有 RFID扫描功能的手持设备，对员工的 RFID卡 进行扫描获取RFID号。才实现此功能322.4输出数据变量名属性

6、说明nu mberstri ng员工的员工号rfidstri ng员工的RFID号flagint数据存储状态的标志位322.5业务算法和流程3.2.2.6数据设计给出本程序中的局部数据结构说明，包括数据结构名称，功能说明，具体数 据结构说明(定义、注释设计、取值)等。相关数据库表，数据存储设计(具体 说明需要以文件方式保存的数据文件名、数据存储格式、数据项及属性等。)3.2.2.7源程序文件说明packageimportimportimport animportimportimportimportimportimportimportimportimportimportimportimporti

7、mport */public class EmployeeActivity extends Activity private Butt on sca n;private Butt on saveMessage etExtras();how();break;case保存员工信息按钮到数据库,保存成功之后清空editTextoStri ng().trim(); rfid = ().toStri ng().trim();employeeServicenew=newBlueOcea nEmployeeServiceBlueOcea nEmployeeService( con text );BlueOc

8、ea nEmployee boe =BlueOcea nEmployee();int flag =0;how();tart();(getApplicatio nCon text(), .show();else (getApplicatio nCon text(), .show(); break;Runn ablen etworkTask = new Runn able() Override public void run() 络请求相关操作UploadService uploadService = new UploadService();(getApplicati onCon text();3

9、22.8函数说明大扫描RFID就成功时发出提示音:(activity 名称); 程序的主体:init();开启数据上传线程:networkTask322.9限制条件要实现此功能必须要具备可以扫描 RFID功能的手持设备，不然无法扫描员 工的RFID号。3.2.3池塘管理3.2.3.1设计图3.2.3.2功能描述此模块主要实现的功能是扫描池塘的 RFID，并手动输入池塘编号，并将其 保存到本地数据库。并等到有网的条件下，将此条信息上传到服务器端的数据库。 实现池塘RFID号与池塘编号的绑定。3.2.3.3输入数据变量名属性说明nu mberstri ng池塘编号（必填）如：育苗池1rfidstr

10、i ng池塘的RFID号（必填）：在检测数据有效性时，需要检测数据是否为空。这些数据的获取离不开具有RFID扫描功能的手持设备，对池塘的RFID卡进行扫描获取RFID号。才实现此功能3.2.3.4输出数据变量名属性说明nu mberstri ng池塘编号rfidstri ng池塘的RFID号flagInt数据存储标志位3.2.3.5业务算法和流程3.2.3.6数据设计给出本程序中的局部数据结构说明，包括数据结构名称，功能说明，具体数 据结构说明（定义、注释设计、取值）等。相关数据库表，数据存储设计（具体 说明需要以文件方式保存的数据文件名、数据存储格式、数据项及属性等。）3.2.3.7源程序文

11、件说明packageimport import import import import import import import import import import import import import import import* Created by zhouxingguo on 2015/7/15.*/public class PondActivity extends Activity private Butt on sca nPon d;how();break;case保存员工信息按钮到数据库,保存成功之后清空 editTextoStri ng().trim(); rfid

12、 = ().toStri ng().trim();BlueOcea nPon dService pon dService =newBlueOcea nPon dService( con text );BlueOcea nPond boe =new BlueOcea nPon d();int flag =0;how();tart();else (getApplicatio nCon text(), .show();break;Runn ablen etworkTask = new Runn able() Overridepublic void run() 络请求相关操作UploadService

13、 uploadService = newUploadService();J;323.8函数说明当扫描RFID就成功时发出提示音:(activity 名称);程序的主体:init();开启数据上传线程:networkTask323.9限制条件要实现此功能必须要具备可以扫描 RFID功能的手持设备，不然无法扫描员 工的RFID号。3.2.4育苗管理3.2.4.1设计图3.2.4.2功能描述本功能主要是对员工对育苗池的操作进行记录，显示扫描员工RFID、池塘RFID。还要扫描海产品的批次二维码，当员工对池塘进行操作时，需要记录操 作类型，并且记录池塘的温度。经这些信息记录到本地数据库。3.2.4.3

14、输入数据变量名属性说明rfidgetUserstri ng员工的RFID （必填）女口：rfidgetPoolstri ng池塘的RFID号（必填）女口：BatchStri ng批次二维码（必填）=18FC90BE5B8124AF983421D29BFC4352getEve nTypeStri ng操作类型（必填），包括：喂食、换水、测 温、入池、投放tempStri ng温度（非必填）如：10CtimeStri ng在检测数据有效性时，需要检测rfidgetUser与rfidgetPool两个输入变量是否 为空。这些数据的获取离不开具有RFID扫描功能及二维码扫描的手持设备，对池 塘的RFI

15、D卡进行扫描并获取RFID号并且对池塘上的产品批次二维码进行扫描， 获取产品批次二维码。324.4输出数据变量名属性说明rfidgetUserstri ng员工的RFIDrfidgetPoolstri ng池塘的RFID号DataStri ng批次二维码，如：getEve nTypeStri ng操作类型tempStri ng温度：10flagint数据存储标志位324.5业务算法和流程3.246数据设计给出本程序中的局部数据结构说明，包括数据结构名称，功能说明，具体数 据结构说明（定义、注释设计、取值）等。相关数据库表，数据存储设计（具体 说明需要以文件方式保存的数据文件名、数据存储格式、数

16、据项及属性等。）3.2.4.7源程序文件说明packageimportimportimportimport importimport andro importimport import import import import import import import import import importimport import import import import importimport import import import/*保苗阶段activityYouthActivityextends Activity Butt on sca nUser;etStri ng(data)

17、;acc_data , data);1, 0)；data);* Created by zhouxingguo on 2015/7/15. */public class private(；Override public voidon Create(B un dle saved In sta nceState) setC onten tView( this );init_spinn er();in it();/* 开启二维码扫描线程* */try sca nThread = new Scan Thread(mHa ndler); catch (Exception e) (getApplicatio

18、 nCon text(),serialport init fail,0).show();return ;();receive = new Fun keyListe ner();how();break;caserfidSca nPool =new RfidSca n();rfidgetPool =();if (rfidgetPool != null )(rfidgetPool );else (getApplicatio nCon text(), .show();break;case();break;case保存员工信息按钮到数据库，保存成功之后清空editTextoStri ng().trim(

19、);rfidPool =().toStri ng().trim(); int flag =0;oStri ng().trim();(flag);(rfidUser );(rfidPool );(time);(type);if (type= 4)(0);else (batch);(temp);(boe);();();();();tart();(getApplicatio nCon text(), .show();else (getApplicatio nCon text(), .show(); break;Runn ablen etworkTask = new Runn able() Overr

20、ide public void run() new UploadService。;络请求相关操作UploadService uploadService =J;Overrideprotected void on Destroy() if (scanThread != null ) ();seanThread .close();unregisterReceiver(receive );()；324.8函数说明当扫描RFID就成功时发出提示音:(activity 名称); 程序的主体:init();开启数据上传线程：networkTask3.249限制条件限制条件是，必须使用具有RFID和二维码扫描

21、功能的手持设备才能完成此 功能。3.2.5加工包装3.2.5.1设计图3.2.5.2功能描述此模块的主要功能是扫描员工的 RFID号，并显示到屏幕上去。工作人员选 择产品类型，扫描产品二维码，一次可以扫描多个产品，并将数据保存到本地数 据库。3.2.5.3输入数据变量名属性说明rfidgetstri ng员工的RFID (必填)女口：QRCodeStri ng产品二维码(必填)=18FC90BE5B8124AF983421D29BFC4352getProductTypeStri ng产品类型(必填)，包括：冻海参、淡海参、 盐海参、鲜活海参、盐渍海参 、及时海参TimeStri ng操作时间。

22、女口在检测数据有效性时，需要检测rfidgetUser与rfidgetPool两个输入变量是否 为空。这些数据的获取离不开具有RFID扫描功能及二维码扫描的手持设备，对池 塘的RFID卡进行扫描并获取RFID号并且对池塘上的产品批次二维码进行扫描， 获取产品批次二维码。325.4输出数据变量名属性说明rfidgetstri ng员工的RFID 女口：QRCodeStri ng产品二维码=18FC90BE5B8124AF983421D29BFC4352getProductTypeStri ng产品类型，包括：冻海参、淡海参、盐海参、 鲜活海参、盐渍海参、及时海参TimeStri ng操作时间。女

23、口flagInt数据存储状态标志位。如：1325.5业务算法和流程325.6数据设计给出本程序中的局部数据结构说明，包括数据结构名称，功能说明，具体数 据结构说明（定义、注释设计、取值）等。相关数据库表，数据存储设计（具体 说明需要以文件方式保存的数据文件名、数据存储格式、数据项及属性等。）325.7源程序文件说明给出本程序的各源程序文件的说明，包括源程序文件名称及其所在目录，功 能说明，包含的前导文件及函数名称等。325.8函数说明当扫描RFID就成功时发出提示音:（activity 名称）;程序的主体:init（）;开启数据上传线程：networkTask为下拉菜单添加选项：init_sp

24、inner（） 将扫描多个二维码：sortAndadd（BlueOceanProduct类型的数组,String 类型的 二维码值），返回值为含有不同产品二维码值的ListvBlueOceanProduct类型的数组。325.9限制条件限制条件是，用户具有是由此功能的权限和使用具有RFID和二维码扫描功能的手持设备才能完成此功能。3.2.6物流管理3.2.6.1设计图3.2.6.2功能描述本功能的主要功能是将一批货物的二维码与快递公司、快递单号绑定到一 块，并记录当前操作的员工 RFID。用户扫描产品二维码就可以知道产品的运输 途径。简要描述子模块1的业务功能。3.2.6.3输入数据变量名属性

25、说明rfidStrstri ng员工的RFID （必填）女口：QRCodeStri ng产品二维码（必填）=18FC90BE5B8124AF983421D29BFC4352BarCodeStri ng物流快单号getCompa nyStri ng物流公司（必填），包括：顺丰、EmseTimeStri ng操作时间。女口3.2.6.4输出数据变量名属性说明rfidStrstri ng员工的RFID 。女口：QRCodeStri ng产品二维。如：=18FC90BE5B8124AF983421D29BFC4352BarCodeStri ng物流快单号，如：88getCompa nyStri ng物

26、流公司，包括：顺丰、EMS、申通快递、 圆通快递、中通快递、韵达快递、百世汇通 等。TimeStri ng操作时间。女口FlagInt数据存储标志位，如：1326.5业务算法和流程326.6数据设计给出本程序中的局部数据结构说明，包括数据结构名称，功能说明，具体数 据结构说明（定义、注释设计、取值）等。相关数据库表，数据存储设计（具体 说明需要以文件方式保存的数据文件名、数据存储格式、数据项及属性等。）326.7源程序文件说明给出本程序的各源程序文件的说明，包括源程序文件名称及其所在目录，功 能说明，包含的前导文件及函数名称等。326.8函数说明当扫描RFID就成功时发出提示音:（activi

27、ty 名称）; 程序的主体:init（）;开启数据上传线程：networkTask为下拉菜单添加选项：init_spinner（）3.2.7数据管理模块1主要分为以下几个子模块：子模块 1、子模块2和子模块N。3.2.7.1设计图数据分类选择界面本地数据显示界面3.2.7.2功能描述将本地的数据库保存的信息以可视化的界面显示出来，便于用户查询。3.2.7.3输入数据详细描述用户输入的数据（包括任何输入设备）以及这些数据的有效性检验 规则。详细描述从物理模型中的哪些表获取数据以及获取这些数据的条件。3.2.7.4输出数据详细描述子功能1所产生的数据以及这些数据的表现形式。3.2.7.4.1业务算法和流程从业务角度详细描述根据输入数据产生输出数据的业务算法和流程。3.2.7.5数据设计给出本程序中的局部数据结构说明，包括数据结构名称，功能说明，具体数 据结构说明（定义、注释设计、取值）等。相关数据库表，数据存储设计（具体327.6源程序文件说明给出本程序的各源程序文件的说明，包括源程序文件名称及其所在目录，功 能说明，包含的前导文件及函数名称等。3.2.7.6.1函数说明删除数据deleteData（）重写 onR