[发明专利]一种基于流程和函数的轻量化契约式软件开发方法

说明书

本发明提供一种基于流程和函数的轻量化契约式软件开发方法，包括步骤S1：产品经理逐层分解业务，填写各个业务的描述，形成业务分类树；项目经理和架构师在业务分类树的节点下设计业务流程图；业务分类树和业务流程图导出文档，形成软件的业务契约；步骤S2：架构师将业务流程图中的各个功能点使用函数来定义输入输出接口；函数接口及其描述可视化展示以及导出文档，形成软件的技术契约；开发人员基于软件的技术契约，利用工具自动化产生函数的实现代码框架；本发明可以看到代码中的流程和业务是否准确实现，准确理解业务需求，遵循业务契约完成编码，保证开发人员实现的功能点能够满足设计要求。

技术领域

本发明属于软件工程技术领域，主要解决软件开发中业务到代码的可跟踪性问题。一种基于流程和函数的轻量化契约式软件开发方法，基于函数和流程等现代编程模式，通过注解手段添加业务跟踪信息，形成代码中的业务契约的和技术契约，保障客户、产品经理、项目经理在业务的理解的一致性，以及架构师和开发人员技术理解上的一致性。

背景技术

在软件开发中，客户常常在业务流程理解上存在偏差，造成返工。项目经理和开发人员也常常在技术理解上的不一致，造成无效的代码编写。其中主要原因是由于从业务到代码缺乏可跟踪性造成。在开发过程中，通常使用文档、UML图等描述需求和设计，而使用代码来编写功能点和业务流程，代码和文档之间缺乏必要的跟踪，造成客户在软件交付前，难以看到实际开发的功能和流程是否满足要求。产品经理也难以看到代码是否正确无误地完成来所需的功能和流程。

契约式开发的思想是通过准确无二义的业务或技术约束，来保证程序接口和实现正确性。通常需要在代码中通过编写前置后置条件、以及添加一致性检测的注解信息来保证设计和实现的功能相符。因此，可以解决架构师和开发人员之间的理解不一致问题。然而，严格的契约式开发需要形式化方法的支持，对人员素质要求很高，并且通常只能解决设计与实现的可跟踪性，而无法解决业务、设计、实现三者的可跟踪性。

发明内容

为有效解决业务、设计、实现三者的一致性和可跟踪性，减少软件开发的参与各方的沟通成本，本发明提出了一种基于流程和函数的轻量化契约式软件开发方法。该方法在软件开发中定义了两类契约：

1）业务契约：客户、项目/产品经理以流程作为契约。产品经理可以分解业务，形成业务概览图。项目经理可以在业务概览图的各个业务模块下设计流程（使用基本的Java代码编写流程代码，无需实现细节），软件工具可以逆向生成业务流程图。基于业务概览图和业务流程图，项目/产品经理可以与客户之间进行业务确认。

2）技术契约：项目经理/架构师和开发人员间以函数作为技术契约。函数定义了流程中某个功能点需要实现的功能，定义了输入输出的格式。函数接口一般是架构师设计处理的，项目经理和使用函数结构构造流程，并生成实现代码框架。开发人员在代码框架中填写代码来实现函数功能。

本发明具体的技术方案为：

一种基于流程和函数的轻量化契约式软件开发方法，包括以下步骤：

步骤S1：产品经理逐层分解业务，填写各个业务的描述，形成业务分类树；项目经理和架构师在业务分类树的节点下设计业务流程图；业务分类树和业务流程图导出文档，形成软件的业务契约；

进一步的，步骤S1包括以下子步骤：

S1.1、产品经理使用开发工具，逐层分解业务，形成的业务分类树；业务分类树以YAML文件形式，存放在项目源代码目录下；开发工具可以读取和可视化展示该业务分类树，查看各个业务的描述；

S1.2、项目经理和架构师使用代码直接编写业务流程，代码在工具中逆向生成业务流程图；业务流程图可以调用函数，每个函数在流程中是一个功能点；流程也可以调用业务内其他流程，进行流程组合；

S1.3、在代码中，使用FLow注解机制来为流程添加管理和描述信息，这些描述信息能够在工具中可视化展示和浏览。