pull/89/head
sunface 3 years ago
parent 42bf6d84d7
commit 28443caa1f

@ -8,7 +8,7 @@
- [寻找牛刀,以便小试](first-try/intro.md)
- [安装Rust环境](first-try/installation.md)
- [墙推VSCode!](first-try/editor.md)
- [认识Cargo(todo)](first-try/cargo.md)
- [认识Cargo](first-try/cargo.md)
- [不仅仅是Hello world](first-try/hello-world.md)
## Rust学习三部曲
@ -49,14 +49,15 @@
- [适用Result返回错误](errors/result.md)
- [自定义错误](errors/user-define.md)
- [让错误输出更优雅](errors/pretty-format.md)
- [会导致panic的代码](errors/panic-codes.md)
- [Cargo详解](cargo/intro.md)
- [常用命令](cargo/commands.md)
- [项目结构](cargo/layout.md)
- [Cargo.toml和Cargo.lock](cargo/cargo-toml-lock.md)
- [依赖管理](cargo/dependency.md)
- [构建缓存](cargo/cache.md)
- [版本管理](cargo/version.md)
- [依赖覆盖](cargo/dependency-override.md)
- [工作空间](cargo/workspace.md)
- [条件编译、条件依赖](cargo/feature.md)
- [配置参数(todo)](cargo/manifest.md)

@ -0,0 +1 @@
# 依赖管理

@ -0,0 +1 @@
# 会导致panic的代码

@ -1,4 +1,152 @@
## 认识Cargo
但凡经历过C/C++、Go语言1.10版本之前的用户都知道一个好的包管理工具有多么的重要我们那个时候时如此的羡慕nodejs的npm包管理但是却求而不得包管理工具最重要的意义就是**任何用户拿到你的代码,都能运行起来**"而不会因为各种包版本依赖焦头烂额Go语言在1.10版本之前所有的包都是在github.com下存放导致了所有的项目都公用一套依赖代码在本地项目复杂后这简直是一种依赖。
## cargo check
说多了都是泪笔者目前还有一个早期Go的项目(15年写的)用到了iris(一个坑爹http服务)结果现在运行不起来了因为找不到iris当时的那个版本
作为一门现代化语言,`Rust`吸收了多个语言的包管理优点,为大家提供超级大杀器:`cargo`,真的,但凡用过后,你都不会想要其他语言的包管理工具了。
总而言之,`cargo`提供了一系列的工具从项目的建立、构建到测试、运行直至部署为Rust项目的管理提供尽可能完整的手段同时与Rust语言及其编译器rustc紧密结合可以说用了后就忘不掉如同那种初恋般的触电感觉。
## 创建一个"你好,世界"项目
又见"你好,世界",肯定有读者在批评了:你就不能优点创意吗?"世界,你好"不行吗?你是读者,你说了算,好的,那我们来创建一个"世界,你好"。
上门提到过Rust语言的包管理工具名称叫`cargo`好在我们无需手动安装在之前安装Rust的时候就一起安装了如果你在终端无法使用这个命令考虑一下`环境变量`是否正确的设置,你需要把`cargo`可执行文件所在的目录添加到环境变量中。
在终端输入:
```console
$ cargo new world_hello
```
上面的命令使用`cargo new`创建了一个项目,项目名是`world_hello`(向读者势力低头的项目名称,泪奔),这个项目的结构和配置文件都是由`cargo`生成,这种结构和配置文件意味着**该项目被cargo所管理**早期的cargo在创建项目时必须添加`--bin`的参数,如下所示:
```console
$ cargo new world_hello --bin
```
现在的版本,已经无需这个参数,`cargo`默认就为我们创建`bin`类型的项目顺便说一句rust项目主要分为两个类型bin和lib前者是一个可以运行的项目后者是一个依赖库项目。
创建的项目结构:
```console
.
├── .git
├── .gitignore
├── Cargo.toml
└── src
└── main.rs
```
是的连git都给你创建了比小棉袄还体贴。
## 运行该项目
有两种方式可以运行我们的项目,先来看看第一种
#### cargo run
真的很简单,我就不废话了,在项目根目录下运行:
```console
$ cargo run
Compiling world_hello v0.1.0 (/Users/sunfei/development/rust/world_hello)
Finished dev [unoptimized + debuginfo] target(s) in 0.43s
Running `target/debug/world_hello`
Hello, world!
```
好了,你已经看到程序的输出: `"Hello, world"`, 可能有读者不愿意了,说好了"世界,你好"呢? 别急,在下一节,我们再对代码进行修改。
在上面的过程中,`cargo run`会对项目进行编译,然后再运行项目,如同我们下面将做的
#### 手动编译和运行项目
先来编译项目:
```console
$ cargo build
Finished dev [unoptimized + debuginfo] target(s) in 0.00s
```
接着手动运行:
```console
$ ./target/debug/world_hello
Hello, world!
```
很简单对吧?细心的读者可能已经发现,在调用的时候,路径`./target/debug/world_hello`中有一个明晃晃的`debug`字段,没错我们运行的是`debug模式`,在这种模式下,**代码的编译速度会非常快**,但是**运行速度就比较慢**了原因在于这个模式下Rust编译器不会做任何的优化只为了尽快的编译完成让你的开发流程更加顺畅。
那如果我们想要高性能的代码怎么办?可以添加`--release`来编译:
- `cargo run --release`
- `cargo build --release`
如果你用的第二个命令,就要换一个路径来运行程序
```console
$ ./target/release/world_hello
Hello, world!
```
当项目大了后,`cargo run`和`cargo build`不可避免的会变慢,那么有没有更快的方式来验证代码的正确性呢?大杀器来了,接着!
## cargo check
`cargo check`是我们在代码开发过程中用的最多的命令,它的作用很简单:快速的检查一下代码能否编译通过,所以速度会非常快,帮助我们节省大量的编译时间(毕竟Rust不是Go需要做很多复杂的编译优化和语言特性解析所以编译速度比Go慢了不少)。
```console
$ cargo check
Checking world_hello v0.1.0 (/Users/sunfei/development/rust/world_hello)
Finished dev [unoptimized + debuginfo] target(s) in 0.06s
```
## cargo.toml 和 cargo.lock
`cargo.toml`和`cargo.lock`是cargo项目代码管理的核心文件cargo工具的所有活动均基于这两个文件。
`cargo.toml`是cargo特有的项目数据描述文件存储了项目的所有元配置信息如果rust开发者希望rust项目能够按照期望的方式进行构建、测试和运行那么必须按照合理的方式构建`cargo.toml`。
`cargo.lock`文件是cargo工具根据同一项目的toml文件生成的项目依赖详细清单文件所以我们一般不用不管它只需要对着cargo.toml文件撸就行了。
> 什么情况下该把`cargo.lock`上传到git仓库里很简单当你的项目是一个可运行的程序时就上传`cargo.lock`,如果是一个依赖库项目,那么请把它添加到`.gitignore`中
现在可以打开"世界,你好"项目下的`cargo.toml`文件,我们来简单介绍下:
#### package配置段落
`package`中配置了我们项目的一些描述信息,典型的如下:
```toml
[package]
name = "world_hello"
version = "0.1.0"
edition = "2021"
```
`name`字段定义了项目名称,`version`字段定义了项目的当前版本,新项目默认是`0.1.0``edition`字段定义了我们使用的Rust大版本因为本书很新(不仅仅是现在新未来也将及时修订跟得上Rust最新大版本),所以我们使用的是`Rust edition 2021`大版本,现有的很多项目还在使用`Rust edition 2018`,具体参见[Rust版本详解](../appendix/rust-version.md).
#### 定义项目依赖
使用cargo工具的最大优势就在于能够对该项目的各种依赖项进行方便、统一和灵活的管理。这也是使用cargo对Rust项目进行管理的重要目标之一。在cargo的toml文件描述中主要通过各种依赖段落来描述该项目的各种依赖项。`cargo.toml`中常用的依赖段落包括一下几种:
- 基于rust官方仓库crates.io通过版本说明来描述
- 基于项目源代码的git仓库地址通过URL来描述
- 基于本地项目的绝对路径或者相对路径通过类Unix模式的路径来描述
这三种形式具体写法如下:
```toml
[dependencies]
rand = "0.3"
hammer = { version = "0.5.0"}
color = { git = "https://github.com/bjz/color-rs" }
geometry = { path = "crates/geometry" }
```
相信聪明的读者已经能看懂该怎么引入外部依赖库,我们就不逐行解释了。
详细的说明参见此章:[Cargo依赖管理](../cargo/dependency.md),但是不建议新手现在去看,等学习后面,自然就能看到。
## 基于cargo的项目组织结构
在上文我们已经看到了cargo默认生成的项目结构但是真实的项目还有所不同但是在目前的学习阶段我们还不需要关注这个感兴趣的同学可以移步此处[Cargo项目结构](../cargo/layout.md)
至此大家对Rust项目的创建和管理已经有了初步的了解让我们来完善刚才的`"世界,你好"`项目吧。

@ -8,3 +8,30 @@ VScode从15年刚开始推出我就在使用了做为第一个吃螃蟹的
> Visual Studio Code(VS Code)是微软2015年推出的一个轻量但功能强大的源代码编辑器基于 Electron 开发,支持 Windows、Linux 和 macOS 操作系统。它内置了对JavaScriptTypeScript和Node.js的支持并且具有丰富的其它语言和扩展的支持功能超级强大。Visual Studio Code是一款免费开源的现代化轻量级代码编辑器支持几乎所有主流的开发语言的语法高亮、智能代码补全、自定义快捷键、括号匹配和颜色区分、代码片段、代码对比 Diff、GIT命令 等特性,支持插件扩展,并针对网页开发和云端应用开发做了优化。
## 安装Vscode的Rust插件
在VScode的左侧扩展目录里搜索`rust`,你能看到两个Rust插件如果没有意外这两个应该分别排名第一和第二:
1. 官方的`Rust`,作者是`The Rust Programming Language`, 官方出品,牛逼就完了,但是。。。我们并不推荐,这个插件有几个问题:
- 首先是在代码跳转上支持的很烂,只能在自己的代码库中跳转,一旦跳到别的三方库,那就无法继续跳转,对于查看标准库和三方库的源码带来了极大的困扰
- 其次不支持类型自动标注对于Rust语言而言类型说明是非常重要的特别是在你不知道给变量一个什么类型时这种IDE的自动提示就变得弥足珍贵
- 代码提示不太好用,有些方法即不提示,也不能跳转
2. 社区驱动的`rust-analyzer`非常推荐上面说的所有问题在这个插件上都得到了解决不得不说rust社区 yyds!
所以,综上所述,我们选择`rust-analyer`作为Rust语言的插件具体的安装很简单点击插件选择安装即可根据提示可能需要重新加载ide。
ide安装完成后在第一次打开Rust项目时需要安装一些依赖具体的状态在左下角会进行提示包括下载、代码构建building等。
在插件默认设置下,每一次保存代码,都会出进行一次重新编译,如果你的电脑慢,有一点一定要注意:在编译器构建代码的同时,不要在终端再运行`cargo run`等命令进行编译不然会获得一个报错提示大意是当前文件目录已经被锁定等待其它使用者释放如果等了很久ide还是没有释放(虽然我没遇到过,但是存在这个可能性)你可以关掉ide并手动kill掉`rust-anylyzer`,然后重新尝试即可。
> 在搜索VScode插件时报错`提取扩展出错XHR failed`,这个报错是因为网络原因导致,很可能是你的网络不行或者翻墙工具阻拦你的访问,试着关掉翻墙,再进行尝试
## 安装其它好用的插件
在此,再推荐大家几个好用的插件:
1. Better TOML用于更好的展示.toml文件
2. Error Lens, 更好的获得错误展示
3. One Dark Pro, 非常好看的Vscode主题
4. CodeLLDB, debugger程序
好了至此Vscode的配置就已经全部结束是不是很简单下面让我们来用Cargo创建一个Rust项目然后用Vscode打开.
Loading…
Cancel
Save