CN106559251B

CN106559251B - 一种基于yang模型的编译方法、及对应的接口、组件和系统

Info

Publication number: CN106559251B
Application number: CN201510642373.3A
Authority: CN
Inventors: 冯冲; 杜宝伟; 戴娴娴
Original assignee: ZTE Corp
Current assignee: ZTE Corp
Priority date: 2015-09-30
Filing date: 2015-09-30
Publication date: 2019-03-15
Anticipated expiration: 2035-09-30
Also published as: CN106559251A; WO2017054531A1

Abstract

本申请提出一种基于YANG模型的编译方法、及对应的接口、组件和系统，涉及网络通信技术领域，包括：获取待解析YANG文件；解析所述YANG文件获得对应的YANG模型；基于所述YANG模型生成对应的应用程序接口API数据。降低用户对NETCONF协议报文和YANG模型的专业知识的要求，减少不必要的手动配置设备的步骤，并降低用户开发维护成本。

Description

一种基于YANG模型的编译方法、及对应的接口、组件和系统

技术领域

本发明涉及网络通信技术领域，具体涉及一种基于YANG模型的编译方法、及对应的接口、组件和系统。

背景技术

随着网络规模的不断扩大，网络配置管理自动化、智能化的需求越来越迫切。软件定义网络(Software Defined Network，SDN)技术是解决方案之一。通过集中的SDN控制器实现网络资源的统一管理与整合后，采用规范化的北向接口为上层应用提供按需的网络资源及服务，实现网络能力开放。目前，NETCONF协议是可以满足以上的要求的协议之一，作为北向接口的通道存在。YANG是一种模型定义语言，对NETCONF协议操作的配置数据和管理数据进行建模。但是目前NETCONF报文下发，需要用户对NETCONF协议以及YANG建模语言非常精通或者网管侧需要对YANG模型进行硬编码，这样在多变的网络服务和不断变化的设备中是不灵活的。

发明内容

本发明为了解决配置网络设备不灵活、网管侧需要对YANG模型进行硬编码实现的问题，提供一种基于YANG模型的编译方法、及对应的接口、组件和系统。

为了实现上述发明目的，本发明采取的技术方案如下：

一种基于YANG模型的编译方法，包括：

获取待解析YANG文件；

解析所述YANG文件获得对应的YANG模型；

基于所述YANG模型生成对应的应用程序接口API数据。

优选地，解析所述YANG文件获得对应的YANG模型之前还包括：

验证所述YANG文件的正确性和/或完整性。

优选地，所述YANG模型描述YANG模块和模块内节点之间的关系。

优选地，获取待解析YANG文件之前还包括：

获取待解析YANG文件存放的目录全路径和生成代码的目录全路径。

优选地，基于所述YANG模型生成对应的API数据包括：

将所述YANG模型根据映射规则生成对应的API数据，所述API数据包括数据传输对象和数据访问对象，所述数据传输对象用于存放配置节点的信息，所述数据访问对象用于对数据传输对象按照报文的格式要求进行处理后生成待抽象封装的报文。

为解决上述技术问题，本发明还提供一种基于YANG模型的编译方法，包括：

接收应用程序接口API数据；所述API数据通过解析YANG文件获得的YANG模型生成；

根据所述API数据生成协议数据；

与代理服务器建立连接，通过所述连接将所述协议数据发送至代理服务器。

优选地，根据所述API数据生成协议数据包括：

获得所述API数据中的数据传输对象和数据访问对象，根据所述数据传输对象和数据访问对象生成协议数据，所述数据传输对象用于存放配置节点的信息，所述数据访问对象用于对数据传输对象按照报文的格式要求进行处理后生成待抽象封装的报文。

优选地，将所述协议数据发送至代理服务器之后还包括：

接收所述代理服务器端反馈的结果数据，根据所述结果数据解析出协议内容；

将所述协议内容封装后，返回给用户设备。

优选地，接收应用程序接口API数据之前还包括：

获取配置信息，所述配置信息包括以下的一项或者多项：

代理服务器信息、用户设备信息、会话管理信息、事务管理信息、操作信息。

优选地，根据所述API数据生成协议数据之前还包括：

对所述API数据进行抽象封装。

优选地，当根据所述结果数据解析出的协议内容为成功信息时，所述将所述协议内容封装后，返回给用户设备，包括：将所述成功信息封装入成功API类中，返回给用户设备；

当根据所述结果数据解析出的协议内容为错误信息时，所述将所述协议内容封装后，返回给用户设备，包括：将所述错误信息封装入报错API类中，返回给用户设备；

当根据所述结果数据解析出的协议内容为节点信息时，所述将所述协议内容封装后，返回给用户设备，包括：将所述节点信息封装入API业务数据类中，返回给用户设备。

为解决上述技术问题，本发明还提供一种基于YANG模型的应用程序接口，包括：

获取模块，用于获取待解析YANG文件；

解析模块，用于解析所述YANG文件获得对应的YANG模型；

编译模块，用于基于所述YANG模型生成对应的应用程序接口API数据。

优选地，所述接口还包括：

验证模块，用于验证所述YANG文件的正确性和/或完整性。

优选地，所述获取模块还用于获取配置的YANG文件存放的目录全路径和生成代码的目录全路径。

为解决上述技术问题，本发明还提供一种基于YANG模型的插件程序组件，包括：

接收模块，用于接收应用程序接口API数据；所述API数据通过解析YANG文件获得的YANG模型生成；

生成模块，用于根据所述API数据生成协议数据；

连接模块，用于与代理服务器建立连接，通过所述连接将所述协议数据发送至代理服务器。

优选地，所述生成模块根据所述API数据生成协议数据是指：

优选地，所述组件还包括：

反馈模块，用于接收所述代理服务器端反馈的结果数据；

协议模块，用于根据所述结果数据解析出协议内容；

封装模块，用于将所述协议内容封装后，返回给用户设备。

优选地，所述生成模块还用于：对所述API数据进行抽象封装。

优选地，所述封装模块包括成功封装单元、报错封装单元、业务封装单元，

所述成功封装单元，用于当根据所述结果数据解析出的协议内容为成功信息时，将所述成功信息封装入成功API类中，返回给用户设备；

所述报错封装单元，用于当根据所述结果数据解析出的协议内容为错误信息时，将所述错误信息封装入报错API类中，返回给用户设备；

所述业务封装单元，用于当根据所述结果数据解析出的协议内容为节点信息时，将所述节点信息封装入API业务数据类中，返回给用户设备。

为解决上述技术问题，本发明还提供一种基于YANG模型的网络自动化系统，包括：上述接口和组件。

本发明和现有技术相比，具有如下有益效果：

本发明提供的方案体现了YANG模型中的数据逻辑，屏蔽了NETCONF操作的复杂性。同时将用户所要进行的配置查询等操作请求转化成对应的协议报文，并可以将报文发送到对应的设备上，获得操作结果，还能够控制设备不同版本的YANG模型。这样就大大降低用户对NETCONF协议报文和YANG模型的专业知识的要求，减少不必要的手动配置设备的步骤，并降低用户开发维护成本。

附图说明

图1是本发明实施例的一种基于YANG模型的编译方法的流程图；

图2是本发明实施例的另一种基于YANG模型的编译方法的流程图；

图3是本发明实施例的一种基于YANG模型的应用程序接口的结构示意图；

图4是本发明实施例的一种基于YANG模型的插件程序组件的结构示意图；

图5是本发明实施例的一种基于YANG模型的网络自动化系统的结构示意图；

图6是本发明实施例1的根据YANG文件生成相应API数据的流程图；

图7是本发明实施例1的生成的API数据的文件位置关系图；

图8是本发明实施例1的API展现的类图；

图9是本发明实施例2和3的获得协议内容并返回给用户设备的流程图。

具体实施方式

为使本发明的发明目的、技术方案和有益效果更加清楚明了，下面结合附图对本发明的实施例进行说明，需要说明的是，在不冲突的情况下，本申请中的实施例和实施例中的特征可以相互任意组合。

如图1所示，本发明实施例提供一种基于YANG模型的编译方法，包括：

S1、获取待解析YANG文件；

S2、解析所述YANG文件获得对应的YANG模型；

S3、基于所述YANG模型生成对应的应用程序接口API数据。

本发明实施例提供的一种基于YANG模型的编译方法主要用来读取、解析YANG文件，并得到对应的YANG模型，能够描述YANG模块和模块内节点之间的关系，通过生成的应用程序接口API数据，体现了YANG模型中的数据逻辑，屏蔽了底层协议操作的复杂性。

步骤S3基于所述YANG模型生成对应的API数据包括：

其中，S2之前还包括：

验证所述YANG文件的正确性和/或完整性。

所述YANG模型描述YANG节点之间的关系。

S1之前还包括：

如图2所示，本发明实施例还提供一种基于YANG模型的编译方法，包括：

S4、接收应用程序接口API数据；所述API数据通过解析YANG文件获得的YANG模型生成；

S5、根据所述API数据生成协议数据；

S6、与代理服务器建立连接，通过所述连接将所述协议数据发送至代理服务器。

其中，步骤S5包括：

获得所述API数据中的数据传输对象和数据访问对象，根据所述数据传输对象和数据访问对象生成协议数据。

其中，S6之后还包括：

S7、接收所述代理服务器端反馈的结果数据，根据所述结果数据解析出协议内容；

S8、将所述协议内容封装后，返回给用户设备。

S4之前还包括：

获取配置信息，所述配置信息包括以下的一项或者多项：

S5之前还包括：

对所述API数据进行抽象封装。

当根据所述结果数据解析出的协议内容为成功信息时，S8包括：将所述成功信息封装入成功API类中，返回给用户设备；

当根据所述结果数据解析出的协议内容为错误信息时，S8包括：将所述错误信息封装入报错API类中，返回给用户设备

当根据所述结果数据解析出的协议内容为节点信息时，S8包括：将所述节点信息封装入API业务数据类中，返回给用户设备。

如图3所示，本发明实施例还提供一种基于YANG模型的应用程序接口，包括：

获取模块101，用于获取待解析YANG文件；

解析模块103，用于解析所述YANG文件获得对应的YANG模型；

编译模块104，用于基于所述YANG模型生成对应的应用程序接口API数据。

所述应用程序接口还包括：

验证模块102，用于验证所述YANG文件的正确性和/或完整性。

所述获取模块101还用于获取配置的YANG文件存放的目录全路径和生成代码的目录全路径。

如图4所示，本发明实施例还提供一种基于YANG模型的插件程序组件，包括：

接收模块202，用于接收应用程序接口API数据；所述API数据通过解析YANG文件获得的YANG模型生成；

生成模块203，用于根据所述API数据生成协议数据；

连接模块204，用于与代理服务器建立连接，通过所述连接将所述协议数据发送至代理服务器。

所述生成模块根据所述API数据生成协议数据是指：

所述插件程序组件还包括：

反馈模块205，用于接收所述代理服务器端反馈的结果数据；

协议模块206，用于根据所述结果数据解析出协议内容；

封装模块207，用于将所述协议内容封装后，返回给用户设备。

所述生成模块还用于对所述API数据进行抽象封装。

其中，所述封装模块207包括成功封装单元2072、或报错封装单元2074、或业务封装单元2076，

所述成功封装单元2072，用于当根据所述结果数据解析出的协议内容为成功信息时，将所述成功信息封装入成功API类中，返回给用户设备；

所述报错封装单元2074，用于当根据所述结果数据解析出的协议内容为错误信息时，将所述错误信息封装入报错API类中，返回给用户设备

所述业务封装单元2076，用于当根据所述结果数据解析出的协议内容为节点信息时，将所述节点信息封装入API业务数据类中，返回给用户设备。

如图5所示，本发明实施例还提供一种基于YANG模型的网络自动化系统，包括：上述应用程序接口和插件程序组件。

一个系统中可以有多个插件程序Plug-in组件，Plug-in组件可以是NETCONF协议实现，也可以是CLI，SNMP，RESTCONF，OVSDB等协议实现。

本发明实施例主要分成两部分功能。

第一部分：API数据生成

通过读取所有需要被使用的YANG文件，验证YANG文件的正确性和完整性，并得到YANG模型；

通过YANG模型生成相应的API数据。

第二部分：如何使用API数据

配置必要的信息，例如设备信息，会话管理信息，事务管理信息，操作信息等；

生成协议数据，将其发送给Agent；

得到从Agent端收到结果数据，解析出协议内容，将内容封装后，并返回给用户。

其中，对下层提供了抽象封装，使得下层无需关注实现细节，对上屏蔽各种差异。还提供了设备管理、会话管理、事务管理等实现。

实施例1

流程图如图6。

首先，对配置文件进行配置，主要包括源YANG文件存放的目录全路径，存放生成代码的目录全路径，用户可以添加在生成代码前面的前缀名等。

其次，根据RFC6020来解析YANG文件，确认YANG文件的版本号、正确性、完整性(即符合与其他YANG模块的依赖关系)，并生成相应的YANG模型。

最后，根据YANG映射规则，生成对应的代码。

下面以根据YANG文件生成JAVA代码为例说明：

配置文件中，包含但不局限于以下内容：

yangSource＝E:\\

codePath＝D:\\

prefixName＝com.zte

yangSource表示的是源YANG文件所存放的目录全路径。codePath表示的是生成代码所存储的目录全路径。prefixName表示的是用户添加的前缀名(对于JAVA来说也就是包名)。

用户准备的YANG文件如下：

获取YANG文件，经过分析，该YANG文件是正确和完整的。

随后根据YANG模型转化为JAVA代码的映射规则，来生成对应的Java API。所提供的Java API包括了业务数据类和数据访问对象类(Data Access Object，DAO)。业务数据类可以被用直接使用或者继承，而数据访问对象类可以对数据模型进行操作，如create、merge，replace等，这些操作会使得数据在操作中被加上相应的标识。用户在设置节点信息的时候，只需要关注业务数据类；而用户需要对这些节点信息进行操作的时候，则使用数据访问对象类DAO。

如图7所示，其中的“com.zte”为用户前缀名，在com.zte.testYang.rev20150514包中，TestYang.java为业务数据类，TestYangDAO.java为数据访问对象类。

以com.zte.testYang.rev20150514.a包中的B.java为例，显示了B.java中类的继承关系，内部成员等，文件如下：

Public class B

Extends AbstractYangDate

{

private String c；

private com.zte.testYang.rev20150514.typedef.DDef d；

}

举例说明YANG模型到JAVA类的映射规则：

YANG模型中节点转化为类，节点名转化为类名。数据子节点作为父亲结点的属性。TYPE类型作为父亲节点的数据类型。

1module

映射对象：类

类名称：module名称

例如在图7中，表示为TestYang.java

2container

映射对象：类

类名称：container名称

例如在图7中，表示为A.java

3list

映射对象：类

类名称：list名称

例如在图7中，表示为B.java

4leaf

映射对象：成员变量

变量名称：leaf名称

变量类型：根据leaf的type不同而不同

例如在上面文件中，表示为private String c；

Private com.zte.testYang.rev20150514.typedef.DDef d；

该API展现的类图如图8所示，最后，将这些文件存入到codePath所指定的目录中。

实施例2

如图9所示，用户想要配置节点数据，以NETCONF作为PLUG-IN组件为例：

步骤301初始化：读取配置文件信息，如Agent设备ID，IP地址，端口号，账号密码等。

步骤302使用相应版本的业务数据类填入相应节点信息的配置信息。

步骤303调用相应的数据访问对象类，根据Agent的ID，IP等信息，建立到Agent端的NETCONF连接。

步骤304调用Plug-in组件(NETCONF组件)，生成NETCONF协议报文。

步骤305根据步骤303建立的通道，发送步骤304生成的NETCONF协议报文到Agent。

步骤306收到Agent端返回的NETCONF消息结果；将结果解析出内容部分。

步骤307将返回的内容封装入API中返回给用户。这里根据返回结果的不同，会封装入不同的API。如果返回成功ok结果，则封装入成功的API类中；如果返回失败的错误信息，则封装入报错API类中。

实施例3

如图9所示，用户想要获取节点数据，以NETCONF作为PLUG-IN组件为例：

步骤401系统初始化：读取配置文件信息，如Agent设备ID，IP地址，端口号，账号密码等。

步骤402使用业务数据类填入想要获取的节点信息。

步骤403调用相应版本的数据访问对象类，根据Agent的ID，IP等信息，建立到Agent端的NETCONF连接。

步骤404调用Plug-in组件(NETCONF组件)，生成NETCONF协议报文。

步骤405根据步骤403建立的通道，发送步骤404生成的NETCONF协议报文到Agent。

步骤406收到Agent端返回的NETCONF消息结果；将结果解析出内容部分。

步骤407将返回的内容封装入API中返回给用户。这里根据返回结果的不同，会封装入不同的API。如果返回节点信息，则将其封装入对应的API业务数据类中；如果返回失败的错误信息，则封装入报错API类中。

虽然本发明所揭示的实施方式如上，但其内容只是为了便于理解本发明的技术方案而采用的实施方式，并非用于限定本发明。任何本发明所属技术领域内的技术人员，在不脱离本发明所揭示的核心技术方案的前提下，可以在实施的形式和细节上做任何修改与变化，但本发明所限定的保护范围，仍须以所附的权利要求书限定的范围为准。

Claims

1.一种基于YANG模型的编译方法，其特征在于，包括：

获取待解析YANG文件；

解析所述YANG文件获得对应的YANG模型；

基于所述YANG模型生成对应的应用程序接口API数据。

2.如权利要求1所述的方法，其特征在于：解析所述YANG文件获得对应的YANG模型之前还包括：

验证所述YANG文件的正确性和/或完整性。

3.如权利要求1所述的方法，其特征在于：所述YANG模型描述YANG模块和模块内节点之间的关系。

4.如权利要求1所述的方法，其特征在于，获取待解析YANG文件之前还包括：

5.如权利要求1所述的方法，其特征在于：基于所述YANG模型生成对应的API数据包括：

6.一种基于YANG模型的编译方法，其特征在于：包括：

根据所述API数据生成协议数据；

7.如权利要求6所述的方法，其特征在于，根据所述API数据生成协议数据包括：

8.如权利要求6所述的方法，其特征在于，将所述协议数据发送至代理服务器之后还包括：

将所述协议内容封装后，返回给用户设备。

9.如权利要求6所述的方法，其特征在于：接收应用程序接口API数据之前还包括：

获取配置信息，所述配置信息包括以下的一项或者多项：

10.如权利要求6所述的方法，其特征在于：根据所述API数据生成协议数据之前还包括：

对所述API数据进行抽象封装。

11.如权利要求8所述的方法，其特征在于：

当根据所述结果数据解析出的协议内容为成功信息时，所述将所述协议内容封装后，返回给用户设备，包括：将所述成功信息封装入成功API类中，返回给用户设备；

12.一种基于YANG模型的应用程序接口，其特征在于，包括：

获取模块，用于获取待解析YANG文件；

解析模块，用于解析所述YANG文件获得对应的YANG模型；

13.如权利要求12所述的接口，其特征在于：还包括：

验证模块，用于验证所述YANG文件的正确性和/或完整性。

14.如权利要求12所述的接口，其特征在于：所述获取模块还用于获取配置的YANG文件存放的目录全路径和生成代码的目录全路径。

15.一种基于YANG模型的插件程序组件，其特征在于：包括：

生成模块，用于根据所述API数据生成协议数据；

16.如权利要求15所述的组件，其特征在于，所述生成模块根据所述API数据生成协议数据是指：

17.如权利要求15所述的组件，其特征在于，还包括：

反馈模块，用于接收所述代理服务器端反馈的结果数据；

协议模块，用于根据所述结果数据解析出协议内容；

封装模块，用于将所述协议内容封装后，返回给用户设备。

18.如权利要求15所述的组件，其特征在于：所述生成模块还用于：

对所述API数据进行抽象封装。

19.如权利要求17所述的组件，其特征在于：所述封装模块包括成功封装单元、报错封装单元、业务封装单元，

20.一种基于YANG模型的网络自动化系统，其特征在于：包括：权利要求12-14任一所述接口和权利要求15-19任一所述组件。