rust学习十四.1、编译和发布单元包Crate
本文简要介绍如何编译和发布单元包(crate)。很可惜的是，找了一会，没有发现可以发布到除了Crates.io之外的地方。 可能是我没有找到，也可能仅仅是因为我本人仅是初学者。希望国内的大学和其它机构能够创建那么一个国内的库，避免哪天封禁后，无处可去。
本文对应相关书籍的第十四章节的第1，2子章节。
发布一个单元包的大概过程：
[*]配置库的构建选项等
[*]给代码添加友好的注释
[*]注册Crates.io的账号，并获得令牌和设置邮件。实际是GitHub账户
[*]编译代码 （可跳过）
[*]使用cargo login登录
[*]使用cargo publish发布
一、配置构建选项等
主要工作是修改Cargo.toml。
示例配置：
# 名称- 如果要发布，则必须是唯一
name = "minigrep"
# 版本 -这个可以自己定义
version = "0.1.0"
# 发行版-这个不允许定。截止2024/12 ,只允许 2015,2018,2021,2024
edition = "2021"
description ="一个从文本文件中查找字符的命令行工具。只支持utf8编码的文件"
#许可说明
license = "MIT OR Apache-2.0"
# 配置说明-开发
# 优化级别，默认是0，对于发行是3。此值越小表示优化程度越低。
# 优化越多，编译时间越长
opt-level = 0
# 配置说明-发布
opt-level = 3package -包说明
[*]name - 包名称，必须有的。不可在crates.io内重复。先到先得。没有测试过是否可以使用中文，理论上应该可以
[*]vesion -版本，必须有
[*]edition -发行版，必须有，截止2024/12 ,只允许 2015,2018,2021,2024
[*]description - 描述，必须有
[*]license - 许可，必须有。如果不希望个性化的，就简单的按照书本要求的即可。据说这里采用的是linux的spdx符号.
profile.xxx - 分类配置说明
可以不配置，因为默认情况下，开发的时候，采用0级别，发布的时候采用3级别。
opt-level 介于 , 越大编译花费时间越长，理论上可执行结果性能更好.
其它配置
暂不论，据作者所言，后面的章节还会继续讨论这个问题。所以，我本人也会再以后就cargo这个工具专门编写有关日记。
另外为了发布后好看一点，建议在Cargo.toml同级别目录中创建一个README.md
二、给代码添加友好的注释
重点：
[*]有三种注释，分别是 ///，//!, /**/
[*]注释的部分遵循markdown语法。所以要修改显示布局、样式等等，只需要遵循markdown语法即可
[*]使用 cargo doc --open 确认下效果
///和/**/效果是一样的，看个人习惯
//! 会展示稍微不一样的内容，效果相当于一个序言，概述等
如果要添加代码块，则用··· (波浪线~下那个字符)即可.
示例：
//! minigrep
//! 这是一个单元包概述
//! minigrep 是一个命令行程序，它允许用户搜索文本文件内容。
/// 参数配置结构体
#
pub struct Config {
/// 被搜索的文件名，可以是全路径（含文件名），也可以不含路径的文件名
pub file_name: String,
/// 从被搜索的文件中查找的字符串
pub target: String,
/// 是否显示帮助信息.仅当用户输入的第一个参数为 --help 时，该值为 true
pub show_help: bool,
}
/**
* 处理参数的模块 <br>
* 包括 build、is_too_big,show_help
*/
pub mod config {
use super::Config;
use std::env;
use std::fs;
use std::path::Path;
/// **构建一个参数配置结构体** <br>
/// **args** 参数列表 ,数组类型，非空。第一个表示程序路径，第二个为target_name,第三个为file_path <br>
/// 返回： 参数配置结构体<br>
/// 异常: 如果参数异常则返回错误信息<br>
/// 例子：
/// ```
/// use std::env;
/// use minigrep::{config,search};
/// fn main() {
/// let args: Vec<String> = env::args().collect();
/// let con=config::build(&args).unwrap_or_else(|err|{
/// eprintln!("程序异常:{}",err);
/// std::process::exit(1);
/// });
/// }
/// ```
看效果：
三、账户：令牌和邮件
登录crates.io。
获取令牌
注意的是，必须先用github的账号登录。如果使用邮箱认证，还需要登录确认下。
登录后，点击“Account Settings”,即可，进入后点击左边的“API Tokens”:
过期时间和作用范围，自己选。上面是不过期，所有范围。
点击“Generate Token"，结果如下：
https://img2024.cnblogs.com/blog/1177268/202412/1177268-20241211193220786-1907773568.png
把最下面这个字符串复制下来，保存好。
这个令牌可以重新生成。
设置邮件
点击上图的"Profile",还需要设置邮件,具体略。设置完毕后，如下图：
四、编译代码
运行 cargo build --release
这一个步骤可以省略，因为执行cargo publish的时候会自动编译
五、使用cargo login登录
执行 cargo login xxxx, 其中xxx是Crates.io获得的api令牌
注意：如果申请的令牌是无期限的，则建议定期做个cargo logout。避免泄露令牌。
六、使用cargo publish发布
6.1、运行 cargo publish
很不幸的是，这个minigrep已经存在了，所以必须修改下。
再次发布，提示确认邮件地址有问题，要去该下账户中的邮件信息(如果没有设置邮件）。
如果成功，大概如下：
从这个输出看，发布经过大概几个过程：打包，验证，编译，上传。
6.2、确认发布结果
有两个方式：
[*]另启一个工程，引用mmsearch 0.1.0版本
[*]直接在Crates.io中进行搜索
采用第二个方式：
6.3、取消和撤销取消
取消发布
cargo yank --vers 0.1.0
再看看crates.io
撤销取消
cargo yank --vers 0.1.0 --undo
常识
不同于maven等工具，cargo 不能对同个版本重新发布。
这一点，本人导致比较赞同这种策略。 当然maven等策略也有存在的场景。
但个人还是推荐这个！
6.4、publish的其它
cargo help publish ，可以看到具有许多的选项，主要是几个部分：
[*]发布相关-包括
[*]--token token
[*] --registry registry
[*]打包
[*]--target triple
[*]--target-dir directory
[*]编译
[*]-p
[*]通用
[*]+toolchain
[*] --config KEY=VALUE or PATH
[*]其它...
不一一解释了。
不过有一个值得关注的，就是 --registry registry,中应该是允许发布到Crates.io之外的地方。
七、小结
[*]按照默认的选项发布一个应用还是很容易的
[*]发布具有更多丰富的选项，远不止本文所提到的。rust的发布功能还是很强大的
[*]rust的发布明显对于时下的流行技术还是比较关注，注入toml,markdown，
来源：程序园用户自行投稿发布，如果侵权，请联系站长删除
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！
页:
[1]