CN110633079A - 一种基于yaml语言的业务开发方法及系统 - Google Patents

Abstract

本发明实施例提供一种基于yaml语言的业务开发方法及系统，所述方法包括：根据用户的业务需求，通过解析yaml文件对所述业务需求进行描述；根据yaml文件中描述的路由，当判定用户访问请求所带的路由与yaml文件中描述路由匹配时，执行yaml文件中描述的业务插件；将业务插件的执行结果返回给用户。本技术方案采用描述性很强的yaml语言来定义服务的基本信息和执行流程，具有可读性强，易于理解，且可以推动工程代码复用性的增强，对于互联网服务开发有着实际有效的意义。

Description

一种基于yaml语言的业务开发方法及系统

技术领域

本发明属于业务开发领域，具体涉及一种基于yaml语言的业务开发方法及系统。

背景技术

目前互联网公司在web服务领域大多采用基于英文超级文本预处理语言php(Hypertext Preprocessor)的Laravel，thinkPHP，Yaf(Yet Another Framework)等开发框架，基于此类开发框架开发程序时，大多采用传统的模型-视图-控制器MVC(Model ViewController)开发模式来解耦业务代码，随着互联网业务的日渐复杂，也出现了MSVC(Microsoft Visual C++)等新的开发模式，后面统称MVC模式。

对于现有技术中MVC开发模式虽然一直被众多互联网公司采用，但它有四个明显的缺陷：

1、随着业务代码的迭代，控制器(C)层会逐步变得臃肿庞大而难以维护；

2、传统的MVC开发框架路由模式大多基于控制器名称和执行方法的名称，缺乏描述性，且各自独立，而不是在一个统一的位置进行定义；

3、近年新兴的Laravel框架虽然支持统一定义路由，但路由与业务逻辑实现完全分离，无法直接明了地总览一个服务接口的基本信息和处理流程；

4、在MVC开发模式下，大多都过度关注业务逻辑的实现，而忽略了代码的可复用性，从而降低了代码的可维护性，间接增加了软件迭代的风险。

发明内容

本发明实施例提供一种基于yaml语言的业务开发方法及系统，采用描述性很强的yaml语言来定义服务的基本信息和执行流程，具有可读性强，易于理解，且可以推动工程代码复用性的增强，对于互联网服务开发有着实际有效的意义。

为实现上述目的，一方面，本发明实施例提供了一种基于yaml语言的业务开发方法，所述方法包括：

根据用户的业务需求，通过解析yaml文件对所述业务需求进行描述；

根据yaml文件中描述的路由，当判定用户访问请求所带的路由与yaml文件中描述路由匹配时，执行yaml文件中描述的业务插件；

将业务插件的执行结果返回给用户。

另一方面，本发明实施例提供了一种基于yaml语言的业务开发系统，所述系统包括：

业务描述单元，用于根据用户的业务需求，通过解析yaml文件对所述业务需求进行描述；

业务执行单元，用于根据yaml文件中描述的路由，当判定用户访问请求所带的路由与yaml文件中描述路由匹配时，执行yaml文件中描述的业务插件；

结果返回单元，用于将业务插件的执行结果返回给用户。

上述技术方案具有如下有益效果：

本发明技术方案采用yaml定义服务信息和插件式的处理流程，与传统的mvc开发框架相比，本框架设计跳出了mvc模式的泥潭，采用描述性很强的yaml语言来定义服务的基本信息和执行流程，具有可读性强，易于理解；在定义业务处理流程时，采用插件的方式，能非常有效地让开发人员去关注代码的可复用性，插件化的开发方式会不停地督促开发人员对代码进行重构和优化，从而更大化的满足插件的可插拔以及高复用的特性；对于互联网服务开发有着实际有效的意义。

附图说明

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

图1是本发明实施例一种基于yaml语言的业务开发方法的流程图；

图2是本发明实施例一种基于yaml语言的业务开发方法的流程示意图；

图3是本发明实施例一种基于yaml语言的业务开发系统的示意图。

具体实施方式

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

如图1、2所示，是本发明实施例一种基于yaml语言的业务开发方法的流程图，所述方法包括：

S101、根据用户的业务需求，通过解析yaml文件对所述业务需求进行描述；

优选地，所述yaml文件对所述业务需求进行的描述如下：对业务需求的服务功能信息、服务所属的模块、路由、业务插件以及服务响应内容的格式化和返回分别进行描述，。

具体参见下表：

description	描述服务的功能信息等
		module	服务所属的模块
uri	统一资源标识符，用于路由
		method	服务请求方式，用于路由
process	定义至少一个处理业务流程的插件
		response	格式化服务响应内容并返回

具体地，通过yaml文件进行描述的数据实例如下：

description:"创建广告计划"

module:campaign

uri:/campaign/store

method:POST

process:

-

\App\Request\Filter\ParamInit

-

\App\Request\Plugin\AuthPlugin

-

\App\Request\Logic\StoreLogic

-

\App\Request\Convert\CampaignConvert

response:

handler:\App\Request\Handler\JsonResponseHandler

S102、根据yaml文件中描述的路由，当判定用户访问请求所带的路由与yaml文件中描述的路由匹配时，执行yaml文件中描述的业务插件；

优选地，通过以下步骤判定用户访问请求所带的路由与yaml文件中描述的路由匹配：

对比用户访问请求所带的统一资源标识符uri和服务请求方式method是否与yaml文件中描述的统一资源标识符uri和服务请求方式method是否一致，若一致，则判定用户访问请求所带的路由与yaml文件中描述的路由匹配，可执行下一步即执行业务插件；否则向用户抛出404异常。

优选地，yaml文件对业务插件的描述包括：

插件Filter用于前置的参数初始化；

插件Plugin用于核心且可复用的业务处理段；

插件Logic用于个性化的业务流程处理；

插件Convert用于业务处理之后的数据结构转换；并且，

根据不同的业务需求，在yaml文件中描述一个或者多个插件。

优选地，对yaml文件中描述的一个或者多个插件，通过由上而下逐个顺序执行来保证业务的正确性；以及，

采用全局context对象进行插件间的上下文传递，先执行的插件将后执行插件需要依赖的数据写入到context对象中供后执行的插件获取并使用；以此保证插件间上下文的传递和通信。

S103、将业务插件的执行结果返回给用户。

根据上游插件传递的将要返回的数据，将要返回的数据转换为实际用户侧所需要的数据协议格式，如json或xml，然后通过http响应给用户。

对应于上述方法，如图3所示，是本发明实施例一种基于yaml语言的业务开发系统的示意图，所述系统包括：

业务描述单元21，用于根据用户的业务需求，通过解析yaml文件对所述业务需求进行描述；

业务执行单元22，用于根据yaml文件中描述的路由，当判定用户访问请求所带的路由与yaml文件中描述的路由匹配时，执行yaml文件中描述的业务插件；

结果返回单元23，用于将业务插件的执行结果返回给用户。

优选地，所述业务描述单元21，具体用于：

对业务需求的服务功能信息、服务所属的模块、路由、业务插件以及服务响应内容的格式化和返回分别进行描述，所述路由包括统一资源标识符和服务请求方式。

优选地，所述业务执行单元22包括路由匹配判断模块，用于：

对比用户访问请求所带的统一资源标识符和服务请求方式是否与yaml文件中描述的统一资源标识符和服务请求方式是否一致，若一致，则判定用户访问请求所带的路由与yaml文件中描述的路由匹配。

优选地，所述业务描述单元21包括业务插件描述模块，用于对业务插件进行描述，包括：

插件Filter用于前置的参数初始化；

插件Plugin用于核心且可复用的业务处理段；

插件Logic用于个性化的业务流程处理；

插件Convert用于业务处理之后的数据结构转换；并且，

根据不同的业务需求，在yaml文件中描述一个或者多个插件。

优选地，所述业务执行单元22具体用于：

对yaml文件中描述的一个或者多个插件，通过由上而下逐个顺序执行；以及，

采用全局context对象进行插件间的上下文传递，先执行的插件将后执行插件需要依赖的数据写入到context对象中供后执行的插件获取并使用。

本发明采用描述能力很强的yaml语言来定义一个服务，通过这种方式，只需要阅读一个yaml文件，便可以看到服务的各项关键信息，包括服务的描述，所属模块，资源地址，请求方式，业务处理流程，响应处理等。在定义业务处理流程时，采用插件的方式，能非常有效地让开发人员去关注代码的可复用性，插件化的开发方式会不停地督促开发人员对代码进行重构和优化，从而更大化的满足插件的可插拔以及高复用的特性。

应该明白，公开的过程中的步骤的特定顺序或层次是示例性方法的实例。基于设计偏好，应该理解，过程中的步骤的特定顺序或层次可以在不脱离本公开的保护范围的情况下得到重新安排。所附的方法权利要求以示例性的顺序给出了各种步骤的要素，并且不是要限于所述的特定顺序或层次。

在上述的详细描述中，各种特征一起组合在单个的实施方案中，以简化本公开。不应该将这种公开方法解释为反映了这样的意图，即，所要求保护的主题的实施方案需要比清楚地在每个权利要求中所陈述的特征更多的特征。相反，如所附的权利要求书所反映的那样，本发明处于比所公开的单个实施方案的全部特征少的状态。因此，所附的权利要求书特此清楚地被并入详细描述中，其中每项权利要求独自作为本发明单独的优选实施方案。

为使本领域内的任何技术人员能够实现或者使用本发明，上面对所公开实施例进行了描述。对于本领域技术人员来说；这些实施例的各种修改方式都是显而易见的，并且本文定义的一般原理也可以在不脱离本公开的精神和保护范围的基础上适用于其它实施例。因此，本公开并不限于本文给出的实施例，而是与本申请公开的原理和新颖性特征的最广范围相一致。

上文的描述包括一个或多个实施例的举例。当然，为了描述上述实施例而描述部件或方法的所有可能的结合是不可能的，但是本领域普通技术人员应该认识到，各个实施例可以做进一步的组合和排列。因此，本文中描述的实施例旨在涵盖落入所附权利要求书的保护范围内的所有这样的改变、修改和变型。此外，就说明书或权利要求书中使用的术语“包含”，该词的涵盖方式类似于术语“包括”，就如同“包括，”在权利要求中用作衔接词所解释的那样。此外，使用在权利要求书的说明书中的任何一个术语“或者”是要表示“非排它性的或者”。

本领域技术人员还可以了解到本发明实施例列出的各种说明性逻辑块(illustrative logical block)，单元，和步骤可以通过电子硬件、电脑软件，或两者的结合进行实现。为清楚展示硬件和软件的可替换性(interchangeability)，上述的各种说明性部件(illustrative components)，单元和步骤已经通用地描述了它们的功能。这样的功能是通过硬件还是软件来实现取决于特定的应用和整个系统的设计要求。本领域技术人员可以对于每种特定的应用，可以使用各种方法实现所述的功能，但这种实现不应被理解为超出本发明实施例保护的范围。

本发明实施例中所描述的各种说明性的逻辑块，或单元都可以通过通用处理器，数字信号处理器，专用集成电路(ASIC)，现场可编程门阵列或其它可编程逻辑装置，离散门或晶体管逻辑，离散硬件部件，或上述任何组合的设计来实现或操作所描述的功能。通用处理器可以为微处理器，可选地，该通用处理器也可以为任何传统的处理器、控制器、微控制器或状态机。处理器也可以通过计算装置的组合来实现，例如数字信号处理器和微处理器，多个微处理器，一个或多个微处理器联合一个数字信号处理器核，或任何其它类似的配置来实现。

本发明实施例中所描述的方法或算法的步骤可以直接嵌入硬件、处理器执行的软件模块、或者这两者的结合。软件模块可以存储于RAM存储器、闪存、ROM存储器、EPROM存储器、EEPROM存储器、寄存器、硬盘、可移动磁盘、CD-ROM或本领域中其它任意形式的存储媒介中。示例性地，存储媒介可以与处理器连接，以使得处理器可以从存储媒介中读取信息，并可以向存储媒介存写信息。可选地，存储媒介还可以集成到处理器中。处理器和存储媒介可以设置于ASIC中，ASIC可以设置于用户终端中。可选地，处理器和存储媒介也可以设置于用户终端中的不同的部件中。

在一个或多个示例性的设计中，本发明实施例所描述的上述功能可以在硬件、软件、固件或这三者的任意组合来实现。如果在软件中实现，这些功能可以存储与电脑可读的媒介上，或以一个或多个指令或代码形式传输于电脑可读的媒介上。电脑可读媒介包括电脑存储媒介和便于使得让电脑程序从一个地方转移到其它地方的通信媒介。存储媒介可以是任何通用或特殊电脑可以接入访问的可用媒体。例如，这样的电脑可读媒体可以包括但不限于RAM、ROM、EEPROM、CD-ROM或其它光盘存储、磁盘存储或其它磁性存储装置，或其它任何可以用于承载或存储以指令或数据结构和其它可被通用或特殊电脑、或通用或特殊处理器读取形式的程序代码的媒介。此外，任何连接都可以被适当地定义为电脑可读媒介，例如，如果软件是从一个网站站点、服务器或其它远程资源通过一个同轴电缆、光纤电缆、双绞线、数字用户线(DSL)或以例如红外、无线和微波等无线方式传输的也被包含在所定义的电脑可读媒介中。所述的碟片(disk)和磁盘(disc)包括压缩磁盘、镭射盘、光盘、DVD、软盘和蓝光光盘，磁盘通常以磁性复制数据，而碟片通常以激光进行光学复制数据。上述的组合也可以包含在电脑可读媒介中。

以上所述的具体实施方式，对本发明的目的、技术方案和有益效果进行了进一步详细说明，所应理解的是，以上所述仅为本发明的具体实施方式而已，并不用于限定本发明的保护范围，凡在本发明的精神和原则之内，所做的任何修改、等同替换、改进等，均应包含在本发明的保护范围之内。

Claims (10)

1.一种基于yaml语言的业务开发方法，其特征在于，所述方法包括：

根据用户的业务需求，通过解析yaml文件对所述业务需求进行描述；

根据yaml文件中描述的路由，当判定用户访问请求所带的路由与yaml文件中描述的路由匹配时，执行yaml文件中描述的业务插件；

将业务插件的执行结果返回给用户。

2.如权利要求1所述的基于yaml语言的业务开发方法，其特征在于，所述yaml文件对所述业务需求进行的描述如下：

对业务需求的服务功能信息、服务所属的模块、路由、业务插件、以及服务响应内容的格式化和返回分别进行描述，所述路由包括统一资源标识符和服务请求方式。

3.如权利要求2所述的基于yaml语言的业务开发方法，其特征在于，通过以下步骤判定用户访问请求所带的路由与yaml文件中描述的路由匹配：

对比用户访问请求所带的统一资源标识符和服务请求方式与yaml文件中描述的统一资源标识符和服务请求方式是否一致，若一致，则判定用户访问请求所带的路由与yaml文件中描述的路由匹配。

4.如权利要求1-3之一所述的基于yaml语言的业务开发方法，其特征在于，对业务插件的描述包括：

插件Filter用于前置的参数初始化；

插件Plugin用于核心且可复用的业务处理段；

插件Logic用于个性化的业务流程处理；

插件Convert用于业务处理之后的数据结构转换；并且，

根据不同的业务需求，在yaml文件中描述一个或者多个插件。

5.如权利要求4所述的基于yaml语言的业务开发方法，其特征在于，对yaml文件中描述的一个或者多个插件，通过由上而下逐个顺序执行；以及，

采用全局context对象进行插件间的上下文传递，先执行的插件将后执行的插件需要依赖的数据写入到context对象中供后执行的插件获取并使用。

6.一种基于yaml语言的业务开发系统，其特征在于，所述系统包括：

业务描述单元，用于根据用户的业务需求，通过解析yaml文件对所述业务需求进行描述；

业务执行单元，用于根据yaml文件中描述的路由，当判定用户访问请求所带的路由与yaml文件中描述的路由匹配时，执行yaml文件中描述的业务插件；

结果返回单元，用于将业务插件的执行结果返回给用户。

7.如权利要求6所述的基于yaml语言的业务开发系统，其特征在于，所述业务描述单元，具体用于：

对业务需求的服务功能信息、服务所属的模块、路由、业务插件、以及服务响应内容的格式化和返回分别进行描述。

8.如权利要求7所述的基于yaml语言的业务开发系统，其特征在于，所述业务执行单元包括路由匹配判断模块，用于：

对比用户访问请求所带的统一资源标识符和服务请求方式与yaml文件中描述的统一资源标识符和服务请求方式是否一致，若一致，则判定用户访问请求所带的路由与yaml文件中描述的路由匹配。

9.如权利要求6-8之一所述的基于yaml语言的业务开发系统，其特征在于，所述业务描述单元包括业务插件描述模块，用于对业务插件进行描述，包括：

插件Filter用于前置的参数初始化；

插件Plugin用于核心且可复用的业务处理段；

插件Logic用于个性化的业务流程处理；

插件Convert用于业务处理之后的数据结构转换；并且，

根据不同的业务需求，在yaml文件中描述一个或者多个插件。

10.如权利要求9所述的基于yaml语言的业务开发系统，其特征在于，所述业务执行单元具体用于：

对yaml文件中描述的一个或者多个插件，通过由上而下逐个顺序执行；以及，

采用全局context对象进行插件间的上下文传递，先执行的插件将后执行的插件需要依赖的数据写入到context对象中供后执行的插件获取并使用。

Images