命令行工具（CLI）对于开发者和系统管理员来说是不可或缺的工具。Rust 以其性能和安全性著称，是构建健壮高效的 CLI 应用的绝佳选择。本指南将带你一步步使用 Rust 创建一个命令行工具，并充分利用 Rust 1.70+ 的最新特性。
为什么要选择 Rust 构建 CLI 工具？
性能: Rust 编译为原生代码，无需运行时或垃圾回收器。 安全性: 内存安全保证可以防止常见的错误。 生态系统: 丰富的库和工具。 并发: 对异步编程的出色支持。
开发环境搭建
确保已安装最新版本的 Rust。Rustup 是管理 Rust 版本的推荐工具。
安装 Rust
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
更新 Rust
rustup update
创建新的 Rust 项目
使用 Cargo（Rust 的包管理器）创建一个新的 Rust 项目。
cargo new my_cli_tool
cd my_cli_tool
使用 clap 解析命令行参数
clap 是一个强大的 crate，用于解析命令行参数和子命令。
将 clap 添加到依赖项
在 Cargo.toml 中添加：
[dependencies]
clap = { version = "4.3.10", features = ["derive"] }
编写参数解析器
在 src/main.rs 中：
use clap::{Arg, Command};
fn main() {
let matches = Command::new("my_cli_tool")
.version("1.0")
.author("Your Name <you@example.com>")
.about("Does awesome things")
.arg(
Arg::new("input")
.about("Input file")
.required(true)
.index(1),
)
.arg(
Arg::new("verbose")
.short('v')
.about("Increases verbosity")
.multiple_occurrences(true),
)
.get_matches();
// Access arguments
let input = matches.value_of("input").unwrap();
let verbosity = matches.occurrences_of("verbose");
println!("Input file: {}", input);
println!("Verbosity level: {}", verbosity);
}
运行应用程序
cargo run -- input.txt -vvv
输出:
Input file: input.txt
Verbosity level: 3
实现核心功能
让我们为 CLI 工具添加一些功能。假设我们正在创建一个工具，用于统计文本文件中行数、单词数和字符数（类似于 wc）。
读取文件
在 main.rs 中添加以下代码：
use std::fs::File;
use std::io::{self, BufRead, BufReader};
fn main() {
// ... (previous code)
// Open the file
let file = File::open(input).expect("Could not open file");
let reader = BufReader::new(file);
// Initialize counters
let mut lines = 0;
let mut words = 0;
let mut bytes = 0;
for line in reader.lines() {
let line = line.expect("Could not read line");
lines += 1;
words += line.split_whitespace().count();
bytes += line.len();
}
println!("Lines: {}", lines);
println!("Words: {}", words);
println!("Bytes: {}", bytes);
}
运行应用程序
创建一个名为 input.txt 的示例文件：
echo "Hello world!" > input.txt
echo "This is a test file." >> input.txt
运行该工具：
cargo run -- input.txt
输出:
Input file: input.txt
Verbosity level: 0
Lines: 2
Words: 6
Bytes: 33
添加子命令和高级功能
子命令允许你的 CLI 工具执行不同的操作。
使用子命令更新 clap 解析器
修改 main.rs：
use clap::{Arg, Command};
fn main() {
let matches = Command::new("my_cli_tool")
.version("1.0")
.author("Your Name <you@example.com>")
.about("Does awesome things")
.subcommand_required(true)
.arg_required_else_help(true)
.subcommand(
Command::new("count")
.about("Counts characters, words, or lines")
.arg(
Arg::new("chars")
.short('c')
.long("chars")
.about("Count characters"),
)
.arg(
Arg::new("words")
.short('w')
.long("words")
.about("Count words"),
)
.arg(
Arg::new("lines")
.short('l')
.long("lines")
.about("Count lines"),
)
.arg(
Arg::new("input")
.about("Input file")
.required(true)
.index(1),
),
)
.get_matches();
match matches.subcommand() {
Some(("count", sub_m)) => {
let input = sub_m.value_of("input").unwrap();
let count_chars = sub_m.is_present("chars");
let count_words = sub_m.is_present("words");
let count_lines = sub_m.is_present("lines");
// Call function to perform counting
perform_counting(input, count_chars, count_words, count_lines);
}
_ => unreachable!("Exhausted list of subcommands"),
}
}
fn perform_counting(input: &str, chars: bool, words: bool, lines: bool) {
// ... (implement counting logic)
}
实现 perform_counting
fn perform_counting(input: &str, chars: bool, words: bool, lines: bool) {
let file = File::open(input).expect("Could not open file");
let reader = BufReader::new(file);
let mut line_count = 0;
let mut word_count = 0;
let mut char_count = 0;
for line in reader.lines() {
let line = line.expect("Could not read line");
if lines {
line_count += 1;
}
if words {
word_count += line.split_whitespace().count();
}
if chars {
char_count += line.len();
}
}
if lines {
println!("Lines: {}", line_count);
}
if words {
println!("Words: {}", word_count);
}
if chars {
println!("Characters: {}", char_count);
}
}
使用子命令运行工具
cargo run -- count -l -w input.txt
输出:
Lines: 2
Words: 6
错误处理和日志记录
对于 CLI 工具来说，健壮的错误处理和日志记录至关重要。
使用 anyhow 进行错误处理
在 Cargo.toml 中添加 anyhow：
[dependencies]
anyhow = "1.0"
更新函数以返回 Result：
use anyhow::{Context, Result};
fn main() -> Result<()> {
// ... (previous code)
Ok(())
}
fn perform_counting(input: &str, chars: bool, words: bool, lines: bool) -> Result<()> {
let file = File::open(input).with_context(|| format!("Could not open file '{}'", input))?;
// ... (rest of the code)
Ok(())
}
使用 env_logger 添加日志记录
在 Cargo.toml 中添加 env_logger 和 log：
[dependencies]
log = "0.4"
env_logger = "0.10"
在 main 中初始化日志记录器：
use log::{debug, error, info, trace, warn};
fn main() -> Result<()> {
env_logger::init();
// ... (rest of the code)
}
在代码中使用日志宏：
fn perform_counting(input: &str, chars: bool, words: bool, lines: bool) -> Result<()> {
info!("Starting counting for file: {}", input);
// ... (rest of the code)
Ok(())
}
运行应用程序时设置日志级别：
RUST_LOG=info cargo run -- count -l -w input.txt
增强用户体验
使用 colored 添加彩色输出
在 Cargo.toml 中添加 colored：
[dependencies]
colored = "2.0"
在输出中使用 colored：
use colored::*;
println!("Lines: {}", line_count.to_string().green());
println!("Words: {}", word_count.to_string().yellow());
println!("Characters: {}", char_count.to_string().blue());
使用 indicatif 添加进度条
在 Cargo.toml 中添加 indicatif：
[dependencies]
indicatif = "0.17"
使用进度条：
use indicatif::ProgressBar;
fn perform_counting(input: &str, chars: bool, words: bool, lines: bool) -> Result<()> {
let file = File::open(input).with_context(|| format!("Could not open file '{}'", input))?;
let metadata = file.metadata()?;
let total_size = metadata.len();
let reader = BufReader::new(file);
let pb = ProgressBar::new(total_size);
// ... (read the file and update pb)
pb.finish_with_message("Done");
Ok(())
}
构建和分发你的 CLI 工具
构建发布二进制文件
cargo build --release
二进制文件将位于 target/release/my_cli_tool。
使用 cross 进行交叉编译
安装 cross：
cargo install cross
为不同的目标构建：
cross build --target x86_64-unknown-linux-musl --release
使用 cargo-bundle 打包
对于 macOS 应用程序或 Windows 安装程序，请考虑使用 cargo-bundle。
发布到 Crates.io
在 Cargo.toml 中更新元数据：
[package]
name = "my_cli_tool"
version = "1.0.0"
authors = ["Your Name <you@example.com>"]
description = "A CLI tool for counting lines, words, and characters."
homepage = "https://github.com/yourusername/my_cli_tool"
repository = "https://github.com/yourusername/my_cli_tool"
license = "MIT"
登录并发布：
cargo login
cargo publish
总结
你现在已经使用 Rust 创建了一个功能丰富的命令行工具，包括参数解析、子命令、错误处理、日志记录以及彩色输出和进度条等增强用户体验功能。
关键要点:
Rust 的性能和安全性使其成为 CLI 工具的理想选择。 clapcrate 简化了参数解析和子命令管理。使用 anyhow进行错误处理和使用env_logger进行日志记录提高了鲁棒性。使用 colored和indicatif增强 UX 使你的工具更易于使用。使用 Cargo 及其相关工具可以轻松构建和分发你的工具。
