【Rust进阶】通过测试驱动开发学习：02_项目搭建

第一个项目

创建一个对链表处理的库，包含链表新建，插入，获取元素，反转，排序等。具体功能在开发的时候详细说明。

链表

链表是一种常见的数据结构，它由一系列节点组成，每个节点包含数据元素和指向下一个节点的引用。链表可以分为单向链表、双向链表和循环链表等不同类型。

单向链表中，每个节点包含一个数据元素和一个指向下一个节点的引用。最后一个节点的引用通常为空（null）。

双向链表中，每个节点除了包含数据元素和指向下一个节点的引用外，还包含指向前一个节点的引用。

循环链表是一种特殊的链表，其中最后一个节点指向第一个节点，形成一个循环。

链表的优点是插入和删除操作效率高，时间复杂度为O(1)。然而，链表的缺点是访问元素的效率较低，需要遍历整个链表，时间复杂度为O(n)。

头结点

• 带头结点的链表是指在链表的头部增加一个空节点，这个节点不存储数据，仅用于简化链表操作。
• 不带头结点的链表则直接从存储数据的第一个节点开始。

带头结点的链表在实现上更加简单，因为不需要特殊处理头节点为空的情况，而不带头结点的链表则需要额外处理头节点为空的情况。带头结点的链表可以简化插入和删除操作的代码逻辑，但会浪费一个节点的存储空间。

接下来没有特殊说明我们的链表都默认带头结点，而头结点的值设为其包含的元素个数。

创建一个库项目

cargo new --lib 库名

定义链表

#[derive(Debug)]
pub struct LinkedNode<T> {
	data: T,
	next: Option<Box<LinkedNode<T>>>,
}


#[derive(Debug)]
pub struct LinkedList<T> {
	head: Option<Box<LinkedNode<T>>>,
}

1. 定义节点的结构体LinkedNode，它包含一个data字段，存储当前节点的数据，next字段是一个枚举类型，包含了指向下一个节点的指针。
2. 定义了链表的结构体LinkedList，它包含一个字段head，是一个枚举类型，包含了一个指向第一个节点的指针。

从上面的代码中，其实我们发现LinkedNode结构体就已经使用和表示链表结构，为什么还要创建一个新的结构体Linked_list来将Node封装进去呢？

LinkedNode<T> 结构体表示链表的节点，而 LinkedList<T> 结构体则表示整个链表的结构。为什么要分开这两个结构体呢？这主要涉及到设计和使用的灵活性、代码组织以及一些操作的方便性。

1. 抽象层次： Node<T> 结构体是链表节点的具体实现，而 LinkedList<T> 结构体是对整个链表的抽象。通过引入 LinkedList 这一层次，你可以对外提供更高级别的操作，例如插入、删除、反转等，而不需要直接操作节点的内部结构。

2. 封装和隐藏细节： 使用 LinkedList 可以隐藏底层实现细节，用户不需要关心节点的具体结构，而只需调用 LinkedList 提供的方法进行操作。这有助于维护代码的一致性和易用性。

3. 操作方便性： LinkedList 可以提供一些便捷的操作方法，如在链表头部插入元素、尾部插入元素等。这些方法可以通过模式匹配和对 Node 结构体的内部进行调用来实现，但如果直接在 Node 上操作，可能会使代码显得更加冗长。

4. 可扩展性： 如果未来你决定改变链表的底层实现，例如使用双向链表或其他数据结构，只需修改 LinkedList 的内部实现而无需改变使用链表的代码。这种解耦可以提高代码的可维护性和可扩展性。

5. 一致性和规范性： 使用 LinkedList 作为接口可以让代码库中的多个模块或者多个人员保持一致的链表使用方式，而不会因为 Node 结构体的变化而产生影响。

在实践中，这种分层设计的方式通常有助于提高代码的清晰度、可维护性和可拓展性。

新建表

  
impl<T> LinkedNode<T> {

	pub fn new(value: T) -> Self {

		LinkedNode {

			data: value,

			next: None,

		}

	}

}

  

impl<T> LinkedList<T> {

	pub fn new(value: T) -> Self {

		LinkedList {

			head: Some(Box::new(LinkedNode::new(value))),

		}

	}
}

编写测试

先使用属性宏#[cfg(test)]来标记一个测试模块，该属性指示编译器仅在测试的时候被编译。同时使用#[test]来标记一个测试函数。

// Unit tests
#[cfg(test)]
mod test {
    use super::*;

    #[test]
    fn test_linked_node() {
        let node = LinkedNode::new(1);
        assert_eq!(node.data, 1);
    }

    #[test]
    fn test_linked_list() {
        let list = LinkedList::new(1);
        assert_eq!(list.head.as_ref().unwrap().data, 1);
    }
}

运行测试

运行 cargo test 命令时，会触发 Rust 项目中的测试套件，并执行所有标记为测试函数的代码块。

测试通过 ✅

版本管理

我们的项目第一步初步搭建已经完成了，为了方便对项目进行管理，我们使用Git。

如果没有接触过Git可以自行搜索其相关的用法，并不复杂，后续我们的项目都是基于Git进行版本管理的。

rust使用cargo创建一个项目的时候，如果你上级目录没有git仓库，或者你没有特殊禁用生成git仓库，它会自动给你初始化一个git仓库

# 项目根目录下初始化一个git仓库
git init 

# 将已经修改的项目添加到暂存区
git add .

# 将暂存区的内容提交到本地仓库
git commit -m "相关内容的描述"
# 

现在我们将一个初始项目搭建起来了，后续我们的开发流程在确定要实现某一个功能后就在如下几个环节之间循环开发：

编写测试 -> 运行测试 -> 修复错误 -> 测试通过 -> 版本管理

下一章我们将对链表的数据进行增删改查。