软件架构文档样例.docx

软件架构文档样例.docx

《软件架构文档样例.docx》由会员分享，可在线阅读，更多相关《软件架构文档样例.docx（10页珍藏版）》请在冰豆网上搜索。

软件架构文档样例

4In1Ｓystem

软件架构文档

版本　〈1。

1〉

修订文档历史记录

日期

版本

说明

作者

２010／1１／23

1。

0

初始版本

ＢenXu

201０/１2/20

1。

1

BeｎＸu

1。

简介4

１.２范围ﻩ4

1。

3ﻩ定义、首字母缩写词和缩略语4

1。

４参考资料4

2。

ﻩ架构表示方式ﻩ４

3。

架构目标和约束ﻩ４

4。

用例视图ﻩ4

4。

1主要用例５

４.1。

1ﻩ申请注册ﻩ5

４。

１。

３用户角色管理5

4.１。

4角色权限管理ﻩ6

4。

１。

6配件信息管理ﻩ6

5.ﻩ逻辑视图ﻩ６

５。

３ﻩBusiｎess　Serviｃe层7

5。

3。

1ﻩSerｖｉcｅ包7

5。

３.2ﻩModel包8

5。

４Ｍiddlewarｅ层ﻩ８

6．2Sｅrvｅｒ9

6．３ﻩＤB　Ｓｅｒverﻩ9

7。

ﻩ数据视图9

8。

大小和性能ﻩ1０

ﻬ软件架构文档

1.简介

1.1目的

本文档将从架构方面对系统进行综合概述,其中会使用多种不同的架构视图来描述系统的各个方面。

它用于记录并表述已对系统的架构方面作出的重要决策。

1.2范围

本文档用于4Ｉn1小组正在开发中的4Ｉn１系统。

４ｎ1系统是为ABC汽车4S店设计的业务管理系统,将提供汽车的整车销售、配件销售、售后服务以及信息反馈等功能。

1.3定义、首字母缩写词和缩略语

见４In１系统术语表

1.4参考资料

1．４In1系统术语表，1．０版,4Iｎ１小组

2.4Iｎ1系统前景文档，1。

１版，4In1小组

３.　4Ｉn1系统软件需求规约，1。

0版，4In1小组

4。

４In1系统软件开发计划，1。

1版,４Iｎ1小组

5。

4Ｉn1系统初始迭代计划，1.１版，4Iｎ１小组

6。

　4In１系统细化迭代计划，1．0版,4In1小组

7.　4Ｉｎ1系统风险列表,1.０版，4In1小组

8．　RＵP的软件架构文档模板

2.架构表示方式

本文档将通过以下一系列视图来表示４In1系统的软件架构:

用例视图、逻辑视图、部署视图。

本文档不包括进程视图和实施视图。

这些视图都是通过PowｅrDesiｇner工具建立的ＵMＬ模型。

3.架构目标和约束

1.系统在开发过程中有如下设计约束：

开发语言为Jａvａ,采用关系型数据库存放数据,采用基于ＵMＬ的面向对象分析与设计方法进行开发,采用B/S架构。

2.系统应支持1０0人以上同时访问服务器并支持５00人以上同时访问数据库,服务器的响应时间不应该超过5秒。

3.所有用户在保证网络连接的情况下可同时通过局域网和互联网访问系统.

4.系统必须保证数据的安全访问，用户需要通过用户名和密码进行身份认证,同时对数据的访问要进行授权认证.

4.用例视图

本章是对软件架构的用例视图的描述.由于４Iｎ１系统的用例数量太多，因此本章只选了部分与架构设计相关的用例。

对于其余的用例，可参考软件需求规约。

选取的用例包括:

●注册申请

●用户注册审核

●用户角色管理

●角色权限管理

●车型信息管理

●配件信息管理

4.1主要用例

图１系统管理用例图

4.1.1申请注册

简要说明:

该用例允许4S店员工提出注册申请,从而成为4In1系统用户。

该用例的主要参与者为４S店员工。

4.1.2用户注册审核

简要说明：

该用例允许系统管理员对系统的注册申请进行审核。

决定其是否成为系统用户。

该用例的主要参与者是系统管理员。

4.1.3用户角色管理

简要说明：

该用例允许系统管理员管理系统中所有用户的角色，它包括已分配角色用户的角色修改。

该用例的主要参与者为系统管理员。

4.1.4角色权限管理

简要说明：

该用例允许系统管理员管理系统中各个职员角色的权限。

它包括角色的创建，查询,删除。

对各个角色进行权限的添加与移除。

该用例的主要参与者是系统的管理员。

4.1.5车型信息管理

简要说明:

该用例允许系统管理员管理４S店参与销售的所有车型信息.它包括销售车型信息的查询、创建、删除和修改。

该用例的主要参与者是系统的管理员。

4.1.6配件信息管理

简要说明：

该用例允许系统管理员管理4S店参与销售的所有配件信息。

它包括销售配件信息的查询、创建、删除和修改。

该用例的主要参与者是系统的管理员。

5.逻辑视图

本章是对软件架构的逻辑视图的描述。

主要内容包括描述重要的类，类的分包,子系统以及子系统的分层等．另外还包括了一些重要用例的实现。

5.1概述

图24In1系统总体架构图

4In1系统的逻辑视图主要由三层组成，分别是Applicａtｉon层、Ｂｕsiness　Service层和Middle层。

Aｐpliｃａｔion层主要由响应各种用户界面请求的动作类组成，它会调用BuｓｉnessSeｒvicｅ层中的函数进行业务逻辑处理，同时根据结果显示不同的界面给用户.

BusinessSeｒｖicｅ层主要完成实际的业务逻辑,同时包括与数据库的表对应的实体类,以及访问数据库的DAO类。

Mｉｄｄle层为SＳH２框架的函数库.

5.2Appｌicatｉｏｎ层

图3Applｉｃaｔion层架构图

Applicaｔioｎ层主要由９个子包组成，这9个子包分别是ＲepaiｒAｃtions包、FeedｂacｋＡctｉons包、SｅｌlＡssuｒaｎｃeActions包、BuyPartActionｓ包、ＳeｌlＰartActionｓ包、SellCarＡｃtiｏns包、BuyCａrActionｓ包、AuthｏritｙＡｃｔｉｏｎｓ包和ＷarｅsActｉons包。

5.3BusiｎｅssServｉce层

ＢusinessＳerｖｉcｅ层包括Seｒvｉce和Moｄel两个包。

5.3.1Service包

图4　Sｅｒvice包架构图

Sｅrｖiｃe包主要由三个包组成，IAｕtｈｏｒitｙServiｃｅ包负责处理用户的身份认证以及角色和权限管理，IGeneｒalBｕsｉｎｅssSｅrｖice包负责整车销售、配件销售、采购、售后服务以及信息反馈过程中的表单处理，IＷaｒesServiｃｅ包负责车型信息、配件信息的管理以及库存信息.

5.3.2Ｍodel包

图5Modｅｌ包架构图

Model包由４个表单的实体类以及对应的4个表单ＤAＯ类,与角色和身份相关的一些类:

Peｒmｉssiｏn类、Rolｅ类、Stｕｆf类、PermisｓioｎDAＯ类、RoleＤAO类和ＳtuffＤＡO类，Car类、CaｒDAO类、Paｒt类、PartDAO类、Cusｔｏmer类和CusｔomerDＡO类等组成。

5.4Ｍiddleｗarｅ层

图6Miｄｄlｅwaｒe层架构图

6.部署视图

本章描述了部署和运行软件的物理网络（硬件）配置。

图6　4In1系统部署图

6.1UsｅrClｉeｎt

用户主要通过浏览器来访问系统，支持的浏览器包括IE6+和Ｆirefox３。

6+,客户端与服务端的连接可以是局域网或互联网。

6.2Serｖeｒ

应用服务器运行4In1系统，4In1系统部署在Tomｃａt7.0容器上，它与数据服务器通过ｊdbc连接。

6.3ＤBSeｒvｅｒ

数据服务器运行ｍyｓｑl5。

1数据库。

7.数据视图

图７　数据模型ER图

8.大小和性能

本系统采用的软件架构可以很好的支持如下性能需求:

1.系统应支持100人以上同时访问服务器并支持500人以上同时访问数据库。

2.服务器的响应时间不应该超过5秒.

9.质量

本系统采用的软件架构可以很好的支持系统质量方面的需求:

1.系统应当方便所有用户的使用，对于有基础计算机水平的用户的培训时间应不超过2小时。

2.系统应该提供在线的支持帮助。

3.系统必须能够保证每天2４小时不间断运行,可用率为99％。

4.合理的设计系统的结构以保证较高的可维护性,系统的模块应该可替换。

5.系统应当正确处理发生的异常或者错误，并返回错误信息．