当前位置： 首页 > article >正文

【Rust Crate之Actix Web(一)】

article 2024/12/26 11:21:07

Rust Crate之Actix Web

  • 什么是Actix Web？
  • Actix Web 入门
    • 代码宏展开,看看` #[get("/")] ` 做了什么
    • Actix Web中的State
    • Actix Web中的scope
    • Actix Web中的extractors
      • Path
      • Query
      • JSON
      • URL-encoded form
  • 总结

什么是Actix Web？

Actix Web is a poweful ，pragmatic，and extremely fast web framework for Rust

Actix Web 作为一个服务器框架,非常适合于搭建小型http服务器,方便快捷,它支持Http/1，Http2，TLS，尽管他也支持了Websocket，但在此不予讨论。

Actix Web 入门

代码示例：

use actix_web::{get, post, web, App, HttpResponse, HttpServer, Responder};

#[get("/")]           //使用ACtix定义的宏,可以直接将响应函数定义具体路由地址(url),并确定以什么方式访问(如这里的根,Get方式),
async fn hello() -> impl Responder {
    HttpResponse::Ok().body("Hello world!")
}

#[post("/echo")]
async fn echo(req_body: String) -> impl Responder {
    HttpResponse::Ok().body(req_body)
}

async fn manual_hello() -> impl Responder {
    HttpResponse::Ok().body("Hey there!")
}

#[actix_web::main]  //标明Actix web程序入口,默认支持异步编程
async fn main() -> std::io::Result<()> {
    HttpServer::new(|| { //创建HttpServer
        App::new()       //使用App 实例注册request处理程序.
            .service(hello) //使用宏路由的,用sercvice注册
            .service(echo)  
            .route("/hey", web::get().to(manual_hello)) //也可以手动,更清晰的注册路由
    })
    .bind(("127.0.0.1", 8080))?//绑定具体的Ip & Port
    .run()            //run起来您的程序
    .await
}
//ps:以上代码为官方示例

代码宏展开,看看#[get("/")] 做了什么

#![feature(prelude_import)]
#[prelude_import]
use std::prelude::rust_2021::*;
#[macro_use]
extern crate std;
use actix_web::{get, post, web, App, HttpResponse, HttpServer, Responder};
#[allow(non_camel_case_types, missing_docs)]
pub struct hello;
// 正如官文中描述的那样:Finally, the app is started inside an HttpServer which will serve incoming 
// requests using your App as an "application factory". 每一个request处理程序都实现了HttpServiceFactory
impl ::actix_web::dev::HttpServiceFactory for hello {
    fn register(self, __config: &mut actix_web::dev::AppService) {
    //register将会在Service做为参数传入时,最终调用HttpServiceFactory::register将resource注册
        async fn hello() -> impl Responder {
            HttpResponse::Ok().body("Hello world!")
        }
        let __resource = ::actix_web::Resource::new("/")
            .name("hello")
            .guard(::actix_web::guard::Get())
            .to(hello);
        ::actix_web::dev::HttpServiceFactory::register(__resource, __config);
    }
}
#[allow(non_camel_case_types, missing_docs)]
pub struct echo;
impl ::actix_web::dev::HttpServiceFactory for echo {
    fn register(self, __config: &mut actix_web::dev::AppService) {
        async fn echo(req_body: String) -> impl Responder {
            HttpResponse::Ok().body(req_body)
        }
        let __resource = ::actix_web::Resource::new("/echo")
            .name("echo")
            .guard(::actix_web::guard::Post())
            .to(echo);
        ::actix_web::dev::HttpServiceFactory::register(__resource, __config);
    }
}
async fn manual_hello() -> impl Responder {
    HttpResponse::Ok().body("Hey there!")
}
fn main() -> std::io::Result<()> {
    <::actix_web::rt::System>::new()
        .block_on(async move {
            {
                HttpServer::new(|| {
                        App::new()
                            .service(hello)
                            .service(echo)
                            .route("/hey", web::get().to(manual_hello))
                    })
                    .bind(("127.0.0.1", 8080))?
                    .run()
                    .await
            }
        })
}

Actix Web中的State

Actix web 框架下的State,即承载Server内部非请求数据的数据载体,不要被名称迷惑,它可以通过自定义数据来表示Server的状态,而更多的是用以共享全局性质的变量,通常来讲,如在开发时对数据库链接管理的数据库连接池,也可以是只读的base_url,在共享此类变量时需要注意,Actix Web Server针对每一条数据请求都是会独立出一条thread,所以共享时的同步尤为重要,所以在实现自定义的数据时,请注意使用同步原语。
代码示例：

...
let db_pool = Data::new(db_pool);
....app_data(db_pool.clone())...

State在闭包直接初始化时是无法做同步的,当开发者需要同步机制,则需要如上述代码一般,先在外部声明,再clone传入。

Actix Web中的scope

Scope表示范围，在服务中即表示统一前缀，举个例子：/user/login /user/info中的/user便是前缀,这方便开发者将api以restful形式拆分,更好的做分类,进一步的,开发者可以通过ServiceConfig 将具体的请求处理程序分配到不同的module中,使得整个程序代码更加的结构化。

use actix_web::{web, App, HttpResponse, HttpServer};

// this function could be located in a different module
fn scoped_config(cfg: &mut web::ServiceConfig) {
    cfg.service(
        web::resource("/test")
            .route(web::get().to(|| async { HttpResponse::Ok().body("test") }))
            .route(web::head().to(HttpResponse::MethodNotAllowed)),
    );
}

// this function could be located in a different module
fn config(cfg: &mut web::ServiceConfig) {
    cfg.service(
        web::resource("/app")
            .route(web::get().to(|| async { HttpResponse::Ok().body("app") }))
            .route(web::head().to(HttpResponse::MethodNotAllowed)),
    );
}

#[actix_web::main]
async fn main() -> std::io::Result<()> {
    HttpServer::new(|| {
        App::new()
            .configure(config)
            .service(web::scope("/api").configure(scoped_config))
            .route(
                "/",
                web::get().to(|| async { HttpResponse::Ok().body("/") }),
            )
    })
    .bind(("127.0.0.1", 8080))?
    .run()
    .await
}
//ps: 例子来源于官文

Actix Web中的extractors

extractors在Acitx Web中是类型安全的,extractors提供了提取请求数据中为特定类型的不同方法,使得代码更加清晰安全.

Path

Path用于将请求路径上的信息转为自定义类型。

//具体的
#[derive(Deserialize)] //自定义类型一定需要实现反序列化
struct Info {
    user_id: u32,
    friend: String,
}
/// extract path info using serde
#[get("/users/{user_id}/{friend}")] //宏中名称要和自定义类型中的名称对齐.
async fn index(info: web::Path<Info>) -> Result<String> {
    Ok(format!(
        "Welcome {}, user_id {}!",
        info.friend, info.user_id
    ))
}

Query

Query用于请求参数的提取,将其转换成具体的类型。

#[derive(Deserialize)]
struct Info {
    username: String,
}

//如果请求参数中并不包含需要提取的字段数据,则server将会返回404
#[get("/")]
async fn index(info: web::Query<Info>) -> String {
    format!("Welcome {}!", info.username)
}

JSON

JSON 用于将请求中的json格式请求体转为具体的类型。

use actix_web::{post, web, App, HttpServer, Result};
use serde::Deserialize;

#[derive(Deserialize)]
struct Info {
    username: String,
}

/// deserialize `Info` from request's body
#[post("/submit")]
async fn submit(info: web::Json<Info>) -> Result<String> {
    Ok(format!("Welcome {}!", info.username))
}

URL-encoded form

用于将表单数据提取成具体的数据类型。

use actix_web::{post, web, App, HttpServer, Result};
use serde::Deserialize;

#[derive(Deserialize)]
struct FormData {
    username: String,
}

/// extract form data using serde
/// this handler gets called only if the content type is *x-www-form-urlencoded*
/// and the content of the request could be deserialized to a `FormData` struct
#[post("/")]
async fn index(form: web::Form<FormData>) -> Result<String> {
    Ok(format!("Welcome {}!", form.username))
}

涉及到更具体的可以参阅官方文档的Api Document

Actix Web架构摘要

总结

Actix Web 易用性高,性能出众,如果开发者想在生产环境中使用Rust做Http Server,其是值得一选的,在整体的开发框架中,State同步,提取和Connfigure 以及Handler的 布局设计是重要的。

“不论我们接受与否,一个不确定的时代已经到来”


http://www.kler.cn/a/383445.html

相关文章：

  • 什么样的LabVIEW控制算自动控制？
  • Linux服务器端自动挂载存储设备（U盘、移动硬盘）
  • 大语言模型学习工具及资源总结和落地应用
  • 容器技术所涉及Linux内核关键技术
  • FreeSWITCH实现多人电话会议功能
  • R 语言 | 绘图的文字格式(绘制上标、下标、斜体、文字标注等)
  • Sigrity Power SI 3D-EM Inductance Extraction模式如何进行电感的提取操作指导(一)
  • 计算机体系结构知识（二）-gdb和args
  • Linux -- 初识线程
  • 【鉴权】OAuth 2.0: 高度灵活与安全的身份认证框架
  • 百度实习生内推
  • Java实战项目-基于微信小程序的校园生活互助服务小程序
  • 供热的一些基础技术数据
  • 2024年10月全球人工智能领域的重大事件盘点
  • Prompt Engineering介绍
  • AI大模型重塑软件开发流程：定义、应用场景、优势、挑战及未来展望
  • 父组件调用函数式子组件，并向子组件传递函数参数。
  • Web3中的区块链技术：从基础设施到应用的演变
  • Python Matplotlib：基本图表绘制指南
  • 社交电商全球化：开源链动模式的引领与挑战
  • uniapp 整合 OpenLayers - 测距测面
  • 安装mysql主从复制
  • SpringMVC快速上手
  • 微信小程序uniapp基于Android的流浪动物管理系统 70c3u
  • mysql代码生成器
  • Linux云计算个人学习总结（一）