CN102662683A

CN102662683A - 基于键-值对格式的通信设备配置文件的生成和导入方法

Info

Publication number: CN102662683A
Application number: CN2011104592211A
Authority: CN
Inventors: 张志虎; 王国峰; 吴雄伟; 肖虎涛
Original assignee: GUANGDONG DONGYAN NETWORK TECHNOLOGIES Co Ltd
Current assignee: GUANGDONG DONGYAN NETWORK TECHNOLOGIES Co Ltd
Priority date: 2011-12-30
Filing date: 2011-12-30
Publication date: 2012-09-12
Anticipated expiration: 2031-12-30
Also published as: CN102662683B

Abstract

本发明提供了一种基于键-值对格式的通信设备配置文件的生成和导入方法，其包括：S1）将通信设备内存中的配置信息数据结构填充到内存字典中，再将内存字典输出到键-值对格式的配置文件；S2）创建内存字典，解析键-值对格式的配置文件并填充内存字典，再将内存字典中的数据设置到通信设备内存中的配置信息数据结构，并对通信设备进行配置。本方法能够广泛应用于通信领域，提高通信系统的运行效率和稳定性。

Description

基于键-值对格式的通信设备配置文件的生成和导入方法

技术领域

本发明涉及通信领域，包括以太网交换机、EPON（以太网无源光网络）系统、GPON（吉比特无源光网络）系统、EOC（同轴电缆以太网）系统，特别涉及通信设备生成、导入配置文件的方法。

技术背景

在通信系统中，由于通信设备运行和管理的需要，在对通信设备配置完毕之后，需要将配置信息生成配置文件保存到非易失性存储器中。如果通信设备意外重启，则可以加载非易失性存储器中的配置文件，恢复掉电之前的配置信息，从而正常工作。可见，配置文件的保存、加载是通信设备必须具备的基本功能。

通信设备的配置项很多，现有的通信设备配置一般都是基于CLI（命令行）的脚本文件来实现的。

配置的具体步骤如下：

1）用户通过串口或Telnet登录通信设备，通过CLI修改通信设备一个或多个配置项；

2）CLI解析模块通过解析命令行参数，调用对应的底层接口，执行配置；

3）保存CLI命令，形成脚本配置文件，并保存到非易失存储器中；

如果通信设备掉电重启时，将会从非易失存储器加载CLI脚本文件，并依次从脚本文件中取出每条CLI命令并执行，恢复到掉电之前的状态。

采用上述这种保存配置的方式，有如下缺点：

1）设备必须实行CLI配置方式，否则无法解析、下发CLI格式的配置文件；

2）CLI改动之后，配置保存相关的代码也必须做相应调整，效率较低；

3）通信设备实现配置保存相关的代码与其CLI命令完全配套，不同通信设备之间配置保存模块的代码无法复用；

基于键-值对格式文本配置方法的相应优点：

1）目前集中网管的趋势越来越明显，开发CLI的必要性有所降低，可以酌情不实现CLI。

如果用Key-Value格式来实现，配置文件模块就不依赖于CLI模块，CLI可以不实现，或者晚实现；

2）在实现了CLI的情况下，即使CLI发生了改动，配置保存、下发相关的代码不需要做任何改动，效率较高；

3）基于Key-Value格式的配置文件模块，可以复用于不同通信设备上；

4）配置高效和快速的生成和导入；

高效的哈希查找算法，决定了配置修改过程的高效，快速的生成数据字典和导出数据字典保证了键-值对格式配置文本的快速导入和生成。

非易失性存储器上Key（键）-Value（值）格式的配置文件是指基于ASCII编码的描述简单参数的文本文件。这些参数包括（字符型，整型，浮点型，布尔型）。并且这种格式优点是，结构清晰，容易使用和修改。

1.该配置文件一般被分为一个或多个段落（Section），描述如下：

[Section Name1]

每个段落的名字都在方括号里面，并且每个段落只能占据一行。节点的名字的组成可以是除方括号和换行符之外的所有字符。

2.每个段落都可以含有一个和多个字段，描述如下：

Key=Value; comment

Key可以是任何字符（可以含有空格），在等号右侧的Value可以是任何字符。Value可能被包含双引号之间，如果没有双引号，Value的值被解析为等号之后和注释之前的最后一个非空格字符中间的所有字符。

发明内容

本发明目的在于提供一种基于Key-Value格式的配置文件的生成和导入方法，本发明采用线性的存储结构，高效的哈希查找算法，以及整合的安全高效操作方法（增加，修改，删除），使得该方法能够广泛应用于通信领域，提高通信系统的运行效率和稳定性。

本发明所采用的技术方案是：基于键-值对格式的通信设备配置文件的生成和导入方法，其包括：S1）首先根据设备需求，将通信设备内存中的设备配置数据结构通过填充、保存内存字典的方式输出到键-值对格式的配置文件；S2）然后通过创建、填充内存字典的方式，将键-值对格式的配置文件的数据读取到通信设备内存相应的设备配置数据结构中，并对其进行配置。

所述的方法，生成配置文件的方法包括以下步骤：

S11）根据设备配置段的个数，在内存中创建相应容量的字典；

S12）根据设备的配置项，取出通信设备程序数据结构中的配置信息，根据关键字依据哈希算法计算得到哈希值，并依次将关键字、属性值和哈希值填充到内存中的字典；

S13）将内存字典中的Key和Value字符串，以Key=Value的形式导入到文本文件中，生成特定配置对象的配置文件，并存储到非易失性存储器中，其中Key表示键，Value表示值；

S14）释放内存中的字典。

所述的方法，步骤S11中字典格式包括字典的总的记录条数、字典总存储空间的大小、字典索引、字典索引对应的属性值、字典索引对应的哈希值。

所述的方法，步骤S12计算键索引的方法为：通过哈希算法，计算每个不同Key字符串的哈希值，并保存到字典索引中；并且Key值采用“Section:Key”方式存储，其中Section表示段落。

所述的方法，步骤S13生成配置文件的方法具体包括：

S131）遍历字典找到不含冒号的字段值的总个数，得到整个字典的分段信息；

S132）如果段落数目为0，直接返回空；

S133）如果段落数目不为0，从第一个段落开始，取出段落的名称和它所占的字节数，以“[Section]”格式输出到文本一行；

S134）以段落名次为关键字依次搜索字典，将含有相同段落名的Key取出Value的值，去掉Key中的“Section：”，并以“Key=Value”的格式输出的文本中的一行；

S135）重复S133和S134，直到将字典中每个段落及段落所包含的内容全部输出为止。

所述的方法，导入Key-Value格式配置文件的方法包括：

S21）根据设备配置段的个数，在内存中创建相应容量的字典；

S22）读取非易失性存储器上Key-Value格式的配置文件，逐行解析，填充到内存字典中；

S23）根据通信设备的需要，对字典进行操作；

S24）逐条读取内存字典中的设备配置信息，发送到通信设备内存相应的设备配置数据结构中，并对其进行配置；

S25）释放字典。

所述的方法，步骤S22逐行解析的方法包括：

S221）以只读的方式打开在非易失性存储器上的Key-Value格式的配置文件；

S222）从配置文件中读取一行到内存；

S223）计算这一行含有的字符串的长度；

S224）查看字符串的结束符是否为换行符，如果不是则认为一行的字符长度超过了预定的内存缓存大小，退出程序，否则继续；

S225）去掉行尾的换行符；

S226）判断是否存在多行连接符，如果是则退出，否则继续；

S227）去掉行首和行尾的空格字符；

S228）重新计算去掉换行符和空格字符之后的字符串的长度；

如果长度小于0，则认为此行为空行，跳到S222继续执行；

如果行首第一个字符为井号或分号，则认为此行为注释行，跳到S222继续执行；

如果字符串的第一个字符是左方括号，并且最后一个字符为右方括号,则将字符左方括号与右方括号之间的字符解析成段落的名称，并将其取出来；

S229）如果字符串中含有等号，取出字符串中等号两边的值分别作为Key和Value；

等号右边的值出现类似如下面的情况：

Key=

Key=;

Key=#

则取Value等于0；

如果字符串中不含有等号，解析为此行错误，跳到S222继续执行；

S2210）从文本中解析的数据，如果是段落名称，填充字典索引=段落名称，属性值=0，然后通过哈希算法计算段落名称得到哈希值并填充；

如果取出的是Key和Value的值，填充字典索引=取出的Key值，属性=取出的Value值，然后通过哈希算法计算Key的哈希值并填充。

所述的方法，步骤S23的操作方法包括增加、删除和修改。

本方法流程清晰，算法高效，可扩展性强，适用范围广，可有效应用于以太网交换机、EPON系统、GPON系统、EOC系统等应用场景。因此，不必针对每套系统或者每个配置对象单独设计一种配置文件的生成和导入的方法，极大的减少代码的开发成本，提高了系统的可维护性和稳定性。

附图说明

图1是基于Key-Value字典的基本结构图。

图2是导入设备配置文件流程图。

图3生成设备配置文件流程图。

具体实施方式

本发明提供一种基于Key-Value格式配置文件的生成和导入方法。将通信设备内存中的设备配置数据结构写入到Key-Value格式的字典中，然后将字典中的信息导出为配置文件并写入非易失性存储器。在通信设备系统启动时，将非易失性存储器中的设备配置文件导入到Key-Value格式的字典中，然后将字典中的相关信息读到内存中相应的设备配置数据结构中并对相关设备进行相应配置。

以下结合附图，本发明结合配置文件的生成和导入的过程，说明本发明的具体过程。根据操作类型分为生成和导入两个流程。

一．生成配置文件

图3给出了设备生成配置保存的流程，包括以下步骤：

步骤1、根据设备配置段的个数，在内存中创建相应容量的字典。

系统默认为每一个字段创建能够容纳128条记录的字典。

内存中字典的格式如图1，分为五个部分；

1）字典的总的字段数；

2）字典中每个字段所占存储空间的大小，默认为128；

3）字典中关键字对应的属性值；

4）字典中关键字；

5）字典中哈希指针；

字典是一个Key和Value的关联列表。每一个关联都由唯一的字Key标识。当在字典中按照Key查询字符串Value时，通过字典内在的方法（基于无冲突的哈希算法）能够快速查询得到匹配的字符串（Value）。

步骤2、根据设备的配置项，如图1所示，将系统应用程序数据结构中的配置信息依次填充到内存中的字典，并根据哈希（Hash）算法，每个不同Key字符串，会计算得到不同的Value值，保存于字典中。并且Key值的存储方式是“Section:Key”方式存储的。

Key的数据类型只支持字符串（对大小写不敏感），Value的数据类型支持整型、布尔型、浮点型、字符串。

1）整型：支持常用的不同进制的表示方式（C语言语法规则）。

例如，十进制，八进制（以0为起始位），十六进制（以0x为起始位）。

“42”->42

“042”->34（八进制->十进制）

“0x42”->66（十六进制->十进制）

2）布尔型：支持的不仅是0和1，支持如下一些在配置设备中常用的表达方式。

满足以下任何一个，会被解析为布尔型的真：

①以字符‘y’为起始位；

②以字符‘Y’为起始位；

③以字符‘t’为起始位；

④以字符‘T’为起始位；

⑤以字符‘1’为起始位；

满足以下任何一个，会被解析为布尔型的假：

①以字符‘n’为起始位；

②以字符‘N’为起始位；

③以字符‘f’为起始位；

④以字符‘F’为起始位；

⑤以字符‘0’为起始位；

其中，Y或 y 是yes的首写字母，N 或 n 是no的首写字母，T或 t 是 true的首写字母，F 或 f是 false的首写字母。

3）浮点型：支持双精度浮点型，它的范围在负数的时候是从-1.79769313486232*10³⁰⁸到-4.94065645841247*10^-324，而正数的时候是从4.94065645841247*10^-324到1.79769313486232*10³⁰⁸。

4）字符串：依据ASCII编码的文本文件单行最大长度，支持最大1024字节。

步骤3、将内存中字典中的Key和Value字符串，以Key=Value的形式导入到文本文件中，生成特定配置对象的配置文件，并保存到非易失性存储器中。

具体步骤如下：

①遍历字典找到不含冒号的字段值（即“Section”）的总个数，整个字典分多少个段落（Section）；

②如果段落数目为0，直接返回空；

③如果段落数目不为0，从第一个段落（Section）开始，取出段落的名称和它所占的字节数，以[Section]格式输出到文本一行；

④然后以段落名次为关键字依次搜索字典，将含有相同段落名的Key，并取出Value的值，去掉Key中的“Section：”，并以“Key=Value”的格式输出的文本中的一行；

⑤重复③和④，直到将字典中每个段落及段落所包含的内容全部输出为止。

步骤4、释放内存中的字典。

二．导入配置文件

图2给出了设备生成的配置文件导入的流程，包括以下步骤：

步骤1、在内存中创建字典，同生成配置文件步骤1；

步骤2、读非易失性存储器上Key-Value格式的配置文件，逐行解析，填充到内存字典中；

具体的步骤如下：

①以只读的方式打开在非易失性存储器上的Key-Value格式的配置文件；

②从配置文件中读取一行（1024字节长度）到内存；

③计算这一行含有的字符串的长度；

④查看字符串的结束符是否为换行符'\n'，如果不是则认为一行的字符长度超过了预定的内存缓存大小，退出程序，否则继续；

⑤去掉行尾的换行符'\n'；

⑥判断是否存在多行连接符'\\'，如果是，退出，否则继续；

⑦去掉行首和行尾的空格字符；

⑧重新计算去掉换行符和空格字符之后的字符串的长度；

如果长度小于0，则认为此行为空行，跳到②继续执行；

如果行首第一个字符为'#'或';'，则认为此行为注释行，跳到②继续执行；

如果字符串的第一个字符是'['和最后一个字符为']',则将字符'['与']'之间的字符解析成段落的名称，并将其取出来；

除以上几种情况继续下一步；

⑨如果字符串中含有'='取出字符串中'='两边的值，

等号右边的值出现类似如下面的情况

Key=

Key=;

Key=#

取Value等于0；

如果字符串中不含有'=',解析为此行错误，跳到②继续执行;

⑩从文本中解析的数据分为两种类型，一种是段落名称，另一种是Key和Value的值；

如果是段落名称，填充如图1结构体，索引=段落名称，属性值=0，通过哈希算法计算得到Hash值并填充；

如果取出的是Key和Value的值，索引=取出的Key值，属性=取出的Value值，通过哈希算法计算得到Hash值并填充；

步骤3、字典的操作（增加，删除，修改）；

字典的操作的基础是查找，然后才是操作。

字典的查找操作步骤如下：

①根据索引计算得到哈希值；

②从字典的第一条记录开始查询；

③比较记录的哈希值和上一步得到哈希值

如果不匹配，重复②；

如果匹配，继续执行；

④比较记录的索引和需要查找的索引

⑤如果匹配，代表此记录即要查找的记录

不匹配，跳到②，直到最后一条记录；

字典的增加操作，分为两种情况，

①字典里有空位，按照如图1结构体填充即可；

②字典里没有空位，将字典的容量扩充一倍；

然后插入到第一个空位即可；

字典的删除操作，分为字典的删除和字典里记录的删除，

①字典的删除，从字典里第一条记录开始，依次释放索引、属性值、哈希值，直到最后一条记录，最后释放字典对象；

②字典记录的删除，根据字典的查找操作，找到相应的记录，并释放如图1数据结构里的索引值和属性值，并将哈希值置为0；

字典的修改操作，根据字典的查找操作，找到相应的记录，并修改如图1数据结构里的属性值；

步骤4、逐条读取内存字典中的设备配置信息到内存中相应的设备配置数据结构中并对相关设备进行相应配置；

步骤5、释放字典。

三．哈希算法实现描述

/*

* 功能简述：根据给定的Key值计算哈希值.

* 参数： Key值

* 返回值：哈希值

*/

unsigned dictionary_hash(char * key)

{

int len; /* 定义整型变量，存放 Key值长度 */

unsigned hash; /* 定义无符号整型变量，存放哈希值 */

int i; /* 定义循环变量 */

len = strlen(key); /* 获取Key值长度，并存放于变量len中 */

for (hash=0, i=0 ; i<len ; i++) /* 从Key值的第一个字符开始循环，直到最

后一个字符 */

{

hash += (unsigned)key[i]; /* 累加Key值 */

hash += (hash<<10); /* 将上一步的结果左移10位与原值相加 */

hash ^= (hash>>6); /* 将上一步的结果右移6位与原值异或 */

}

hash += (hash <<3); /* 将上一步结果左移3位并原值相加 */

hash ^= (hash >>11); /* 将上一步结果右移11位与原值异或 */

hash += (hash <<15); /* 将上一步结果左移12位与原值相加 */

return hash; /* 返回上一步结果即哈希值 */

} 。

Claims

1.基于键-值对格式的通信设备配置文件的生成和导入方法，其特征在于包括：

S1)将通信设备内存中的配置信息数据结构填充到内存字典中，再将内存字典输出到键-值对格式的配置文件；

S2)创建内存字典，解析键-值对格式的配置文件并填充内存字典，再将内存字典中的数据设置到通信设备内存中的配置信息数据结构，并对通信设备进行配置。

2.根据权利要求1所述的方法，其特征在于，生成配置文件的方法包括以下步骤：

S11)根据设备配置段落的个数，在内存中创建相应容量的字典；

S12)根据设备的配置项，取出通信设备程序数据结构中的配置信息，根据关键字依据图4算法计算得到哈希值，并依次将关键字、属性值和哈希值填充到内存字典中；

S13)将内存字典中的Key和Value字符串，以Key＝Value的形式导入到文本文件中，生成特定配置对象的配置文件，并存储到非易失性存储器中，其中Key表示键，Value表示值；

S14)释放内存中的字典。

3.根据权利要求2所述的方法，其特征在于：步骤S11中字典格式包括字典的总的记录条数、字典总存储空间的大小、字典索引、字典索引对应的属性值、字典索引对应的哈希值。

4.根据权利要求3所述的方法，其特征在于，步骤S12计算键索引的方法为：通过哈希算法，计算每个不同Key字符串的哈希值，并保存到字典索引中；并且Key值采用“Section:Key”方式存储，其中Section表示段落。

5.根据权利要求4所述的方法，其特征在于，步骤S13生成配置文件的方法具体包括：

S131)遍历字典，得到整个字典的段落的总个数；

S132)如果段落数目为0，直接返回空；

S133)如果段落数目不为0，从第一个段落开始，取出段落的名称和它所占的字节数，以“[Section]”格式输出到文本一行；

S134)以段落名次为关键字依次搜索字典，将含有相同段落名的Key取出Value的值，去掉Key中的“Section：”，并以“Key＝Value”的格式输出的文本中的一行；

S135)重复S133和S134，直到将字典中每个段落及段落所包含的内容全部输出为止。

6.根据权利要求5所述的方法，其特征在于，导入键-值对格式的配置文件的方法包括：

S21)根据设备配置段落的个数，在内存中创建相应容量的字典；

S22)读取非易失性存储器上Key-Value格式的配置文件，逐行解析，填充到内存字典中；

S23)根据通信设备的需要，对字典进行操作；

S24)逐条读取内存字典中的数据，设置到通信设备内存中的配置信息数据结构，并对通信设备进行配置。；

S25)释放字典。

7.根据权利要求6所述的方法，其特征在于，步骤S22逐行解析的方法包括：

S221)以只读的方式打开在非易失性存储器上的Key-Value格式的配置文件；

S222)从配置文件中读取一行到内存；

S223)计算这一行含有的字符串的长度；

S224)查看字符串的结束符是否为换行符，如果不是则认为一行的字符长度超过了预定的内存缓存大小，退出程序，否则继续；

S225)去掉行尾的换行符；

S226)判断是否存在多行连接符，如果是则退出，否则继续；

S227)去掉行首和行尾的空格字符；

S228)重新计算去掉换行符和空格字符之后的字符串的长度；

如果长度小于0，则认为此行为空行，跳到S222继续执行；

如果字符串的第一个字符是左方括号，并且最后一个字符为右方括号，则将字符左方括号与右方括号之间的字符解析成段落的名称，并将其取出来；

S229)如果字符串中含有等号，取出字符串中等号两边的值分别作为Key和Value；

等号右边的值出现下面的情况：

Key＝

Key＝；

Key＝#

则取Value等于0；

S2210)从文本中解析的数据，如果是段落名称，填充字典索引＝段落名称，属性值＝0，然后通过哈希算法计算段落名称得到哈希值并填充；

如果取出的是Key和Value的值，填充字典索引＝取出的Key值，属性＝取出的Value值，然后通过哈希算法计算Key的哈希值并填充。

8.根据权利要求6所述的方法，其特征在于：步骤S23的操作方法包括增加、删除和修改。