第三章系统概要设计中的架构设计
系统分析的目的就是把需求转换为系统的设计，分析与设计是一个前后相互关联的过程。通过对本章内容的学习，读者将被引入软件开发的设计阶段。软件系统的设计一般分为概要设训和详细设计，概要设计中最重要的工作是系统的架构设计。
从软件系统的开发实现角度来看，系统的架构设计主要可以分为逻辑架构设计与物理架构设计两个紧密相关的设计内容。系统的逻辑架构设计结果定义了应用系统中的基本逻辑组成元素，以及这些逻辑元素之间的关系，这在UML中主要通过架构包图来表示；系统的物理架构设计主要关注“目标程序及其依赖的运行库和系统软件”如何安装或部署到客户最终环境的物理主机中．以及如何部署主机（如各种形式的服务器主机）和网络配置来保证软件系统的可靠性、可伸缩性和稳定运行性等方面的要求．这主要通过UML中的部署图来表示。
在系统的架构设计中，应尽可能地分析清楚系统中哪些逻辑元素是稳定的需求，哪些是经常变化的需求。以便在进行系统设计时，能够将软件系统的核心部分建立在稳定的需求上。本章主要介绍系统概要设计中与“架构设计”有关的内容，并通过州上商城项目中系统架构设计的示例来阐述与架构设计有关的思想、原则和方法以及模式的具体应用。
3.1 概要设计
3.1.1 软件系统设计概述
1．软件系统设计概述
（1）什么是系统设计?
系统设计就是通过某种特定的平台，完成软件系统的整体功能（也就是把软件需求转变为软件的具体方案）的实现。从工程管理的角度来看，软件设计分为如下两个阶段：概要设计和详细设计。
图3.1为概要设计和详细设计的具体工作内容。
图3. l概要设计和详细设计的具体工作内容
概要设计的工作重点在于进行系统的静态结构或者高层架构设汁；详细设计的工作重点在于系统的用户界面、动态结构设计以及测试计划的制定等。
（2）系统的概要设计。
将软件系统的功能性需求和非功能性需求转化为数据结构和软件的系统结构，并合理地设计和规划出组成软件系统的物理元素：程序、数据库、过程、文件等内容。分析设计人员可以利用UML中的包图来建立和体现软件系统的体系架构。图3.2所示为某图书馆管理系统项目中的架构包图。
图3.2某图书馆管理系统项目中的架构包图
从上面的架构包图中，很明显地能够看出，该系统采用标准的4层架构实现：表示层、控制层、业务处理层和数据访问层；并日还能够了解每层中各个核心的组件及其关系。
（3）系统的详细设计（重点是系统的动态结构设计）。
通过对软件系统结构表示的进一步细化和完善，最后获得软件系统的详细数据结构和算法、关键性问题的解决等方面的解决方案。为此，分析设计人员可以利用UML中的类图建立相应的体系结构，同时再辅以UML中的4种动态分析图（顺序图、活动图、状态图和协作图），进一步地描述和体现系统中各个用例的实现行为。图3.3所示为某图书馆管理系统项目中业务层的类图。
图3.3某图书馆管理系统项目中业务层的类图
在分析阶段，软件系统的开发者通过建立特定的软件系统模型来表示真实世界中的问题，以便理解业务过程以及这个过程中需要用到的各种信息（业务数据和数据之间的关系）。
图3.4所示为某图书馆管理系统项目中管理员的各种可能的活动状态图示。
图3.4某图书馆管理系统项目中管理员的各种可能的活动状态在具体实施系统的分析时，首先要学会分解问题，把复杂软件系统中的各种信息和需求进行综合考虑，然后分解成多个易于理解的小问题。最后通过建立软件系统的需求模型来对问题领域进行组织、构造和模拟，并且编制出相应的技术文档。
在对软件系统进行分析建模的过程中，必须要邀请用户方的有关人员参与，并且需要用
户进一步地解释这些需求。其目的是验证开发者建立的软件模型是否是正确的、合理的、可
行的。因为软件系统的设计本身，实际上也是个建模的过程，它把分析阶段得出的信息，也就是需求模型，转换为称为解决方案的设计模型。
图3.5所示为某图书馆管理系统项目中的各个组件的图示，利用组件图能够帮助客户理
解最终的系统结构，并使开发人员的实现工作有一个明确的目标；同时组件图还能帮助开发
组中的其他人员（如帮助文档人员）理解系统。
图3.5某图书馆管理系统项目中的各个组件的图示
2．为什么要进行软件系统的设计
（1）进行软件系统设计的主要原因。
因为建立的软件系统逻辑模型中的用例及用例图并不是分析模型，或者说不能够满足系统的分析需要。它们只是形成分析模型中的素材，而对于用例的分析，开发者可以构造出一个分析模型，但是很少有开发者直接根据这个分析模型去完成软件系统的程序编程实现的。为什么呢?开发者首先应该了解这样一个事实，从用例及用例图得到的分析模型，只表达了软件系统中的一些关键性概念，而不能表达软件系统中的性能和系统的外观（如用户界面GUI）等方面的内容。
系统分析模型对于最终的软件系统结构设计来说，又往往过于简单和粗糙，而在软件开发中倡导的“组件复用”、“模块分离”和“面向接口编程实现”等原则在这个系统分析模型中都不能被考虑。
因此，软件系统的分析设计人员有必要再对前面构造出的分析模型进一步地设计和完善，以最终构造出开发者期望的软件系统发计模型。以利于指导软件系统的编程实现。
（2）进行软件系统设计的目的。
对软件系统进行全面设计的主要目的是指明一种易转化成软件系统功能代码的解决方案，是对系统分析工作的进一步细化和具体实现。也就是进一步细化分析阶段提取的各个类（包括其操作和属性），并H增加新的类以处理诸如系统中涉及的数据库系统、用户接口、与其他设备的通信、控制和驱动其他的设备等技术领域的问题。
3．系统设计的基本要求
（1）系统分析和系统设计两者之间应该是相互合作的。
系统分析是面向问题的，是明确和了解问题的过程，重在理解和翻译，灵活性一般比较高；而系统设计则是面向解决方案的，是排除技术困难和解决问题的过程，重在精化和适应，受约束性和限制条件一般比较多。
从整体上看，分析和设计是不同的，在分析阶段关注的是对需求的描述和理解，而在设计阶段，主要考虑的是具体的技术实现方案。它们是保障问题和针对该问题的解决方案趋于合理和有效的基本动力。
（2）在进行软件系统设计时应该注意的要点。
·应该考虑能否使用重复的体系结构模式或者重用成熟的系统架构。
也就是要考虑本系统能否达到在体系结构级别上的软件重用，即能否在不同的软件体系结构中，使用同一个体系结构。比如，人们经常提及的客户服务器模式的C/S体系结构和浏览器服务器模式的B/S体系结构等的具体应用问题。
·体系结构从更高的层面上应该考虑的问题主要体现在“不变”的因素上。
软件系统的体系结构一般应关注应用系统中的设计模式，更加体现在通过技术解决这些业务差异所带来的影响。比如，关注是否是分布式应用程序、系统分层是如何设计和实现的，也关注系统的性能和安全性等方面的要求是如何满足的。
为了能够达到该设计目标，软件系统的设计者必须要了解和分离系统中的“不变”和“可变”部分，然后将它们分离开。对“不变”部分或者是稳定的部分，尽可能地加以重用。
4．软件设计中的“3W”原则
软件设计既是面对软件工程的具体应用技术，同时也是聚焦于大批开发者相互协作结果的艺术，成功的软件系统产品应该来自于合理的系统设计。什么是合理的系统设计呢?
软件系统的开发者在进行软件系统开发时，最需要考虑的问题就是他们开发和设计出的软件系统或者产品必须满足客户企业发展战略规划的需求，并且能够帮助企业解决实际经营中的问题，提高本企业在同行业中的竞争力。一个合理的软件系统的设计，应该遵守软件设计中的“3w”原则。
（1）Who（为谁而设计，应该明确软件系统的真正用户是谁）。
为谁设计表达的是软件系统的开发者必须认真研究客户企业的业务领域、研究企业本身的工作特点，从而对于企业本身的业务规则和流程有深刻的理解，最后形成针对这个企业业务经营状态的解决方案。
（2）What（要解决用户在应用系统时的哪些问题，功能有哪些?性能又有哪些?）。
要解决用户的什么问题，表达的是开发者必须把企业存在的问题提取出来，分析研究哪些问题可以用信息化技术或者特定的软件系统和工具解决；同时还应该搞清楚，企业应用了该信息化技术以后，企业的业务流程需要进行的更改，以及这些更改带给企业的正面和负面影响。
（3）Why（为什么要解决这些问题?将这些问题解决后，能否为用户带来价值、降低开发方的成本等）。
为什么要解决这些用户问题，表达的是如何帮助企业产生可度量的价值，而这些价值是在研究企业目前存在的问题的基础上产生的，没有这些价值的产生，对软件系统的投资是没有意义的。价值不可度量，企业领导者就不可能积极地支持应用该软件系统或者开发出某套软件系统。另外，还要注意的是设计必须是便于用户使用的。减少系统维护和培训资源的消耗，而且系统应操作简单、应用方便。
“3W”原则的本质，就是要求软件系统的设计者围绕“用户”而不是围绕“开发者”或者“时髦的技术”来开展软件系统的设计和开发工作。因此满足“用户的需求、便于用户的使用，同时又能使开发出的软件系统在应用新技术方面尽可能简单．相应地降低开发成本”，这就是软件系统的开发者应该追求的设计目标。
软件系统设计过程中的各项活动，其实就是权衡“利与弊”的过程，设计人员需要在“简单”与“复杂”之间、“功能实现”与“系统性能”之间、一种“技术方案”与另一种也可行的“技术方案”之间进行权衡。因此，好的设计方案，一定是“中庸”的设计。
5．软件系统常用的设计方法
（1）面向过程的设计方法。
面向过程设计方法的基础建立在3种能够构成结构化程序的逻辑构造方面，顺序、选择和重复上；并且面向过程的设计方法采用的是“自顶向下、逐步精化”的瀑布式设计方法，由于瀑布式设计方法是按“自顶而下”的顺序进行的，这就要求设计者在一开始就要对系统需要解决的各个问题有全面的、周密的了解。
（2）面向对象的设计方法。
面向对象的设计方法主要定义系统中各种可能类型的对象，并对每种类型的对象进行细化，以找出对象之间的关系；面向对象的设计方法关注的是消息和响应机制。
3.1.2 面向对象设计方法
1．面向对象设计方法
（1）面向对象设计方法的特点。
在面向对象设计(Object-Oriented Design，OOD)方法中，可以充分利用对象具有的抽象性、封装性、继承性、多态性等特性，同时面向对象设计方法是一种“自下而上”的设计方法，这与面向过程的设计方法中的“自上而下”刚好相反。
另外，面向对象设计方法的最基本的概念是类、职责、状态、角色等，及与这些概念相关的耦合度、聚合度、可重用性、可扩展性、可维护性等。
（2）“自下而上”的设计方法的优点是能够形成一种螺旋上升的软件开发方式。
不像面向过程式设计那样，在设计的开始阶段就需要明确整个软件系统本身，面向对象的设计往往从问题的一部分(局部)着手，一点一点地构建整个软件系统的各个模块。随着开发者在开发过程中逐步加深对软件系统需求的理解，开发者将分阶段和分层次地添加对这些新功能的具体实现。
这些新的理解以及开发中遇到的需求变化．都会再作用到软件系统开发本身（也包括设计阶段），从而形成一种螺旋式上升的开发方式和开发过程。在这种开发方式中，对于已有的系统设计或者部分编程实现的代码，只需要进行局部修改或者调整以体现系统的变化即可。
2．面向对象设计方法与面向过程设计方法的最根本的区别
（1）面向对象的设计方法将整个软件系统看成对象集。
面向对象的设计方法把软件系统看成是一起工作来完成某项任务的对象集合，对象是软件系统中对消息做出响应的事物。对象之间的关系体现问题之问的关系，对象中的属性体现问题的特征，对象中的方法体现问题的行为或者功能服务。
在面向对象的设计中产生的各个逻辑对象，其实就是对软件系统所在问题域中各个问题的映射，设计的结果是有指导意义的。
（2）面向对象设计方法关注的核心。
面向对象设计方法中关注的不是它该做什么（这在面向对象的分析中已经明确），而是它如何做出反应，也就是对消息的响应，这是与面向过程方法的根本不同点。
由于面向对象方法把对象看成软件系统对消息做出响应的事物，这种与面向过程完全不同的看待计算机软件系统的方法，必然会构造出完全不同的分析、设计和编程实现方式。
（3）在面向对象设计(当然也包括编程实现)中更多地看重类之间的关系。
从面向对象的角度来看各个对象之间的关系时，一般有“关联”、“继承”和“内聚”等形式。面向对象编程的过程就是将各个类按以上的各种关系组合在一起，这些关系本身都非常简单，不过组合在一起却能提供强大的设计能力。例如例3．1的代码示例体现了客户和订单之间的关联关系，因为每个订单对应特定的客户，每个客户对应一些特定的订单。
例3-1 体现了客户和订单之间关联关系的代码示例。
Public class UserInfo{
Private ArrayList Orders；
／／…其他的成员定义，在此加以省略
}
Public class Order{
private UserInfo someOneUser；
／／…其他的成员定义，在此加以省略
}
面向过程中的结构化设计历来备受冷落的主要原因就是软件系统的需求和系统的设计之间存在一定的分离和鸿沟，因为在结构化设计中的模块和模块之间的关系，被紧紧地局限于信息流，这限制了对模块之间众多关系(比如继承和内聚关系)的表达，也无法体现模块和模块之间其他的众多关系，包含各种各样的结构、行为、依赖、包含（在结构化设计中这种关系隐含在分层中）、继承、关联关系等。
（4）面向对象的设计是适应性过程，而面向过程的设计是预测的。
面向对象设计更多地将重点放在“职责”的划分、“变化点”的隔离、“交互机制”的确定等问题上，并且面向对象的设计认为变化是不可避免的驱动因素，整个设计是在迭代变更中完成的。
3．面向对象设计的应用场合
（1）设计中强调的是软件系统的重用和重构。
面向对象的设计，更倾向于建立一种灵活多变、便于修改、便于升级的软件系统，设计中强调的是软件系统中各种组件的重用和重构。
（2）设计中强调的是软件系统的可扩展性。
由于面向对象设计技术的成熟和不断发展，面向对象设计已经形成了一系列的重要设计原则和方法、设计模式。这些原则和方法可以大大提高系统的设计质量；从而使得应用面向对象设计的方法设计和建立一个大型的、分布式的、可升级的、可维护的而且安全的软件系统成为可能。
3.1.3 系统设计中的概要设计
1．概要设计又称为系统的结构设计
（1）在什么时候应该进行系统的概要设计。
在系统需求相对比较明确并对需求进行域建模之后，接着进行系统的概要设计。概要设计对随后进行的编程实现、单元测试和集成测试、系统安装部署实施和维护工作都将起到关键性的影响作用。通过对系统进行概要设计，将系统开发过程中“做什么”的逻辑模型变换为“如何做”的物理模型。
（2）系统概要设计的重要性
系统分析过程中产生的分析模型和系统设计过程中产生的设计模型，两者应该是交错的，并且是迭代进行的；概要设计的重要性，主要体现在它是把系统需求转化为软件系统的实现过程中最重要的开发环节，并且系统概要设计的优劣会在根本上决定软件系统的整体质量和性能。
2．系统概要设计中涉及的主要内容
（1）制定本软件系统的开发规范。
制定本软件系统的各种开发规范是项目小组今后共同开发的基础，有了开发规范和程序模块之间、项目成员彼此之间的接口规则、方式和方法，开发团队中的各个成员就有了共同的工作语言、工作平台，使整个软件开发工作可以协调、有序地进行。制定规范涉及的主要内容如下：
·代码体系、模块之间的接口和命名规则。
·规定设计文档的编制标准。
·规定与硬件、操作系统的接口规约和命名规则。
（2）体系结构设计（架构设计）。
体系结构是对复杂软件系统的一种抽象，如客户/服务器（C/S）和浏览器/Web服务器/数据库服务器（B/W/S）结构等的应用。同时在架构设计中还应该考虑采用框架技术的形式和服务器的平台类型等内容。
（3）划分系统中的各个模块并进行组件类的设计。
根据用户的需求，实现从功能上来划分各个功能模块。在模块设计中应该遵守功能独立的单一职责原则（Single-Responsibility Principle，SRP）。因为功能独立的模块可以降低开发、测试、维护等阶段的代价，而且被重用的可能性更高。
（4）数据结构与算法设计。
设计高效率的程序是基于良好的数据结构与算法的，而不是基于编程技巧的。因为数据结构与算法就是一类数据的表示及其相关的操作。确定软件系统涉及的文件系统的结构，以及数据库中数据访问的模式，进行数据完整性和安全性的设计，并确定输入、输出文件的详细数据结构是本阶段需要考虑的问题。
（5）数据库的逻辑设计。
根据模块设计和划分出的各个实体类、实体类之间的关系、实体类中各个成员的属性等确定出数据库表中的字段和各个字段的数据类型。构造数据库的表结构必须遵循一定的规则。在关系数据库中，这种规则就是范式。一般说来，数据库只需满足到第3范式（3NF）即可——通常被认为在性能、扩展性和数据完整性方面达到了比较好的平衡。
（6）其他如可靠性等方面的设计。
软件系统在运行过程中，为了能够适应环境的变化和用户新的功能要求，需经常对软件进行修正、完善。在软件开发的一开始就要确定软件可靠性和其他质量指标，考虑相应措施，使得软件易于修改和易于维护。
3．概要设计中涉及系统设计的基本原则
软件系统设计的主要任务是什么？如何正确地进行系统各个子模块的功能划分？在模
块划分时要遵守的原则和方法、设计的目标是什么?评价一个软件系统设计的优劣，主要考查如下指标是否达到或者满足。
（1）先进性。
在设计思想、系统构架、采用技术和选用平台上均要有一定的先进性、前瞻性和扩充性。特别要考虑一定时期内业务的增长和应用的变化趋势。在充分考虑技术先进性的同时，应尽量采用技术成熟、市场占有率比较高的产品，从而保证建成的网站系统具有良好的稳定性、可扩展性和安全性。
（2）实用性。
在尽量满足业务功能需求的前提下，结合各业务角色的工作特点，做到简单、实用和人性化。
（3）可靠性。
由于企业应用中不可避免地要涉及不同的用户群（操作层、管理层和业务层等人员），因此建设的信息服务网站系统必须在建设平台上保证系统的可靠性和安全性。系统设计中应有适量冗余及其他保护措施，平台和应用软件应具有容错性和容灾性。
（4）开放性。
在系统架构、采用的技术实现和选用的平台等都必须要有较好的开放性。特别是在选择产品上，要符合开放性要求，遵循国际标准化组织的技术标准，对选定的产品既要有自己的独特优势，又能与其他多家优秀的产品进行组合，共同构成一个开放的、易扩充的、稳定的和统一的软件系统。
（5）可维护性。
系统设计应标准化和规范化，按照分层设计、模块化实现并遵守面向接口编程实现的基本原则。
（6）可伸缩性。
企业应用网站系统的网上业务建设是一个循序渐进、不断扩充的过程，系统要采用积木式结构，整体构架的考虑要与现有系统进行无缝连接，为今后系统的扩展和集成留有扩充空间。
（7）可移植性。
在选择开发应用的平台上，应该考虑能够建设一套与平台无关，有统一的服务接口规范和与各种数据库都能够相连的应用组件。
4．概要设计后的重要输出
（1）概要设计说明书。
·编码规范：信息形式、接口规约、命名规则；
·物理模型：组件图、配置图；
·不同角度的构架视图：用例视图、逻辑视图、进程视图、部署视图、实施视图、数据视图（可选）：
·系统总体布局：组成部分以及各部分在物理上、逻辑上的相互关系。
（2）数据库设计说明书，主要给出使用的DBMS简介、数据库的概念模型、逻辑设计、结果。
（3）用户手册，对需求分析阶段编写的用户手册进行补充。
（4）制定初步的测试计划，并对测试策略、方法、步骤提出明确要求。
软件体系结构设计说明书 编者说明： 随着OO方法论地日臻成熟，其思想也从编程（OOP）到了设计（OOD）和分析（OOA），而软件体系结构则是从设计的最高层进行设计与规划的技术，本文档模板就是用来帮助你从用例视图、逻辑视图、进程视图、部署视图等方面对系统进行总体描述。 1.文档简介 [本节主要是描述软件体系结构设计说明书的目的、范围、相关术语、参考资料和本文档的摘要性介绍。软件体系结构设计属于高层设计文档，是符合现代软件工程要求的概要设计。] 1.1 目的 [软件体系结构设计说明书，将从设计的角度对系统进行综合的描述，使用不同的视图来描述其不同方面。在本小节中，将对该文档的结构进行简要的说明，明确该文档针对的读者群，指导他们正确的地使用该文档。] 1.2 范围 [说明该文档所涉及的内容范围，以及将影响的内容。] 1.3 定义、首字母缩写词和缩略语 [与其它文档一样，该文档也需要将本文档中所涉及的所有术语、缩略语进行详细的定义。还有一种可简明的做法，就是维护在一个项目词汇表中，这样就可以避免在每个文档中都重复很多内容。] 1.4参考资料 [在这一小节中，应完整地列出该文档引用的所有文档。对于每个引用的文档都应该给出标题、标识号、日期以及来源，为阅读者查找这些文档提供足够详细的信息。] 1.5 概述 [在本小节中，主要是说明软件体系结构设计说明书各个部分所包含的主要内容，就像一个文章摘要一样。同时也应该对文档的组织方式进行解释。]
2. 体系结构表示方式 [本节说明软件体系结构在当前系统中的作用及其表示方式。它将列举其所必需的用例视图、逻辑视图、进程视图、部署视图或实施视图，并分别说明这些视图包含哪些类型的模型元素。] 3. 软件体系结构的目标和约束 [本节说明对软件体系结构具有某种重要影响的软件需求和用户目标，例如，系统安全性、保密性、第三方组件的使用、可移植性、发布和重新使用。它还要记录可能适用的特殊约束：设计与实施策略、开发工具、团队结构、时间表、遗留系统等。]
一、系统设计得原则 1、系统性 从整个系统得角度进行考虑,系统得代码要统一,设计规范要标准,传递语言要尽可能一致,对系统得数据采集要做到数出一处、全局共享,使一次输入得到多次利用。 2、灵活性 系统应具有较好得开放性与结构得可变性,采用模块化结构,提高各模块得独立性,尽可能减少模块间得数据偶合,使各子系统间得数据依赖减至最低限度。 3、可靠性 可靠性就是指系统抵御外界干扰得能力及受外界干扰时得恢复能力。一个成功得管理信息系统必须具有较高得可靠性,如安全保密性、检错及纠错能力、抗病毒能力等。 4、经济性 经济性指在满足系统需求得前提下,尽可能减小系统得开销。一方面,在硬件投资上不能盲目追求技术上得先进,而应以满足应用需要为前提;另一方面,系统设计中应尽量避免不必要得复杂化,各模块应尽量简洁,以便缩短处理流程、减少处理费用。 二、系统设计得主要内容 1、系统总体结构设计 系统总体结构设计包括两方面得内容: 系统网络结构设计; 系统模块化结构设计。 2、代码设计 代码设计就就是通过设计合适得代码形式,使其作为数据得一个组成部分,用以代表客观存在得实体、实物与属性,以保证它得唯一性便于计算机处理。 3、数据库(文件)设计 根据系统分析得到得数据关系集与数据字典,再结合系统处理流程图,就可以确定出数据文件得结构与进行数据库设计。 4、输入/输出设计 输入/输出设计主要就是对以纪录为单位得各种输入输出报表格式得描述,另外,对人机对话各式得设计与输入输出装置得考虑也在这一步完成。 5、处理流程设计 处理流程设计就是通过系统处理流程图得形式,将系统对数据处理过程与数据在系统存储介质间得转换情况详细地描述出来。 6、程序流程设计 程序流程设计就是根据模块得功能与系统处理流程得要求,设计出程序模框图,为程序员进行程序设计提供依据。 7、系统设计文档 系统标准化设计就是指各类数据编码要符合标准化要求,对数据库(文件)命名、功能模块命名也要标准化。 描述系统设计结果就是指系统设计说明书,程序设计说明书,系统测试说明书以及各种图表等,要将她们汇集成册,交有关人员与部门审核批准; 拟定系统实施方案设计就是在系统设计结果得到有关人员与部门认可之后,拟定系统实施计划,详细地确定出实施阶段得工作内容、时间与具体要求。
软件结构设计规范
精选编制： 审核： 批准：
目录 1.简介 (6) 1.1.系统简介 (6) 1.2.文档目的 (6) 1.3.范围 (6) 1.4.与其它开发任务/文档的关系 (6) 1.5.术语和缩写词 (6) 2.参考文档 (8) 3.系统概述 (9) 3.1.功能概述 (9) 3.2.运行环境 (9) 4.总体设计 (10) 4.1.设计原则/策略 (10) 4.2.结构设计 (10) 4.3.处理流程 (10) 4.4.功能分配与软件模块识别 (11) 5.COTS及既有软件的使用 (12) 5.1.COTS软件的识别 (12) 5.2.COTS软件的功能 (12)
5.3.COTS软件的安全性 (12) 5.4.既有软件的识别 (12) 5.5.既有软件的功能 (13) 5.6.既有软件的安全性 (13) 6.可追溯性分析 (14) 7.接口设计 (15) 7.1.外部接口 (15) 7.2.内部接口 (15) 8.软件设计技术 (16) 8.1.软件模块 (16) 8.2.数据结构 (16) 8.3.数据结构与模块的关系 (16) 9.软件故障自检 (17)
1.简介 1.1.系统简介 提示：对系统进行简要介绍，包括系统的安全目标等。 1.2.文档目的 提示： 软件结构设计的目的是在软件需求基础上，设计出软件的总体结构框架，实现软件模块划分、各模块之间的接口设计、用户界面设计、数据库设计等等，为软件的详细设计提供基础。 软件结构设计文件应能回答下列问题： 软件框架如何实现软件需求； 软件框架如何实现软件安全完整度需求； 软件框架如何实现系统结构设计； 软件框架如何处理与系统安全相关的对软/硬件交互。 1.3.范围 1.4.与其它开发任务/文档的关系 提示：如软件需求和界面设计文档的关系 1.5.术语和缩写词 提示：列出项目文档的专用术语和缩写词。以便阅读时，使读者明确，从
软件体系结构设计说明书 1.文档简介 [本节主要是描述软件体系结构设计说明书的目的、范围、相关术语、参考资料和本文档的摘要性介绍。软件体系结构设计属于高层设计文档，是符合现代软件工程要求的概要设计。] 1.1 目的 [软件体系结构设计说明书，将从设计的角度对系统进行综合的描述，使用不同的视图来描述其不同方面。在本小节中，将对该文档的结构进行简要的说明，明确该文档针对的读者群，指导他们正确的地使用该文档。] 1.2 范围 [说明该文档所涉及的内容范围，以及将影响的内容。] 1.3 定义、首字母缩写词和缩略语 [与其它文档一样，该文档也需要将本文档中所涉及的所有术语、缩略语进行详细的定义。还有一种可简明的做法，就是维护在一个项目词汇表中，这样就可以避免在每个文档中都重复很多内容。] 1.4参考资料 [在这一小节中，应完整地列出该文档引用的所有文档。对于每个引用的文档都应该给出标题、标识号、日期以及来源，为阅读者查找这些文档提供足够详细的信息。] 1.5 概述 [在本小节中，主要是说明软件体系结构设计说明书各个部分所包含的主要内容，就像一个文章摘要一样。同时也应该对文档的组织方式进行解释。] 2. 体系结构表示方式 [本节说明软件体系结构在当前系统中的作用及其表示方式。它将列举其所必需的用例视图、逻辑视图、进程视图、部署视图或实施视图，并分别说明这些视图包含哪些类型的模型元素。]
3. 软件体系结构的目标和约束 [本节说明对软件体系结构具有某种重要影响的软件需求和用户目标，例如，系统安全性、保密性、第三方组件的使用、可移植性、发布和重新使用。它还要记录可能适用的特殊约束：设计与实施策略、开发工具、团队结构、时间表、遗留系统等。] 4.用例视图 [本节使用用例分析技术所生成的系统用例模型，描述其中的一些用例或场景。在该模型中纳入用例或场景，应该是系统中最重要、最核心的功能部分。] [另外，在本节中还应该选择一个主要的用例，对其进行描述与解释，以帮助读者了解软件的实际工作方式，解释不同的设计模型元素如何帮助系统实现。] 5. 逻辑视图 [逻辑视图主要是反映系统本质的问题领域类模型，在逻辑视图中将列出组成系统的子系统、包。而对每个子系统、包分解成为一个个类，并说明这些关键的实体类的职责、关系、操作、属性。这也是OO思想的体现，以类、类与类之间的协作、包、包与包之间的协作模型来表达系统的逻辑组织结构。] 5.1概述 [在本小节中，列出逻辑视图的顶层图，该图将反映系统由哪些包组成，每个包之间的关系与协作，以及包的层次结构。使得读者对整个软件体系结构有一个整体的了解。] 5.2影响软件体系结构的重要设计包 [在本小节中，将从逻辑视图中选择有重要意义的设计包，每个设计包有一个小节来描述，说明这些包的名称、简要的说明、该包中的主要类和相关的类图。对于包中的重要的类，还应该说明其名称、简要说明、主要职责、操作、属性等。] 6. 进程视图 [本节主要描述该软件体系结构下，系统运行态的情况。描述系统在执行时，包括哪些进程（包括线程、进程、进程组），以及它们之间是如何进行通信的、如何进行消息传递、接口如何。并且来说明如何进行组织。]
一、系统设计的原则 1、系统性 从整个系统的角度进行考虑，系统的代码要统一，设计规范要标准，传递语言要尽可能一致，对系统的数据采集要做到数出一处、全局共享，使一次输入得到多次利用。 2、灵活性 系统应具有较好的开放性和结构的可变性，采用模块化结构，提高各模块的独立性，尽可能减少模块间的数据偶合，使各子系统间的数据依赖减至最低限度。 3、可靠性 可靠性是指系统抵御外界干扰的能力及受外界干扰时的恢复能力。一个成功的管理信息系统必须具有较高的可靠性，如安全保密性、检错及纠错能力、抗病毒能力等。 4、经济性 经济性指在满足系统需求的前提下，尽可能减小系统的开销。一方面，在硬件投资上不能盲目追求技术上的先进，而应以满足应用需要为前提；另一方面，系统设计中应尽量避免不必要的复杂化，各模块应尽量简洁，以便缩短处理流程、减少处理费用。 二、系统设计的主要内容 1、系统总体结构设计 系统总体结构设计包括两方面的内容： 系统网络结构设计； 系统模块化结构设计。 2、代码设计 代码设计就是通过设计合适的代码形式，使其作为数据的一个组成部分，用以代表客观存在的实体、实物和属性，以保证它的唯一性便于计算机处理。 3、数据库（文件）设计
根据系统分析得到的数据关系集和数据字典，再结合系统处理流程图，就可以确定出数据文件的结构和进行数据库设计。 4、输入/输出设计 输入/输出设计主要是对以纪录为单位的各种输入输出报表格式的描述，另外，对人机对话各式的设计和输入输出装置的考虑也在这一步完成。 5、处理流程设计 处理流程设计是通过系统处理流程图的形式，将系统对数据处理过程和数据在系统存储介质间的转换情况详细地描述出来。 6、程序流程设计 程序流程设计是根据模块的功能和系统处理流程的要求，设计出程序模框图，为程序员进行程序设计提供依据。 7、系统设计文档 系统标准化设计是指各类数据编码要符合标准化要求，对数据库（文件）命名、功能模块命名也要标准化。 描述系统设计结果是指系统设计说明书，程序设计说明书，系统测试说明书以及各种图表等，要将他们汇集成册，交有关人员和部门审核批准； 拟定系统实施方案设计是在系统设计结果得到有关人员和部门认可之后，拟定系统实施计划，详细地确定出实施阶段的工作内容、时间和具体要求。 另外，为了保证系统安全可靠运行，还要对数据进行保密设计，对系统进行可靠性设计。 三、系统设计的步骤 1、系统总体设计 包括：系统总体布局方案的确定；软件系统总体结构设计；数据存储的总体设计；计算机和网络系统方案的选择。 2、详细设计
网站软件(结构)设计说明书 一．引言 1．引言 1）将系统划分成物理部分，即程序、文件、数据库、文档、图片等。 2）设计软件结构，即将需求规格转换为体系结构，划分出程序的基本模块组成，确定模块间的相互关系，并确定系统的数据结构。 3）预期的读者：本说明书是软件体系结构设计的说明书，主要读者群为项目组成员，其次供公司上层(老师)评审，并指导开发人员的开发。 4）本说明书为系统的概要设计说明书，为系统详细的设计的主要依据。主要读者群为项目组成员，使得项目组内成员对整个系统的主要功能以及其概要的实现手段,有一个宏观的把握，是整个系统最初形，同时也是最基本的引导性文档(软件体系结构设计说明书)，将从设计的角度对系统进行综合的描述，使用不同的视图来描述其不同方面。在本说明书中，将对该说明书的结构进行简要的说明，明确该说明书针对的读者群,指导他们正确的使用该说明书。 2．背景 1）项目名称：山桐子绿色能源科技有限责任公司 2）项目任务提出者:黄先生 3）项目负责人：杨卫 4）开发者：何文静,先雪莉,王娟,白瑜,杨卫 5）开发工具：Flash CS4；Dreamweaver8 6）运行平台：本项目采用WINDOW 2000为操作系统 7）适用用户：所有能上网浏览网页的用户,主要用户是需要山桐子的人群. 3．定义 1）该文档也需要将本文档中所涉及的所有术语、缩略语进行详细的定义。还有一种可简明的做法，就是维护在一个项目词汇表中，这样就可以避免在每个文档中都重复很多内容。 2）比如: DL:登录ZC:注册GSJJ:公司简介CPZS:产品展示SCYF:生产研发WDDD:我的订单XWZX:新闻中心LXWM:联系我们RCZP:人才招聘 4．参考资料 列出有关的参考资料，如： (1) 本项目的经核准的计划任务书和需求说明书； (2) 属于本项目的其他已发表的文件；如开发标准书； (3)本文件中各处引用到的文件资料： [1] 陈元国．需求分析说明书．参考资料书，2013.4 [2] 顾正刚．网站规划和建设．机械工业出版社，2010.2 [3] 张强．数据库设计说明书．参考资料书，2013.5
1.1系统总体设计原则 为确保系统的建设成功与可持续发展，在系统的建设与技术方案设计时我们遵循如下的原则：1、统一设计原则统筹规划和统一设计系统结构。尤其是应用系统建设结构、数据模型结构、数据存储结构以及系统扩展规划等内容，均需从全局出发、从长远的角度考虑。2、先进性原则系统构成必须采用成熟、具有国内先进水平，并符合国际发展趋势的技术、软件产品和设备。在设计过程中充分依照国际上的规范、标准，借鉴国内外目前成熟的主流网络和综合信息系统的体系结构，以保证系统具有较长的生命力和扩展能力。保证先进性的同时还要保证技术的稳定、安全性。3、高可靠/高安全性原则系统设计和数据架构设计中充分考虑系统的安全和可靠。4、标准化原则系统各项技术遵循国际标准、国家标准、行业和相关规范。5、成熟性原则系统要采用国际主流、成熟的体系架构来构建，实现跨平台的应用。6、适用性原则保护已有资源，急用先行，在满足应用需求的前提下，尽量降低建设成本。7、可扩展性原则信息系统设计要考虑到业务未来发展的需要，尽可能设计得简明，降低各功能模块耦合度，并充分考虑兼容性。系统能够支持对多种格式数据的存储。 1.2业务应用支撑平台设计原则 业务应用支撑平台的设计遵循了以下原则：1、遵循相关规范或标准遵循J2EE、XML、JDBC、EJB、SNMP、HTTP、TCP/IP、SSL等业界主流标准2、采用先进和成熟的技术系统采用三层体系结构，使用XML规范作为信息交互的标准，充分吸收国际厂商的先进经验，并且采用先进、成熟的软硬件支撑平台及相关标准作为系统的基础。3、可灵活的与其他系统集成系统采用基于工业标准的技术，方便与其他系统的集成。4、快速开发/快速修改的原则系统提供了灵活的二次开发手段，在面向组件的应用框架上，能够在不影响系统情况下快速开发新业务、增加新功能，同时提供方便地对业务进行修改和动态加载的支持，保障应用系统应能够方便支持集中的版本控制与升级管理。5、具有良好的可扩展性系统能够支持硬件、系统软件、应用软件多个层面的可扩展性，能够实现快速开发/重组、业务参数配置、业务功能二次开发等多个方面使得系统可以支持未来不断变化的特征。6、平台无关性系统能够适应多种主流主机平台、数据库平台、中间件平台，具有较强的跨系统平台的能力。7、安全性和可靠性系统能保证数据安全一致，高度可靠，应提供多种检查和处理手段，保证系统的准确性。针对主机、数据库、网络、应用等各层次制定相应的安全策略和可靠性策略保障系统的安全性和可靠性。8、用户操作方便的原则系统提供统一的界面风格，可为每个用户群，包括客户，提供一个一致的、个性化定制的和易于使用的操作界面。 9、应支持多CPU的SMP对称多处理结构 1.3共享交换区数据库设计原则 1.统一设计原则为保证数据的有效性、合理性、一致性和可用性，在全国统一设立交换资源库基本项目和统一编码的基础上，进行扩展并制定统一的交换资源库结构标准。 2.有效提取原则既要考虑宏观决策需要，又要兼顾现实性，并进行业务信息的有效提取，过滤掉生产区中的过程性、地方性数据，将关键性、结果性数据提交集中到交换区数据库中。 3.保证交换原则统一设计数据交换接口、协议、流程和规范，保证数据通道的顺畅。 4.采用集中与分布式相结合的系统结构根据XX电子政务网络发达，地区经济差异性等特点，交换区采用集中与分布式相结合的数据库系统结构，并逐步向大型集中式数据库系统过渡。这些与外部系统交换的数据也需要从生产区数据得到，也就是说需要XXXX数据和各XXXX 数据的采集不只是局限于XXXX和XXXX原定的指标。 1.4档案管理系统设计原则
软件架构设计说明书 The final edition was revised on December 14th, 2020.
目录
1.引言 [对于由多个进程构成的复杂系统，系统设计阶段可以分为：架构设计（构架设计）、组件高层设计、组件详细设计。对于由单个进程构成的简单系统，系统设计阶段可以分为：系统概要设计、系统详细设计。本文档适用于由多个进程构成的复杂系统的构架设计。] [架构设计说明书是软件产品设计中最高层次的文档，它描述了系统最高层次上的逻辑结构、物理结构以及各种指南，相关组件（粒度最粗的子系统）的内部设计由组件高层设计提供。] [系统：指待开发产品的软件与硬件整体，其软件部分由各个子系统嵌套组成，子系统之间具有明确的接口； 组件：指粒度最粗的子系统； 模块：指组成组件的各层子系统，模块由下一层模块或函数组成；] [此文档的目的是： 1）描述产品的逻辑结构，定义系统各组件（子系统）之间的接口以及每个组件（子系统）应该实现的功能； 2）定义系统的各个进程以及进程之间的通信方式； 3）描述系统部署，说明用来部署并运行该系统的一种或多种物理网络（硬件）配置。对于每种配置，应该指出执行该系统的物理节点（计算机、网络设备）配置情况、节点之间的连 接方式、采用何种通信协议、网络带宽。另外还要包括各进程到物理节点的映射； 4）系统的整体性能、安全性、可用性、可扩展性、异常与错误处理等非功能特性设计； 5）定义该产品的各个设计人员应该遵循的设计原则以及设计指南，各个编程人员应该遵循的编码规范。 ] [建议架构设计工程师与组件设计工程师共同完成此文档。] [架构设计说明书的引言应提供整个文档的概述。它应包括此文档的目的、范围、定义、首字母缩写词、缩略语、参考资料和概述。]
框架结构体系结构设计 第一章建筑设计 1.1 设计资料 建筑设计使用年限50年。年均气温27.6度，最高气温39度，最低气温4.3度。东北风为主导风向，基本风压0.35kN/m2，基本雪压0kN/m2。年降雨量1002.3mm，最大雨量135.6mm/d。 拟建建筑场地已经人工填土平整，地形平坦，地面高程为2.4m。土质构成自地表向下依次为： ①杂填土：厚度约为0.6m，承载力特征值fak=85kPa，天然重度16.2kN/m2。 ②灰色粘土：厚度约为1.8m，承载力特征值fak=120kPa，天然重度18.4kN/m2。 ③褐色粉质粘土：厚度约为1.6m，少量粉砂，含粘粒，饱和，松散稍密状。承载力特征值fak=220kPa，天然重度19.4kN/m2。 ④中砂：厚度约为6.7m，以中粗砂为主，饱和，属密实状态，承载力特征值为240kPa，工程地质性质良好，可作为持力层。 场地地下水水位高程约为2.3m。经取水样进行水质分析，判定该地下水对混凝土无侵蚀性。经地质勘察部门确定，场地地震基本烈度为7度，设计基本地震的加速度为0.1g，框架抗震等级为三级。建筑场地为Ⅱ类，设计地震分组为第三组，场地特征周期为0.45s。梁、板、柱的混凝土均选用C30，梁、柱主筋选用HRB400，箍筋选用HPB300，板受力钢筋选用HRB335。 1.2 建筑设计方案 一个设计应满足到适用、耐久、美观三大要求。首先，应考虑场地的环境、使用功能、结构施工、材料设备、建筑经济及建筑艺术等问题，同时，还应考虑建筑与结构，建筑与各种设备等相关技术的综合协调，以及如何以更少的材料、劳动力、投资和时间来实现各种要求。该工程为多层住宅楼，根据设计任务书的要求，该住宅楼层 m左右。 数为6层，建筑面积47002 1.3 结构设计说明 本工程采用 ，框架抗震等级为三级。本工程耐火等级为二级，其建筑构件的耐火极限及燃烧性能均按民用建筑设计规范执行.全部图纸尺寸除标高以米为单位外均以毫米为单位。本工程结构图中所注标高均为结构标高。
[XX模块] 软件详细设计说明书 (仅供内部使用) 版权所有侵权必究文件修改记录 目录
1 目的 5 2 代码框架描述 5 2.1 目录结构 5 2.2 源文件说明 5 2.3 模块配置文件说明 5 3 数据结构 6 3.1 数据结构定义 6 3.2 数据结构关系图（可选） 6 3.3 公共头文件定义 6 4 子模块（实体）1详细设计说明 6 4.1 数据结构 7 4.2 处理流程详细说明 7 4.3 编码设计 7 4.3.1 函数1 7 4.3.2 函数2 8 4.3.n 函数n 8 5 子模块（实体）2详细设计说明 8
6 附录子系统定义表 8 软件详细设计说明书 关键词: 摘要: 缩略语说明： 参考资料： 列出本文档的所有参考文献（包括：正式/非正式出版物、公司/部门文档等），格式如下： 作者＋书名（或杂志、文献、文档）＋出版社（或期号、卷号、公司文档编号）＋出版日期 模板使用说明： [1]注明可选的部分，可以根据实际情况选择是否填写；如果不必说明，请务必保留相关的章节标题，同时在该可选章节的内容中填入“无”；未注名可选的，则必须描述；如果有些设计此模版中没有合适的地方填写，则补充在最后的其他栏目中
[2]模版中斜体字相当于撰写指南，最后文稿请将本模板中所有的斜体字部分全部删除。 [3]模板里并不说明设计技术和方法，而只是说明应包含哪些内容，以及如何描述、组织这些内容。 [4]对于移植的代码，描述可以相对简单一些，但以下这些章节不能省略：代码框架描述、第3节可以简写，第4节可以根据项目实际情况简写 1 目的 阐明编写详细设计说明书的目的 2 代码框架描述 本部分描述系统的源代码分布框架，说明源代码存放的目录结构、各源文件的功能。总体设计中有一个开发视图，这一部分就是对总体设计中开发视图的进一步细化。 2.1 目录结构 说明系统源代码文件存放的目录、子目录，及其包含的文件列表。如下： 2.2 源文件说明 如下表格式对系统包含的源代码文件进行大致说明：
归一大数据平台 数据仓库 系统设计说明书受控不受控
修改变更记录：
目录 1引言 (5) 1.1文档编制目的 (5) 1.2背景 (6) 1.3词汇表 (6) 1.4参考资料 (6) 2总体设计 (7) 2.1软件体系结构 (7) 2.2系统运行体系......................................................................... 错误！未定义书签。 2.2.1运行体系图..................................................................... 错误！未定义书签。 2.2.2程序/模块对应表............................................................ 错误！未定义书签。 2.3系统物理结构 (7) 2.4技术路线 (8) 3系统接口设计 (8) 3.1用户接口 (8) 4子系统/模块设计 (8) 4.1数据仓库 (8) 4.1.1ODL(操作数据)层设计 (8) 4.1.2BDL(数据仓库)层设计 (10) 4.1.3IDL(宽表)层设计 (11) 4.1.4PDL(应用)层设计 (12) 4.1.5PUB(维度)层设计 (15) 4.1.6数据导出设计 (16) 5数据结构与数据库设计 (17) 6外部存储结构设计 (17) 7故障处理说明 (17) 8尚需解决的问题 (18)
编写指南： 本模板力图给出系统设计阶段可能包括的基本信息，重点在于和需求分析文档相联系。描述系统整体情况。如果某个章节在项目或当前阶段中无法描述，则可保留其标题，注明“不
软件体系结构设计说明书1.文档简介 [本节主要是描述软件体系结构设计说明书的目的、范围、相关术语、参考资料和本文档的摘要性介绍。软件体系结构设计属于高层设计文档，是符合现代软件工程要求的概要设计。] 1.1 目的 [软件体系结构设计说明书，将从设计的角度对系统进行综合的描述，使用不同的视图来描述其不同方面。在本小节中，将对该文档的结构进行简要的说明，明确该文档针对的读者群，指导他们正确的地使用该文档。] 1.2 范围 [说明该文档所涉及的内容范围，以及将影响的内容。] 1.3 定义、首字母缩写词和缩略语 [与其它文档一样，该文档也需要将本文档中所涉及的所有术语、缩略语进行详细的定义。还有一种可简明的做法，就是维护在一个项目词汇表中，这样就可以避免在每个文档中都重复很多内容。] 1.4参考资料 [在这一小节中，应完整地列出该文档引用的所有文档。对于每个引用的文档都应该给出标题、标识号、日期以及来源，为阅读者查找这些文档提供足够详细的信息。] 1.5 概述 [在本小节中，主要是说明软件体系结构设计说明书各个部分所包含的主要内容，就像一个文章摘要一样。同时也应该对文档的组织方式进行解释。]
2. 体系结构表示方式 [本节说明软件体系结构在当前系统中的作用及其表示方式。它将列举其所必需的用例视图、逻辑视图、进程视图、部署视图或实施视图，并分别说明这些视图包含哪些类型的模型元素。] 3. 软件体系结构的目标和约束 [本节说明对软件体系结构具有某种重要影响的软件需求和用户目标，例如，系统安全性、保密性、第三方组件的使用、可移植性、发布和重新使用。它还要记录可能适用的特殊约束：设计与实施策略、开发工具、团队结构、时间表、遗留系统等。] 4.用例视图 [本节使用用例分析技术所生成的系统用例模型，描述其中的一些用例或场景。在该模型中纳入用例或场景，应该是系统中最重要、最核心的功能部分。] [另外，在本节中还应该选择一个主要的用例，对其进行描述与解释，以帮助读者了解软件的实际工作方式，解释不同的设计模型元素如何帮助系统实现。] 5. 逻辑视图 [逻辑视图主要是反映系统本质的问题领域类模型，在逻辑视图中将列出组成系统的子系统、包。而对每个子系统、包分解成为一个个类，并说明这些关键的实体类的职责、关系、操作、属性。这也是OO思想的体现，以类、类与类之间的协作、包、包与包之间的协作模型来表达系统的逻辑组织结构。]
面向服务的软件体系架构总体设计分析 计算机技术更新换代较为迅速，软件开发也发生较多改变，传统软件开发体系已经无法满足当前对软件生产的需求。随着计算机不断普及，软件行业必须由传统体系向面向服务架构转变。随着软件应用范围不断增大，难度逐渐上升，需要通过成本手段，提高现有资源利用率。通过面向服务体系结构可提高软件行业应对敏捷性，实现软件生产的规模化、产业化、流水线化。 1 软件危机的表现 1.1 软件成本越来越高 计算机最初主要用作军事领域，其软件开发主要由国家相关部分扶持，因此无需考虑软件开发成本。随着计算机日益普及，计算机已经深入到人们生活中，软件开发大多面向民用，因此软件开发过程中必须考虑其开发成本，且计算机硬件成本出现跳水现象，由此导致软件开发成本比例不断提升。 1.2 开发进度难以控制 软件属于一种智力虚拟产品，软件与其他产品最大不同是其存在前提为内在逻辑关系。相较于计算机硬件粗生产情况，传统工作中的加班及倒班无法应用到软件开发中，提升软件开发进度无法通过传统生产方法实现。且在软件开发过程中会出现一些意料不到的因素，影响软件开发流程，导致软件开发未按照预期计划展开。由此可见不仅软件项目开发难度不断增加，软件系统复杂复杂性也不断提升，即使增加
开发人手也未必能取得良好效果。 1.3 软件质量难以令人满意 软件开发另一常见问题就是在软件开发周期内将产品开发出来，但软件本身表现出的性能却未达到预期目标，难以满足用户多方位需求。该问题属于软件行业开发通病，当软件程序出现故障时会导致巨大损失。在此过程中软件开发缺乏有效引导，开发人员在开发过程中往往立足于自身想法展开软件开发，因此软件开发具有较强主观性，与客户想法不一致，因此导致软件产品质量难以让客户满意。 1.4 软件维护成本较高 与硬件设施一样，软件在使用过程中需要对其进行维护。软件被开发出来后首先进行公测，发现其软件存在的问题，并对其重新编辑提升软件性能，从而为客户提供更好服务。其次软件需要定时更新，若程序员在开发过程中并未按照相关标准执行会导致其缺乏技术性文档，提升软件使用过程中的维护难度。另外在新增或更新软件过程中可能导致出现新的问题，影响软件正常使用，并可能造成新的问题。由此可见软件开发成功后仍旧需要花费较高成本进行软件维护。 2 面向服务体系架构原理 2.1 面向服务体系架构定义 面向服务体系构架从本质上是一种应用体系架构，体系所有功能均是一种独立服务，所有服务均通过自己的可调用接口与程序相连，因此可通过服务理论实现相关服务的调动。面向服务体系构架从本质上来说就是为一种服务，是服务方通过一系列操作后满足被服务方需求的
软件详细设计说明书（例） 作者： 完成日期： 签收人： 签收日期： 修改情况记录：
目录 1 引言 (4) 1.1 编写目的 (4) 1.2 范围 (5) 1.3 定义 (5) 1.4 参考资料 (5) 2 总体设计 (6) 2.1 需求规定 (6) 2.2 运行环境 (6) 2.3 基本设计概念和处理流程 (8) 2.4 结构 (10) 2.5 功能需求与程序的关系 (13) 2.6 人工处理过程 (16) 2.7 尚未解决的问题 (16) 3 接口设计 (16) 3.1 用户接口 (16) 3.2 外部接口 (17) 3.3 内部接口 (18) 4 运行设计 (21) 4.1 运行模块组合 (21) 4.2 运行控制 (22)
4.3 运行时间 (22) 5 系统数据结构设计 (23) 5.1 逻辑结构设计要点 (23) 5.2 物理结构设计要点 (1) 5.3 数据结构与程序的关系 (5) 6 系统出错处理设计 (5) 6.1 出错信息 (6) 6.2 补救措施 (6) 6.3 系统维护设计 (6)
1 引言 1.1 编写目的 随着证券交易电子化程度的不断提高，券商对于各种业务提出了新的要求，为了满足券商的发展需求，更好的为客户提供服务，现结合原有各版本的证券交易软件的优点和特点，开发一套采用Client/Server结构的证券交易软件管理系统（SQL版）。本系统从底层予以优化，使整个系统的运行速度得到较大提高，通过重新优化数据库内部结构，使系统的可扩充性得到极大提高。 本说明书给出SQL版证券交易系统的设计说明，包括最终实现的软件必须满足的功能、性能、接口和用户界面、附属工具程序的功能以及设计约束等。 目的在于： ?为编码人员提供依据； ?为修改、维护提供条件； ?项目负责人将按计划书的要求布置和控制开发工作全过程； ?项目质量保证组将按此计划书做阶段性和总结性的质量验证和确认。 本说明书的预期读者包括： ?项目开发人员，特别是编码人员； ?软件维护人员； ?技术管理人员； ?执行软件质量保证计划的专门人员； ?参与本项目开发进程各阶段验证、确认以及负责为最后项目验收、鉴定提供相应报告的有关人员。 ?合作各方有关部门的复杂人；项目负责人和全体参加人员。
编号：_________________ 版本：_________________ <系统名称> 详细设计说明书 委托单位: 承办单位: 编写:(签名)_________________年月日 复查:(签名)_________________年月日 批准:(签名)_________________ 年月日
目录 第1章引言 (1) 1.1编写目的 (1) 1.2系统说明 (1) 1.3术语 (1) 1.4参考资料 (1) 第2章软件结构 (2) 2.1软件结构图 (2) 2.2模块子结构图 (2) 2.3模块清单 (2) 第3章模块设计 (3) 3.1模块1 （标识符） (3) 3.1.1模块概述 (3) 3.1.2功能和性能（1、功能 2、性能） (3) 3.1.2.1（标识符）功能（ＩＰＯ图） (3) 3.1.2.2性能 (3) 3.1.3输入/输出项 (3) 3.1.3.1输入项 (3) 3.1.3.2输出项 (3) 3.1.4数据结构 (3) 3.1.4.1全局数据结构 (4) 3.1.4.2局部数据结构 (4) 3.1.5算法 (4) 3.1.6限制条件 (4) 3.1.7测试计划 (4) 3.2模块2 (4)
第1章引言 1.1编写目的 软件详细设计说明书的一般编写目的可直接引用下面一段话：“说明一个软件系统各个层次中的每个程序（每个模块或子程序）的设计考虑。”当然，作者可包含一些与问题相关的特殊目的，附于上述一段话的尾部 1.2系统说明 任务提出单位： 开发单位： 预期用户： 1.3术语 序号术语说明性定义 ＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿ 1.4参考资料 1
系统软件详细设计说明书 1.引言 1.1编写目的 本详细设计说明书是针对网络信息体系结构的课程作业而编写。目的是对该项目进行详细设计，在概要设计的基础上进一步明确系统结构，详细地介绍系统的各个模块，为进行后面的实现和测试作准备。本详细设计说明书的预期读者为本项目小组的成员以及对该系统感兴趣，在以后想对系统进行扩展和维护的人员。 2. 系统的结构 ●ui：系统界面部分，负责接受用户输入，显示系统输出，负责其他模块功能的协调调用， 并含有站搜索功能，即在用户指定的已打开的ftp站点中搜索用户需要的资源。ui部分调用common部分的功能读取xml文件中保存的界面元素属性信息，用户最近访问过的10个ftp信息，用户选择的下载的ftp容列表及其他需要通过xml文件保存的信息。 ●client：实现ftp客户端的功能，ftp连接，ftp上传及下载：上传或下载用户指定的资源， 并返回相应的信息。
●search:资源实时检索部分，根据用户输入的资源名称关键字，资源类型和选择的检索方 式检索用户需要的资源，并验证资源的可用性，返回可用资源及其大小，速度等相关信息。 ●preview：资源预览部分，显示用户选择的资源的部分容，以使用户决定是否需要该资 源。preview部分调用common部分读取属性文件的容亦显示预览资源容的显示格式。3．模块1（ui）设计说明 3.1模块描述 实现用户界面的包，含有11个文件51个类，是本系统中最复杂的代码。 3.2功能 负责接受用户输入，显示系统输出，其他模块功能的协调调用，并含有站搜索功能，即在用户指定的已打开的ftp站点中搜索用户需要的资源。 3.3交互的模块 client，search，preview，common。 3.4 模块设计 该模块中的主要文件，文件中包含的主要类及其功能和与其它包的交互如下： ●MainFrame.java：MainFrame是含有主函数的类，也是lyra客户端开始执行的类， 它先后进行资源的初始化，显示主界面等工作，根据屏幕大小设置界面大小，设置界面的观感。 ●FtpFrame_AboutBox.java:显示关于窗口的类，当用户点击帮助菜单中的关于菜单 项时会弹出关于对话框。 ●Tools.java：FileTools是文件操作辅助类，可以实现文件的递归删除等。 ●XMLController.java: JDOMTes是操作xml文件的类，用JDOM来操作xml文件， 实现的功能有： （1）保存ftp服务器的文件列表（站搜索时使用），递归的从ftp服务器读取列表，并存入一个xml文件中（文件的命名方法是：ip+用户名.xml）;以目录树的形式保存。 （2）根据文件名在文件中查找文件，站搜索时使用。 （3）保存ftp服务器的信息：ip，端口（默认端口21不保存），用户名（默认anonymous 不保存），密码，最多存10个；存在resource\settings\ serversinfor.xml文件中。 （4）读取已存储的ftp服务器信息。 （5）从type.xml读取搜索的类型。 ●Constants.java:放置系统运行时使用的一些常量，initcontent（）函数对所有常量进 行初始化，这个函数在MainFrame中被调用一次。iconHashMap是hash表，用于存放文件的系统图标。 ●CustomizedController.java：包含自定义的控件类，java中的控件可能不能满足需求， 需要自己定义某些属性。这些控件会在创建界面时使用。其中含有的类有： （1）CustomizedJTable 是表格类，设置表格的某些属性，如字体等。 （2）CustomizedTableCellRenderer是表格单元格绘制器类，主要用于显示文件的系统图标，和文件名。 （3）LeftPanel类的父类是JTabbedPane，用户显示主窗口左边的面板。 （4）RightPanel类的父类是JPanel，用户显示右边的主题部分，包括右上边的搜索及服务器选项，和中间的显示服务器文件的TabbedPane。. （5）BottomPanel类是右下放显示下载和服务器信息的JTabbedPane。
软件(结构)设计说明(SDD) 说明： 1.《软件(结构)设计说明》(SDD)描述了计算机软件配置项(CSCI的设计。它描述了CSCI级设计决策、CSCI体系结构设计(概要设计)和实现该软件所需的详细设计。SDD可用接口设计说明IDD和数据库(顶层)设计说明DBDD加以补充。 2.SDD连同相关的IDD和DBDD是实现该软件的基础。向需方提供了设计的可视性，为软件支持提供了所需要的信息。 3.IDD和DBDD是否单独成册抑或与SDD合为一份资料视情况繁简而定。
目录 软件(结构)设计说明(SDD) (1) 1引言 (3) 1.1标识 (3) 1.2系统概述 (3) 1.3文档概述 (3) 1.4基线 (3) 2引用文件 (3) 3 CSCI级设计决策 (3) 4 CSCI体系结构设计 (4) 4.1体系结构 (4) 4.1.1程序(模块)划分 (4) 4.1.2程序(模块)层次结构关系 (4) 4.2全局数据结构说明 (4) 4.2.1常量 (4) 4.2.2变量 (4) 4.2.3数据结构 (5) 4.3 CSCI部件 (5) 4.4执行概念 (5) 4.5接口设计 (6) 4.5.1接口标识与接口图 (6) 5 CSCI详细设计 (7) 6需求的可追踪性 (8) 7注解 (8) 附录 (8)
1引言 1.1标识 本条应包含本文档适用的系统和软件的完整标识。(若适用)包括标识号、标题、缩略词语、版本号、发行号。 1.2系统概述 本条应简述本文档适用的系统和软件的用途。它应描述系统与软件的一般性质；概述系统开发、运行和维护的历史；标识项目的投资方、需方、用户、开发方和支持机构；标识当前和计划的运行现场；并列出其他有关文档。 1.3文档概述 本条应概述本文档的用途与内容，并描述与其使用有关的保密性或私密性要求。 1.4基线 说明编写本系统设计说明书所依据的设计基线。 2引用文件 本章应列出本文档引用的所有文档的编号、标题、修订版本和日期。本章也应标识不能通过正常的供货渠道获得的所有文档的来源。 3 CSCI级设计决策 本章应根据需要分条给出CSCI级设计决策，即CSCI行为的设计决策(忽略其内部实现，从用户的角度看，它如何满足用户的需求)和其他影响组成该CSCI的软件配置项的选择与设计的决策。 如果所有这些决策在CSCI需求中均是明确的，或者要推迟到CSCI的软件配置项设计时指出，本章应如实陈述。为响应指定为关键性的需求(如安全性、保密性、私密性需求)而作出的设计决策，应在单独的条中加以描述。如果设计决策依赖于系统状态或方式，则应指出这种依赖性。应给出或引用理解这些设计所需的设计约定。CSCI级设计决策的例子如下： a.关于CSCI应接受的输入和产生的输出的设计决策，包括与其他系统、HWCI, CSCI和用户的接口(本文的4.5.x标识了本说明要考虑的主题)。如果该信息的部分或全部已在接口设计说
<集团公司管理系统> 详细设计说明书 版本 <1.2>
修订历史记录 1．引言 1.1编写目的 在前一阶段（概要设计说明书）中，已解决了实现该系统需求的程序模块设计问题。包括如何把该系统划分成若干个模块、决定各个模块之间的接口、模块之间传递的信息，以及数据结构、模块结构的设计等。在以下的详细设计报告中将对在本阶段中对系统所做的所有详细设计进行说明。
在本阶段中，确定应该如何具体地实现所要求的系统，从而在编码阶段可以把这个描述直接翻译成用具体的程序语言书写的程序。主要的工作有：根据在《需求分析说明书》中所描述的数据、功能、运行、性能需求，并依照《概要设计说明书》所确定的处理流程、总体结构和模块外部设计，设计软件系统的结构设计、逐个模块的程序描述（包括各模块的功能、性能、输入、输出、算法、程序逻辑、接口等等）。 在以下的各个阶段中，《用户操作手册》将与本阶段的工作紧密结合，努力作到让用户易懂易学。系统的测试和维护也将参考本说明书，检验本系统的各项性能指标，及时发现纰漏及时修补，一定要把功能强大、稳定可靠、便于维护的集团公司管理系统交到用户手中。 1.2项目背景 本项目（集团公司管理系统），由《青春三人组开发小组》负责开发。 本集团公司管理系统系统项目主要由两部分形成： 1.登陆界面； 2.各部门操作界面。 1.3术语定义 1.Oracle: 系统服务器所使用的数据库管理系统（DBMS）。 2.SQL: 一种用于访问查询数据库的语言。 3.主键：数据库表中的关键域，值互不相同。 4.Tomcat: Functions as a servlet container developed under the Jakarta Project at the Apache Software Foundation. Tomcat implements the servlet and the JavaServer Pages (JSP) specifications from Sun Microsystems. It's considered to be an application server. 1.4参考资料 a.项目开发计划； b.需求分析说明书； c.概要设计说明书； d.测试计划（初稿）； e.用户操作手册（初稿）； f.《Java2入门经典》 g.《Java 程序设计技巧与开发实例》