详细设计(范例)

1、CJTPDDS001网中网企业名片业务详细设计上海超捷系统集成有限公司，19971/45网中网企业名平业务网中网企业名平业务详细设计详细设计CJTPDDS001网中网企业名片业务详细设计上海超捷系统集成有限公司，19972/45文档信息文档信息作者创建日期版本部门名称修修订订文档文档历历史史记录记录日期日期版本版本说说明明作者作者2004-07-091.0详细设计初稿Geek2004-07-201.1改进版本(见 Wiki:修改文档)GeekCJTPDDS001网中网企业名片业务详细设计上海超捷系统集成有限公司，19973/45目录目录1.介介绍绍. 11.1目的目的.11.2文档文档协协定定

2、.11.3阅读阅读者建者建议议 .11.4参考参考.12.模模块详细设计块详细设计. 12.1Database Service Module.12.1.1类图.12.1.2协作图 .32.1.3时序图 .42.1.4其它图 .42.2Log Service Module .42.3Conference Module.42.3.1模块类图.42.3.2协作图 .132.3.3时序图 .152.3.4其它图 .152.4Fax Module.152.4.1模块类图.152.4.2协作图 .192.4.3时序图 .202.4.4其它图 .212.5SMS Module.222.5.1模块类图.222

3、.5.2协作图 .262.5.3时序图 .262.5.4其它图 .282.6SMS Service Module.282.7Communication Module.282.7.1模块类图.282.7.2协作图 .292.7.3时序图 .292.7.4其它图 .312.8Exception handle module.312.8.1模块类图.31CJTPDDS001网中网企业名片业务详细设计上海超捷系统集成有限公司，19974/452.9Conference Service Module.312.10Fax Service Module.312.11Enterprise Employee Mo

4、dule.322.11.1模块类图.322.11.2协作图.372.11.3时序图.372.11.4其它图.372.12Enterprise Management Module.372.12.1模块类图.372.12.2协作图.402.12.3时序图.402.12.4其它图.402.13Struts Module.413.TEST CASE CLASS DESIGN. 414.系系统软统软件框架（件框架（FRAMEWORK） ）. 414.1Struts Framework.415.系系统软统软件件设计设计模式模式(DESIGN PATTERN) . 416.Q&A . 41CJTPD

5、DS001网中网企业名平业务详细设计上海超捷系统集成有限公司，19971/451.1. 介绍介绍1.11.1 目的目的此文档作为软件开发者代码实现的指导书，提供代码开发者详细的实现方法。1.21.2 文档协定文档协定本文档的书写遵循公司定义的文档规范，并且定义如下协定：ConventionDescriptionDemo粗体标题或者字段B粗斜体重要信息，需要注意BI蓝色字体需要确认Blue斜体使用方法说明I1.31.3 阅读者建议阅读者建议此文档作为代码开发人员，单元测试人员阅读。1.41.4 参考参考2.2. 模块详细设计模块详细设计2.12.1 DatabaseDatabase Servic

6、eService ModuleModule2.1.1 类图类图类图编号：SDS-CLSD-0001类图：CJTPDDS001网中网企业名平业务详细设计上海超捷系统集成有限公司，19972/45Database Module+ setINParameterValue(parameterIndex : int, value : Object) : void+ getOUTParameterValue(parameterIndex : int) : Object+ setOUTParameterType(parameterIndex : int, sqlType : int) : int- conn

7、ection : DatabaseConnection- callableStatement : CallableStatement- PreparedStatement : PreparedStatementOracleConnection+ prepareCall(String sql : int) : int+ callStoreProcedure() : int+ rollback() : int+ commit() : int+ beginTransaction() : int+ query(sql : String) : Resultset+ update(sql : String

8、) : int+ delete(sql : String) : int+ insert(sql : String) : int+ disconnect() : int+ connect() : int- errorInfo : String- type : int- password : String- user : String- URL : StringDatabaseConnection1.*+ release() : void+ instance(number : int, conFactory : ConnectionFactory) : void+ instance() : voi

9、d+ setConnectionFactory(conFactory : ConnectionFactory) : void+ removeConnection(con : DatabaseConnection) : void+ addConnection(con : DatabaseConnection) : void+ getConnection(type : int) : DatabaseConnection- connectionPool : ListConnectionPooljava.sqlResultset+ buildConnection() : DatabaseConnect

10、ionConnectFactory+ buildConnection() : DatabaseConnectionOracleConnectionFactoryDatabaseClient+ releaseConnection(connection : Connection) : void+ getConnection() : OracleConnectionOracleClientCallableStatementPreparedStatementResultsetStatementConnectionDrivermanager SybaseConnection: connec

11、t ()Nameint connect (String ipAddr,int port,String user,String password)throws DatabaseExceptionDescriptionCreate connection to database serverCreate precall statement of connection;if the connection type is STORE_PROCEDURE,create store procedure statement.Please refer to JDK APIIf fail,get the corr

12、esponding error information and set to Exception.Input (s)ipAddr Database Server IPport Database Server PortCJTPDDS001网中网企业名平业务详细设计上海超捷系统集成有限公司，19973/45user Database User Namepassword Dabase User passwordOutput (s)NoneReturn (s)RET_SUCCESS- Connect SuccessfulRET_FAILURE- Connect fail. SybaseC

13、onnection:disconnect ()Nameint disconnect ()throws DatabaseExceptionDescriptionclose connection to database serverclose the statement or all the result set with statementInput (s)NoneOutput (s)NoneReturn (s)RET_SUCCESS- Disconnect SuccessfulRET_FAILURE- Disconnect fail. SybaseConnection:inser

14、t ()Nameint insert (String sql)DescriptionUsing the statement to insert the record with sqlIf fail,get the corresponding error information and set to errorInfo attributeInput (s)Sql The standard sql to executeOutput (s)NoneReturn (s)RET_SUCCESS- Insert SuccessfulRET_FAILURE- Insert fail.2.1.2 协协作作图图

15、 Collaboration 1描述：Sybase Client 类的使用协作图编号：SDS-CORD-001Collaboration Diagram：CJTPDDS001网中网企业名平业务详细设计上海超捷系统集成有限公司，19974/45 : ConnectionPool : SybaseConnectionFactory1: create()2: instance(10,sybaseConnectionFactory)3: setConnectionFactory(conFactory:ConnectionFactory)4: * addConnection(con:Con

16、nection)5: buildConnection()6: create() : Connection : Statement : SybaseConnection : Drivermanager7: getConnection()8: create()9: create() : SybaseClient10: getConnection(type:int)2.1.3 时时序序图图略。2.1.4 其它其它图图2.22.2 LogLog ServiceService ModuleModule说明：1）采用 Log4j作为 Log Service

17、/log4j/docs/download.html2）采用 Log4Cxx作为 C+的 log Service: /directory/All_Packages_in_Directory/log4cpp.html2.32.3 ConferenceConference ModuleModule说明：本文档所有称为 Member 都为 EnterpriseEmployee 的 alias2.3.1 模模块类图块类图类图编号：SDS-CLSD-0002类图：CJTPDDS001网中网企业名平业务详细设计上海超捷系统集成有限公司，19975/45 Conference

18、 Module+ run() : voidAutoEndConferenceTask+ run() : voidAutoStartConferenceTaskTimer1.*+ start() : voidApplication+ run() : voidTimerTask+ queryAttendMembers() : void+ Conference(identity : int) : void+ modify(attendMembers : List) : int+ autoStartConference() : void+ autoEndConference() : void+ que

19、ry(creator : Member, beginDate : Date, endDate : Date, status : int) : List+ query(creator : Member, beginDate : Date, endDate : Date) : List+ query(creator : Member, status : int) : List+ query() : int+ modify(type : int, date : Date) : int+ modify(type : int, date : Date, attendMembers : List) : i

20、nt+ list(owner : Member) : List+ reply(msg : String, type : int, replyer : Member) : int+ cancel() : int+ appoint() : int+ end() : int+ start() : int+ delete() : int+ create(creator : Member, manager : Member, date : Date, attendMembers : List, type : int) : int- attendMemeberNumber : int- topic : S

21、tring- manager : Member- status : int- creator : Member- password : String- identity : int- attendMembers : List- date : Date- type : intConference Attribute DescriptionAttributeDescriptionExampleTypeConference TypeAPPOINT_TYPE: Appoint ConferenceSTART_TYPE: Start conference immediatelyDateIf

22、 the conference type is APPOINT type, it indicates when will the conference start04/06 12:30:00CJTPDDS001网中网企业名平业务详细设计上海超捷系统集成有限公司，19976/45attendMembersThe attend members of the conference. A list of enterprise employees. If the member is out of the enterprise, then the employee identity is -1Identi

23、tyThe identity of the conference. System assigns the identity and the identity is only.PasswordThe password of the conference. System assigns the password for the conference. The password must be random generatedCreatorThe creator of the conference. The creator is the enterprise employeeStatusThe st

24、atus of the conference. System maintains the status. The conference has following status:START_STAT APPOINT_STAT CLOSE_STATE and CANCEL_STATManagerThe manager of the conference. The manager is assigned by creator and is the enterprise employeeattendMemberNumberThe max attend member number Con

25、ference: create ()Nameint create (Member creator, Date date, List attendMembers, int type, Member manager)throws ConferenceExceptionDescriptionSend create conference request to conference serverKeep the conference information to database. Set the conference identity and password to attribute. If the

26、 database record fail, please roll back create conference request(delete conference) and log the messageSend the short message request through SMS service. If SMS Service is not available, record the message to short message exception queue and wait system to send againInput (s)Creator The creator o

27、f the conference. If object of MemberManager The manager of the conferenceDate The time of the conference beginAttend Members The list member need to join conferenceType APPOINT_TYPE(0) or ELSE(1.)Output (s)NoneReturn (s)Exception of conferenceCJTPDDS001网中网企业名平业务详细设计上海超捷系统集成有限公司，19977/45Refer to 2.8

28、 Conference: delete ()Nameint delete () throws ConferenceExceptionDescriptionIf the conference status is APPOINT, just change the status to CANCEL and send short message to SMS serviceIf the conference status is not APPOINT,send delete conference request to conference service and change the s

29、tatus to CLOSEInput (s)NoneOutput (s)NoneReturn (s)Exception Conference: start ()Nameint start ()DescriptionChange the status of the conference to STARTInput (s)NoneOutput (s)NoneReturn (s)RET_SUCCESS(0)RET_FAIL(1) Conference: end ()Nameint end ()DescriptionChange the status to CLOSEIn

30、put (s)NoneOutput (s)NoneReturn (s)RET_SUCCESS(0)RET_FAIL(1) Conference: appoint ()Nameint appoint ()DescriptionChange the status to APPOINTInput (s)NoneCJTPDDS001网中网企业名平业务详细设计上海超捷系统集成有限公司，19978/45Output (s)NoneReturn (s)RET_SUCCESS(0)RET_FAIL(1) Conference: cancel ()Nameint cancel ()D

31、escriptionChange the status to CANCELInput (s)NoneOutput (s)NoneReturn (s)RET_SUCCESS(0)RET_FAIL(1) Conference: reply ()Nameint reply (String msg, int type, Member replyer)DescriptionSend short message request to conference creatorNeed to record the status of reply To every member of conferen

32、ce, need to keep the status of all conference in the databaseInput (s)Msg The attached message send to creatorType ATTEND (0) will attend the meeting REJECT(1) can not attend the meeting NOTSURE(2) not sure Replier Who reply the conferenceOutput (s)NoneReturn (s)RET_SUCCESS(0)RET_FAIL(1) Conf

33、erence: list ()NameStatic List list (Member owner)DescriptionGet all the conference list of owner from databaseInput (s)owner The creator of the conferenceOutput (s)NoneReturn (s)List of conference.CJTPDDS001网中网企业名平业务详细设计上海超捷系统集成有限公司，19979/45If list is empty, then no conference find from database2.3

34、.1.10Conference: modify (0)Nameint modify (int type, Date date, List attendMembers)DescriptionAll the type，date and attend members of the conference changedModify the data and keep the data in the databaseSend short message to SMS server. Must compare the attend members to primary members. If the me

35、mber removed from the conference, send the “DO NOT NEED TO ATTEND MEETING” message, if the member joined to the conference, send the “PLEASE JOIN THE MEETING” message. The other member must be notified that the time is changedIf the type is changed from APPOINT to IMMEDIALTY, must send create reques

36、t to conference serviceInput (s)Type The type of the conferenceDate The time of the conference startAttend Members The attend members of the meetingOutput (s)NoneReturn (s)RET_SUCCESS(0)RET_FAIL(1)1Conference: modify (1)Nameint modify (int type, Date date)DescriptionThe type，date of the confe

37、rence changedModify the data and keep the data in the databaseSend short message to SMS serverIf the type is changed from APPOINT to IMMEDIALTY, must send create request to conference service and modify the time and statusInput (s)Type The type of the conferenceDate The time of the conference startO

38、utput (s)NoneCJTPDDS001网中网企业名平业务详细设计上海超捷系统集成有限公司，199710/45Return (s)RET_SUCCESS(0)RET_FAIL(1)2Conference: modify (2)Nameint modify (List attendMembers)DescriptionThe attend members of the conference changedModify the data and keep the data in the databaseSend short message to SMS server. Must

39、 compare the attend members to primary members. Just send short message to modified members. If the member removed from the conference, send the “DO NOT NEED TO ATTEND MEETING” message, if the member joined to the conference, send the “PLEASE JOIN THE MEETING” message.Input (s)Type The type of the c

40、onferenceDate The time of the conference startOutput (s)NoneReturn (s)RET_SUCCESS(0)RET_FAIL(1)3Conference: query (0)Nameint query ()DescriptionGet all the information of the conference from database and set the information to the object attributeInput (s)NoneOutput (s)NoneReturn (s)RET_SUCCE

41、SS(0)RET_FAIL(1)4Conference: query (1)NameStatic List query (Member creator, int status)DescriptionGet the list of conference that it is created by creator and the indicated status Input (s)Creator The creator of the conferenceStatus The status of the conferenceCJTPDDS001网中网企业名平业务详细设计上海超捷系统集成

42、有限公司，199711/45Output (s)NoneReturn (s)List of conference.If list is empty, then no conference find from database5Conference: query (2)NameStatic List query (Member creator, Date beginDate, Date endDate)DescriptionGet the list of conference that it is created by creator and the date is between

43、 begin date and end date Input (s)Creator The creator of the conferenceBegin date The begin date of the searched conferenceEnd date The end date of the searched conferenceOutput (s)NoneReturn (s)List of conference.If list is empty, then no conference find from database6Conference: query (3)Na

44、meStatic List query (Member creator, Date beginDate, Date endDate, int status)DescriptionGet the list of conference that it is created by creator and the date is between begin date and end date and the status is the indicated statusInput (s)Creator The creator of the conferenceBegin date The begin d

45、ate of the searched conferenceEnd date The end date of the searched conferenceStatus The status of the conferenceOutput (s)NoneReturn (s)List of conference.If list is empty, then no conference find from database7Conference: autoStartConference ()NameStatic void autoStartConference() throws Co

46、nferenceExceptionDescriptionGet the list of the conference that need to be started: If the status of the conference is APPOINT, and the span of the start time and current time is less than FIVE(can be configured) minutes, the conference need to be CJTPDDS001网中网企业名平业务详细设计上海超捷系统集成有限公司，199712/45started

47、Send the start conference request to conference server until all the conference is startedChange the status of the conference to startLog the successful number and fail numberInput (s)NoneOutput (s)NoneReturn (s)Exception8Conference: autoEndConference ()NameStatic void autoEndConference()thro

48、ws ConferenceExcptionDescriptionGet the list of the conference that need to be closed: If the status of the conference is START, and the span of the start time and current time exceed 12(can be configured) hours, the conference need to be closedSend the delete conference request to conference server

49、 until all the conference is closedChange the status of the conference to closeLog the successful number and fail numberInput (s)NoneOutput (s)NoneReturn (s)Exception9Conference: Conference () Namevoid Conference(int identity)throws ConferenceExceptionDescriptionConstruct a conference object

50、that the conference identity is known and get all the information of indicated conference from databaseIf get information fail, must throw a defined exception. Detail see 2.8 Exception handleInput (s)Identity The identity of the conferenceOutput (s)NoneReturn (s)Exception The exception throwCJTPDDS0

51、01网中网企业名平业务详细设计上海超捷系统集成有限公司，199713/45Void If no exception0Conference: queryAttendMembers () NameList queryAttednMembersDescriptionGet conference attend membersInput (s)NoneOutput (s)NoneReturn (s)List of members 2.3.2 协协作作图图 Collaboration 1描述：Conference 类的使用协作图编号：SDS-CORD-002USECASE：US

52、ECASE-0001Collaboration Diagram：CJTPDDS001网中网企业名平业务详细设计上海超捷系统集成有限公司，199714/453: Execute()1: Login()4: Create()SystemUser5: isLegalUser()6: Forward()2: JudgeInput()8: GeneratePersonalMenu()9: Select CreateConference Menu()LoginAction10: Link()Login PageLoginFormPersonal Main Page7: Create(User)UserRi

53、ghtsUserConference Create Page12: JudgeInput()11: CreateConference()22: SendShortMsg()CreateConferenceForm13: Execute()CreateConferenceActionResultPage23: Forward()15: Create()RightsManagerConference14: HasRights()DatabaseLoggerSMS ServerSMS GW20: Record()21: Log()ClientMessagePackageConnection19: S

54、end()16: CreateConference()17: GeneratePackage()Message18: Create() Collaboration 2描述：系统自动开始或者结束电话编号：SDS-CORD-003USECASE：USECASE-0001Collaboration Diagram：CJTPDDS001网中网企业名平业务详细设计上海超捷系统集成有限公司，199715/45 : Application1: start() : AutoEndConferenceTask2: create()3: schedual(autoEndConferenceTask)

55、 : Conference4: * autoEndConference() : Timer2.3.3 时时序序图图略。2.3.4 其它其它图图 Conference state diagramCREATE_FLAG != APPOINT / CreateSTART_STATECREATE_FLAG = APPOINT / Create/ StartAPPOINT_STATE/ Delete/CloseCLOSE_STATE/ Delete/CancelCANCEL_STATE2.42.4 FaxFax ModuleModule2.4.1 模模块类图块类图类图编号：SDS-CLSD

56、-0003类图：CJTPDDS001网中网企业名平业务详细设计上海超捷系统集成有限公司，199716/45 Located onFax ModuleFile System Fax file+ upload(fileName : int) : String+ download(fileName : URL) : voidFax file Download/Upload ControlMember1+ fax(identity : int) : void+ send(fileName : URL) : void+ delete() : void+ output(faxPhoneNumber : S

57、tring, identity : int) : void+ output(faxPhoneNumber : String) : void+ list(receiver : Member) : List- status : int- identity : int- receiver : String- sender : String- date : DateFax+ modify(member : Member, type : int, faxPhoneNumber : String) : void+ create(member : Member, type : int, faxPhoneNu

58、mber : String) : void+ getFaxPhoneNumber() : String+ getType() : int+ FaxConfig(member : Member) : void- member : Member- faxPhoneNumber : String- type : intFaxConfig Attribute Description.1 Class: FaxAttributeDescriptionExampleDateThe date of the fax receive04/06 12:30:00SenderThe fax

59、 sender, use phone number to indicate the senderReceiverThe receiver of the fax. Use phone number to indicate the receiverStatusThe fax status. See 2.4.4IdentityThe identity of the fax. System assigns for it.2 Class: FaxConfigAttributeDescriptionExampleTypeThe type of fax.CACHE_TYPE（0）: cache

60、 for faxFAX_MACHINE_TYPE(1):fax machine typeFaxPhoneNumberIf the fax type is FAX_MACHINE_TYPE, it indicate the fax machine numberMemberThe owner of the fax configureCJTPDDS001网中网企业名平业务详细设计上海超捷系统集成有限公司，199717/4 Fax: list ()NameStatic List list (Member receiver)DescriptionList all the fax that mem