CN101944023A - Unix服务器软件通用命令行接口实现方法 - Google Patents

Abstract

本发明提供了一种集成在UNIX服务器软件系统上的通用命令行接口模型及实现方法。根据人机交互语言命令的特点，并充分考虑到用户的各种需求，制定了完善的接口。同时，本发明对命令行接口按照功能进行了模块化封装，使得在C++软件系统中能够简单方便的应用，不需要过多的重复开发，提高了代码的可重用性，缩短了软件开发周期。并可以支持二次开发，节省了开发成本。另外，本发明应用命令树生成策略构造命令集，提供命令提示及补全功能，为用户提供了一种简单实用，不需要记忆各种复杂命令的命令行输入方法。

Description

UNIX服务器软件通用命令行接口实现方法

技术领域

本发明提供了一种集成在UNIX服务器软件系统上的通用命令行接口模型及实现方法。

 背景技术

命令行接口（Command Line Interface，简写：CLI）是在图形用户界面（GUI）得到普及之前使用最为广泛的人机交互用户界面（它通常不支持鼠标），用户通过键盘输入指令，机器系统接收到指令后，予以执行。

通常认为，命令行接口没有图形用户界面那么方便用户操作，图形用户界面软件更美观易用，命令行接口的软件通常需要用户记忆操作的命令。但是，由于命令行接口本身的特点，要比图形用户界面节约计算机系统的资源，在熟记命令的前提下，使用命令行接口往往要比使用图形用户界面的操作速度要快；功能也更加强大。所以，在现在的图形用户界面的操作系统中和应用软件中，通常都保留着可选的命令行接口。

命令行接口在现代通信系统中是非常重要，尤其在UNIX服务器软件系统中，由于UNIX服务器系统本身的特性及其软件对性能要求，使得图形用户界面力有未逮，所以需要一个功能完善的命令行接口，来提供丰富的控制与自动化管理功能。

 发明内容

为了解决现有技术中存在的上述问题，本发明提出一种UNIX服务器软件通用命令行接口实现方法，具体技术方案如下：

一种UNIX服务器软件通用命令行接口实现方法，是在软件系统中驻留命令处理模块CliServer和命令行用户接口程序cmdsh两个配合工作的部分，由这两个部分构成通用命令行接口；

cmdsh是通用的，即一个cmdsh可以配合多个不同的CliServer工作；

cmdsh通过与软件系统中CliServer进行通信；

用户通过cmdsh发送指令到软件系统来完成相应的工作；

从发送命令到软件系统的命令行接口，到返回执行结果的过程如下：

1)cmdsh连接到软件系统的CliServer，CliServer经过用户名及密码的检验后判断用户登录是否成功；

2)登录成功，用户通过cmdsh发送命令给命令行接口；

3)CliServer收到来自cmdsh的命令，进行合法性检验；

4)如果通过了合法性检验，根据命令中的信息，由软件系统中的相应执行命令处理相应的命令，并将命令执行结果返回cmdsh；

5)如果没通过合法性检验，返回执行出错信息给cmdsh并断开与cmdsh的连接；

6)cmdsh等待用户输入新命令。

 所述cmdsh通过TCP/IP协议与CliServer进行通信；cmdsh通过socket方式连接到CliServer。

所述通用命令行接口中，命令集的数据组织形式是命令树，树上的每个节点就是一个命令的描述信息，定义了该命令的命令字，命令的说明描述，命令类型，及该命令的处理函数入口地址。

命令树的生成过程是，首先构建根节点，按照节点node的结构填充树根节点；再根据子命令生成根命令root下的各个子节点及节点说明；最终生成命令终节点，命令终节点中包含有执行命令的入口函数；命令节点都生成完成后，如果命令有参数，则在命令终结点下继续生成相应的参数节点。

对所述命令树进行解析匹配，分析字符串的正确性，以决定是否执行该命令，过程是，逐层解析匹配各个节点，通过匹配命令树中定义的命令子节点及其参数规则来判断输入命令的有效性；在匹配完成后，从匹配到的最终命令节点来获取函数的入口地址，并执行命令对应的处理函数。

所述命令树进行解析匹配，并对命令树进行判断合法性，步骤如下：

a)从命令树root节开始匹配，根据命令匹配root的所有分支子节点，若没有，则失败；

b)若有子命令，根据子命令匹配当前命令节点的分枝子节点，若没有，则当前命令节点为命令终结点；

c)命令的参数个数是否与命令树命令终结点的分支子节点的个数一致，若不一致，则出错。

 所述步骤2)中，登录成功，用户发送的命令是命令字符串，其格式为：

命令（命令 子命令 子命令 …）+ 空格 + 参数列表（参数l 参数2 … 参数n）

命令以空格来分隔每个子命令，参数列表中以空格来分隔每个参数。

所述步骤3)中，合法性检验是先把命令字符串按以上格式拆分命令字符串，然后根据命令树对命令及命令参数的描述信息来检验该命令字符串的合法性，是否符合命令节点的定义；

所述步骤4)中，执行命令处理相应的命令是，根据命令树数据结构中对该命令的入口函数描述信息，执行命令对应的处理函数。

 本发明根据人机交互语言命令的特点，并充分考虑到用户的各种需求，制定了简单完善的接口。同时，本发明对命令行接口按照功能进行模块化封装，使得在C++软件系统中能够简单方便的应用，不需要过多的重复开发，提高了代码的可重用性，缩短了软件开发周期。并可以支持二次开发，节省了开发成本。另外，本发明应用命令树生成策略构造命令集，提供命令提示及补全功能，为用户提供了一种简单实用，不需要记忆各种复杂命令的命令行输入方法。

一个功能强大的命令行接口是UNIX服务器高端软件产品所必须的。通过它可以使本来繁琐的工作，如软件日常维护，错误定位，软件更新等，变得简单方便。本发明已经在彩铃，短信等多个UNIX服务器软件产品中实验应用。

 附图说明

图1是具体实施例中，命令行工作流程示意图；

图2是具体实施例中，命令树结构示意图。

 具体实施方式

下面结合附图与具体实施方式对本发明作进一步说明。

命令行接口由驻留在软件系统中的命令处理模块（CliServer）和命令行用户接口程序（cmdsh）2部分组成，两者配合工作。命令行用户接口程序是通用的，即一个用户接口程序，可以配合多个不同的命令处理模块工作。命令行用户接口程序通过TCP/IP协议与软件系统中命令处理程序进行通信。用户（系统管理员或软件维护人员）通过命令行用户接口程序发送指令到软件系统来完成相应的工作，如查询资源使用情况，监控系统运行状况，修改系统环境变量等。

为了对命令行的执行流程有一个比较清晰的说明 ，下面分析从发送命令到软件系统的命令行接口，到返回执行结果的过程，如图1所示。

具体执行流程分析如下：

( 1 ) 首先将命令行处理程序CliServer集成到应用软件系统中，并构造命令节点来生产命令树。

( 2 ) 命令行用户接口程序（cmdsh）通过socket方式连接到软件系统命令处理模块（CliServer），命令处理模块经过用户名及密码的检验后判断其登录是否成功。  

( 3 ) 登录成功，用户就可以通过cmdsh发送命令给命令行接口。用户在输入命令字符串时，可以通过TAB制表符进行命令自动补全以及命令和命令参数的说明帮助，方便用户的操作。cmdsh发送的命令字符串格式为：

命令（命令 子命令 子命令 …）+ 空格 + 参数列表（参数l 参数2 … 参数n）

命令以空格来分隔每个子命令，参数列表中以空格来分隔每个参数。

如：add user name pwd，其中add user为命令字符串；name pwd 为参数列表。

( 4 )CliServer收到命令字符串，并按以上格式拆分命令字符串，然后根据命令树对命令及命令参数的描述信息来检验该命令字符串的合法性 ，是否符合命令节点的定义。

( 5 ) 如果通过了合法性检验，根据命令树数据结构中对该命令的入口函数描述信息，通过回调的方式执行命令对应的处理函数并将命令执行结果返回cmdsh。

( 6 ) 如果没通过合法性检验，返回执行出错信息并断开网络连接。 

( 7 ) cmdsh程序又回到提示输入命令状态，等待用户输入命令。

 具体实施时，按照命令行接口的工作流程，可分成4个功能模块来实现本接口：通信模块、命令解析处理模块、命令树生成模块和用户接口模块。

(一)     通信模块实现

通信模块需要完成命令行用户接口程序与软件系统命令处理模块间的通信，通信方式采用TCP/IP协议长连接。软件系统命令处理模块CliServer为服务端，命令行用户接口程序cmdsh为客户端，为了不过多的消耗系统资源，可对支持的客户端数进行限制。

如果一台服务器有多个软件系统应用命令行接口，每个命令行服务端需要监听不同的端口。当客户端在指定端口与服务端连接成功后，通信模块负责登录消息及命令消息的收发，以及消息报文的拆分。客户端登陆3次失败，则服务器与客户端断开连接。

通信模块中消息格式定义如下：

                      

(二)     命令树生成模块实现

命令树：即命令行接口中命令集的数据组织形式 ，树上的每个节点就是一个命令的描述信息，详细定义了该命令的命令字，命令的说明描述，命令类型，及该命令的处理函数入口地址。命令解析过程通过搜索命令树来完成。

其中命令树每一个节点（node）的结构定义如下所示：

命令树生成模块主要是组织本命令行接口的命令集。为了提高命令解析模块的效率，命令集以树的形式组织，如图2：

下面以图2命令树为例，具体描述命令树的生成。

此命令树共构造了3条命令，“show running config”、“show version”和“add account <name> <pwd>”，（此处的参数用尖括号括起来，以此来和命令区分，在node结构中通过Type来区分）。首先必须构建根节点，按照node的结构填充树根节，再根据子命令生成根命令root下子show子节点和add子节点及节点说明， 同样生成version子节点和running子节点及account子节点及其以下的命令子节点。

其中version子节点，config子节点和account子节点是命令终节点。命令终节点中包含有执行命令的入口函数。命令节点都生成完成后，如果命令有参数，则需要在命令终结点下生成参数节点，name子节点和pwd子节点都是参数节点。

命令树可以在程序中手工构造，也可以由文件自动构造。

 (三)     命令解析模块实现

命令解析模块是命令行接口中的重要模块。它主要用来拆分用户输入的字符串，并分析字符串的正确性，以决定是否执行该命令。该模块需要匹配命令树中定义的命令子及其参数规则来判断输入命令的有效性。在命令匹配完成后，从匹配到的最终命令节点来获取函数的入口地址，并执行命令对应的处理函数。

其解析匹配的核心内容包括：

（ 1 ) 从命令树root节开始匹配，根据命令匹配root的所有分支子节点，若没有，则失败。

（ 2 ) 若有子命令 ，根据子命令匹配当前命令节点的分枝子节点，若没有，则当前命令节点为命令终结点。

（ 3 ) 命令的参数个数是否与命令树命令终结点的分支子节点的个数一致，若不一致，则出错。

命令行解析与匹配的核心代码如下所示：

命令匹配的核心代码如下所示：

(四)     用户接口模块实现

用户接口模块是用户输入命令并显示执行结果的人机交互界面。实现了以下功能：

当连接成功后，提示用户输入用户名及密码登陆到命令行接口。

登陆成功后，生成输入界面及命令输入提示符”>”（类似于DOS界面）。

当用户输入命令时，开始按字符接收客户的输入。如果没有输入，就等待，否则判断输入的字符，如果退格键 ，删除命令输入缓冲中当前光标位置处的一个字符；如果是UP/DOWN 键，则翻阅历史命令；如果输入制表符（tab）键，则按照命令树格式进行命令字符串的补全；如果输入？键，则输出命令帮助信息；如果输入键值在空格与127之间，将该输入键值保存到输入命令接收缓冲，并刷新客户端界面；如果是回车键，标志客户一次正常的命令字符串输入已结束，此时应将命令字符串传入传输模块并由传输模块发送到命令行处理模块。

在用户接口模块中，会记录界面的相关信息，如当前光标位置、命令行字符串的最大字符个数、一屏的每行宽度及列数，当用户的当前光标超过每行宽度时，就换行；当输入的命令行字符串超过最大字符个数时，就禁止用户再输入。

Claims (5)

1.一种UNIX服务器软件通用命令行接口实现方法，其特征是在软件系统中驻留命令处理模块CliServer和命令行用户接口程序cmdsh两个配合工作的部分，由这两个部分构成通用命令行接口；

cmdsh是通用的，即一个cmdsh可以配合多个不同的CliServer工作；

cmdsh通过与软件系统中CliServer进行通信；

用户通过cmdsh发送指令到软件系统来完成相应的工作；

从发送命令到软件系统的命令行接口，到返回执行结果的过程如下：

1)cmdsh连接到软件系统的CliServer，CliServer经过用户名及密码的检验后判断用户登录是否成功；

2)登录成功，用户通过cmdsh发送命令给命令行接口；

3)CliServer收到来自cmdsh的命令，进行合法性检验；

4)如果通过了合法性检验，根据命令中的信息，由软件系统中的相应执行命令处理相应的命令，并将命令执行结果返回cmdsh；

5)如果没通过合法性检验，返回执行出错信息给cmdsh并断开与cmdsh的连接；

6)cmdsh等待用户输入新命令。

2.根据权利要求1所述的UNIX服务器软件通用命令行接口实现方法，其特征是所述cmdsh通过TCP/IP协议与CliServer进行通信；cmdsh通过socket方式连接到CliServer。

3.根据权利要求1或2所述的UNIX服务器软件通用命令行接口实现方法，其特征是所述通用命令行接口中，命令集的数据组织形式是命令树，树上的每个节点就是一个命令的描述信息，定义了该命令的命令字，命令的说明描述，命令类型，及该命令的处理函数入口地址；

命令树的生成过程是，首先构建根节点，按照节点node的结构填充树根节点；再根据子命令生成根命令root下的各个子节点及节点说明；最终生成命令终节点，命令终节点中包含有执行命令的入口函数；命令节点都生成完成后，如果命令有参数，则在命令终结点下继续生成相应的参数节点；

对所述命令树进行解析匹配，分析字符串的正确性，以决定是否执行该命令，过程是，逐层解析匹配各个节点，通过匹配命令树中定义的命令子节点及其参数规则来判断输入命令的有效性；在匹配完成后，从匹配到的最终命令节点来获取函数的入口地址，并执行命令对应的处理函数。

4.根据权利要求3所述的UNIX服务器软件通用命令行接口实现方法，其特征是所述命令树进行解析匹配，并对命令树进行判断合法性，步骤如下：

a)从命令树root节开始匹配，根据命令匹配root的所有分支子节点，若没有，则失败；

b)若有子命令，根据子命令匹配当前命令节点的分枝子节点，若没有，则当前命令节点为命令终结点；

c)命令的参数个数是否与命令树命令终结点的分支子节点的个数一致，若不一致，则出错。

5.根据权利要求4所述的UNIX服务器软件通用命令行接口实现方法，其特征是

所述步骤2)中，登录成功，用户发送的命令是命令字符串，其格式为：

命令（命令 子命令 子命令 …）+ 空格 + 参数列表（参数l 参数2 … 参数n）

命令以空格来分隔每个子命令，参数列表中以空格来分隔每个参数；

所述步骤3)中，合法性检验是先把命令字符串按以上格式拆分命令字符串，然后根据命令树对命令及命令参数的描述信息来检验该命令字符串的合法性，是否符合命令节点的定义；

所述步骤4)中，执行命令处理相应的命令是，根据命令树数据结构中对该命令的入口函数描述信息，执行命令对应的处理函数。

Images