沈阳中小企业网站建设,wordpress带样式备份,竞价推广工具,网站首选域301如何做本教程笔记来自 杨旭老师的 rust web 全栈教程#xff0c;链接如下#xff1a;
https://www.bilibili.com/video/BV1RP4y1G7KF?p1vd_source8595fbbf160cc11a0cc07cadacf22951
学习 Rust Web 需要学习 rust 的前置知识可以学习杨旭老师的另一门教程
https://www.bili…本教程笔记来自 杨旭老师的 rust web 全栈教程链接如下
https://www.bilibili.com/video/BV1RP4y1G7KF?p1vd_source8595fbbf160cc11a0cc07cadacf22951
学习 Rust Web 需要学习 rust 的前置知识可以学习杨旭老师的另一门教程
https://www.bilibili.com/video/BV1hp4y1k7SV/?spm_id_from333.999.0.0vd_source8595fbbf160cc11a0cc07cadacf22951
今天来入门基于 rust 的 web 框架 Actix
Actix简单使用
Actix - Rust 的 Actor 异步并发框架
Actix 基于 Tokio 和 Future开箱具有异步非阻塞事件驱动并发能力其实现低层级 Actor 模型来提供无锁并发模型而且同时提供同步 Actor具有快速、可靠易可扩展。
Actix 之上是高性能 Actix-web 框架很容易上手。使用 Actix-web 开发的应用程序将在本机可执行文件中包含 HTTP 服务器。你可以把它放在另一个像 nginx 这样的 HTTP 服务器上。但即使完全不存在另一个 HTTP 服务器 (像 nginx) 的情况下Actix-web 也足以提供 HTTP 1 和 HTTP 2 支持以及 SSL/TLS。这对于构建微服务分发非常有用。
我们需要先创建一个项目然后引入需要的依赖然后使用 bin 指定我们的 bin 目录
[package]
name stage_2
version 0.1.0
edition 2021[dependencies]
actix-web 3
actix-rt 1.1.1[[bin]]
name server1之后我们在 src 下创建一个 bin 目录和一个 server1.rs 编写我们的框架
对于 server1.rs 我们需要初始化一个 app 作为我们的 web 项目然后为它配置一个路由的函数之后再指定的端口运行我们的 app 项目。因为它是异步的所以我们要加上 await 和 async 进行修饰并且使用 actix_rt::main 这个包
use actix_web::{web, App, HttpResponse, HttpServer, Responder};
use std::io;
#[actix_rt::main]
async fn main() - io::Result() {let app move || App::new().configure(general_routes);HttpServer::new(app).bind(127.0.0.1:3000)?.run().await
}之后我们编写我们的路由函数它传入一个配置项你可以在其中配置对应路由的处理方法比如我们处理 /health 路径的 get 方法我们就可以用如下的方式进行编写在 to 之后提供一个函数作为我们的处理函数。
处理函数是需要实现 Responder 这个 Trait 的所以我们的返回值需要使用 HttpResponse 相关的函数进行返回其中 Ok() 表示 200 这个状态码之后又使用 json 函数返回了一段 json 作为作为我们的返回值
pub fn general_routes(cfg: mut web::ServiceConfig) {cfg.route(/health, web::get().to(health_check_handler));
}pub async fn health_check_handler() - impl Responder {HttpResponse::Ok().json(Actix Web Service is running!)
}现在我们的创建搭建完毕了我们在命令行启动我们的项目然后访问 120.0.0.1:3000 可以看到Actix Web Service is running! 这句话那么我们的项目就可以正常使用了
构建完整的 rust API
现在我们已经可以运行我们的 Actix 框架了之后我们来尝试构建一个完整的具有增删改查功能的 api我们再新建一个 teacher-service.rs 把这个项目设置为默认项目并且加载我们需要的包
[package]
name stage_3
version 0.1.0
edition 2021
default-run teacher-service[dependencies]
actix-web 3
actix-rt 1.1.1
serde { version 1.0.132, features [derive] }
chrono { version 0.4.19, features [serde] }[[bin]]
name server1[[bin]]
name teacher-service数据库的部分将会在下一部分讲解我们先把我们的数据放在内存中我们先建立一个 models.rs 它用于定义我们的数据结构 通过刚刚引入的 serde 包我们可以让 json 数据转化为我们的数据结构
use actix_web::web;
use chrono::NaiveDateTime;
use serde::{Deserialize, Serialize};#[derive(Deserialize, Serialize, Debug, Clone)]
pub struct Course {pub teacher_id: usize,pub id: Optionusize,pub name: String,pub time: OptionNaiveDateTime,
}impl Fromweb::JsonCourse for Course {fn from(course: web::JsonCourse) - Self {Course {teacher_id: course.teacher_id,id: course.id,name: course.name.clone(),time: course.time,}}
}之后我们编写一个 state.rs 封装我们全局共享的数据结构它包括一个响应一个访问次数和一个返回的结构体这个内容将作为全局内容在我们的程序中共享因为涉及到多个程序会调用 visit_count 和 courses 数据所以我们把他们放在 Mutex 中来保证互斥调用
use std::sync::Mutex;use crate::modelds::Course;pub struct AppState {pub health_check_response: String,pub visit_count: Mutexu32,pub courses: MutexVecCourse,
}之后将上一步简单 get 方法的路由配置到这里我们新建 routers.rs 来存放路由
use super::handlers::*;
use actix_web::web;
pub fn general_routes(cfg: mut web::ServiceConfig) {cfg.route(/health, web::get().to(health_check_handler));
}然后新建一个 handlers.rs 方法来定于我们的对于路由的处理函数这里我们可以调用全局注册的 app_state 这个内容会在下一部分讲到。我们取出共享数据里的 访问次数和响应内容之后返回一个 json 数据。
use super::state::AppState;
use actix_web::{web, HttpResponse};pub async fn health_check_handler(app_state: web::DataAppState) - HttpResponse {println!(incoming for health check);let health_check_response app_state.health_check_response;let mut visit_count app_state.visit_count.lock().unwrap();let response format!({} {} times, health_check_response, visit_count);*visit_count 1;HttpResponse::Ok().json(response)
}最后我们配置我们的主函数 teacher-service.rs 在 3000 端口启动我们的项目我们将一个初始化的 shared_data 配置到项目中之后在项目的整个的流程中都可以使用它
use actix_web::{web, App, HttpServer};
use std::io;
use std::sync::Mutex;#[path ../handlers.rs]
mod handlers;
#[path ../models.rs]
mod modelds;
#[path ../routers.rs]
mod routers;
#[path ../state.rs]
mod state;use routers::*;
use state::AppState;#[actix_rt::main]
async fn main() - io::Result() {let shared_data web::Data::new(AppState {health_check_response: Im OK..to_string(),visit_count: Mutex::new(0),courses: Mutex::new(vec![]),});let app move || {App::new().app_data(shared_data.clone()).configure(general_routes)};HttpServer::new(app).bind(127.0.0.1:3000)?.run().await
}这样我们就可以在 127.0.0.1:3000 启动我们的项目当你调用 127.0.0.1:3000/health 的时候你可以看到输出了
Im OK. 1 times每调用一次times 1
处理POST 请求
我们现在已经可以处理 get 请求并且返回一组预定的数据了现在我们来尝试调用 POST 请求来新增我们的数据
我们首先注册一个新的路由它在一个 /courses 的空间中表示它的所有 api 都必须使用 localhost:3000/courses 开头我们先添加一个 localhost:3000/courses 的路由它是 post 方法用于新增一条数据
pub fn course_routes(cfg: mut web::ServiceConfig) {cfg.service(web::scope(/courses).route(/, web::post().to(new_course)));
}之后我们在 handlers.rs 编写它的处理函数我们要做的是把我们收到的数据写入到 app_state 中我们先计算出有多少个数据来计算出新增数据的 id 号作为唯一标识然后将传入数据存入我们的全局数据中
要注意我们需要先获取所有权然后将数据克隆一份来计算长度否则数据在使用完毕以后就被回收了
use super::modelds::Course;
use chrono::Utc;
pub async fn new_course(new_course: web::JsonCourse,app_state: web::DataAppState,
) - HttpResponse {println!(Received new course);let course_count app_state.courses.lock().unwrap().clone().into_iter().filter(|course| course.teacher_id new_course.teacher_id).collect::VecCourse().len();let new_course Course {teacher_id: new_course.teacher_id,id: Some(course_count 1),name: new_course.name.clone(),time: Some(Utc::now().naive_utc()),};app_state.courses.lock().unwrap().push(new_course);HttpResponse::Ok().json(Course added)
}我们编写一个测试来测试我们的接口
mod tests {use super::*;use actix_web::http::StatusCode;use std::sync::Mutex;#[actix_rt::test]async fn post_course_test() {let course web::Json(Course {teacher_id: 1,name: Test course.into(),id: None,time: None,});let app_state: web::DataAppState web::Data::new(AppState {health_check_response: .to_string(),visit_count: Mutex::new(0),courses: Mutex::new(vec![]),});let resp new_course(course, app_state).await;assert_eq!(resp.status(), StatusCode::OK);}
}动态路由
有时候我们希望我们的路径中带有我们需要的查询数据例如我们希望通过 /course/1 来查询对应 id 为1 的老师的课程通过 /course/1/12 来查询对应 id 为1 的老师 id 为 12的课程那么我们需要构建一个动态路由
首先我们这样编写一个路由其中的 user_id 和 course_id 可以作为参数提取到而我们的路径可以匹配到这些路由
pub fn course_routes(cfg: mut web::ServiceConfig) {cfg.service(web::scope(/courses).route(/, web::post().to(new_course)).route(/{user_id}, web::get().to(get_courses_for_teacher)).route(/{user_id}/{course_id}, web::get().to(get_course_detail)),);
}
之后我们在 handlers 里编写处理方法通过传入参数 params 可以拿到我们的路径我们需要构建我们的查询来返回对应的值
pub async fn get_courses_for_teacher(app_state: web::DataAppState,params: web::Pathusize,
) - HttpResponse {let teacher_id: usize params.0;let filtered_courses app_state.courses.lock().unwrap().clone().into_iter().filter(|course| course.teacher_id teacher_id).collect::VecCourse();if filtered_courses.len() 0 {HttpResponse::Ok().json(filtered_courses)} else {HttpResponse::Ok().json(No courses found for teacher.to_string())}
}pub async fn get_course_detail(app_state: web::DataAppState,params: web::Path(usize, usize),
) - HttpResponse {let (teacher_id, course_id) params.0;let selected_course app_state.courses.lock().unwrap().clone().into_iter().find(|x| x.teacher_id teacher_id x.id Some(course_id)).ok_or(Course not found);if let Ok(course) selected_course {HttpResponse::Ok().json(course)} else {HttpResponse::Ok().json(Course not found.to_string())}
}我们也可以为我们编写的这两个方法添加测试 #[actix_rt::test]async fn get_all_courses_success() {let app_state: web::DataAppState web::Data::new(AppState {health_check_response: .to_string(),visit_count: Mutex::new(0),courses: Mutex::new(vec![]),});let teacher_id: web::Pathusize web::Path::from(1);let resp get_courses_for_teacher(app_state, teacher_id).await;assert_eq!(resp.status(), StatusCode::OK);}#[actix_rt::test]async fn get_one_course_success() {let app_state: web::DataAppState web::Data::new(AppState {health_check_response: .to_string(),visit_count: Mutex::new(0),courses: Mutex::new(vec![]),});let params: web::Path(usize, usize) web::Path::from((1, 1));let resp get_course_detail(app_state, params).await;assert_eq!(resp.status(), StatusCode::OK);}如果通过测试我们将拥有一个完整的具有新增和查询功能的 api 了我们将刚刚编写的路由注册到我们的主程序
async fn main() - io::Result() {let shared_data web::Data::new(AppState {health_check_response: Im OK..to_string(),visit_count: Mutex::new(0),courses: Mutex::new(vec![]),});let app move || {App::new().app_data(shared_data.clone()).configure(general_routes).configure(course_routes)};HttpServer::new(app).bind(127.0.0.1:3000)?.run().await
}现在你可以通过 POSTMAN 等工具来测试新增和查询数据的 api 了之后我们将会讲解通过数据库来持久化我们的数据而不是用全局注入的数据结构存储数据。
说明
本教程只是作者的学习笔记帮助理解和记忆 RUST 开发课程全部来源是 B站 杨旭老师的教程
https://www.bilibili.com/video/BV1RP4y1G7KF?p1vd_source8595fbbf160cc11a0cc07cadacf22951
教学 demo 可以查看大佬的 git
https://github.com/FrancisYLfan/rust_web_server_from_yang
