如何使用Rust框架 Actix构建web后端

如何使用Rust框架 Actix构建web后端

rust的生态里,后端框架使用量最大的两个框架是RocketActix,本文使用的是Actix框架。

本文部分展示代码为,曾经公司王者荣耀比赛写的后端项目逻辑。展示的代码隐藏了部分实现,这里大家有兴趣的话可以直接在我的github repo 中寻找源码,并欢迎大家给我提供意见(点赞一键三连🐶)。也欢迎大家对于本文积极提出意见。

环境

  • macOS环境下安装rust简单,一行命令curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh rust的相关工具就下载好了。这里如果需要可以更新下载源为国内源。
  • IDE使用JetBrains的RustRover,目前EAP版本下免费。

启动

创建项目之后,项目的依赖都在Cargo.toml中配置,数据库依赖方面使用sqlx,features使用mysql。:

[dependencies]
actix-web = "4.4"
dotenvy = "0.15"
env_logger = "0.10"
sqlx = { version = "0.7.1", features = ["mysql", "runtime-tokio", "chrono"] }
······

关于架构方面,使用多层架构:

.
├── Cargo.lock
├── Cargo.toml
└── src
    ├── controller
    ├── main.rs
    ├── model
    ├── repository
    └── service

入口文件

main文件书写如下,分别是函数签名和内容:

#[actix_web::main]
async fn main() -> io::Result<()> {
    init_environment();
    let server_addr = env::var(SERVER_ADDR).expect(SERVER_ADDR_NOT_SET_MSG);
    let database_url = env::var(DATABASE_URL).expect(DATABASE_URL_NOT_SET_MSG);
    let pool = init_database(database_url).await;

    log::info!("{}{}", STARTING_SERVER_LOG, server_addr);

    HttpServer::new(move || { create_app(pool.clone()) })
        .bind(server_addr)?
        .run()
        .await
}

先用一个属性宏将main函数转换为一个异步函数,允许函数使用异步操作。函数签名中,函数名为main,返回类型为io::Result<()>:: 在rust里是关联函数调用(类似于静态方法),与之对应的是实例函数(类似于成员方法)。

继续看函数内容,获得环境里的值进行初始化。然后HttpServer::new初始化一个新的HTTP服务器实例;move || { create_app(pool.clone()) }这是一个rust的闭包写法,获取了作用域外的变量的所有权(所有权是rust 核心机制,这里就不展开了)。然后绑定指定的地址、启动服务器、以及声明启动服务器的异步。

定义controller

我们定义一下controller的代码,这里的思路和其他后端框架实现差不多。

用属性宏指定请求路径,获得接收的参数PostParam,然后传递这个param给对应的service处理,响应成功。

#[post("/")]
async fn pick_heroes(
    web::Json(param): web::Json<PostParam>,
    app_state: web::Data<AppState>,
) -> actix_web::Result<impl Responder> {
    let response_data = app_state.service.pick.pick_heroes(param).await?;
    Ok(web::Json(response_data))
}

定义model

这是我们前端需要用到的MyResult结构体,包含多个字端,包括整数、字符串、时间结构体、数组Vec包裹的日志结构体;属性宏赋予了调试和序列化的特性。

#[derive(Debug, Serialize)]
pub struct MyResult {
    pub team_id: i32,
    pub data: String,
    pub time: NaiveDateTime,
    pub logs: Vec<Log>,
}

定义service

下面是service的核心代码片段,定义PickServicetrait特征和PickServiceImpl结构体,然后先给PickServiceImpl结构体加一个返回自身的关联函数。然后实现PickService这个定义好的trait。

#[async_trait]宏在这里帮助我们在trait里支持异步函数;: Sync + Send意为有两个约束,SyncSend是两个并发特性(trait),能确保类型在多线程环境中的安全使用;Arc是一个用于线程安全的指针,可以用来在多线程环境中分享数据;<dyn HeroRepository>表示实现了这个trait。

#[async_trait]
pub trait PickService: Sync + Send {
    async fn pick_heroes(&self, param: PostParam) -> Result<MyResult, actix_web::Error>;
}

pub struct PickServiceImpl {
    pub hero_repository: Arc<dyn HeroRepository>,
    pub team_repository: Arc<dyn TeamRepository>,
    pub log_repository: Arc<dyn LogRepository>,
}

impl PickServiceImpl {
    pub fn new(
        hero_repository: Arc<dyn HeroRepository>,
        team_repository: Arc<dyn TeamRepository>,
        log_repository: Arc<dyn LogRepository>,
    ) -> Self {
        PickServiceImpl { hero_repository, team_repository, log_repository }
    }
}

下面代码实现了方法pick_heroes,可以将team_repository查询到的team数据,放入MyResult结构体之中,之后又将teamresult的可变引用放入check_team_is_picked方法,进一步处理,处理之后的rusult则成功响应返回。方法返回Result<MyResult, sqlx::Error>类型,即成功时返回MyResult对象,失败则返回sqlx::Error

#[async_trait]
impl PickService for PickServiceImpl {
    async fn pick_heroes(&self, param: PostParam) -> Result<MyResult, actix_web::Error> {
        let mut team = self.team_repository.get_by_encrypt_code(param.encrypt_code).await
            .map_err(actix_web::error::ErrorInternalServerError)?;

        let mut result = MyResult {
            team_id: team.id,
            data: team.pick_content.clone(),
            time: current_time(),
            logs: self.log_repository.get_by_team_id(team.id).await
                .expect(GET_LOGS_FAILED_ERROR),
        };

        self.check_team_is_picked(&mut team, &mut result).await;
        Ok(result)
    }
}

定义repository

这是team相关的repo的一个函数,在sqlx这个包的使用习惯下,直接把sql写在代码里,返回我们想要查询的Team数据,如果报错,则返回sqlx::Error类型。

#[async_trait]
impl TeamRepository for TeamRepositoryImpl {
    async fn get_by_encrypt_code(&self, encrypt_code: String) -> Result<Team, sqlx::Error> {
        sqlx::query_as::<_, Team>("SELECT * FROM `team` WHERE `encrypt_code` = ?")
            .bind(encrypt_code)
            .fetch_one(&*self.pool)
            .await
    }
}

End

代码风格和项目依赖架构就到此为止了,以上举了一些代码的例子,展示Actix框架中的一些风格和功能,以及rust语言在开发项目中的特性。在学习rust的路上,老实说我遇到不小的挑战,很多语法和特性习惯跟之前掌握的语言语法差距不小,以及老生常谈地跟rust编译器斗智斗勇、debug的漫长经历。

作为StackOverflow调查中连续多年的最受欢迎语言,整体来说算是国外雷声大,国内雨点小。不过随着一些国内的大厂(如字节)入场,和一些市场和生态的兴起,或许Rust语言未来在国内兴盛也未可知(希望别像"风暴要火")。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,542评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,596评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,021评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,682评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,792评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,985评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,107评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,845评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,299评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,612评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,747评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,441评论 4 333
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,072评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,828评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,069评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,545评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,658评论 2 350

推荐阅读更多精彩内容