重构以提高模块化和错误处理

为了改进我们的程序,我们将修复四个与程序的结构以及它如何处理潜在错误相关的问题。首先,我们的 main 函数现在执行两个任务:解析参数和读取文件。随着我们程序的增长,main 函数处理的独立任务数量将会增加。当一个函数承担越来越多的职责时,它就变得更难理解、更难测试,并且在不破坏其某个部分的情况下更难更改。最好将功能分离,以便每个函数负责一个任务。

这个问题也与第二个问题相关:虽然 queryfile_path 是我们程序的配置变量,但像 contents 这样的变量用于执行程序的逻辑。main 函数越长,我们需要引入作用域的变量就越多;作用域中的变量越多,就越难跟踪每个变量的用途。最好将配置变量分组到一个结构中,以明确它们的用途。

第三个问题是,我们在读取文件失败时使用了 expect 来打印错误消息,但错误消息只是打印 应该能够读取文件。读取文件可能会以多种方式失败:例如,文件可能丢失,或者我们可能没有打开它的权限。现在,无论情况如何,我们都会为所有事情打印相同的错误消息,这不会给用户任何信息!

第四,我们使用 expect 来处理错误,如果用户在没有指定足够参数的情况下运行我们的程序,他们会从 Rust 收到一个 index out of bounds 错误,这并没有清楚地解释问题。最好将所有的错误处理代码放在一个地方,这样未来的维护人员如果需要更改错误处理逻辑时,只需查阅一个地方的代码。将所有错误处理代码放在一个地方,还可以确保我们打印的消息对最终用户有意义。

让我们通过重构我们的项目来解决这四个问题。

二进制项目的关注点分离

将多个任务的职责分配给 main 函数的组织问题在许多二进制项目中很常见。因此,当 main 函数开始变得很大时,Rust 社区已经制定了分割二进制程序的不同关注点的指南。此过程包含以下步骤

  • 将您的程序拆分为一个 main.rs 文件和一个 lib.rs 文件,并将您的程序逻辑移动到 lib.rs
  • 只要您的命令行解析逻辑很小,它就可以保留在 main.rs 中。
  • 当命令行解析逻辑开始变得复杂时,将其从 main.rs 中提取出来并移动到 lib.rs

经过此过程后,保留在 main 函数中的职责应仅限于以下内容

  • 使用参数值调用命令行解析逻辑
  • 设置任何其他配置
  • 调用 lib.rs 中的 run 函数
  • 处理 run 返回错误的情况

此模式是关于关注点分离:main.rs 处理程序的运行,lib.rs 处理手头任务的所有逻辑。因为您不能直接测试 main 函数,所以此结构允许您通过将其移动到 lib.rs 中的函数来测试您的所有程序逻辑。保留在 main.rs 中的代码将足够小,可以通过阅读来验证其正确性。让我们按照此过程重新构建我们的程序。

提取参数解析器

我们将提取用于解析参数的功能到一个 main 将调用的函数中,以准备将命令行解析逻辑移动到 src/lib.rs。清单 12-5 显示了新的 main 开头,它调用了一个新的函数 parse_config,我们暂时将其定义在 src/main.rs 中。

文件名:src/main.rs
use std::env;
use std::fs;

fn main() {
    let args: Vec<String> = env::args().collect();

    let (query, file_path) = parse_config(&args);

    // --snip--

    println!("Searching for {query}");
    println!("In file {file_path}");

    let contents = fs::read_to_string(file_path)
        .expect("Should have been able to read the file");

    println!("With text:\n{contents}");
}

fn parse_config(args: &[String]) -> (&str, &str) {
    let query = &args[1];
    let file_path = &args[2];

    (query, file_path)
}
清单 12-5:从 main 中提取 parse_config 函数

我们仍然将命令行参数收集到一个向量中,但是我们不是在 main 函数中将索引 1 处的参数值分配给变量 query,将索引 2 处的参数值分配给变量 file_path,而是将整个向量传递给 parse_config 函数。然后,parse_config 函数保存逻辑,确定哪个参数进入哪个变量,并将值返回给 main。我们仍然在 main 中创建 queryfile_path 变量,但 main 不再负责确定命令行参数和变量之间的对应关系。

对于我们的小程序来说,这种重构可能看起来有点矫枉过正,但是我们正在以小的、增量的步骤进行重构。进行此更改后,再次运行程序以验证参数解析是否仍然有效。经常检查您的进度是很好的做法,以便在出现问题时帮助识别原因。

分组配置值

我们可以采取另一个小的步骤来进一步改进 parse_config 函数。目前,我们返回一个元组,但随后我们立即将该元组再次拆分为各个部分。这是一个信号,表明我们可能还没有正确的抽象。

另一个表明有改进空间的指标是 parse_configconfig 部分,这意味着我们返回的两个值是相关的,并且都是一个配置值的一部分。我们目前没有在数据结构中表达这种含义,只是将两个值分组到一个元组中;我们将把这两个值放入一个结构中,并给每个结构字段一个有意义的名称。这样做将使此代码的未来维护人员更容易理解不同值之间的关系以及它们的用途是什么。

清单 12-6 显示了对 parse_config 函数的改进。

文件名:src/main.rs
use std::env;
use std::fs;

fn main() {
    let args: Vec<String> = env::args().collect();

    let config = parse_config(&args);

    println!("Searching for {}", config.query);
    println!("In file {}", config.file_path);

    let contents = fs::read_to_string(config.file_path)
        .expect("Should have been able to read the file");

    // --snip--

    println!("With text:\n{contents}");
}

struct Config {
    query: String,
    file_path: String,
}

fn parse_config(args: &[String]) -> Config {
    let query = args[1].clone();
    let file_path = args[2].clone();

    Config { query, file_path }
}
清单 12-6:重构 parse_config 以返回 Config 结构的实例

我们添加了一个名为 Config 的结构,它被定义为具有名为 queryfile_path 的字段。parse_config 的签名现在表示它返回一个 Config 值。在 parse_config 的主体中,我们过去返回引用 argsString 值的字符串切片,现在我们定义 Config 以包含拥有的 String 值。main 中的 args 变量是参数值的所有者,并且仅允许 parse_config 函数借用它们,这意味着如果 Config 试图获取 args 中值的所有权,我们将违反 Rust 的借用规则。

有很多方法可以管理 String 数据;最简单的方法(尽管效率有点低)是在值上调用 clone 方法。这将为 Config 实例制作数据的完整副本以拥有,这比存储对字符串数据的引用需要更多的时间和内存。但是,克隆数据也使我们的代码非常简单,因为我们不必管理引用的生命周期;在这种情况下,为了获得简单性而放弃一点性能是值得的。

使用 clone 的权衡

许多 Rustaceans 倾向于避免使用 clone 来解决所有权问题,因为它有运行时成本。在 第 13 章中,您将学习如何在这种情况中使用更有效的方法。但是现在,复制一些字符串以继续取得进展是可以的,因为您只会复制一次,并且您的文件路径和查询字符串非常小。拥有一个有点低效的工作程序,而不是在第一次尝试时就尝试过度优化代码是更好的。随着您对 Rust 的经验越来越丰富,从最有效的解决方案开始会更容易,但是现在,调用 clone 是完全可以接受的。

我们已经更新了 main,以便它将 parse_config 返回的 Config 实例放入名为 config 的变量中,并且我们更新了以前使用单独的 queryfile_path 变量的代码,以便它现在使用 Config 结构上的字段。

现在我们的代码更清楚地表达了 queryfile_path 是相关的,并且它们的目的是配置程序的工作方式。任何使用这些值的代码都知道在 config 实例中找到它们,这些字段的名称是为了它们的用途而命名的。

Config 创建构造函数

到目前为止,我们已经从 main 中提取了负责解析命令行参数的逻辑,并将其放置在 parse_config 函数中。这样做帮助我们看到 queryfile_path 值是相关的,并且这种关系应该在我们的代码中表达。然后,我们添加了一个 Config 结构来命名 queryfile_path 的相关用途,并且能够从 parse_config 函数中返回值的名称作为结构字段名称。

现在 parse_config 函数的目的是创建一个 Config 实例,我们可以将 parse_config 从普通函数更改为与 Config 结构关联的名为 new 的函数。进行此更改将使代码更符合惯用法。我们可以通过调用 String::new 来创建标准库中类型的实例,例如 String。类似地,通过将 parse_config 更改为与 Config 关联的 new 函数,我们将能够通过调用 Config::new 来创建 Config 的实例。清单 12-7 显示了我们需要进行的更改。

文件名:src/main.rs
use std::env;
use std::fs;

fn main() {
    let args: Vec<String> = env::args().collect();

    let config = Config::new(&args);

    println!("Searching for {}", config.query);
    println!("In file {}", config.file_path);

    let contents = fs::read_to_string(config.file_path)
        .expect("Should have been able to read the file");

    println!("With text:\n{contents}");

    // --snip--
}

// --snip--

struct Config {
    query: String,
    file_path: String,
}

impl Config {
    fn new(args: &[String]) -> Config {
        let query = args[1].clone();
        let file_path = args[2].clone();

        Config { query, file_path }
    }
}
清单 12-7:将 parse_config 更改为 Config::new

我们已经更新了 main,其中我们以前调用 parse_config,现在改为调用 Config::new。我们已经将 parse_config 的名称更改为 new 并将其移动到 impl 块中,这会将 new 函数与 Config 关联起来。再次尝试编译此代码以确保其有效。

修复错误处理

现在我们将致力于修复我们的错误处理。回想一下,如果向量包含少于三个项,则尝试访问 args 向量中索引 1 或索引 2 处的值会导致程序崩溃。尝试在没有任何参数的情况下运行程序;它看起来像这样

$ cargo run
   Compiling minigrep v0.1.0 (file:///projects/minigrep)
    Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.0s
     Running `target/debug/minigrep`
thread 'main' panicked at src/main.rs:27:21:
index out of bounds: the len is 1 but the index is 1
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

index out of bounds: the len is 1 but the index is 1 行是为程序员设计的错误消息。它不会帮助我们的最终用户了解他们应该做什么。现在让我们修复它。

改进错误消息

在清单 12-8 中,我们在 new 函数中添加了一个检查,该检查将在访问索引 1 和索引 2 之前验证切片是否足够长。如果切片不够长,程序会崩溃并显示更好的错误消息。

文件名:src/main.rs
use std::env;
use std::fs;

fn main() {
    let args: Vec<String> = env::args().collect();

    let config = Config::new(&args);

    println!("Searching for {}", config.query);
    println!("In file {}", config.file_path);

    let contents = fs::read_to_string(config.file_path)
        .expect("Should have been able to read the file");

    println!("With text:\n{contents}");
}

struct Config {
    query: String,
    file_path: String,
}

impl Config {
    // --snip--
    fn new(args: &[String]) -> Config {
        if args.len() < 3 {
            panic!("not enough arguments");
        }
        // --snip--

        let query = args[1].clone();
        let file_path = args[2].clone();

        Config { query, file_path }
    }
}
清单 12-8:添加对参数数量的检查

这段代码类似于我们在清单 9-13 中编写的 Guess::new 函数,我们在 value 参数超出有效值范围时调用了 panic!。在这里,我们不是检查值范围,而是检查 args 的长度是否至少为 3,并且该函数的其余部分可以在满足此条件的前提下运行。如果 args 的项少于三个,则此条件将为 true,并且我们调用 panic! 宏以立即结束程序。

new 中添加了这几行额外的代码后,让我们在没有任何参数的情况下再次运行程序,看看现在的错误是什么样子

$ cargo run
   Compiling minigrep v0.1.0 (file:///projects/minigrep)
    Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.0s
     Running `target/debug/minigrep`
thread 'main' panicked at src/main.rs:26:13:
not enough arguments
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

这个输出更好:我们现在有了一个合理的错误消息。但是,我们也得到了一些我们不想给用户看的额外信息。也许我们在列表 9-13 中使用的技术在这里不是最佳的:调用 panic! 更适合用于编程问题而不是使用问题,正如第 9 章所讨论的相反,我们将使用你在第 9 章中了解到的另一种技术——返回一个 Result来表示成功或错误。

返回 Result 而不是调用 panic!

我们可以改为返回一个 Result 值,该值在成功的情况下将包含一个 Config 实例,并在错误的情况下描述问题。我们还将函数名从 new 更改为 build,因为许多程序员期望 new 函数永远不会失败。当 Config::buildmain 通信时,我们可以使用 Result 类型来表示存在问题。然后我们可以更改 main 以将 Err 变体转换为对用户来说更实用的错误,而没有调用 panic! 导致的关于 thread 'main'RUST_BACKTRACE 的周围文本。

列表 12-9 显示了我们需要对我们现在调用的函数 Config::build 的返回值进行的更改,以及返回 Result 所需的函数体。请注意,在我们更新 main 之前,这不会编译,我们将在下一个列表中进行更新。

文件名:src/main.rs
use std::env;
use std::fs;

fn main() {
    let args: Vec<String> = env::args().collect();

    let config = Config::new(&args);

    println!("Searching for {}", config.query);
    println!("In file {}", config.file_path);

    let contents = fs::read_to_string(config.file_path)
        .expect("Should have been able to read the file");

    println!("With text:\n{contents}");
}

struct Config {
    query: String,
    file_path: String,
}

impl Config {
    fn build(args: &[String]) -> Result<Config, &'static str> {
        if args.len() < 3 {
            return Err("not enough arguments");
        }

        let query = args[1].clone();
        let file_path = args[2].clone();

        Ok(Config { query, file_path })
    }
}
列表 12-9:从 Config::build 返回 Result

我们的 build 函数返回一个 Result,其中在成功情况下包含一个 Config 实例,在错误情况下包含一个字符串字面量。我们的错误值将始终是具有 'static 生命周期的字符串字面量。

我们在函数体中做了两个更改:当用户没有传递足够的参数时,我们现在返回一个 Err 值,而不是调用 panic!,并且我们将 Config 返回值包装在 Ok 中。这些更改使函数符合其新的类型签名。

Config::build 返回一个 Err 值允许 main 函数处理从 build 函数返回的 Result 值,并在错误情况下更干净地退出进程。

调用 Config::build 并处理错误

为了处理错误情况并打印用户友好的消息,我们需要更新 main 以处理 Config::build 返回的 Result,如列表 12-10 所示。我们还将退出命令行工具并返回非零错误代码的责任从 panic! 中移除,改为手动实现。非零退出状态是一种约定,用于向调用我们程序的进程发出信号,表明该程序以错误状态退出。

文件名:src/main.rs
use std::env;
use std::fs;
use std::process;

fn main() {
    let args: Vec<String> = env::args().collect();

    let config = Config::build(&args).unwrap_or_else(|err| {
        println!("Problem parsing arguments: {err}");
        process::exit(1);
    });

    // --snip--

    println!("Searching for {}", config.query);
    println!("In file {}", config.file_path);

    let contents = fs::read_to_string(config.file_path)
        .expect("Should have been able to read the file");

    println!("With text:\n{contents}");
}

struct Config {
    query: String,
    file_path: String,
}

impl Config {
    fn build(args: &[String]) -> Result<Config, &'static str> {
        if args.len() < 3 {
            return Err("not enough arguments");
        }

        let query = args[1].clone();
        let file_path = args[2].clone();

        Ok(Config { query, file_path })
    }
}
列表 12-10:如果构建 Config 失败,则以错误代码退出

在此列表中,我们使用了一个我们尚未详细介绍的方法:unwrap_or_else,它由标准库在 Result<T, E> 上定义。使用 unwrap_or_else 允许我们定义一些自定义的、非 panic! 的错误处理。如果 Result 是一个 Ok 值,则此方法的行为类似于 unwrap:它返回 Ok 包装的内部值。但是,如果该值是一个 Err 值,则此方法会调用闭包中的代码,这是一个匿名函数,我们定义并将其作为参数传递给 unwrap_or_else。我们将在第 13 章中更详细地介绍闭包。现在,你只需要知道 unwrap_or_else 会将 Err 的内部值传递给我们的闭包,在本例中,它是我们在列表 12-9 中添加的静态字符串 "not enough arguments",在垂直管道之间出现的参数 err 中。然后,闭包中的代码可以在运行时使用 err 值。

我们添加了一个新的 use 行,将标准库中的 process 带入作用域。错误情况下将运行的闭包中的代码只有两行:我们打印 err 值,然后调用 process::exitprocess::exit 函数会立即停止程序并返回作为退出状态代码传递的数字。这类似于我们在列表 12-8 中使用的基于 panic! 的处理,但我们不再得到所有额外的输出。让我们试试看

$ cargo run
   Compiling minigrep v0.1.0 (file:///projects/minigrep)
    Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.48s
     Running `target/debug/minigrep`
Problem parsing arguments: not enough arguments

太棒了!这个输出对我们的用户来说更加友好。

main 中提取逻辑

现在我们已经完成了配置解析的重构,让我们转向程序的逻辑。正如我们在“二进制项目关注点分离”中所述,我们将提取一个名为 run 的函数,该函数将保存当前 main 函数中所有与设置配置或处理错误无关的逻辑。完成后,main 将简洁易懂,我们可以通过检查来验证它,并且我们将能够为所有其他逻辑编写测试。

列表 12-11 显示了提取的 run 函数。现在,我们只是进行小的、增量的改进,即提取函数。我们仍然在src/main.rs中定义该函数。

文件名:src/main.rs
use std::env;
use std::fs;
use std::process;

fn main() {
    // --snip--

    let args: Vec<String> = env::args().collect();

    let config = Config::build(&args).unwrap_or_else(|err| {
        println!("Problem parsing arguments: {err}");
        process::exit(1);
    });

    println!("Searching for {}", config.query);
    println!("In file {}", config.file_path);

    run(config);
}

fn run(config: Config) {
    let contents = fs::read_to_string(config.file_path)
        .expect("Should have been able to read the file");

    println!("With text:\n{contents}");
}

// --snip--

struct Config {
    query: String,
    file_path: String,
}

impl Config {
    fn build(args: &[String]) -> Result<Config, &'static str> {
        if args.len() < 3 {
            return Err("not enough arguments");
        }

        let query = args[1].clone();
        let file_path = args[2].clone();

        Ok(Config { query, file_path })
    }
}
列表 12-11:提取一个包含程序其余逻辑的 run 函数

run 函数现在包含 main 中的所有剩余逻辑,从读取文件开始。run 函数将 Config 实例作为参数。

run 函数返回错误

将剩余的程序逻辑分离到 run 函数中后,我们可以改进错误处理,就像我们在列表 12-9 中对 Config::build 所做的那样。run 函数不是允许程序通过调用 expect 来 panic,而是在出现问题时返回 Result<T, E>。这将使我们能够进一步将处理错误的逻辑整合到 main 中,使其对用户友好。列表 12-12 显示了我们需要对 run 的签名和主体进行的更改。

文件名:src/main.rs
use std::env;
use std::fs;
use std::process;
use std::error::Error;

// --snip--


fn main() {
    let args: Vec<String> = env::args().collect();

    let config = Config::build(&args).unwrap_or_else(|err| {
        println!("Problem parsing arguments: {err}");
        process::exit(1);
    });

    println!("Searching for {}", config.query);
    println!("In file {}", config.file_path);

    run(config);
}

fn run(config: Config) -> Result<(), Box<dyn Error>> {
    let contents = fs::read_to_string(config.file_path)?;

    println!("With text:\n{contents}");

    Ok(())
}

struct Config {
    query: String,
    file_path: String,
}

impl Config {
    fn build(args: &[String]) -> Result<Config, &'static str> {
        if args.len() < 3 {
            return Err("not enough arguments");
        }

        let query = args[1].clone();
        let file_path = args[2].clone();

        Ok(Config { query, file_path })
    }
}
列表 12-12:更改 run 函数以返回 Result

我们在这里进行了三个重大更改。首先,我们将 run 函数的返回类型更改为 Result<(), Box<dyn Error>>。此函数之前返回 unit 类型 (),我们在 Ok 的情况下保持不变。

对于错误类型,我们使用了trait 对象 Box<dyn Error>(并且我们使用顶部的 use 语句将 std::error::Error 带入了作用域)。我们将在第 17 章中介绍 trait 对象。现在,只需知道 Box<dyn Error> 意味着该函数将返回一个实现 Error trait 的类型,但我们不必指定返回值将是什么特定类型。这使我们可以灵活地返回在不同错误情况下可能属于不同类型的错误值。dyn 关键字是 dynamic 的缩写。

其次,我们删除了对 expect 的调用,转而使用 ? 运算符,正如我们在第 9 章中所讨论的那样。? 不会在出现错误时 panic!,而是会从当前函数返回错误值,以供调用者处理。

第三,run 函数现在在成功情况下返回一个 Ok 值。我们在签名中将 run 函数的成功类型声明为 (),这意味着我们需要将 unit 类型值包装在 Ok 值中。这种 Ok(()) 语法乍一看可能有点奇怪,但像这样使用 () 是惯用方法,表示我们调用 run 只是为了它的副作用;它不会返回我们需要的值。

当你运行此代码时,它会编译,但会显示警告

$ cargo run -- the poem.txt
   Compiling minigrep v0.1.0 (file:///projects/minigrep)
warning: unused `Result` that must be used
  --> src/main.rs:19:5
   |
19 |     run(config);
   |     ^^^^^^^^^^^
   |
   = note: this `Result` may be an `Err` variant, which should be handled
   = note: `#[warn(unused_must_use)]` on by default
help: use `let _ = ...` to ignore the resulting value
   |
19 |     let _ = run(config);
   |     +++++++

warning: `minigrep` (bin "minigrep") generated 1 warning
    Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.71s
     Running `target/debug/minigrep the poem.txt`
Searching for the
In file poem.txt
With text:
I'm nobody! Who are you?
Are you nobody, too?
Then there's a pair of us - don't tell!
They'd banish us, you know.

How dreary to be somebody!
How public, like a frog
To tell your name the livelong day
To an admiring bog!

Rust 告诉我们,我们的代码忽略了 Result 值,而 Result 值可能表示发生了错误。但是我们没有检查是否发生了错误,并且编译器提醒我们,我们可能打算在这里添加一些错误处理代码!现在让我们纠正这个问题。

main 中处理从 run 返回的错误

我们将检查错误并使用类似于我们在列表 12-10 中对 Config::build 使用的技术来处理它们,但略有不同

文件名:src/main.rs

use std::env;
use std::error::Error;
use std::fs;
use std::process;

fn main() {
    // --snip--

    let args: Vec<String> = env::args().collect();

    let config = Config::build(&args).unwrap_or_else(|err| {
        println!("Problem parsing arguments: {err}");
        process::exit(1);
    });

    println!("Searching for {}", config.query);
    println!("In file {}", config.file_path);

    if let Err(e) = run(config) {
        println!("Application error: {e}");
        process::exit(1);
    }
}

fn run(config: Config) -> Result<(), Box<dyn Error>> {
    let contents = fs::read_to_string(config.file_path)?;

    println!("With text:\n{contents}");

    Ok(())
}

struct Config {
    query: String,
    file_path: String,
}

impl Config {
    fn build(args: &[String]) -> Result<Config, &'static str> {
        if args.len() < 3 {
            return Err("not enough arguments");
        }

        let query = args[1].clone();
        let file_path = args[2].clone();

        Ok(Config { query, file_path })
    }
}

我们使用 if let 而不是 unwrap_or_else 来检查 run 是否返回 Err 值,如果返回则调用 process::exit(1)run 函数不会返回我们想要 unwrap 的值,就像 Config::build 返回 Config 实例一样。因为 run 在成功情况下返回 (),所以我们只关心检测错误,因此我们不需要 unwrap_or_else 返回解包后的值,它只会是 ()

if letunwrap_or_else 函数的主体在两种情况下是相同的:我们打印错误并退出。

将代码拆分为库 crate

到目前为止,我们的 minigrep 项目看起来不错!现在我们将拆分src/main.rs文件,并将一些代码放入src/lib.rs文件中。这样,我们就可以测试代码,并拥有一个责任较少的src/main.rs文件。

让我们将 main 函数中不存在的所有代码从src/main.rs移动到src/lib.rs

  • run 函数定义
  • 相关的 use 语句
  • Config 的定义
  • Config::build 函数定义

src/lib.rs的内容应具有列表 12-13 中显示的签名(为了简洁起见,我们省略了函数的主体)。请注意,在我们在列表 12-14 中修改src/main.rs之前,这不会编译。

文件名:src/lib.rs
use std::error::Error;
use std::fs;

pub struct Config {
    pub query: String,
    pub file_path: String,
}

impl Config {
    pub fn build(args: &[String]) -> Result<Config, &'static str> {
        // --snip--
        if args.len() < 3 {
            return Err("not enough arguments");
        }

        let query = args[1].clone();
        let file_path = args[2].clone();

        Ok(Config { query, file_path })
    }
}

pub fn run(config: Config) -> Result<(), Box<dyn Error>> {
    // --snip--
    let contents = fs::read_to_string(config.file_path)?;

    println!("With text:\n{contents}");

    Ok(())
}
列表 12-13:将 Configrun 移动到src/lib.rs

我们大量使用了 pub 关键字:在 Config 上、其字段和其 build 方法上以及 run 函数上。我们现在有一个库 crate,它具有我们可以测试的公共 API!

现在我们需要将我们移动到src/lib.rs的代码带入src/main.rs中的二进制 crate 的作用域,如列表 12-14 所示。

文件名:src/main.rs
use std::env;
use std::process;

use minigrep::Config;

fn main() {
    // --snip--
    let args: Vec<String> = env::args().collect();

    let config = Config::build(&args).unwrap_or_else(|err| {
        println!("Problem parsing arguments: {err}");
        process::exit(1);
    });

    println!("Searching for {}", config.query);
    println!("In file {}", config.file_path);

    if let Err(e) = minigrep::run(config) {
        // --snip--
        println!("Application error: {e}");
        process::exit(1);
    }
}
列表 12-14:在src/main.rs中使用 minigrep 库 crate

我们添加了一个 use minigrep::Config 行,将库 crate 中的 Config 类型带入二进制 crate 的作用域,并且我们在 run 函数前加上了我们的 crate 名称。现在,所有功能都应该连接起来并且可以正常工作。使用 cargo run 运行程序,并确保一切正常。

呼!这可真是费了不少功夫,但我们为未来的成功奠定了基础。现在处理错误更容易了,而且我们还使代码更具模块化。从现在开始,我们几乎所有的工作都将在 src/lib.rs 中完成。

让我们利用这种新获得的模块化优势,做一些在旧代码中很难做到但在新代码中很容易做到的事情:我们将编写一些测试!