项目地址:https://github.com/kingwel-xie/xcli-rs

xcli是一个命令行的工具,支持自定义添加命令,每个命令支持缩写使用,同时也支持tab方式补全命令。

设计思路

这个工具的设计初衷是为了能够提供命令行功能,同时可以很容易的添加自定义的命令。

应用场景

目前在libp2p-rs中,xcli提供了命令行的功能,可对swarm和kad进行调试。

类型转换

从命令行中获取到的参数args是一个引用类型的&str数组,即&[&str]。在xcli中,实现了一个名为check_param的宏,返回的值即为想要转换的对应类型。check_param!需要四个参数

($param_count:expr, $required:expr, $args:ident, ($($change_type:ty=>$has_from:expr), *))

分别代表参数总个数、必选参数个数,参数列表,最后一个参数比较特殊,代表着需要转换的类型。书写格式形如(String=>1),对于所有输入参数都需要设置该转换类型。

需要注意的一点是,参数的总个数必须与最后的参数转换类型个数相同。譬如总共有5个参数,那么后面的类型转换也需要将这五个参数的类型都进行设置。

举例说明:

let u = check_param!(3, 1, args, (String=>1, String=>1, String=>1))

这段代码表示总共需要三个参数,其中一个是必须的,另外两个是可选的,这三个参数都是String类型的。返回值的个数最少是1个(必须参数一定返回),最多是3个。

命令补全

由于底层库使用的是rustyline,它提供了一个Completer的trait,实现fn complete()即可支持tab补全。

在App::run()中,我们对Command执行了一个方法:

self.rl.borrow_mut().set_helper(Some(PrefixCompleter::new(&self.tree)));

这段代码的逻辑是将Command单独抽离出来形成一个类似树的结构。
以下这段代码是补全功能的核心:

  1. 初始化返回的vector,偏移量,下一个节点
  2. 循环当前节点的子命令节点
    1. 如果输入的字符串长度大于等于子命令的长度
      1. 字符串开头是子命令的名称
        1. 字符串长度与子命令长度相等,vector加一个空格
        2. 不相等,将子命令添加到vector中
      2. 记录子命令长度为偏移量,将子命令标记为下一个递归的起始节点。
    2. 如果子命令的开头与字符串匹配
      1. vector添加字符串,记录偏移量,标记子命令为下一个递归起始节点
  3. 如果vector不止一个数据,说明有多个匹配的命令,直接返回
  4. 如果满足执行子命令的递归情况,从字符串的偏移量位开始继续执行tab completion.

    pub fn _complete_cmd(node: &PrefixNode, line: &str, pos: usize) -> Vec<String> {
        debug!("cli to complete {} for node {}", line, node.name);
        let line = line[..pos].trim_start();
        let mut go_next = false;
    
        let mut new_line: Vec<String> = vec![];
        let mut offset: usize = 0;
        let mut next_node = None;
    
        //var lineCompleter PrefixCompleterInterface
        for child in &node.children {
            //debug!("try node {}", child.name);
            if line.len() >= child.name.len() {
                if line.starts_with(&child.name) {
                    if line.len() == child.name.len() {
                        // add a fack new_line " "
                        new_line.push(" ".to_string());
                    } else {
                        new_line.push(child.name.to_string());
                    }
                    offset = child.name.len();
                    next_node = Some(child);
    
                    // may go next level
                    go_next = true;
                }
            } else if child.name.starts_with(line) {
                new_line.push(child.name[line.len()..].to_string());
                offset = line.len();
                next_node = Some(child);
            }
        }
    
        // more than 1 candidates?
        if new_line.len() != 1 {
            debug!("offset={}, candidates={:?}", offset, new_line);
            return new_line;
        }
    
        if go_next {
            let line = line[offset..].trim_start();
            return PrefixCompleter::_complete_cmd(next_node.unwrap(), line, line.len());
        }
    
        debug!("offset={}, nl={:?}", offset, new_line);
        new_line
    }

使用方法

以help命令为例,实现一个显示可用命令的功能:

    app.add_subcommand(
        Command::new_with_alias("help", "h")
            .about("displays help information")
            .usage("help [command]")
            .action(cli_help)),
    );

    /// Action of help command
    fn cli_help(app: &App, args: &[&str]) -> XcliResult {
        if args.is_empty() {
            app.tree.show_subcommand_help();
        } else if let Some(cmd) = app.tree.locate_subcommand(args) {
            cmd.show_command_help();
        } else {
            println!("Unrecognized command {:?}", args)
        }
        Ok(CmdExeCode::Ok)
    }

调用add_subcommand()向cli实例中添加一个help命令,action方法参数是一个返回值为XcliResult的fn。XcliResult是一个T为CmdExeCode,E为XcliError的Result类型:

pub type XcliResult = stdResult<CmdExeCode, XcliError>;

在这里我们定义了cli_help函数,正常运行时返回值为Ok。实现的命令效果如图所示:
xcli,一个简单易用的命令行工具

userdata

add_subcommand_with_userdata()是在v0.5.0新增支持的一个方法。有时候使用者可能希望测试一些自定义的数据结构,这个方法可以支持用户注册自己的数据到xcli中,后续可以通过命令行的方式进行调试。方法声明如下:

pub fn add_subcommand_with_userdata(&mut self, subcmd: Command<'a>, value: IAny) {
    self.handlers.insert(subcmd.name.clone(), value);
    self.tree.subcommands.push(subcmd);
}

这段代码的逻辑是将value添加到全局的handler中,handler是一个HashMap,key为命令名称,value是传入的IAny类型值。

方法的第一个参数是Command,定义了命令的名称、子命令、对应的执行函数等等属性;第二个参数是相关的用户数据,IAny是Box<dyn std::any::Any>,意味着可以放入绝大多数的自定义类型参数。

使用的逻辑也较为简单,以下是示例代码:

    app.add_subcommand_with_userdata(
        Command::new_with_alias("userdata", "ud")
            .about("controls testing features")
            .action(|app, _args| -> XcliResult {
                let data_any = app.get_handler("userdata").unwrap();

                let data = data_any.downcast_ref::<usize>().expect("usize");

                println!("userdata = {}", data);
                Ok(CmdExeCode::Ok)
            }),
        Box::new(100usize)
    );

在这里,我们注册了一个叫userdata的子命令,其中value设置为了100。执行userdata命令时,从handler中取出userdata对应的值,downcast_ref解析出usize,再进行println。实现效果如图所示:
xcli,一个简单易用的命令行工具

libp2p-rs中的使用

由于userdata命令的存在,我们可以使用自己的数据去定义子命令。例如在libp2p-rs中,提供有swarm和kad的controller与主循环交互,因此我们可以用这两个controller去定义命令:

app.add_subcommand_with_userdata(swarm_cli_commands(), Box::new(swarm_control.clone()));
app.add_subcommand_with_userdata(dht_cli_commands(), Box::new(kad_control.clone()));

实现效果图:

  1. swarm peer,无参即展示当前连接peer
    xcli,一个简单易用的命令行工具

  2. swarm peer,有参显示对应peer信息
    xcli,一个简单易用的命令行工具

  3. dht stats显示当前状态
    xcli,一个简单易用的命令行工具

Netwarps 由国内资深的云计算和分布式技术开发团队组成,该团队在金融、电力、通信及互联网行业有非常丰富的落地经验。Netwarps 目前在深圳、北京均设立了研发中心,团队规模30+,其中大部分为具备十年以上开发经验的技术人员,分别来自互联网、金融、云计算、区块链以及科研机构等专业领域。
Netwarps 专注于安全存储技术产品的研发与应用,主要产品有去中心化文件系统(DFS)、去中心化计算平台(DCP),致力于提供基于去中心化网络技术实现的分布式存储和分布式计算平台,具有高可用、低功耗和低网络的技术特点,适用于物联网、工业互联网等场景。
公众号:Netwarps