在当今的软件开发领域，命令行界面 (CLI) 工具扮演着至关重要的角色。它们提供了高效、便捷的方式来与系统进行交互。而 Rust 语言凭借其性能、安全性以及丰富的生态系统，成为了构建 CLI 工具的理想选择。本文将带你一步步用 Rust 语言打造一个自定义 CLI 工具，实现文件批量重命名的功能。
需求分析
我们的目标是构建一个能够根据指定模式批量重命名文件的 CLI 工具。具体功能如下：
模式匹配： 只重命名与指定模式匹配的文件。 前缀添加： 为匹配到的文件名添加一个静态前缀，但不改变文件名本身。 预览功能： 在执行重命名操作之前，提供一个预览功能，展示将要被重命名的文件及其新的文件名。
开发步骤
项目初始化
首先，使用
cargo new命令创建一个新的 Rust 项目：
cargo new file-renamer
然后进入项目目录：
cd file-renamer
添加依赖
在
Cargo.toml文件中添加clap依赖，用于解析命令行参数：
[dependencies]
clap = { version = "4.0", features = ["derive"] }
设计 CLI 语法
为了方便用户使用，我们需要定义一个清晰直观的 CLI 语法。我们将采用以下语法：
<程序名> <指令> <目录> <模式> <前缀>
<程序名>: 程序的名称，例如file-renamer。<指令>: 可以是stage（预览）或commit（执行）。<目录>: 需要搜索文件的目录路径。<模式>: 用于匹配文件名的正则表达式。<前缀>: 要添加到文件名之前的字符串。
导入依赖
在
main.rs文件中导入必要的库：
use clap::Parser;
use regex::Regex;
use std::fs;
use std::path::Path;
定义命令行参数结构
使用
clap::Parser宏定义一个结构体来描述命令行参数：
#[derive(Parser)]
struct Args {
#[arg(short, long)]
instruction: String,
#[arg(short, long)]
dir: String,
#[arg(short, long)]
pattern: String,
#[arg(short, long)]
prefix: String,
}
编写核心逻辑
在
main函数中编写核心逻辑，包括解析命令行参数、匹配文件、重命名文件等：
fn main() -> Result<(), Box<dyn std::error::Error>> {
let args = Args::parse();
let instruction = &args.instruction;
let re = Regex::new(&args.pattern)?;
let dir_path = Path::new(&args.dir);
// 检查目录路径是否有效
if !dir_path.is_dir() {
eprintln!("Error: The path '{}' is not a directory.", args.dir);
return Ok(());
}
// 根据指令执行不同的操作
match instruction.as_str() {
"stage" => {
for entry in fs::read_dir(dir_path)? {
let entry = entry?;
let path = entry.path();
// 仅处理文件
if path.is_file() {
if let Some(filename) = path.file_name().and_then(|f| f.to_str()) {
if re.is_match(filename) {
let new_filename = format!("{}{}", args.prefix, filename);
println!("File '{}' will be renamed to '{}'", filename, new_filename);
}
}
}
}
}
"commit" => {
for entry in fs::read_dir(dir_path)? {
let entry = entry?;
let path = entry.path();
// 仅处理文件
if path.is_file() {
if let Some(filename) = path.file_name().and_then(|f| f.to_str()) {
if re.is_match(filename) {
let new_filename = format!("{}{}", args.prefix, filename);
let new_path = path.with_file_name(new_filename);
// 执行重命名操作
fs::rename(&path, &new_path)?;
println!("Renamed '{}' to '{}'", filename, new_path.display());
}
}
}
}
}
_ => {
eprintln!("Error: Invalid instruction '{}'.", instruction);
return Ok(());
}
}
Ok(())
}
代码解析
解析命令行参数： 使用 Args::parse()函数解析命令行参数，并将其存储在args结构体中。创建正则表达式： 使用 Regex::new()函数创建正则表达式对象，用于匹配文件名。检查目录路径： 使用 dir_path.is_dir()函数检查指定的目录路径是否有效。遍历目录： 使用 fs::read_dir()函数遍历目录，并获取每个文件或文件夹的条目。匹配文件： 使用 re.is_match()函数判断文件名是否匹配正则表达式。生成新文件名： 使用 format!()宏拼接新的文件名。预览或重命名： 根据 instruction的值，执行预览或重命名操作。
测试工具
编译并运行程序，使用以下命令测试功能：
cargo run -- --instruction "stage" --pattern "image" --prefix "iphone" --dir "/path/to/images"
该命令将预览所有匹配模式 image 的文件，并显示添加前缀 iphone 后的新文件名。
cargo run -- --instruction "commit" --pattern "image" --prefix "iphone" --dir "/path/to/images"
该命令将实际重命名所有匹配模式的文件，并将结果打印到控制台。
扩展功能
除了基本功能之外，还可以根据需求添加其他功能，例如：
支持多种操作： 除了重命名之外，还可以添加其他操作，例如删除、复制等。 错误处理： 添加更完善的错误处理机制，例如捕获文件系统错误、正则表达式错误等。 进度显示： 在执行重命名操作时，显示进度条，让用户了解操作进度。 配置文件： 使用配置文件存储常用的命令行参数，方便用户重复使用。
总结
本文介绍了如何使用 Rust 语言构建一个自定义 CLI 工具，实现文件批量重命名的功能。通过学习本文，你将掌握 Rust 语言的基本语法、命令行参数解析、文件系统操作等知识，并能够根据自己的需求构建各种功能强大的 CLI 工具。
希望本文对你有所帮助，如果你有任何问题或建议，欢迎在评论区留言。
点击关注并扫码添加进交流群
