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

相关文章

从入门到精通详解Python虚拟环境完全指南

《从入门到精通详解Python虚拟环境完全指南》Python虚拟环境是一个独立的Python运行环境,它允许你为不同的项目创建隔离的Python环境,下面小编就来和大家详细介绍一下吧... 目录什么是python虚拟环境一、使用venv创建和管理虚拟环境1.1 创建虚拟环境1.2 激活虚拟环境1.3 验证虚

Python 基于http.server模块实现简单http服务的代码举例

《Python基于http.server模块实现简单http服务的代码举例》Pythonhttp.server模块通过继承BaseHTTPRequestHandler处理HTTP请求,使用Threa... 目录测试环境代码实现相关介绍模块简介类及相关函数简介参考链接测试环境win11专业版python

Java List 使用举例(从入门到精通)

《JavaList使用举例(从入门到精通)》本文系统讲解JavaList,涵盖基础概念、核心特性、常用实现(如ArrayList、LinkedList)及性能对比,介绍创建、操作、遍历方法,结合实... 目录一、List 基础概念1.1 什么是 List?1.2 List 的核心特性1.3 List 家族成

python连接sqlite3简单用法完整例子

《python连接sqlite3简单用法完整例子》SQLite3是一个内置的Python模块,可以通过Python的标准库轻松地使用,无需进行额外安装和配置,:本文主要介绍python连接sqli... 目录1. 连接到数据库2. 创建游标对象3. 创建表4. 插入数据5. 查询数据6. 更新数据7. 删除

Jenkins的安装与简单配置过程

《Jenkins的安装与简单配置过程》本文简述Jenkins在CentOS7.3上安装流程,包括Java环境配置、RPM包安装、修改JENKINS_HOME路径及权限、启动服务、插件安装与系统管理设置... 目录www.chinasem.cnJenkins安装访问并配置JenkinsJenkins配置邮件通知

c++日志库log4cplus快速入门小结

《c++日志库log4cplus快速入门小结》文章浏览阅读1.1w次,点赞9次,收藏44次。本文介绍Log4cplus,一种适用于C++的线程安全日志记录API,提供灵活的日志管理和配置控制。文章涵盖... 目录简介日志等级配置文件使用关于初始化使用示例总结参考资料简介log4j 用于Java,log4c

史上最全MybatisPlus从入门到精通

《史上最全MybatisPlus从入门到精通》MyBatis-Plus是MyBatis增强工具,简化开发并提升效率,支持自动映射表名/字段与实体类,提供条件构造器、多种查询方式(等值/范围/模糊/分页... 目录1.简介2.基础篇2.1.通用mapper接口操作2.2.通用service接口操作3.进阶篇3

Python自定义异常的全面指南(入门到实践)

《Python自定义异常的全面指南(入门到实践)》想象你正在开发一个银行系统,用户转账时余额不足,如果直接抛出ValueError,调用方很难区分是金额格式错误还是余额不足,这正是Python自定义异... 目录引言:为什么需要自定义异常一、异常基础:先搞懂python的异常体系1.1 异常是什么?1.2

Python实现Word转PDF全攻略(从入门到实战)

《Python实现Word转PDF全攻略(从入门到实战)》在数字化办公场景中,Word文档的跨平台兼容性始终是个难题,而PDF格式凭借所见即所得的特性,已成为文档分发和归档的标准格式,下面小编就来和大... 目录一、为什么需要python处理Word转PDF?二、主流转换方案对比三、五套实战方案详解方案1:

Python yield与yield from的简单使用方式

《Pythonyield与yieldfrom的简单使用方式》生成器通过yield定义,可在处理I/O时暂停执行并返回部分结果,待其他任务完成后继续,yieldfrom用于将一个生成器的值传递给另一... 目录python yield与yield from的使用代码结构总结Python yield与yield