Rust Rocket简朴入门

目次

• 简介
  
• hello world
  
• 常用功能
  
  
  
  • 动态路径
    
  • 多个片段(segments)
    
  • 静态文件服务器
    
  
  
• 简朴WebAPI示例
  
  
  
  • 添加依赖
    
  • 实现接口
    
  • 接口测试
    
  
  
• 参考链接
  

简介

Rust中最着名的两个web框架要数Rocket和Actix了，Rocket更注意易用性，Actix则更注意性能。这里只是了解一下Rust下的WebAPI开发流程，就学一下最简朴的 Rocket。
Rocket 是一个用于 Rust 的异步 Web 框架，专注于可用性、安全性、可扩展性和速度:
github：https://github.com/rwf2/Rocket/tree/v0.5
官网：https://rocket.rs
hello world

需要最新版本的 Rust 来运行 Rocket 应用程序，运行以下命令确保安装了最新的工具链：

1. rustup default stable

复制代码

创建一个新的基于二进制的 Cargo 项目并切换到新目次：

1. cargo new hello-rocket --bin
2. cd hello-rocket

复制代码

执行以下命令，添加 Rocket 依赖项：

1. cargo add rocket

复制代码

在 src/main.rs 文件中添加以下代码：

1. #[macro_use] extern crate rocket;
3. #[get("/")]
4. fn index() -> &'static str {
5.     "Hello, world!"
6. }
8. #[launch]
9. fn rocket() -> _ {
10.     rocket::build().mount("/", routes![index])
11. }

复制代码

上面hello world示例没有main函数，main函数由launch宏生成，可以通过源码看出：

1. pub fn launch(args: TokenStream, input: TokenStream) -> TokenStream {
2.     emit!(attribute::entry::launch_attribute(args, input))
3. }
4. //...
5. async_entry!(launch_attribute, launch::Launch, quote!(fn main() {}));

复制代码

运行程序，访问 http://localhost:8000 以查察应用，VS终端输出如下：

程序带的有彩色输出，如果在文件夹手动打开后没有彩色输出，说明体系不支持ANSI转义序列。
常用功能

动态路径

动态路径比力常见的场景是动态id场景，可以传N个动态类型即动态路径有多层，只要这个类型实现了FromParam：

1. //访问链接示例：http://localhost:8000/hello/张三/25/true
2. #[get("/hello/<name>/<age>/<is_male>")]
3. fn hello(name: &str, age: u8, is_male: bool) -> String {
4.     if is_male {
5.         format!("姓名 {} ，年龄 {}, 性别 男!", name, age)
6.     } else {
7.         format!("姓名 {} ，年龄 {}, 性别 女!", name, age)
8.     }
9. }

复制代码

这个路由会匹配所有/hello/为基础路径的路由，然后将它匹配到的动态路径作为参数传递给处置惩罚器，Rocket默认给标准库里的一些常见类型以及Rocket自身的一些特殊类型实现了FromParam trait。
多个片段(segments)

可以通过的方式来匹配多个动态路径，这种类型的参数一般被叫做分段防护装置(segments guards)，都必须先实现FromSegments这个trait。

1. use std::path::PathBuf;
3. //访问链接示例：http://localhost:8000/page/foo/bar
4. #[get("/page/<path..>")]
5. fn get_page(path: PathBuf) -> String {
6.     let mut output = String::new();
7.     for part in path.iter() {
8.         let part_str = part.to_string_lossy();
9.         println!("路径参数: {}", part_str);
10.         output.push_str(&format!("路径参数: {}\n", part_str));
11.     }
12.     output
13. }

复制代码

PathBuf实现了FromSegments这个trait，所以不用担心/page或者/page//导致的解析失败，也不用担心路径遍历攻击(path traversal attacks)。
静态文件服务器

基于 分段防护装置(segments guards)，可以简朴的实现一个安全的静态文件服务器：

1. use std::path::{Path, PathBuf};
2. use rocket::fs::NamedFile;
4. #[get("public/<file..>")]
5. async fn files(file: PathBuf) -> Option<NamedFile> {
6.     NamedFile::open(Path::new("static/").join(file)).await.ok()
7. }

复制代码

也可以使用 FileServer，只需一行代码即可：

1. //引入FileServer结构体
2. use rocket::fs::FileServer;
4. //将/public作为URI前缀，并将static/作为文件路径
5. rocket.mount("/public", FileServer::from("static/"))

复制代码

在项目根目次下创建一个名为static的文件夹，并将静态文件 example.txt 放在其中，通过以下uri访问文件：

1. http://localhost:8000/public/example.txt

复制代码

在发布项目时，可以将静态文件夹放在与可执行文件相同的目次中，或者根据部署需求将其放在其他位置。
简朴WebAPI示例

下面使用Rocket实现一个简朴的WebAPI，这里的示例只实现Post方法，不涉及JWT鉴权。
添加依赖

执行以下命令添加 serde 依赖：

1. cargo add serde --features "derive"

复制代码

再运行一遍以下命令，打开 json 功能标志：

1. cargo add rocket --features "json"

复制代码

实现接口

在 src/main.rs 文件中实现以下代码：

1. #[macro_use] extern crate rocket;
2. use rocket::serde::{Deserialize, Serialize,json::Json};
4. #[derive(Debug, Deserialize)]
5. #[serde(crate = "rocket::serde")]
6. struct TaskRequest {
7.     description: String,
8.     complete: bool
9. }
11. #[derive(Debug, Serialize)]
12. #[serde(crate = "rocket::serde")]
13. struct TaskResponse {
14.     description: String,
15.     complete: bool
16. }
18. #[post("/todo", data = "<task>")]
19. fn my_function(task: Json<TaskRequest>) -> Json<TaskResponse> {
20.     // 处理接收到的任务
21.     println!("Received task: {:?}", task);
23.     // 返回处理后的任务
24.     Json(TaskResponse {
25.         description: task.description.clone(),
26.         complete: task.complete,
27.     })
28. }
30. #[launch]
31. fn rocket() -> _ {
32.     rocket::build().mount("/", routes![my_function])
33. }

复制代码

接口测试

使用 curl 测试一下接口，在cmd中执行以下命令：

1. curl -X POST -H "Content-Type: application/json" -d "{"description":"Task 1","complete":true}" http://localhost:8000/todo

复制代码

测试结果：

参考链接

• 简朴探索Rust Web开发
  
• rust基础学习——web框架Rocket简朴入门
  
• Rocket 指导 v0.5 开始
  
• cmd输出彩色字体（win10 cmd控制台支持ANSI转义序列）
  

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。