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

《软件项目详细设计文档模板》由会员分享，可在线阅读，更多相关《软件项目详细设计文档模板（41页珍藏版）》请在装配图网上搜索。

1、XXX系统详细设计说明书（部资料请勿外传）编写:日期:检查:日期:日期:日期:XX公司所有不得复制文档变更记录序号变更+/-说明作者版本号日期批准12目录1. 引言51.1编写目的和围51.2术语表51.3参考资料51.4使用的文字处理和绘图工具5全局数据构造说明62.1常量62.2变量62.3数据构造6模块设计63.1用例图61.2 功能设计说明7模块1错误!未定义书签1.2.1 模块2错误!未定义书签接口设计614.1 部接口614.2 外部接口61接口说明614.2.1 调用方式61数据库设计612. 系统平安设计616.1 说明616.2 设计61数据传输局部61622IP过滤分部62

2、6.2.3身份验证局部623. 系统性能设计62系统出错处理621. 引言1.1编写目的和围说明写这份详细设计说明书的目的。本详细设计说明书编写的目的是说明程序模块的设计考虑，包括程序描述、输入/输出、算法和流程逻辑等，为软件编程和系统维护提供根底。本说明书的预期读者为系统设计人员、软件开发人员、软件测试人员和工程评审人员。1.2术语表定义系统或产品中涉及的重要术语，为读者在阅读文档时提供必要的参考信息序号术语或缩略语说明性定义1PMProjectManage工程经理21.3参考资料列出有关资料的名称、作者、文件编号或版本等。参考资料包括:a.需求说明书、架构设计说明书等；b本工程的其他已发表

3、的文件；c.引用文件、资料、软件开发标准等。资料名称作者文件编号、版本资料存放地占八、1.4使用的文字处理和绘图工具文字处理软件：wordoffice绘图工具：Visio全局数据构造说明本章说明本程序系统中使用的全局数据常量、变量和数据构造。2.1常量staticStringSERVER_ADDRES效劳器地址booleanloginFlag登录状态2.2变量BlueUserInfo用户账户构造体2.3数据构造包括数据构造名称，功能说明，具体数据构造说明定义、注释、取值等。2. 模块设计3.1用例图登录注销生产部设置数据管理人员管理池塘管理育苗管理加工包装物流管理育苗场加工厂市场部人事部系统用

4、户3.2功能设计说明3.2.1登录模块模块1主要分为以下几个子模块：子模块1、子模块2和子模块N3.2.1.1设计图3.2.1.2功能描述此模块的主要功能是登录验证功能，保证程序的平安性问题。用户需要验证用户和密码是否正确才能进展下一部操作。321.3输入数据变量名类型说明userNameString用户名（必填）passwordString密码（必填）STOPSPLASHint开场动画标志位SPLASHTIMElong消息发送延迟时间LOGINBUTTONint登录按钮是否能够点击标志位321.4输出数据字段说明code结果，0表示失败，1表示成功，2表示该养殖场地不存在，3表示该Rfid已

5、存在userName用户名PassWord密码userRoleld用户权限，1代表系统用户，2代表人事部，3代表育苗场，4代表生产部，5代表加工厂，6代表市场部，7代表捕捞管理员表现形式为:code=1321.5流程图登入系统3.2.1.6源程序文件说明321.7函数说明对密码进展MD5加密：md5（密码）将用户的账号密码暂时保存等下次登录时可以不用再次输入:saveUserlnfo（Activity名，用户名，密码）3.2.1.8限制条件必须在有网的条件下能使用登录功能3.2.2人员管理3.2.2.1设计图人员管理员工工号请输人员工工号3.2.2.2功能描述通过手持设备扫描员工的RFID号，

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

7、tring员工的员工号rfidstring员工的RFID号flagint数据存储状态的标志位322.5业务算法和流程322.6数据设计给出本程序中的局部数据构造说明，包括数据构造名称，功能说明，具体数据构造说明定义、注释设计、取值等。相关数据库表，数据存储设计具体说明需要以文件方式保存的数据文件名、数据存储格式、数据项及属性等。3.2.2.7源程序文件说明package.blueocean.BlueOceanSource.ui;importandroid.app.Activity;importandroid.content.Context;importandroid.os.Bundle;imp

8、ortandroid.text.TextUtils;importandroid.util.Log;importandroid.view.View;importandroid.widget.Button;importandroid.widget.EditText;importandroid.widget.TextView;importandroid.widget.Toast;import.pda.hf.Util;import.blueocean.BlueOceanSource.R;import.blueocean.BlueOceanSource.entity.BlueOceanEmployee;

9、import.blueocean.BlueOceanSource.service.BlueOceanEmployeeService;import.blueocean.BlueOceanSource.service.UploadService;import.blueocean.BlueOceanSource.utility.RfidSca引/入RFID扫描的开发包/*Createdbyzhouxingguoon2015/7/15.*/publicclassEmployeeActivityextendsActivityprivateButtonsaveMessagg/保存员工信息privateEd

10、itTextinputNumber;/员工编号、卡号privateTextViewinputRfid;/员工RFID信息privateStringnumber;/获取得到的卡号、编号privateStringrfid;/获取得到的RFIDprivateRfidScanrfidScan;privateStringrfidget;OverridepublicvoidonCreate(BundlesavedInstanceState)superonCreate(savedInstanceState);setContentView(R.layouactivity_employee；Util.initS

11、oundPoo(this);init();/获取RFID号和员工工号并保存到本地数据库/初始化控件inputNumber=(EditText)findViewByld(R.idhput_employee_numbej;inputRfid=(TextView)findViewByld(R.idnput_employee_rfiQ;saveMessage=(Button)findViewByld(R.idsave_message_employeescan=(Button)findViewByld(R.idscan_rfid);MyListenerlistener=newMyListener(thi

12、s);saveMessagesetOnClickListener(listener);scan.setOnClickListener(listener);datareceive=getIntent().getExtras();/dataflag=datareceive.getInt(dataflag);/0代表从主界面跳转，1代表从扫描接口跳转/if(dataflag=0)/inputRfid.setText(情扫描员工卡号);/elseif(dataflag=1)/rfidget=datareceive.getString(rfid);/代表从员工录入跳转，1代表从快递跳转/inputRfi

13、d.setText(rfidget);/privateContextcontextpublicMyListener(Contextcontext)this.context=context;OverridepublicvoidonClick(Viewview)switch(view.getld()caseR.id.scan_rfid:rfidScan=newRfidScan();rfidget=rfidScan.scan();if(rfidget!=null)inputRfid.setText(fidget);elseToastmakeTextgetApplicationContext(),R.

14、stringscan_rfid_fail,ToastLENGTH_SHOR)TShow();break;caseR.id.save_message_employe保存员工信息按钮到数据库，保存成功之后清空editText/要保证输入的信息不能全部为空if(!TextUtils.isEmpty(inputNumbergetText()&!TextUtils.isEmpty(inputRfid.getText()number=inputNumber.getText().toString().trim();rfid=inputRfid.getText().toString().trim();Blue

15、OceanEmployeeServiceemployeeServiceewBlueOceanEmployeeServicentexl);BlueOceanEmployeeboenewBlueOceanEmployee();intflag=0;/0表示保存到本地数据库，1表示本地数据库数据待删除boe.setFlag(flag);boe.setNumbernumber);boe.setRfidfid);employeeService.insert(boe);inputNumbersetText);inputRfid.setText);ToastmakeTextgetApplicationCont

16、ext(),R.string.bind_successToastLENGTH_LONpshow();/开辟一个新线程上传数据newThread0etworkTas0start();ToastmakeTextgetApplicationContext(),R.string.save_success_toastToastLENGTH_LONGshow();elseToastmakeTextgetApplicationContext(),R.string.employee_rfid_number_not_nuljToastLENGTH_LONGshow();break;Runnablenetwork

17、Task=newRunnable()Overridepublicvoidrun()/TODO/在这里进展request网络请求相关操作UploadServiceuploadServicenewUploadService();uploadService.upload(getApplicationContext();322.8函数说明大扫描RFID就成功时发出提示音:Util.initSoundPool(activity名称)；程序的主体:init();开启数据上传线程:networkTask3.2.2.9限制条件要实现此功能必须要具备可以扫描RFID功能的手持设备，不然无法扫描员工的RFID号3

18、.2.3池塘管理3.2.3.1设计图3.2.3.2功能描述此模块主要实现的功能是扫描池塘的RFID,并手动输入池塘编号，并将其保存到本地数据库。并等到有网的条件下，将此条信息上传到效劳器端的数据库。实现池塘RFID号与池塘编号的绑定323.3输入数据变量名属性说明numberstring池塘编号（必填）如:育苗池1rfidstring池塘的RFID号（必填）：E2005032530B0187144085E3在检测数据有效性时，需要检测数据是否为空。这些数据的获取离不开具有RFID扫描功能的手持设备，对池塘的RFID卡进展扫描获取RFID号。才实现此功能323.4输出数据变量名属性说明numbe

19、rstring池塘编号rfidstring池塘的RFID号flagInt数据存储标志位323.5业务算法和流程323.6数据设计给出本程序中的局部数据构造说明，包括数据构造名称，功能说明，具体数据构造说明定义、注释设计、取值等。相关数据库表，数据存储设计具体说明需要以文件方式保存的数据文件名、数据存储格式、数据项及属性等。323.7源程序文件说明package.blueocean.BlueOceanSource.ui;importandroid.app.Activity;importandroid.content.Context;importandroid.os.Bundle;importan

20、droid.text.TextUtils;importandroid.util.Log;importandroid.view.View;importandroid.widget.Button;importandroid.widget.EditText;importandroid.widget.TextView;importandroid.widget.Toast;import.pda.hf.Util;import.blueocean.BlueOceanSource.R;import.blueocean.BlueOceanSource.entity.BlueOceanPond;import.bl

21、ueocean.BlueOceanSource.service.BlueOceanPondService;import.blueocean.BlueOceanSource.service.UploadService;import.blueocean.BlueOceanSource.utility.RfidScan;/*Createdbyzhouxingguoon2015/7/15.*/publicclassPondActivityextendsActivityprivateButtonscanPond/点击扫描池塘privateButtonbindPond;/绑定池塘编号和RFID信息priv

22、ateEditTextpondNumber/池塘编号、卡号privateTextViewpondRfid;/池塘RFID信息privateStringnumber;/获取得到的卡号、编号privateStringrfid;/获取得到的RFIDprivateRfidScanrfidScan;privateStringrfidget;superonCreate(savedInstanceState);setContentView(R.layouactivity_pond);Util.initSoundPoo(this);init();/初始化控件privatevoidinit()pondNumbe

23、r=(EditText)findViewByld(R.idnput_pond_numbe);pondRfid=(TextView)findViewByld(R.idnput_pond_rfid);seanPond=(Button)findViewByld(R.idscan_pond_rfid);bindPond=(Button)findViewById(R.idbind_pond);MyListenerlistener=newMyListener(this);seanPondsetOnClickListener(listener);bindPondsetOnClickListener(list

24、ener);privateContexteontextpublicMyListener(Contexteontext)this.context=context;OverridepublicvoidonClick(Viewview)Log.d(aa进入点击);switch(view.getld()caseR.id.scan_pond_rfid:rfidScan=newRfidScan();rfidget=rfidScan.scan();if(rfidget!=null)ToastmakeTextgetApplicationContext(),R.stringscan_rfid_fail,&!Te

25、xtUtils.isEmpty(pondRfid.getText()number=pondNumbergetText().toString().trim();rfid=pondRfid.getText().toString().trim();BlueOceanPondServicepondServicenewBlueOceanPondService。ntexp;BlueOceanPondboe=ewBlueOceanPond();intflag=0;/0表示保存到本地数据库，1表示本地数据库数据待删除boe.setFlag(flag);boe.setNumben(iumber);boe.set

26、Rfidfid);pondService.insert(boe);pondNumbersetText);pondRfid.setText);ToastmakeTextgetApplicationContext(),R.string.bind_successToastLENGTH_LONpshow();/开辟一个新线程上传数据newThreadnetworkTask).start();R.string.pond_fid_number_not_nul,ToastLENGTH_LON)3show();RunnablenetworkTask=newRunnable()/在这里进展request.网络请

27、求相关操作UploadServiceuploadService=ewUploadService();uploadService.upload(PondActivitthis);323.8函数说明当扫描RFID就成功时发出提示音:Util.initSoundPool(activity名称);程序的主体:init();开启数据上传线程:networkTask323.9限制条件要实现此功能必须要具备可以扫描RFID功能的手持设备，不然无法扫描员工的RFID号。3.2.4育苗管理3.2.4.1设计图3.2.4.2功能描述本功能主要是对员工对育苗池的操作进展记录，显示扫描员工RFID池塘RFID。还要扫

28、描海产品的批次二维码，当员工对池塘进展操作时，需要记录操作类型，并且记录池塘的温度。经这些信息记录到本地数据库324.3输入数据在检测数据有效性时，需要检测rfidgetUser与rfidgetPool两个输入变量是否为空。变量名属性说明rfidgetUserstring员工的RFID（必填）女口：E2005032530B0187144085E3rfidgetPoolstring池塘的RFID号（必填）如：E2005032530B017318305B53BatchString批次二维码（必填）suyuan.chinablueocean./show.html?id=18FC90BE5B8124A

29、F983421D29BFC43getEvenTypeString操作类型（必填），包括：喂食、换水、测温、入池、投放tempString温度（非必填）如：10CtimeString时间（必填）如：201603110922这些数据的获取离不开具有RFID扫描功能及二维码扫描的手持设备，对池塘的RFID卡进展扫描并获取RFID号并且对池塘上的产品批次二维码进展扫描，获取产品批次二维码。324.4输出数据变量名属性说明rfidgetUserstring员工的RFIDrfidgetPoolstring池塘的RFID号DataString批次二维码，如：getEvenTypeString操作类型temp

30、String温度：10flagint数据存储标志位324.5业务算法和流程324.6数据设计给出本程序中的局部数据构造说明，包括数据构造名称，功能说明，具体数据构造说明定义、注释设计、取值等。相关数据库表，数据存储设计具体说明需要以文件方式保存的数据文件名、数据存储格式、数据项及属性等。3.247源程序文件说明package.blueocean.BlueOceanSource.ui;importandroid.app.Activity;importandroid.content.BroadcastReceiver;importandroid.content.Context;importandr

31、oid.content.Intent;importandroid.content.IntentFilter;importandroid.os.Bundleimportandroid.os.Handler;importandroid.text.TextUtils;importandroid.util.Log;importandroid.view.View;importandroid.view.inputmethod.Editorlnfo;importandroid.widget.AdapterView;importandroid.widget.ArrayAdapter;importandroid

32、.widget.Button;importandroid.widget.EditText;importandroid.widget.Spinner;importandroid.widget.TextView;importandroid.widget.Toast;import.blueocean.BlueOceanSource.R;import.blueocean.BlueOceanSource.entity.BlueOceanEvent;import.blueocean.BlueOceanSource.service.BlueOceanEventService;import.blueocean

33、.BlueOceanSource.service.UploadService;import.blueocean.BlueOceanSource.utility.DateDefined;import.blueocean.BlueOceanSource.utility.RfidScan;importjava.util.ArrayList;importjava.util.List;import.pda.hf.Util;*/publicclassYouthActivityextendsActivityprivateButtonscanUser/扫描员工rfidprivateButtonscanPond

34、扫描池塘RFIDprivateButtonsaveButton保存信息privateTextViewuserRfid;/员工RFID信息privateEditTextpooIRfid;/池子RFID信息privateTextViewpondQrcode/池塘二维码包含的批次信息privateEditTexttemperature/输入池塘温度privateStringrfidUser;/获取得到的RFIDprivateRfidScanrfidScanUserrfid扫描user类privateStringrfidgetUser;/获取得到的userRfidprivateStringrfidPo

35、ol;/获取得到的池子RFIDprivateRfidScanrfidScanPoolrfid扫描池子类privateStringrfidgetPool;/获取得到的poolRfidprivateStringbatch;/获取池子标签上的批次二维码信息privateSpinnerspinner;/操作类型下拉控件privateListeventList操作类型数据源privateArrayAdaptervStringadapter;/适配器适配操作类型列表privateStringgetEventTypeprivateStringdata;privateBroadcastReceiverecei

36、veprivateScanThreadscanThreadprivateHandlermHandler=newHandler()publicvoidhandleMessage(android.os.Messagemsg)if(msg.what=ScanThreacSCAb)data=msg.getData().getString(data;Log.d(acc_data；data);Util.play(1,0);pondQrcodesetText0ata);OverridepublicvoidonCreate(BundlesavedInstanceState)superonCreate(save

37、dInstanceState);setContentView(R.layouOictivity_youth);Util.initSoundPoo(this);init_spinner();init();seanThread=newScanThreadtiHandler);catch(Exceptione)ToastmakeTexfgetApplicationContext()serialportinitfail：0).show();return;scanThreadstart();receive=newFunkeyListener();代码注册播送接收者IntentFilterfilter=n

38、ewIntentFilter();filter.addAction：android.intent.action.FUN_KEYregisterReceiver(3ceivefilter);Util.initSoundPoo(getApplication();OverridepublicvoidonReceive(Contextcontext,Intentintent)booleandefaultdown=alse;intkeycode=intent.getIntExtrakeycode0);booleankeydown=intent.getBooleanExtrk(eydowndefaultd

39、own);if(keycode=134&keydown)scanThreadscan();privatevoidinit()userRfid=(TextView)findViewByld(R.idnput_baomiao_use);poolRfid=(EditText)findViewByld(R.idnput_baomiao_ponQ;pondQrcode=(TextView)findViewByld(R.idnput_baomiao_pond_qrcode；temperature=(EditText)findViewByld(R.idnput_temperatur9；temperature

40、setlnputType(EditorlnfoTYPE_CLASS_PHONEseanUser=(Button)findViewByld(R.icbaomiao_scan_employescanPond=(Button)findViewById(R.idbaomiao_scan_pond；seanQrcode=(Button)findViewById(R.idbaomiao_pond_qrcode；扫描池塘二维码批次信息saveButton=(Button)findViewByld(R.idsave_button1);MyListenerlistener=newMyListener(this)

41、;scanUsersetOnClickListener(listener);scanPondsetOnClickListener(listener);scanQrcodesetOnClickListener(listener);spinner=(Spinner)findViewByld(R.icbction_spinnei);定义数据源eventLis=newArrayList();eventListadd(喂食);eventListaddf换水);eventListaddf测温);eventListaddf入池);eventListadd(投放);adapte=newArrayAdapter

42、vString沈his,R.layoutsimple_spinner_item,eventLisp;adapte.setDropDownViewResource(R.layoispinner_checked_tex);spinnersetAdapterpdaptei);/spinner监听器获取选择容spinnersetOnltemSelectedListenen6wAdapterView.OnItemSelectedListener()OverridepublicvoidonltemSelected(AdapterViewadapterView,Viewviewt,position,Iong

43、l)privateclassMyListenerimplementsView.OnClickListenerprivateContextcontextpublicMyListener(Contextcontext)this.context=context;switch(view.getld()caseR.id.baomiao_scan_employeerfidScanUse=newRfidScan();rfidgetUser=rfidScanUserscan();if(rfidgetUser=null)userRfidsetText(fidgetUser);elseToastmakeTex(g

44、etApplicationContext(),R.string.scan_fid_fail,ToastLENGTH_SHORThow();fidgetPoo=fidScanPoolscan();if(rfidgetPoo!=null)pooIRfidsetText(fidgetPool);elseToastmakeTextgetApplicationContext(),break;if(!TextUtils.isEmpty(poolRfid.getText()&!TextUtils.isEmpty(userRfid.getText()&!TextUtilsisEmpty(getEventTyp

45、e&(!TextUtils.isEmpty(datai|getEventTypeequals(投放)BlueOceanEventServiceeventServiceiewBlueOceanEventServiccOntexl);BlueOceanEventboe=ewBlueOceanEvent();Stringtime=DateDefineetDate);获取自定义时间格式rfidUser=userRfid.getText().toString().trim();rfidPool=poolRfid.getText().toString().trim();intflag=0;/0表示保存到本

46、地数据库，1表示本地数据库数据待删除inttype=2;if(getEventTypeequals喂食)type=1;elseif(getEventTypeequals换水)type=2;elseif(getEventTypeequals(测温)type=3;elseif(getEventTypeequals投放)type=4;elseif(getEventTypeequals入池)type=6;Stringbatch=data;扫描二维码信息Stringtemp=temperaturegetText().toString().trim();boe.setFlag(flag);boe.setU

47、serRfid(fidUser);boe.setPoolRfid(fidPool);boe.setTime(time);boe.setEventType(type);if(type=4)boe.setBatch(O);eventService.insert(boe);userRfidsetText);pooIRfidsetText);pondQrcodesetText);temperaturesetText);/开辟一个新线程上传数据newThread(ietworkTask).startO;ToastmakeTextgetApplicationContext(),R.string.save_

48、success_toastToastLENGTH_LON)3show();elseToastmakeTex(getAppIicationContext(),R.string.not_null_except_temperatureToastLENGTH_LONGshow();RunnablenetworkTask=newRunnable()Overridepublicvoidrun()/TODO/在这里进展request网络请求相关操作UploadServiceuploadService=ewUploadService();uploadService.upload(YouthActivityhi

49、s);OverrideprotectedvoidonDestroy()if(scanThread!=nuII)scanThreadinterrupt();scanThread.close();unregisterReceiver(eceive；superonDestroy();324.8函数说明当扫描RFID就成功时发出提示音:Util.initSoundPool(activity名称);程序的主体:init();开启数据上传线程:networkTask324.9限制条件限制条件是，必须使用具有RFID和二维码扫描功能的手持设备才能完成此功能。3.2.5加工包装3.2.5.1设计图3.2.5.

50、2功能描述此模块的主要功能是扫描员工的RFID号，并显示到屏幕上去。工作人员选择产品类型，扫描产品二维码，一次可以扫描多个产品，并将数据保存到本地数据库325.3输入数据在检测数据有效性时，需要检测rfidgetUser与rfidgetPool两个输入变量是否变量名属性说明rfidgetstring员工的RFID（必填）女口：E2005032530B0187144085E3QRCodeString产品二维码（必填）suyuan.chinablueocean./show.html?id=18FC90BE5B8124AF983421D29BFC4352getProductTypeString产品类

51、型（必填），包括：冻海参、淡海参、盐海参、鲜活海参、盐渍海参、及时海参TimeString操作时间。如201602111311为空。这些数据的获取离不开具有RFID扫描功能及二维码扫描的手持设备，对池塘的RFID卡进展扫描并获取RFID号并且对池塘上的产品批次二维码进展扫描，获取产品批次二维码。325.4输出数据变量名属性说明rfidgetstring员工的RFID如:E2005032530B0187144085E3QRCodeString产品二维码suyuan.chinablueocean/show.html?id=18FC90BE5B8124AF983421D29BFC43getProductTypeString产品类型，包括：冻海参、淡海参、盐海参、鲜活海参、盐渍海参、及时海参TimeString操作时间。如201602111311flagInt数据存储状态标志位。如：1325.5业务算法和流程登录输入员工RFID号、产品二维码产品类型、时间325.6数据设计给出本程序中的局部数据构造说明，包括数据构造名称，功能说明，具体数据构造说明定义、注释设计、取值等。相关数据库表，数据存储设计具体说明需要以文件方式保存的数据文件名、数据存储格式、数据项及属性等。325.7源程序文件说明给出本程序的各源程序文件的说明，包括源程序文件名称及其所在目录，功能说明，包