You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

493 lines
78 KiB

3 weeks ago
<!DOCTYPE HTML>
<html lang="zh-CN" class="light" dir="ltr">
<head>
<!-- Book generated using mdBook -->
<meta charset="UTF-8">
<title>指定依赖项 - Rust语言圣经(Rust Course)</title>
<!-- Custom HTML head -->
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="theme-color" content="#ffffff">
<link rel="icon" href="../../favicon.svg">
<link rel="shortcut icon" href="../../favicon.png">
<link rel="stylesheet" href="../../css/variables.css">
<link rel="stylesheet" href="../../css/general.css">
<link rel="stylesheet" href="../../css/chrome.css">
<link rel="stylesheet" href="../../css/print.css" media="print">
<!-- Fonts -->
<link rel="stylesheet" href="../../FontAwesome/css/font-awesome.css">
<link rel="stylesheet" href="../../fonts/fonts.css">
<!-- Highlight.js Stylesheets -->
<link rel="stylesheet" href="../../highlight.css">
<link rel="stylesheet" href="../../tomorrow-night.css">
<link rel="stylesheet" href="../../ayu-highlight.css">
<!-- Custom theme stylesheets -->
<link rel="stylesheet" href="../../theme/style.css">
</head>
<body class="sidebar-visible no-js">
<div id="body-container">
<!-- Provide site root to javascript -->
<script>
var path_to_root = "../../";
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
</script>
<!-- Work around some values being stored in localStorage wrapped in quotes -->
<script>
try {
var theme = localStorage.getItem('mdbook-theme');
var sidebar = localStorage.getItem('mdbook-sidebar');
if (theme.startsWith('"') && theme.endsWith('"')) {
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
}
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
}
} catch (e) { }
</script>
<!-- Set the theme before any content is loaded, prevents flash -->
<script>
var theme;
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
if (theme === null || theme === undefined) { theme = default_theme; }
var html = document.querySelector('html');
html.classList.remove('light')
html.classList.add(theme);
var body = document.querySelector('body');
body.classList.remove('no-js')
body.classList.add('js');
</script>
<input type="checkbox" id="sidebar-toggle-anchor" class="hidden">
<!-- Hide / unhide sidebar before it is displayed -->
<script>
var body = document.querySelector('body');
var sidebar = null;
var sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
} else {
sidebar = 'hidden';
}
sidebar_toggle.checked = sidebar === 'visible';
body.classList.remove('sidebar-visible');
body.classList.add("sidebar-" + sidebar);
</script>
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
<div class="sidebar-scrollbox">
<ol class="chapter"><li class="chapter-item affix "><a href="../../about-book.html">关于本书</a></li><li class="chapter-item affix "><a href="../../into-rust.html">进入 Rust 编程世界</a></li><li class="chapter-item affix "><a href="../../first-try/sth-you-should-not-do.html">避免从入门到放弃</a></li><li class="chapter-item affix "><a href="../../community.html">社区和锈书</a></li><li class="spacer"></li><li class="chapter-item affix "><a href="../../some-thoughts.html">Xobserve: 一切皆可观测</a></li><li class="chapter-item affix "><a href="../../beat-ai.html">BeatAI: 工程师 AI 入门圣经</a></li><li class="chapter-item affix "><li class="part-title">Rust 语言基础学习</li><li class="spacer"></li><li class="chapter-item "><a href="../../first-try/intro.html"><strong aria-hidden="true">1.</strong> 寻找牛刀,以便小试</a><a class="toggle"><div></div></a></li><li><ol class="section"><li class="chapter-item "><a href="../../first-try/installation.html"><strong aria-hidden="true">1.1.</strong> 安装 Rust 环境</a></li><li class="chapter-item "><a href="../../first-try/editor.html"><strong aria-hidden="true">1.2.</strong> 墙推 VSCode!</a></li><li class="chapter-item "><a href="../../first-try/cargo.html"><strong aria-hidden="true">1.3.</strong> 认识 Cargo</a></li><li class="chapter-item "><a href="../../first-try/hello-world.html"><strong aria-hidden="true">1.4.</strong> 不仅仅是 Hello world</a></li><li class="chapter-item "><a href="../../first-try/slowly-downloading.html"><strong aria-hidden="true">1.5.</strong> 下载依赖太慢了?</a></li></ol></li><li class="chapter-item "><a href="../../basic/intro.html"><strong aria-hidden="true">2.</strong> Rust 基础入门</a><a class="toggle"><div></div></a></li><li><ol class="section"><li class="chapter-item "><a href="../../basic/variable.html"><strong aria-hidden="true">2.1.</strong> 变量绑定与解构</a></li><li class="chapter-item "><a href="../../basic/base-type/index.html"><strong aria-hidden="true">2.2.</strong> 基本类型</a><a class="toggle"><div></div></a></li><li><ol class="section"><li class="chapter-item "><a href="../../basic/base-type/numbers.html"><strong aria-hidden="true">2.2.1.</strong> 数值类型</a></li><li class="chapter-item "><a href="../../basic/base-type/char-bool.html"><strong aria-hidden="true">2.2.2.</strong> 字符、布尔、单元类型</a></li><li class="chapter-item "><a href="../../basic/base-type/statement-expression.html"><strong aria-hidden="true">2.2.3.</strong> 语句与表达式</a></li><li class="chapter-item "><a href="../../basic/base-type/function.html"><strong aria-hidden="true">2.2.4.</strong> 函数</a></li></ol></li><li class="chapter-item "><a href="../../basic/ownership/index.html"><strong aria-hidden="true">2.3.</strong> 所有权和借用</a><a class="toggle"><div></div></a></li><li><ol class="section"><li class="chapter-item "><a href="../../basic/ownership/ownership.html"><strong aria-hidden="true">2.3.1.</strong> 所有权</a></li><li class="chapter-item "><a href="../../basic/ownership/borrowing.html"><strong aria-hidden="true">2.3.2.</strong> 引用与借用</a></li></ol></li><li class="chapter-item "><a href="../../basic/compound-type/intro.html"><strong aria-hidden="true">2.4.</strong> 复合类型</a><a class="toggle"><div></div></a></li><li><ol class="section"><li class="chapter-item "><a href="../../basic/compound-type/string-slice.html"><strong aria-hidden="true">2.4.1.</strong> 字符串与切片</a></li><li class="chapter-item "><a href="../../basic/compound-type/tuple.html"><strong aria-hidden="true">2.4.2.</strong> 元组</a></li><li class="chapter-item "><a href="../../basic/compound-type/struct.html"><strong aria-hidden="true">2.4.3.</strong> 结构体</a></li><li class="chapter-item "><a href="../../basic/compound-type/enum.html"><strong aria-hidden="true">2.4.4.</strong> 枚举</a></li><li class="chapter-item "><a href="../../basic/compound-type/array.html"><strong aria-hidden="true">2.4.5.</strong> 数组</a></l
</div>
<div id="sidebar-resize-handle" class="sidebar-resize-handle">
<div class="sidebar-resize-indicator"></div>
</div>
</nav>
<!-- Track and set sidebar scroll position -->
<script>
var sidebarScrollbox = document.querySelector('#sidebar .sidebar-scrollbox');
sidebarScrollbox.addEventListener('click', function(e) {
if (e.target.tagName === 'A') {
sessionStorage.setItem('sidebar-scroll', sidebarScrollbox.scrollTop);
}
}, { passive: true });
var sidebarScrollTop = sessionStorage.getItem('sidebar-scroll');
sessionStorage.removeItem('sidebar-scroll');
if (sidebarScrollTop) {
// preserve sidebar scroll position when navigating via links within sidebar
sidebarScrollbox.scrollTop = sidebarScrollTop;
} else {
// scroll sidebar to current active section when navigating via "next/previous chapter" buttons
var activeSection = document.querySelector('#sidebar .active');
if (activeSection) {
activeSection.scrollIntoView({ block: 'center' });
}
}
</script>
<div id="page-wrapper" class="page-wrapper">
<div class="page">
<div id="menu-bar-hover-placeholder"></div>
<div id="menu-bar" class="menu-bar sticky">
<div class="left-buttons">
<label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
<i class="fa fa-bars"></i>
</label>
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
<i class="fa fa-paint-brush"></i>
</button>
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
</ul>
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
<i class="fa fa-search"></i>
</button>
</div>
<h1 class="menu-title">Rust语言圣经(Rust Course)</h1>
<div class="right-buttons">
<a href="../../print.html" title="Print this book" aria-label="Print this book">
<i id="print-button" class="fa fa-print"></i>
</a>
<a href="https://github.com/sunface/rust-course" title="Git repository" aria-label="Git repository">
<i id="git-repository-button" class="fa fa-github"></i>
</a>
<a href="https://github.com/sunface/rust-course/edit/main/src/cargo/reference/specify-deps.md" title="Suggest an edit" aria-label="Suggest an edit">
<i id="git-edit-button" class="fa fa-edit"></i>
</a>
</div>
</div>
<div id="search-wrapper" class="hidden">
<form id="searchbar-outer" class="searchbar-outer">
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
</form>
<div id="searchresults-outer" class="searchresults-outer hidden">
<div id="searchresults-header" class="searchresults-header"></div>
<ul id="searchresults">
</ul>
</div>
</div>
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
<script>
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
});
</script>
<div id="content" class="content">
<!-- Page table of contents -->
<div class="sidetoc"><nav class="pagetoc"></nav></div>
<main>
<h1 id="指定依赖项"><a class="header" href="#指定依赖项">指定依赖项</a></h1>
<p>我们的项目可以引用在 <code>crates.io</code><code>GitHub</code> 上的依赖包,也可以引用存放在本地文件系统中的依赖包。</p>
<p>大家可能会想,直接从前两个引用即可,为何还提供了本地方式?可以设想下,如果你要有一个正处于开发中的包,然后需要在本地的另一个项目中引用测试,那是将该包先传到网上,然后再引用简单,还是直接从本地路径的方式引用简单呢?答案显然不言而喻。</p>
<p>本章节,我们一起来看看有哪些方式可以指定和引用三方依赖包。</p>
<h2 id="从-cratesio-引入依赖包"><a class="header" href="#从-cratesio-引入依赖包"><code>crates.io</code> 引入依赖包</a></h2>
<p>默认设置下,<code>Cargo</code> 就从 <a href="https://crates.io">crates.io</a> 上下载依赖包,只需要一个包名和版本号即可:</p>
<pre><code class="language-toml">[dependencies]
time = &quot;0.1.12&quot;
</code></pre>
<p>字符串 <code>&quot;0.1.12&quot;</code> 是一个 <a href="https://semver.org"><code>semver</code></a> 格式的版本号,符合 <code>&quot;x.y.z&quot;</code> 的形式,其中 <code>x</code> 被称为主版本<code>major</code>, <code>y</code> 被称为小版本 <code>minor</code> ,而 <code>z</code> 被称为补丁 <code>patch</code>,可以看出从左到右,版本的影响范围逐步降低,补丁的更新是无关痛痒的,并不会造成 API 的兼容性被破坏。</p>
<p><code>&quot;0.1.12&quot;</code> 中并没有任何额外的符号,在版本语义上,它跟使用了 <code>^</code><code>&quot;^0.1.12&quot;</code> 是相同的,都是指定非常具体的版本进行引入。</p>
<p>但是 <code>^</code> 能做的更多。</p>
<blockquote>
<p>npm 使用的就是 <code>semver</code> 版本号,从 <code>JavaScript</code> 过来的同学应该非常熟悉。</p>
</blockquote>
<h4 id="-指定版本"><a class="header" href="#-指定版本"><code>^</code> 指定版本</a></h4>
<p>与之前的 <code>&quot;0.1.12&quot;</code> 不同, <code>^</code> 可以指定一个版本号范围,<strong>然后会使用该范围内的最大版本号来引用对应的包</strong></p>
<p>只要新的版本号没有修改最左边的非零数字,那该版本号就在允许的版本号范围中。例如 <code>&quot;^0.1.12&quot;</code> 最左边的非零数字是 <code>1</code>,因此,只要新的版本号是 <code>&quot;0.1.z&quot;</code> 就可以落在范围内,而<code>0.2.0</code> 显然就没有落在范围内,因此通过 <code>&quot;^0.1.12&quot;</code> 引入的依赖包是无法被升级到 <code>0.2.0</code> 版本的。</p>
<p>同理,若是 <code>&quot;^1.0&quot;</code>,则 <code>1.1</code> 在范围中,<code>2.0</code> 则不在。 大家思考下,<code>&quot;^0.0.1&quot;</code> 与哪些版本兼容?答案是:无,因为它最左边的数字是 <code>1</code> ,而该数字已经退无可退,我们又不能修改 <code>1</code>,因此没有版本落在范围中。</p>
<pre><code class="language-shell">^1.2.3 := &gt;=1.2.3, &lt;2.0.0
^1.2 := &gt;=1.2.0, &lt;2.0.0
^1 := &gt;=1.0.0, &lt;2.0.0
^0.2.3 := &gt;=0.2.3, &lt;0.3.0
^0.2 := &gt;=0.2.0, &lt;0.3.0
^0.0.3 := &gt;=0.0.3, &lt;0.0.4
^0.0 := &gt;=0.0.0, &lt;0.1.0
^0 := &gt;=0.0.0, &lt;1.0.0
</code></pre>
<p>以上是更多的例子,<strong>事实上,这个规则跟 <code>SemVer</code> 还有所不同</strong>,因为对于 <code>SemVer</code> 而言,<code>0.x.y</code> 的版本是没有其它版本与其兼容的,而对于 Rust只要版本号 <code>0.x.y</code> 满足 <code>z&gt;=y</code><code>x&gt;0</code> 的条件,那它就能更新到 <code>0.x.z</code> 版本。</p>
<h4 id="-指定版本-1"><a class="header" href="#-指定版本-1"><code>~</code> 指定版本</a></h4>
<p><code>~</code> 指定了最小化版本 :</p>
<pre><pre class="playground"><code class="language-rust edition2021"><span class="boring">#![allow(unused)]
</span><span class="boring">fn main() {
</span>~1.2.3 := &gt;=1.2.3, &lt;1.3.0
~1.2 := &gt;=1.2.0, &lt;1.3.0
~1 := &gt;=1.0.0, &lt;2.0.0
<span class="boring">}</span></code></pre></pre>
<h4 id="-通配符"><a class="header" href="#-通配符"><code>*</code> 通配符</a></h4>
<p>这种方式允许将 <code>*</code> 所在的位置替换成任何数字:</p>
<pre><pre class="playground"><code class="language-rust edition2021"><span class="boring">#![allow(unused)]
</span><span class="boring">fn main() {
</span>* := &gt;=0.0.0
1.* := &gt;=1.0.0, &lt;2.0.0
1.2.* := &gt;=1.2.0, &lt;1.3.0
<span class="boring">}</span></code></pre></pre>
<p>不过 <code>crates.io</code> 并不允许我们只使用孤零零一个 <code>*</code> 来指定版本号 : <code>*</code></p>
<h4 id="比较符"><a class="header" href="#比较符">比较符</a></h4>
<p>可以使用比较符的方式来指定一个版本号范围或一个精确的版本号:</p>
<pre><pre class="playground"><code class="language-rust edition2021"><span class="boring">#![allow(unused)]
</span><span class="boring">fn main() {
</span>&gt;= 1.2.0
&gt; 1
&lt; 2
= 1.2.3
<span class="boring">}</span></code></pre></pre>
<p>同时还能使用比较符进行组合,并通过逗号分隔:</p>
<pre><pre class="playground"><code class="language-rust edition2021"><span class="boring">#![allow(unused)]
</span><span class="boring">fn main() {
</span>&gt;= 1.2, &lt; 1.5
<span class="boring">}</span></code></pre></pre>
<p>需要注意,以上的版本号规则仅仅针对 <code>crate.io</code> 和基于它搭建的注册服务(例如科大服务源) ,其它注册服务(例如 GitHub )有自己相应的规则。</p>
<h2 id="从其它注册服务引入依赖包"><a class="header" href="#从其它注册服务引入依赖包">从其它注册服务引入依赖包</a></h2>
<p>为了使用 <code>crates.io</code> 之外的注册服务,我们需要对 <code>$HOME/.cargo/config.toml</code> ($CARGO_HOME 下) 文件进行配置,添加新的服务提供商,有两种方式可以实现。</p>
<blockquote>
<p>由于国内访问国外注册服务的不稳定性,我们可以使用<a href="http://mirrors.ustc.edu.cn/help/crates.io-index.html">科大的注册服务</a>来提升下载速度,以下注册服务的链接都是科大的</p>
</blockquote>
<p><strong>首先是在 <code>crates.io</code> 之外添加新的注册服务</strong>,修改 <code>.cargo/config.toml</code> 添加以下内容:</p>
<pre><code class="language-toml">[registries]
ustc = { index = &quot;https://mirrors.ustc.edu.cn/crates.io-index/&quot; }
</code></pre>
<p>对于这种方式,我们的项目的 <code>Cargo.toml</code> 中的依赖包引入方式也有所不同:</p>
<pre><code class="language-toml">[dependencies]
time = { registry = &quot;ustc&quot; }
</code></pre>
<p>在重新配置后,初次构建可能要较久的时间,因为要下载更新 <code>ustc</code> 注册服务的索引文件,还挺大的...</p>
<p>注意,这一种使用方式最大的缺点就是在引用依赖包时要指定注册服务: <code>time = { registry = &quot;ustc&quot; }</code></p>
<p><strong>而第二种方式就不需要,因为它是直接使用新注册服务来替代默认的 <code>crates.io</code></strong></p>
<pre><code class="language-toml">[source.crates-io]
replace-with = 'ustc'
[source.ustc]
registry = &quot;git://mirrors.ustc.edu.cn/crates.io-index&quot;
</code></pre>
<p>上面配置中的第一个部分,首先将源 <code>source.crates-io</code> 替换为 <code>ustc</code>,然后在第二部分指定了 <code>ustc</code> 源的地址。</p>
<blockquote>
<p>注意,如果你要发布包到 <code>crates.io</code> 上,那该包的依赖也必须在 <code>crates.io</code></p>
</blockquote>
<h4 id="引入-git-仓库作为依赖包"><a class="header" href="#引入-git-仓库作为依赖包">引入 git 仓库作为依赖包</a></h4>
<p>若要引入 git 仓库中的库作为依赖包,你至少需要提供一个仓库的地址:</p>
<pre><code class="language-toml">[dependencies]
regex = { git = &quot;https://github.com/rust-lang/regex&quot; }
</code></pre>
<p>由于没有指定版本Cargo 会假定我们使用 <code>master</code><code>main</code> 分支的最新 <code>commit</code> 。你可以使用 <code>rev</code><code>tag</code><code>branch</code> 来指定想要拉取的版本。例如下面代码拉取了 <code>next</code> 分支上的最新 <code>commit</code></p>
<pre><code class="language-toml">[dependencies]
regex = { git = &quot;https://github.com/rust-lang/regex&quot;, branch = &quot;next&quot; }
</code></pre>
<p>任何非 <code>tag</code><code>branch</code> 的类型都可以通过 <code>rev</code> 来引入,例如通过最近一次 <code>commit</code> 的哈希值引入: <code>rev = &quot;4c59b707&quot;</code>,再比如远程仓库提供的的具名引用: <code>rev = &quot;refs/pull/493/head&quot;</code></p>
<p>一旦 <code>git</code> 依赖被拉取下来,该版本就会被记录到 <code>Cargo.lock</code> 中进行锁定。因此 <code>git</code> 仓库中后续新的提交不再会被自动拉取,除非你通过 <code>cargo update</code> 来升级。需要注意的是锁定一旦被删除,那 Cargo 依然会按照 <code>Cargo.toml</code> 中配置的地址和版本去拉取新的版本,如果你配置的版本不正确,那可能会拉取下来一个不兼容的新版本!</p>
<p><strong>因此不要依赖锁定来完成版本的控制,而应该老老实实的在 <code>Cargo.toml</code> 小心配置你希望使用的版本。</strong></p>
<p>如果访问的是私有仓库,你可能需要授权来访问该仓库,可以查看<a href="https://course.rs/cargo/git-auth.html">这里</a>了解授权的方式。</p>
<h4 id="通过路径引入本地依赖包"><a class="header" href="#通过路径引入本地依赖包">通过路径引入本地依赖包</a></h4>
<p>Cargo 支持通过路径的方式来引入本地的依赖包:一般来说,本地依赖包都是同一个项目内的内部包,例如假设我们有一个 <code>hello_world</code> 项目( package ),现在在其根目录下新建一个包:</p>
<pre><code class="language-shell"># 在 hello_world/ 目录下
$ cargo new hello_utils
</code></pre>
<p>新建的 <code>hello_utils</code> 文件夹跟 <code>src</code><code>Cargo.toml</code> 同级,现在修改 <code>Cargo.toml</code><code>hello_world</code> 项目引入新建的包:</p>
<pre><code class="language-toml">[dependencies]
hello_utils = { path = &quot;hello_utils&quot; }
# 以下路径也可以
# hello_utils = { path = &quot;./hello_utils&quot; }
# hello_utils = { path = &quot;../hello_world/hello_utils&quot; }
</code></pre>
<p>但是,此时的 <code>hello_world</code> 是无法发布到 <code>crates.io</code> 上的。想要发布,需要先将 <code>hello_utils</code> 先发布到 <code>crates.io</code> 上,然后再通过 <code>crates.io</code> 的方式来引入:</p>
<pre><code class="language-toml">[dependencies]
hello_utils = { path = &quot;hello_utils&quot;, version = &quot;0.1.0&quot; }
</code></pre>
<blockquote>
<p>注意!使用 <code>path</code> 指定依赖的 package 将无法发布到 <code>crates.io</code>,除非 <code>path</code> 存在于 <a href="#dev-dependencies">[dev-dependencies]</a> 中。当然,你还可以使用多种引用混合的方式来解决这个问题,下面将进行介绍</p>
</blockquote>
<h2 id="多引用方式混合"><a class="header" href="#多引用方式混合">多引用方式混合</a></h2>
<p>实际上,我们可以同时使用多种方式来引入同一个包,例如本地引入和 <code>crates.io</code> :</p>
<pre><code class="language-toml">[dependencies]
# 本地使用时,通过 path 引入,
# 发布到 `crates.io` 时,通过 `crates.io` 的方式引入: version = &quot;1.0&quot;
bitflags = { path = &quot;my-bitflags&quot;, version = &quot;1.0&quot; }
# 本地使用时,通过 git 仓库引入
# 当发布时,通过 `crates.io` 引入: version = &quot;1.0&quot;
smallvec = { git = &quot;https://github.com/servo/rust-smallvec&quot;, version = &quot;1.0&quot; }
# N.B. 若 version 无法匹配Cargo 将无法编译
</code></pre>
<p>这种方式跟下章节将要讲述的依赖覆盖类似,但是前者只会应用到当前声明的依赖包上。</p>
<h2 id="根据平台引入依赖"><a class="header" href="#根据平台引入依赖">根据平台引入依赖</a></h2>
<p>我们还可以根据特定的平台来引入依赖:</p>
<pre><code class="language-toml">[target.'cfg(windows)'.dependencies]
winhttp = &quot;0.4.0&quot;
[target.'cfg(unix)'.dependencies]
openssl = &quot;1.0.1&quot;
[target.'cfg(target_arch = &quot;x86&quot;)'.dependencies]
native = { path = &quot;native/i686&quot; }
[target.'cfg(target_arch = &quot;x86_64&quot;)'.dependencies]
native = { path = &quot;native/x86_64&quot; }
</code></pre>
<p>此处的语法跟 Rust 的 <a href="https://doc.rust-lang.org/stable/reference/conditional-compilation.html"><code>#[cfg]</code></a> 语法非常相像,因此我们还能使用逻辑操作符进行控制:</p>
<pre><code class="language-toml">[target.'cfg(not(unix))'.dependencies]
openssl = &quot;1.0.1&quot;
</code></pre>
<p>这里的意思是,当不是 <code>unix</code> 操作系统时,才对 <code>openssl</code> 进行引入。</p>
<p>如果你想要知道 <code>cfg</code> 能够作用的目标,可以在终端中运行 <code>rustc --print=cfg</code> 进行查询。当然,你可以指定平台查询: <code>rustc --print=cfg --target=x86_64-pc-windows-msvc</code>,该命令将对 <code>64bit</code> 的 Windows 进行查询。</p>
<p>聪明的同学已经发现,这非常类似于条件依赖引入,那我们是不是可以根据自定义的条件来决定是否引入某个依赖呢?具体答案参见后续的 <a href="https://course.rs/cargo/reference/features.html">feature</a> 章节。这里是一个简单的示例:</p>
<pre><code class="language-toml">[dependencies]
foo = { version = &quot;1.0&quot;, optional = true }
bar = { version = &quot;1.0&quot;, optional = true }
[features]
fancy-feature = [&quot;foo&quot;, &quot;bar&quot;]
</code></pre>
<p>但是需要注意的是,你如果妄图通过 <code>cfg(feature)</code><code>cfg(debug_assertions)</code>, <code>cfg(test)</code><code>cfg(proc_macro)</code> 的方式来条件引入依赖,那是不可行的。</p>
<p><code>Cargo</code> 还允许通过下面的方式来引入平台特定的依赖:</p>
<pre><code class="language-toml">[target.x86_64-pc-windows-gnu.dependencies]
winhttp = &quot;0.4.0&quot;
[target.i686-unknown-linux-gnu.dependencies]
openssl = &quot;1.0.1&quot;
</code></pre>
<h2 id="自定义-target-引入"><a class="header" href="#自定义-target-引入">自定义 target 引入</a></h2>
<p>如果你在使用自定义的 <code>target</code> :例如 <code>--target bar.json</code>,那么可以通过下面方式来引入依赖:</p>
<pre><code class="language-toml">[target.bar.dependencies]
winhttp = &quot;0.4.0&quot;
[target.my-special-i686-platform.dependencies]
openssl = &quot;1.0.1&quot;
native = { path = &quot;native/i686&quot; }
</code></pre>
<blockquote>
<p>需要注意,这种使用方式在 <code>stable</code> 版本的 Rust 中无法被使用,建议大家如果没有特别的需求,还是使用之前提到的 feature 方式</p>
</blockquote>
<h2 id="dev-dependencies"><a class="header" href="#dev-dependencies">[dev-dependencies]</a></h2>
<p>你还可以为项目添加只在测试时需要的依赖库,类似于 <code>package.json</code>( Nodejs )文件中的 <code>devDependencies</code>,可以在 <code>Cargo.toml</code> 中添加 <code>[dev-dependencies]</code> 来实现:</p>
<pre><code class="language-toml">[dev-dependencies]
tempdir = &quot;0.3&quot;
</code></pre>
<p>这里的依赖只会在运行测试、示例和 benchmark 时才会被引入。并且,假设<code>A</code> 包引用了 <code>B</code>,而 <code>B</code> 通过 <code>[dev-dependencies]</code> 的方式引用了 <code>C</code> 包, 那 <code>A</code> 是不会引用 <code>C</code> 包的。</p>
<p>当然,我们还可以指定平台特定的测试依赖包:</p>
<pre><code class="language-toml">[target.'cfg(unix)'.dev-dependencies]
mio = &quot;0.0.1&quot;
</code></pre>
<blockquote>
<p>注意,当发布包到 crates.io 时,<code>[dev-dependencies]</code> 中的依赖只有指定了 <code>version</code> 的才会被包含在发布包中。况且,再加上测试稳定性的考虑,我们建议为 <code>[dev-dependencies]</code> 中的包指定相应的版本号</p>
</blockquote>
<h2 id="build-dependencies"><a class="header" href="#build-dependencies">[build-dependencies]</a></h2>
<p>我们还可以指定某些依赖仅用于构建脚本:</p>
<pre><code class="language-toml">[build-dependencies]
cc = &quot;1.0.3&quot;
</code></pre>
<p>当然,平台特定的依然可以使用:</p>
<pre><code class="language-toml">[target.'cfg(unix)'.build-dependencies]
cc = &quot;1.0.3&quot;
</code></pre>
<p>有一点需要注意:构建脚本(<code> build.rs</code> )和项目的正常代码是彼此独立,因此它们的依赖不能互通: 构建脚本无法使用 <code>[dependencies]</code><code>[dev-dependencies]</code> 中的依赖,而 <code>[build-dependencies]</code> 中的依赖也无法被构建脚本之外的代码所使用。</p>
<h2 id="选择-features"><a class="header" href="#选择-features">选择 features</a></h2>
<p>如果你依赖的包提供了条件性的 <code>features</code>,你可以指定使用哪一个:</p>
<pre><code class="language-toml">[dependencies.awesome]
version = &quot;1.3.5&quot;
default-features = false # 不要包含默认的 features而是通过下面的方式来指定
features = [&quot;secure-password&quot;, &quot;civet&quot;]
</code></pre>
<p>更多的信息参见 <a href="https://course.rs/cargo/reference/features.html">Features 章节</a></p>
<h2 id="在-cargotoml-中重命名依赖"><a class="header" href="#在-cargotoml-中重命名依赖">在 Cargo.toml 中重命名依赖</a></h2>
<p>如果你想要实现以下目标:</p>
<ul>
<li>避免在 Rust 代码中使用 <code>use foo as bar</code></li>
<li>依赖某个包的多个版本</li>
<li>依赖来自于不同注册服务的同名包</li>
</ul>
<p>那可以使用 Cargo 提供的 <code>package key</code> :</p>
<pre><code class="language-toml">[package]
name = &quot;mypackage&quot;
version = &quot;0.0.1&quot;
[dependencies]
foo = &quot;0.1&quot;
bar = { git = &quot;https://github.com/example/project&quot;, package = &quot;foo&quot; }
baz = { version = &quot;0.1&quot;, registry = &quot;custom&quot;, package = &quot;foo&quot; }
</code></pre>
<p>此时,你的代码中可以使用三个包:</p>
<pre><pre class="playground"><code class="language-rust edition2021"><span class="boring">#![allow(unused)]
</span><span class="boring">fn main() {
</span>extern crate foo; // 来自 crates.io
extern crate bar; // 来自 git repository
extern crate baz; // 来自 registry `custom`
<span class="boring">}</span></code></pre></pre>
<p>有趣的是,由于这三个 <code>package</code> 的名称都是 <code>foo</code>(在各自的 <code>Cargo.toml</code> 中定义),因此我们显式的通过 <code>package = &quot;foo&quot;</code> 的方式告诉 Cargo我们需要的就是这个 <code>foo package</code>,虽然它被重命名为 <code>bar</code><code>baz</code></p>
<p>有一点需要注意,当使用可选依赖时,如果你将 <code>foo</code> 包重命名为 <code>bar</code> 包,那引用前者的 feature 时的路径名也要做相应的修改:</p>
<pre><code class="language-toml">[dependencies]
bar = { version = &quot;0.1&quot;, package = 'foo', optional = true }
[features]
log-debug = ['bar/log-debug'] # 若使用 'foo/log-debug' 会导致报错
</code></pre>
<div id="giscus-container"></div>
</main>
<nav class="nav-wrapper" aria-label="Page navigation">
<!-- Mobile navigation buttons -->
<a rel="prev" href="../../cargo/reference/intro.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
<i class="fa fa-angle-left"></i>
</a>
<a rel="next prefetch" href="../../cargo/reference/deps-overriding.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<i class="fa fa-angle-right"></i>
</a>
<div style="clear: both"></div>
</nav>
</div>
</div>
<nav class="nav-wide-wrapper" aria-label="Page navigation">
<a rel="prev" href="../../cargo/reference/intro.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
<i class="fa fa-angle-left"></i>
</a>
<a rel="next prefetch" href="../../cargo/reference/deps-overriding.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<i class="fa fa-angle-right"></i>
</a>
</nav>
</div>
<script>
window.playground_copyable = true;
</script>
<script src="../../ace.js"></script>
<script src="../../editor.js"></script>
<script src="../../mode-rust.js"></script>
<script src="../../theme-dawn.js"></script>
<script src="../../theme-tomorrow_night.js"></script>
<script src="../../elasticlunr.min.js"></script>
<script src="../../mark.min.js"></script>
<script src="../../searcher.js"></script>
<script src="../../clipboard.min.js"></script>
<script src="../../highlight.js"></script>
<script src="../../book.js"></script>
<script type="text/javascript" charset="utf-8">
var pagePath = "cargo/reference/specify-deps.md"
</script>
<!-- Custom JS scripts -->
<script src="../../assets/custom.js"></script>
<script src="../../assets/bigPicture.js"></script>
</div>
</body>
</html>