rust学习八、包和模块

总体上，也没有什么特别的地方，和其它语言比较起来。

我们可以看懂熟悉的字眼：包括、模块、use、公共等等

如果是英文，则需要知道crate、pub。

本章节对应相关书籍的第七章节.

一、一个rust可执行程序的大体结构

就本章节而言，尚未接触到一个非常复杂的工程结构，据说有什么工作空间。

不考虑工作空间，那么一个rust可执行应用大概如下：

 

所谓的单元包即"crate"。

crate - 木箱、一箱 等含义。为了方便我们翻译为单元包，小包。

这是因为package已经约定成俗翻译为"包“，那么crate作为一个程序容器，翻译为”小包、单元包"也是可以的。

如果要这个程序可以执行,则至少应该包含一个二进制可执行包，即src/main.rs，其中应该有main()入口。

而这个package反而有点类似于maven工程，cargo new 就是创建一个 package（工程):

 

如果你熟悉java编程，那么rust的package,crate大体可以等价于：

rust                 java

---------------------------------------------

package-        project

crate               package

 

 

单元包分类

 

强调几点：

1. 外部单元包一般通过cargo install 安装到Cargo.toml中
2. 库单元位于src/lib.rs中。可以使用 cargo new --lib xxx 来创建一个库单元包，而不是一个包含了二进制单元包的可执行程序

 

下图包含了两个示例：lzfmatch(库单元包), school（一个可执行程序，包含了一个二进制单元)

 

 单元包组成

 

图看起来好像复杂，例子反而简单。

二、模块系统

换一个角度，一个应用程序，就是无数模块构成的.

和其它大部分语言一样：可以模块嵌套模块；模块嵌套的层次没有明说（应该也不会有那么疯狂自找麻烦的)

图_单元包和模块的简单关系示意

 

实际可以嵌套很多层次。

三、示例

如果看不太明白，或者不太想看，那么直接看例子最直接的。

3.1、结构

包含了两个二级模块student,teacher,以及5个三级子模块。

 

操作系统文件结构

从上图可以看出:

模块student的子包位于同名子目录下student/stuent_course.rs,student/student_info.rs

模块teacher的子包是内联的（即和teacher自身同个文件）

/**
 * 子模块1-通用
 */
pub mod teacher_common {
    pub fn teach() {
        println!("老师在上课");
        super::teacher_inner::learn();   //即使和被访问对象位于同个父亲下两个子模块下，两个子模块内的方法也只能访问对方公共的成员
        //super::teacher_inner::laugh(); //企图访问私有成员会编译错误的。
    }
}

/**
 * 子模块2-家庭
 */
pub mod teacher_family {}

/**
 * 内部模块-私有
 */
mod teacher_inner {
    /**
     * 即使处于同个层级，如果不定义为pub，其它同层级的方法也无法访问，因为毕竟属于不同模块
     */
    pub fn learn() {}
    fn laugh(){
        println!("老师在笑");
    }
}

pub fn go() {
    println!("教师模块");
}

 

 

3.2、 引入/引用说明

//use crate::student::student_info::stru_student;   //通常不要那么麻烦，还要加crate
use student::student_info::stru_student;  //引入单个
use student::student_info::*;  //引入所有的，不要那么麻烦
use student::student_course::Course as Subject;  //引入单个且用别名

mod teacher;
mod student;


fn main() {
    teacher::go();    
    student::go();

    //直接使用子模块的子模块方法
    teacher::teacher_common::teach();
    let stu=stru_student{
        name:"tom".to_string(),
        sex:"男".to_string(),
        age:12,
    };

    print_student(stu);

    let sub=Subject::汉语;
    print!("{:?}",sub);
}

 

上文演示了3种常用的use语法。

注意：由于这些模块都是位于本单元包内，所以需要先用 mod xxx的语法引入模块，然后再使用use语句引入模块内对象（类型、方法等)

 

3.3、pub use

rust还有一个比较独特的pub use,原文的意思是(re-exporting),意思是如果被的作用域导入当前模块，那么可以访问这里pub use的对象。

我们来做个例子：

1.为teacher模块新增子模块study,study下有函数study_hard

2.在teacher中pub use study::study_hard

3.在main.rs种使用

 

四、小结

1. 虽然粗看起来，rust的程序组织有点小复杂，但是和大部分语言没有什么区别，和java很像
2. rust通过包、单元包（二进制、库）、模块来组织应用中的代码
3. 一个单元包可以包含许多模块
4. 模块可以包含子模块
5. 模块之间的嵌套层次没有明确的限定，但不会有人嵌套太多层次
6. rust利用pub use可以做到重导出作用