CN102257498B - 配置文件的注释生成方法及配置文件生成设备 - Google Patents

Abstract

本发明提供一种配置文件的注释生成方法及配置文件生成设备。方法：在待生成文件中识别注释的标签，标签包括起始标签和结束标签，起始标签和结束标签之间的内容为注释；根据起始标签或结束标签，以及标签与标签在配置文件中的生成位置的对应关系，获得注释在配置文件中的生成位置；将注释写入生成位置。设备至少包括注释生成模块，注释生成模块包括：识别单元、获得单元和写入单元。

Description

配置文件的注释生成方法及配置文件生成设备

技术领域

本发明实施例涉及计算机技术领域，尤其涉及一种配置文件的注释生成方法及配置文件生成设备。

背景技术

目前，很多网络设备的配置比较复杂，配置文件的含义难以理解，为了增强配置文件的可读性，各网络设备的厂商都提供了注释配置文件的方法，例如在命令行配置文件中，使用行注释的方式，行头用特殊符号表示注释，例如：采用！或#作为行头的特殊符号。

在实现本发明过程中，发明人发现现有技术中至少存在如下问题：

配置恢复过程是忽略注释内容的，也即当配置文件恢复到主机配置后，如果用户对配置文件进行了修改，然后再重新生成配置文件时，注释内容已经丢失，无法再保留在配置文件中。

发明内容

本发明实施例提供一种配置文件的注释生成方法及配置文件生成设备，用以解决现有技术中配置文件的重新生成过程无法保留注释内容的问题。

本发明实施例提供一种配置文件的注释生成方法，包括：

在待生成文件中识别注释的标签，所述标签包括起始标签和结束标签，所述起始标签和所述结束标签之间的内容为注释；

根据所述起始标签或所述结束标签，以及标签与标签在配置文件中的生成位置的对应关系，获得所述注释在配置文件中的生成位置；

将所述注释写入所述生成位置。

本发明实施例提供一种配置文件生成设备，至少包括注释生成模块，所述注释生成模块包括：

识别单元，用于在待生成文件中识别注释的标签，所述标签包括起始标签和结束标签，所述起始标签和所述结束标签之间的内容为注释；

获得单元，用于根据所述起始标签或所述结束标签，以及标签与标签在配置文件中的生成位置的对应关系，获得所述注释在配置文件中的生成位置；

写入单元，用于将所述注释写入所述生成位置。

本发明实施例的配置文件的注释生成方法及配置文件生成设备，通过识别待生成文件中的注释的标签，根据标签、以及标签与标签在配置文件中的生成位置的对应关系，获得该标签所标识的注释在配置文件中的生成位置，将上述标签所标识的注释写入上述生成位置，从而生成注释，有效解决了现有技术中配置文件的重新生成过程无法保留注释内容的问题，使得配置文件中的注释真正发挥其说明作用，更好地为使用用户提供服务。

附图说明

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

图1为本发明一个实施例提供的配置文件的注释生成方法流程图；

图2为本发明一个实施例提供的配置文件生成设备的结构示意图；

图3为本发明一个实施例提供的注释增加模块的结构示意图；

图4为本发明又一个实施例提供的注释修改模块的结构示意图；

图5为本发明再一个实施例提供的注释删除模块的结构示意图；

图6为本发明还一个实施例提供的配置文件生成设备的结构示意图。

具体实施方式

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

图1为本发明一个实施例提供的配置文件的注释生成方法流程图，如图1所示，该方法包括：

步骤101：用于执行配置文件生成的计算机在待生成文件中识别注释的标签。

需要说明的是，待生成文件不一定是一个完整的文件，而可能是多个保存在计算机的不同位置、代表相同或不同功能的零散文件。在这些零散文件中，会有一部分文件是带有注释的，用以解释这部分文件的功能、用途、或者做其他使用。计算机可以根据从计算机的不同位置将这些零散的文件集中起来，并通过一定的规则生成配置文件。

其中，标签包括起始标签和结束标签，起始标签和结束标签之间的内容即为注释。例如，在待生成文件中，带有标签的注释可以但不限于如下所示：

#<起始标签><注释的内容><结束标签>

注释的标签用于唯一标识该注释在待生成文件中的范围和位置。起始标签与结束标签均可以使用字母、数字、符号中的一种或者多种进行表示。起始标签和结束标签优选采用相同含义的字符串进行表示，为区分起始标签和结束标签，可以在起始标签和/或结束标签上加上不同的字母、数字或符号。例如，在结束标签的字符串前加/。

识别注释的标签过程可以但不限于是一个数据的匹配过程，计算机可以获得预设的注释的标签(包括起始标签和结束标签)数据，将这些预设的注释的标签与待生成文件中的内容进行匹配，匹配成功即为识别成功。例如，计算机接收到操作员输入的预设的注释的标签数据，如head、VPN Block以及end等，即操作员会使用上述数据作为注释的标签，那么计算机在识别注释的标签过程即是在待生成文件中查询是否存在与上述数据完全匹配的数据，如果存在，则说明匹配成功，识别出注释的标签。

步骤102：用于执行配置文件生成的计算机根据上述标签中的起始标签或者结束标签，以及标签与标签在配置文件中生成位置的对应关系，获得该起始标签与结束标签之间的注释在配置文件中的生成位置。

其中，标签与标签在配置文件中生成位置的对应关系是预先获得的，例如，操作员将标签与标签在配置文件中生成位置的对应关系输入到计算机中，并将该对应关系保存在用于执行配置文件生成的计算机上，或者保存在其他用于提供信息存储的服务器上等等。标签与标签在配置文件中生成位置的对应关系可以但不限于如表1所示：

表1

标签	标签在配置文件中的生成位置
		head	文件头
VPN Block	虚拟专用网络模块
		end	文件末尾
......	......

这里需要说明的是，表1中以起始标签和结束标签相同为例进行了说明，即head既是起始标签又是结束标签。当然，起始标签和结束标签也可以不同，例如，起始标签用head，结束标签用/head，但其均对应的是标签在配置文件中的文件头处生成。而且，表1中的起始标签和结束标签均以有一定技术含义的字符串为例进行了说明，如果起始标签和结束标签使用的是不同的或者没有技术含义的、但能够唯一标识标签的字符串进行标识，也是可以使用的。

步骤103：用于执行配置文件生成的计算机将上述起始标签与结束标签之间的注释写入上述生成位置。

由于在起始标签与结束标签之间的内容即为注释的内容，因此，计算机可以从起始标签开始获取内容，直至获取到结束标签为止。将获取到的内容去掉起始标签和结束标签，剩下的内容即为注释的内容。

本发明实施例提供了一种配置文件的注释生成方法，通过识别待生成文件中的注释的标签，根据标签、以及标签与标签在配置文件中的生成位置的对应关系，获得该标签所标识的注释在配置文件中的生成位置，将上述标签所标识的注释写入上述生成位置，从而生成注释。有效解决了现有技术中重新生成配置文件的过程无法保留注释内容的问题，使得配置文件中的注释真正发挥其说明作用，更好地为使用用户提供服务。

在上述实施例的基础上，还需要说明的是：注释的内容可以是用来解释配置文件中各部分内容的解释性语言，还可以是配置文件的修订记录、配置工单号、配置用户的电子签名中的一种或多种，此处不做赘述。

当注释的内容是修订记录时，注释的内容可以帮助管理员记录配置变更顺序、内容以及责任人，对历史变更有一个系统的记录。本实施例中注释的内容是操作员人工记录的，可以抽象和综合，并对设备自动记录的操作日志进行核对，从而发现异常操作等。在本实施例中，带有标签的注释的格式可以为：#<起始标签><修订记录></结束标签>，具体形式举例如下：起始标签采用具有技术含义的字符串head1表示，为区别于起始标签，结束标签采用/head1表示。起始标签与结束标签之间的内容为注释，具体的含义为修订历史：2011年2月15日，鲍勃增加了接口Eth1/1/1.1；2011年2月14日，利兹删除了主板1。当用于执行配置文件生成的计算机识别上述标签后，根据起始标签或结束标签查询标签与标签在配置文件生成位置的对应关系，得到该注释写入配置文件的生成位置，并将注释写入获得的生成位置。

#<head1>

#<Revision History>2011/2/15 Bob ADD Interface Eth0/1/1.1</Revision

History>

#<Revision History>2011/2/14 Lisy Del Board1</Revision History>

#</head1>

当注释的内容是配置工单号时，注释的内容可以对工单内容是否已经被配置并实施进行确定。在本实施例中，带有标签的注释的格式可以为：#<起始标签><工单号></结束标签>，具体形式举例如下：起始标签采用具有技术含义的字符串VPN Block表示，为区别于起始标签，结束标签采用/VPN Block表示。起始标签与结束标签之间的内容为注释，具体的含义为工单号SR002109。当用于执行配置文件生成的计算机识别上述标签后，根据起始标签或结束标签查询标签与标签在配置文件生成位置的对应关系，得到该注释写入配置文件的生成位置，并将注释写入获得的生成位置。

#<VPN Block>

#<Service Order NO>SR002109</Service Order NO>

#</VPN Block>

当注释的内容是配置用户的电子签名时，注释的内容可以识别签名人，对于设备配置管理而言，签名人一般是授权下发本次配置的权签人。在本实施例中，带有标签的注释的格式可以为：#<起始标签><电子签名></结束标签>，具体形式举例如下：起始标签采用具有技术含义的字符串End1表示，为区别于起始标签，结束标签采用/End1表示。起始标签与结束标签之间的内容为注释，具体的含义为签名SIG581321657812234356876453123478451245。

#<End1>

#<E-Signature>SIG581321657812234356876453123478451245</E-Signature>

#</End1>

当然，注释的内容也可以是综合各种不同的注释信息。可选地，带有标签的注释的格式举例如下：

#<起始标签>

#     <电子签名></电子签名>

#    <修订记录></修订记录>

#    <工单号>   </工单号>

#</结束标签>

在上述实施例的基础上，本发明实施例提供的配置文件的注释生成方法中，步骤101之前还可以包括增加注释的步骤：

接收增加注释的命令，该增加注释的命令中包括待增加注释的标签和内容；将待增加注释的标签和内容增加至待生成文件中。在本实施例中，增加注释的命令可以但不限于如下所示：#！<起始标签><结束标签>+<注释内容>。

在上述实施例的基础上，本发明实施例提供的配置文件的注释生成方法中，步骤101之前还可以包括修改注释的步骤：

接收修改注释的命令，该修改注释的命令中包括待修改注释的标签和修改后的注释内容；根据待修改注释的标签获得待修改注释，使用修改后的注释内容替换注释的原内容。在本实施例中，修改注释的命令可以但不限于如下所示：#<起始标签><结束标签>+<修改后的注释内容>。

在上述实施例的基础上，本发明实施例提供的配置文件的注释生成方法中，步骤101之前还可以包括删除注释的步骤：

接收删除注释的命令，该删除注释的命令中包括待删除注释的标签；根据待删除注释的标签获得待删除注释，将该注释及其标签删除。还可以指删除该注释的内容，而将其标签保留，此处不做强制要求。

图2为本发明一个实施例提供的配置文件生成设备的结构示意图，如图2所示，该设备为执行上述方法实施例的特定主体，可以是计算机、单片机等硬件设备。该配置文件生成设备至少包括注释生成模块201，该注释生成模块201包括：识别单元201a、获得单元201b以及写入单元201c。其中，识别单元201a用于在待生成文件中识别注释的标签，该标签包括起始标签和结束标签，该起始标签和结束标签之间的内容为注释。获得单元201b用于根据起始标签或结束标签、以及标签与标签在配置文件中的生成位置的对应关系，获得注释在配置文件中的生成位置；写入单元201c用于将注释写入上述生成位置。

一种实施方式下，该配置文件生成设备还可以包括：注释增加模块202，如图3所示的本发明一个实施例提供的注释增加模块的结构示意图，该注释增加模块202可以包括：接收单元202a和增加单元202b。其中的接收单元202a用于接收增加注释的命令，该增加注释的命令中包括注释的标签和内容，增加单元202b用于根据所述增加注释的命令将注释的标签和内容增加至待生成文件中。

又一种实施方式下，该配置文件生成设备还可以包括：注释修改模块203，如图4所示的本发明又一个实施例提供的注释修改模块的结构示意图，该注释修改模块203可以包括：接收单元203a和修改单元203b。其中的接收单元203a用于接收修改注释的命令，该修改注释的命令中包括待修改注释的标签和修改后的注释内容。修改单元203b用于根据待修改注释的标签获得待修改注释，使用该修改后的注释内容替换注释的原内容。

再一种实施方式下，该配置文件生成设备还可以包括：注释删除模块204，如图5所示的本发明再一个实施例提供的注释删除模块的结构示意图，该注释删除模块204可以包括：接收单元204a和删除单元204b。其中的接收单元204a用于接收删除注释的命令，该删除注释的命令中包括待删除注释的标签。删除单元204b用于根据待删除注释的标签获得待删除注释，并删除上述注释。

在上述实施例方式的基础上，图6为本发明还一个实施例提供的配置文件生成设备的结构示意图，该配置文件生成设备包含了上述实施例提供的多个模块中的一个或多个。多个模块之间可以共用接收单元(如202a)，根据接收单元202a接收到的命令的不同，将命令发送给不同的执行单元。如接收到增加注释的命令时，共用的接收单元202a将命令发送给增加单元202b，接收到修改注释的命令时，共用的接收单元202a将命令发送给修改单元203b，接收到删除注释的命令时，共用的接收单元202a将命令发送给删除单元204b等等。

本发明实施例提供了一种配置文件生成设备，其中包括了注释生成模块，通过识别待生成文件中的注释的标签，根据标签、以及标签与标签在配置文件中生成位置的对应关系，获得该标签所标识的注释在配置文件中的生成位置，将上述标签所标识的注释写入上述生成位置，从而生成注释，有效解决了现有技术中配置文件的重新生成过程无法保留注释内容的问题，使得配置文件中的注释真正发挥其说明作用，更好地为使用用户提供服务。

本领域普通技术人员可以理解：实现上述方法实施例的全部或部分步骤可以通过程序指令相关的硬件来完成，前述的程序可以存储于一计算机可读取存储介质中，该程序在执行时，执行包括上述方法实施例的步骤；而前述的存储介质包括：ROM、RAM、磁碟或者光盘等各种可以存储程序代码的介质。

最后应说明的是：以上实施例仅用以说明本发明的技术方案，而非对其限制；尽管参照前述实施例对本发明进行了详细的说明，本领域的普通技术人员应当理解：其依然可以对前述各实施例所记载的技术方案进行修改，或者对其中部分技术特征进行等同替换；而这些修改或者替换，并不使相应技术方案的本质脱离本发明各实施例技术方案的精神和范围。

Claims (9)

1.一种配置文件的注释生成方法，其特征在于，至少包括生成注释的步骤：

在待生成文件中识别注释的标签，所述标签包括起始标签和结束标签，所述起始标签和所述结束标签之间的内容为注释；其中，所述配置文件为将所述待生成文件通过一定的规则生成的文件；

根据所述起始标签或所述结束标签，以及标签与标签在所述配置文件中的生成位置的对应关系，获得所述注释在所述配置文件中的生成位置；

将所述注释写入所述注释在所述配置文件中的生成位置。

2.根据权利要求1所述的方法，其特征在于，所述在待生成文件中识别注释的标签之前，所述方法还包括增加注释的步骤：

接收增加注释的命令，所述增加注释的命令中包括待增加注释的标签和内容；

将所述待增加注释的标签和内容增加至所述待生成文件中。

3.根据权利要求1所述的方法，其特征在于，所述在待生成文件中识别注释的标签之前，所述方法还包括修改注释的步骤：

接收修改注释的命令，所述修改注释的命令中包括待修改注释的标签和修改后的注释内容；

根据所述待修改注释的标签获得所述待修改注释，使用所述修改后的注释内容替换所述注释的原内容。

4.根据权利要求1所述的方法，其特征在于，所述在待生成文件中识别注释的标签之前，所述方法还包括删除注释的步骤：

接收删除注释的命令，所述删除注释的命令中包括待删除注释的标签；

根据所述待删除注释的标签获得所述待删除注释，将所述注释及其标签删除。

5.根据权利要求1所述的方法，其特征在于，所述标签为字母、数字、符号中的一种或多种。

6.一种配置文件生成设备，其特征在于，至少包括注释生成模块，所述注释生成模块包括：

识别单元，用于在待生成文件中识别注释的标签，所述标签包括起始标签和结束标签，所述起始标签和所述结束标签之间的内容为注释；其中，所述配置文件为将所述待生成文件通过一定的规则生成的文件；

获得单元，用于根据所述起始标签或所述结束标签，以及标签与标签在所述配置文件中的生成位置的对应关系，获得所述注释在所述配置文件中的生成位置；

写入单元，用于将所述注释写入所述注释在所述配置文件中的生成位置。

7.根据权利要求6所述的设备，其特征在于，所述设备还包括：注释增加模块，所述注释增加模块包括：

接收单元，用于接收增加注释的命令，所述增加注释的命令中包括注释的标签和内容；

增加单元，用于将所述注释的标签和内容增加至所述待生成文件中。

8.根据权利要求6所述的设备，其特征在于，所述设备还包括：注释修改模块，所述注释修改模块包括：

接收单元，用于接收修改注释的命令，所述修改注释的命令中包括待修改注释的标签和修改后的注释内容；

修改单元，用于根据所述待修改注释的标签获得所述待修改注释，使用所述修改后的注释内容替换所述注释的原内容。

9.根据权利要求6所述的设备，其特征在于，所述设备还包括：注释删除模块，所述注释删除模块包括：

接收单元，用于接收删除注释的命令，所述删除注释的命令中包括待删除注释的标签；

删除单元，用于根据所述待删除注释的标签获得所述待删除注释，并所述待删除注释。

Images