首页 > 其他分享 >Rust Rocket简单入门

Rust Rocket简单入门

时间:2024-03-19 15:15:28浏览次数:13  
标签:Rocket rocket 路径 Rust hello fn 入门

目录

简介

Rust中最知名的两个web框架要数RocketActix了,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

参考链接

标签:Rocket,rocket,路径,Rust,hello,fn,入门
From: https://www.cnblogs.com/timefiles/p/18082863

相关文章

  • GraphQL入门之分页查询
    前一篇文章讲了怎么创建GraphQL的查询操作,今天在此基础上看看要实现一个简单的分页查询应该怎么做,顺便可以介绍一下GraphQL里的枚举类型和查询参数应该怎么用。创建Node.js的工程mkdirmyappcdmyappnpminit(一路回车)安装依赖包npminstall@apollo/server......
  • cuda从入门到精通(六)共享内存和循环分块实现CUDA矩阵乘
    本文系转载,出处:https://mp.weixin.qq.com/s/1w1WFPoUEvVECsurqmvJDw在CUDA编程中,共享内存和循环分块(looptiling)是两种常见的优化策略,它们可以帮助我们提高矩阵乘法的性能。共享内存(SharedMemory):在GPU中,每个线程块(block)都有自己的共享内存。与全局内存相比,共享内存的访问......
  • python 小小入门2
    紧跟上章使用FinalShell1)mkdiraaa创建文件夹mkdir-p/aaa/bbb/ccc创建文件夹以及后续2)touch 例如touch1.txt也可touch1.txt2.txt3.txt以及touchfsd.sdad也可以创建如果已经有了touch1.txt再创建一个touch1.txt那么他不会覆盖以及删除原来的文件只......
  • RocketMQ之生产者(Producer)
    1.生产者(Producer)生产者是ApacheRocketMQ系统中用来构建并传输消息到服务端的运行实体。生产者通常被集成在业务系统中,将业务消息按照要求封装成ApacheRocketMQ的消息(Message)并发送至服务端2.生产者的传输行为传输行为描述发送方式生产者可通过API接口设置消息发送......
  • FPGA入门笔记008——数码管动态扫描设计与验证
    #FPGA入门笔记008——数码管动态扫描设计与验证1、数码管动态扫描原理​ 8段数码管的结构图如图1所示:图1——8段数码管结构图(a为共阴极,b为共阳极)​ 对于共阴数码管需要给对应段以高电平才会使其点亮,而对于共阳极数码管则需要给低电平才会点亮。AC620上板载的是共阳极数......
  • AIGC之入门之详细介绍
    一、AIGC初识AIGC,即ArtificialIntelligenceGeneratedContent,指的是生成式人工智能。它可以通过处理人的自然语言,对AI下达指令任务,从而自动生成图片、视频、音频等内容。至于AIGC中的StableDiffusion,它可能指的是一种特定的生成模型或技术。StableDiffusion在AIGC领域中......
  • 黑客入门指南
    黑客入门指南......
  • 深入理解mysql 从入门到精通
    1.MySQL结构由下图可得MySQL的体系构架划分为:1.网络接入层2.服务层3.存储引擎层4.文件系统层1.网络接入层提供了应用程序接入MySQL服务的接口。客户端与服务端建立连接,客户端发送SQL到服务端,Java中通过JDBC来实现连接数据库。2.服务层管理工具和服务:系统管理和控......
  • 阿里云-零基础入门推荐系统 【排序模型+模型融合】
    文章目录学习过程赛题介绍评价方式理解赛题理解排序模型读取排序特征转化类型返回排序后的结果排序结果归一化LGB排序模型定义特征列排序模型分组排序模型定义排序模型训练lgb_ranker模型预测lgb_ranker预测结果重新排序及生成提交结果lgb_ranker五折交叉验证lgb_ranker......
  • Mybatis-Plus 快速入门
    快速入门地址:快速测试|MyBatis-Plus(baomidou.com)使用第三方组件:1、导入对应依赖2、研究依赖如何配置3、代码如何编写4、提高扩展技术能力步骤1、创建数据库mybatis_plus2、创建user表DROPTABLEIFEXISTS`user`;​CREATETABLE`user`( idBIGINTN......