28 模块基础

在本篇教程中，我们将深入探讨 Rust 的模块系统。模块是一种重要的组织代码的方式，可以帮助我们将代码划分为不同的部分，使代码结构清晰易读。模块系统是 Rust 中非常核心的概念，能够帮助我们高效地管理项目中不同的功能。

模块的定义

在 Rust 中，我们可以使用 mod 关键字来定义一个模块。模块可以被认为是一种命名空间，允许我们封装相关的功能、数据结构和实现。通过模块，Rust 提供了一个可以有效管理代码的工具。

创建一个简单的模块

下面是一个简单的模块定义的示例：

// 定义一个名为 `my_module` 的模块
mod my_module {
    // 在模块内部定义一个函数
    pub fn greet(name: &str) {
        println!("Hello, {}!", name);
    }
}

// 在外部调用模块中的函数
fn main() {
    my_module::greet("Rustacean");
}

在这个例子中，我们定义了一个名为 my_module 的模块，并在其中实现了一个 greet 函数。注意到我们使用了 pub 关键字来标记函数为公共，这样才能在模块外部进行访问。

通过上述代码，我们可以看到如何创建模块及在模块中定义函数的基本方式。模块内的内容默认是私有的，只有使用 pub 关键字标记为公共后，才能在外部访问。

模块的目录结构

Rust 允许我们将模块组织为文件，通常每个模块拥有其独立的文件，这样可以使得代码更加清晰有序。如果模块需要很多内容，你可以将其放入单独的文件中，并通过 mod 引入它。

文件的方式组织模块

假设我们有一个名为 shapes 的模块，我们想把它放在一个单独的文件中。

1. 创建一个名为 shapes.rs 的文件：

// 在 shapes.rs 文件中
pub mod circle {
    pub fn area(radius: f64) -> f64 {
        std::f64::consts::PI * radius * radius
    }
}

pub mod square {
    pub fn area(side: f64) -> f64 {
        side * side
    }
}

2. 在 main.rs 中引入这个模块：

mod shapes;

fn main() {
    let circle_area = shapes::circle::area(2.0);
    println!("Circle area: {}", circle_area);

    let square_area = shapes::square::area(3.0);
    println!("Square area: {}", square_area);
}

在这个例子中，我们创建了一个名为 shapes 的模块，并在其内部定义了两个子模块 circle 和 square。每个子模块也有一个计算面积的函数。

模块的嵌套

Rust 允许模块的嵌套，一个模块可以包含其他模块，从而形成树形结构。这种情况下，模块之间的关系也会更加清晰。

嵌套模块的示例

mod food {
    pub mod fruit {
        pub fn apple() {
            println!("This is an apple.");
        }
        
        pub fn banana() {
            println!("This is a banana.");
        }
    }

    pub mod vegetable {
        pub fn carrot() {
            println!("This is a carrot.");
        }
    }
}

fn main() {
    food::fruit::apple();
    food::vegetable::carrot();
}

在这个例子中，我们定义了一个名为 food 的模块，其中包含了 fruit 和 vegetable 两个子模块。这种结构清晰地表现了模块之间的关系。

模块的私有性

Rust 有一个重要的特性是模块内容的私有性。默认情况下，模块中的所有项都是私有的，只有在显式地标记为 pub 后，才能被外部访问。

私有性示例

mod my_module {
    // 私有函数
    fn private_function() {
        println!("This is private.");
    }

    // 公共函数
    pub fn public_function() {
        private_function();
        println!("This is public.");
    }
}

fn main() {
    my_module::public_function();
    // my_module::private_function(); // 这会导致编译错误
}

在这个例子中，private_function 是私有的，不能在 main 函数中直接调用，而 public_function 是公共的，能够在外部调用并且可以间接调用私有函数。

小结

在本篇教程中，我们探讨了 Rust 中的模块和其基本使用方式。我们学会了如何定义模块、如何组织模块的目录结构、模块的嵌套关系，以及模块私有性的重要性。这些概念都是有效组织 Rust 项目的基础，为后续的更复杂的模块与包系统打下了良好基础。

在接下来的教程中，我们将讨论 Rust 的包和 Cargo 工具，帮助我们管理项目依赖和构建流程。通过创建和管理包，我们将能更高效地开发 Rust 应用程序。