Rust Rocket简单入门

2024-03-20 18:04
文章标签 简单 rust 入门 rocket

本文主要是介绍Rust Rocket简单入门,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

简介

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 应用程序,运行以下命令确保安装了最新的工具链:

rustup default stable

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

cargo new hello-rocket --bin
cd hello-rocket

执行以下命令,添加 Rocket 依赖项:

cargo add rocket

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

#[macro_use] extern crate rocket;#[get("/")]
fn index() -> &'static str {"Hello, world!"
}#[launch]
fn rocket() -> _ {rocket::build().mount("/", routes![index])
}

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

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

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

image

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

常用功能

动态路径

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

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

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

多个片段(segments)

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

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

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

静态文件服务器

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

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

也可以使用 FileServer,只需一行代码即可:

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

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

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

在发布项目时,可以将静态文件夹放在与可执行文件相同的目录中,或者根据部署需求将其放在其他位置。

简单WebAPI示例

下面使用Rocket实现一个简单的WebAPI,这里的示例只实现Post方法,不涉及JWT鉴权。

添加依赖

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

cargo add serde --features "derive"

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

cargo add rocket --features "json"

实现接口

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

#[macro_use] extern crate rocket;
use rocket::serde::{Deserialize, Serialize,json::Json};#[derive(Debug, Deserialize)]
#[serde(crate = "rocket::serde")]
struct TaskRequest {description: String,complete: bool
}#[derive(Debug, Serialize)]
#[serde(crate = "rocket::serde")]
struct TaskResponse {description: String,complete: bool
}#[post("/todo", data = "<task>")]
fn my_function(task: Json<TaskRequest>) -> Json<TaskResponse> {// 处理接收到的任务println!("Received task: {:?}", task);// 返回处理后的任务Json(TaskResponse {description: task.description.clone(),complete: task.complete,})
}#[launch]
fn rocket() -> _ {rocket::build().mount("/", routes![my_function])
}

接口测试

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

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

测试结果:

image

文章转载自:二次元攻城狮

原文链接:https://www.cnblogs.com/timefiles/p/18082863

体验地址:引迈 - JNPF快速开发平台_低代码开发平台_零代码开发平台_流程设计器_表单引擎_工作流引擎_软件架构

这篇关于Rust Rocket简单入门的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/830299

相关文章

Rust中的注释使用解读

《Rust中的注释使用解读》本文介绍了Rust中的行注释、块注释和文档注释的使用方法,通过示例展示了如何在实际代码中应用这些注释,以提高代码的可读性和可维护性... 目录Rust 中的注释使用指南1. 行注释示例:行注释2. 块注释示例:块注释3. 文档注释示例:文档注释4. 综合示例总结Rust 中的注释

Rust格式化输出方式总结

《Rust格式化输出方式总结》Rust提供了强大的格式化输出功能,通过std::fmt模块和相关的宏来实现,主要的输出宏包括println!和format!,它们支持多种格式化占位符,如{}、{:?}... 目录Rust格式化输出方式基本的格式化输出格式化占位符Format 特性总结Rust格式化输出方式

Rust中的Drop特性之解读自动化资源清理的魔法

《Rust中的Drop特性之解读自动化资源清理的魔法》Rust通过Drop特性实现了自动清理机制,确保资源在对象超出作用域时自动释放,避免了手动管理资源时可能出现的内存泄漏或双重释放问题,智能指针如B... 目录自动清理机制:Rust 的析构函数提前释放资源:std::mem::drop android的妙

Rust中的BoxT之堆上的数据与递归类型详解

《Rust中的BoxT之堆上的数据与递归类型详解》本文介绍了Rust中的BoxT类型,包括其在堆与栈之间的内存分配,性能优势,以及如何利用BoxT来实现递归类型和处理大小未知类型,通过BoxT,Rus... 目录1. Box<T> 的基础知识1.1 堆与栈的分工1.2 性能优势2.1 递归类型的问题2.2

C++初始化数组的几种常见方法(简单易懂)

《C++初始化数组的几种常见方法(简单易懂)》本文介绍了C++中数组的初始化方法,包括一维数组和二维数组的初始化,以及用new动态初始化数组,在C++11及以上版本中,还提供了使用std::array... 目录1、初始化一维数组1.1、使用列表初始化(推荐方式)1.2、初始化部分列表1.3、使用std::

redis群集简单部署过程

《redis群集简单部署过程》文章介绍了Redis,一个高性能的键值存储系统,其支持多种数据结构和命令,它还讨论了Redis的服务器端架构、数据存储和获取、协议和命令、高可用性方案、缓存机制以及监控和... 目录Redis介绍1. 基本概念2. 服务器端3. 存储和获取数据4. 协议和命令5. 高可用性6.

JAVA调用Deepseek的api完成基本对话简单代码示例

《JAVA调用Deepseek的api完成基本对话简单代码示例》:本文主要介绍JAVA调用Deepseek的api完成基本对话的相关资料,文中详细讲解了如何获取DeepSeekAPI密钥、添加H... 获取API密钥首先,从DeepSeek平台获取API密钥,用于身份验证。添加HTTP客户端依赖使用Jav

在Rust中要用Struct和Enum组织数据的原因解析

《在Rust中要用Struct和Enum组织数据的原因解析》在Rust中,Struct和Enum是组织数据的核心工具,Struct用于将相关字段封装为单一实体,便于管理和扩展,Enum用于明确定义所有... 目录为什么在Rust中要用Struct和Enum组织数据?一、使用struct组织数据:将相关字段绑

浅析Rust多线程中如何安全的使用变量

《浅析Rust多线程中如何安全的使用变量》这篇文章主要为大家详细介绍了Rust如何在线程的闭包中安全的使用变量,包括共享变量和修改变量,文中的示例代码讲解详细,有需要的小伙伴可以参考下... 目录1. 向线程传递变量2. 多线程共享变量引用3. 多线程中修改变量4. 总结在Rust语言中,一个既引人入胜又可

利用Python编写一个简单的聊天机器人

《利用Python编写一个简单的聊天机器人》这篇文章主要为大家详细介绍了如何利用Python编写一个简单的聊天机器人,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 使用 python 编写一个简单的聊天机器人可以从最基础的逻辑开始,然后逐步加入更复杂的功能。这里我们将先实现一个简单的