一种基于UML序列图的软件接口调试指导方法

摘要

本发明一种基于UML序列图的软件接口调试指导方法，包括：应用统一建模语言UML序列图进行接口调试的工作记录，制作接口调试交互序列图；对记录接口交互细节的序列图和接口调试工作成果进行定性或定量的评估。通过本发明提供的应用于系统建设的后期的基于UML序列图的软件接口调试指导方法提高软件接口调试，尤其是大规模网络软件接口调试的工作效率和意义作用明显，对系统上线和接口安装调试阶段，采用此方法进行相应的工作指导和工作成果记录，在软件接口调试-这一特定软件生命周期对其进行保护，有利于软件全寿期的运行维护参考。

说明书

技术领域

本发明涉及系统控制技术领域，特别涉及一种基于UML序列图的软件接 口调试指导方法。

背景技术

统一建模语言(UML)是非专利的第三代建模和规约语言。UML是在开发 阶段，说明，可视化，构建和书写一个面向对象软件密集系统的制品的开放 方法。UML展现了一系列最佳工程实践，这些最佳实践在对大规模，复杂系统 进行建模方面，特别是在软件架构层次已经被验证有效。UML作为一种模型语 言，它使开发人员专注于建立产品的模型和结构，而不是选用什么程序语言 和算法实现。当模型建立之后，模型可以被UML工具转化成指定的程序语言代 码。

UML是一种定义良好、易于表达、功能强大且普遍适用的建模语言。它溶 入了软件工程领域的新思想、新方法和新技术。它的作用域不限于支持面向 对象的分析与设计，还支持从需求分析开始的软件开发的全过程。UML是一个 标准的图形表示法，它不是面向对象的分析和设计，也不是一种方法，它仅 仅是一组符号而已。

首先，UML融合了Booch、OMT和OOSE方法中的基本概念，而且这些基本 概念与其他面向对象技术中的基本概念大多相同，因而，UML必然成为这些方 法以及其他方法的使用者乐于采用的一种简单一致的建模语言；其次，UML不 仅仅是上述方法的简单汇合，而是在这些方法的基础上广泛征求意见，集众 家之长，几经修改而完成的，UML扩展了现有方法的应用范围；第三，UML是 标准的建模语言，而不是标准的开发过程。尽管UML的应用必然以系统的开 发过程为背景，但由于不同的组织和不同的应用领域，需要采取不同的开发 过程。

作为一种建模语言，UML的定义包括UML语义和UML表示法两个部分。

(1)UML语义描述基于UML的精确元模型定义。元模型为UML的所有元 素在语法和语义上提供了简单、一致、通用的定义性说明，使开发者能在语 义上取得一致，消除了因人而异的最佳表达方法所造成的影响。此外UML还 支持对元模型的扩展定义。

(2)UML表示法定义UML符号的表示法，为开发者或开发工具使用这些 图形符号和文本语法为系统建模提供了标准。这些图形符号和文字所表达的 是应用级的模型，在语义上它是UML元模型的实例。

标准建模语言UML的重要内容可以由下列五类图(共9种图形)来定义：

第一类是用例图，从用户角度描述系统功能，并指出各功能的操作者。

第二类是静态图(Static diagram)，包括类图、对象图和包图。其中类 图描述系统中类的静态结构。不仅定义系统中的类，表示类之间的联系如关 联、依赖、聚合等，也包括类的内部结构(类的属性和操作)。类图描述的是 一种静态关系，在系统的整个生命周期都是有效的。

对象图是类图的实例，几乎使用与类图完全相同的标识。他们的不同点 在于对象图显示类的多个对象实例，而不是实际的类。一个对象图是类图的 一个实例。由于对象存在生命周期，因此对象图只能在系统某一时间段存在。 包由包或类组成，表示包与包之间的关系。包图用于描述系统的分层结构。

第三类是行为图(Behavior diagram)，描述系统的动态模型和组成对象 间的交互关系。其中状态图描述类的对象所有可能的状态以及事件发生时状 态的转移条件。通常，状态图是对类图的补充。在实用上并不需要为所有的 类画状态图，仅为那些有多个状态其行为受外界环境的影响并且发生改变的 类画状态图。

而活动图描述满足用例要求所要进行的活动以及活动间的约束关系，有 利于识别并行活动。

第四类是交互图(Interactive diagram)，描述对象间的交互关系。其 中顺序图显示对象之间的动态合作关系，它强调对象之间消息发送的顺序， 同时显示对象之间的交互；合作图描述对象间的协作关系，合作图跟顺序图 相似，显示对象间的动态合作关系。除显示信息交换外，合作图还显示对象 以及它们之间的关系。如果强调时间和顺序，则使用顺序图；如果强调上下 级关系，则选择合作图。这两种图合称为交互图。

第五类是实现图(Implementation diagram)。其中构件图描述代码部 件的物理结构及各部件之间的依赖关系。一个部件可能是一个资源代码部件、 一个二进制部件或一个可执行部件。它包含逻辑类或实现类的有关信息。部 件图有助于分析和理解部件之间的相互影响程度。

配置图定义系统中软硬件的物理体系结构。它可以显示实际的计算机和 设备(用节点表示)以及它们之间的连接关系，也可显示连接的类型及部件 之间的依赖性。在节点内部，放置可执行部件和对象以显示节点跟可执行软 件单元的对应关系。

从应用的角度看，当采用面向对象技术设计系统时，首先是描述需求； 其次根据需求建立系统的静态模型，以构造系统的结构；第三步是描述系统 的行为。其中在第一步与第二步中所建立的模型都是静态的，包括用例图、 类图(包含包)、对象图、组件图和配置图等五个图形，是标准建模语言UML 的静态建模机制。其中第三步中所建立的模型或者可以执行，或者表示执行 时的时序状态或交互关系。它包括状态图、活动图、顺序图和合作图等四个 图形，是标准建模语言UML的动态建模机制。因此，标准建模语言UML的主要 内容也可以归纳为静态建模机制和动态建模机制两大类。

申请人在实施本发明的过程中发现：现有在软件接口调试阶段绝大多数 工作靠现场技术人员手工完成，基本没有软件接口调试的方法和工具，因此 软件接口的调试基本处于无据可循的局面，无指导方法和记录工具，如果出 现问题无据可查。因此存在以下问题：

1、现有该项工作处于原始的和整个IT发展不相协调的阶段；

2、也处于传统软件工程和软件生命周期管理的薄弱环节；

3、接口调试正确与否，关系到系统间能否正常工作，关系重大，尤其 对于复杂的大规模系统，如电视台的全台网系统，因此这项工作确实需要评 估、需要记录、具体工作需要方法指导，因此迫切需要一种得力方法和工具 应用于本领域。

发明内容

本发明提供一种基于UML序列图的软件接口调试指导方法，主要解决如下 技术问题：

1、UML序列图是一种需求分析和系统设计的工具，通常用于系统建设的 前期，本发明引用这种方法应用于系统建设的后期，对系统上线和接口安装 调试阶段，采用此方法进行相应的工作指导和工作成果记录；

2、使得原本在此阶段(接口调试阶段)较多依靠人为行为的工作，也有 规范系统工具可以采用。另外，对于此阶段经常出现的无序化、人为因素成 分大和无可靠的文档记录相应工作成果的现状，有了很大的改善；

3、作为一种被广泛认可的系统方法(UML)，规范性的语言表述和可普 遍被技术人员所接受的载体，不但可以在软件接口调试阶段，指导技术人员 工作，还具有通过此工具进行事前事后评估的有利一面，使原先工作中无据 可循、缺少方法和工具的状态得以改善。

4、序列图(Sequence Diagram)采用泳道图的类型，具有严谨的表述方 式，无论对于系统接口中，尤其是Webservice接口的同步调用或异步调用， 以及其它形式的自身函数调用，均可明晰清楚的表示出来，而且序列图带有 时间先后顺序的表述方法，因此是很贴切接口调试工作的一种工具。

本发明提供了一种基于UML序列图的软件接口调试方法，包括：

明确系统交互需要调试的接口，对每一个需要调试的接口应用序列图绘 出交互的细节；

对记录接口交互细节的序列图和接口调试工作成果进行定性或定量的评 估。

附图说明

为了更清楚地说明本发明实施例的技术方案，下面将对实施例描述中使 用的附图作简单地介绍，显而易见地，下面描述中的附图仅仅是本发明的一 些实施例，对于本领域普通技术人员来讲，在不付出创造性劳动的前提下， 还可以根据这些附图获得其他的附图。

图1为本发明实施例一种基于UML序列图的软件接口调试指导方法的流 程图；

图2为本发明实施例一种基于UML序列图的软件接口调试指导方法子网 与主干平台进行统一认证的接口调试交互序列图；

图3为本发明实施例一种基于UML序列图的软件接口调试指导方法子网 与主干平台进行用户和部门信息同步的接口调试交互序列图；

图4为本发明实施例一种基于UML序列图的软件接口调试指导方法子网 通过主干平台与总编室备播进行节目入库的接口调试交互序列图；

图5为本发明实施例一种基于UML序列图的软件接口调试指导方法子网 通过主干平台与总编室进行节目代码绑定的接口调试交互序列图；

图6为本发明实施例一种基于UML序列图的软件接口调试指导方法子网 通过主干平台与媒资系统进行节目素材入库的接口调试交互序列图。

具体实施方式

下面将结合本发明实施例中的附图，对本发明实施例中的技术方案进行 清楚、完整地描述，需要指出的是，所描述的实施例仅仅是本发明的一部分 实施例，而不是全部的实施例。基于本发明中的实施例，本领域普通技术人 员在没有做出创造性劳动前提下所获得的所有其他实施例，都属于本发明保 护的范围。

本发明实施例提供了一种基于UML序列图的软件接口调试指导方法，如 图1所示，包括：

S101，应用UML序列图进行接口调试的工作记录，制作接口调试交互序 列图。

具体步骤为：

S1011，明确系统交互要调试的接口；

S1012，对每一个要调试的接口，应用序列图绘制出交互的细节；

S1013，用泳道代表一个需要交互的系统；

S1014，用箭头指向表示一个接口函数或服务的调用；

S1015，通过泳道的分段清晰表示出同步或异步调用；

S1016，用箭头上方文字表示发出请求(Request)或接受响应(Response) 返回的函数或服务名。

通过步骤S1011-S1016制作出序列图2-6，对应的分别为子网与主干平台 进行统一认证的接口调试交互序列图、子网与主干平台进行用户和部门信息 同步的接口调试交互序列图、子网通过主干平台与总编室备播进行节目入库 的接口调试交互序列图、子网通过主干平台与总编室进行节目代码绑定的接 口调试交互序列图、子网通过主干平台与媒资系统进行节目素材入库的接口 调试交互序列图。

步骤S102，对记录接口交互细节的序列图和接口调试工作成果进行定性 或定量的评估。

具体步骤为：

步骤1021：首先，如步骤S101中绘制的序列图，系统接口间交互的详细 过程表露无遗漏；

步骤1022：对于每张图(对应一个接口)的接口名称、调试人、调试时 间、修改时间、图表绘制人等信息以标签的形式体现在图中，因此使得工作 可追溯，责任可到人，自动记录的时间信息有利于跟踪调试状态到某一个时 间点；

步骤1023：针对每一张序列图进行接口调试方法、状态、进度和问题的 讨论和评估，不但可以快速发现问题所在，同时也避免空谈或机房现场办公。

步骤1024：根据调试进展和调整每张序列图，发布不同版本；

步骤1025：接口全部调试完毕，整理所有图表，并记录在案，可作为正 式工作文档永久与项目其它技术文档一并保存；

步骤1026：对于系统在运行阶段发生的接口问题，可有助于技术人员远 程诊断问题所在，尤其对于与外网隔离的、无法进行远程管理的生产型网络 尤其有效。

本发明实施例提供的应用于系统建设的后期的基于UML序列图的软件 接口调试指导方法提高软件接口调试，尤其是大规模网络软件接口调试的工 作效率和意义作用明显，对系统上线和接口安装调试阶段，采用此方法进行 相应的工作指导和工作成果记录，在软件接口调试-这一特定软件生命周期对 其进行保护，有利于软件全寿期的运行维护参考。

通过以上的实施方式的描述，本领域的技术人员可以清楚地了解到本发 明可以通过硬件实现，也可以借助软件加必要的通用硬件平台的方式来实现。 本领域技术人员可以理解附图只是一个优选实施例的示意图，附图中的模块 或流程并不一定是实施本发明所必须的。本领域技术人员可以理解实施例中 的装置中的模块可以按照实施例描述进行分布于实施例的装置中，也可以进 行相应变化位于不同于本实施例的一个或多个装置中。上述实施例的模块可 以合并为一个模块，也可以进一步拆分成多个子模块。

上述本发明实施例序号仅仅为了描述，不代表实施例的优劣。以上公开 的仅为本发明的几个具体实施例，但是，本发明并非局限于此，任何本领域 的技术人员能思之的变化都应落入本发明的保护范围。