[2023.09.18]: Rust中类型转换在错误处理中的应用解析

2023-09-18 20:54:06

随着项目的进展,关于Rust的故事又翻开了新的一页,今天来到了服务器端的开发场景,发现错误处理中的错误类型转换有必要分享一下。
Rust抽象出来了Result<T,E>,T是返回值的类型,E是错误类型。只要函数的返回值的类型被定义为Resut<T,E>,那么作为开发人员就有责任来处理调用这个函数可能发生的错误。通过Result<T,E>,Rust其实给开发人员指明了一条错误处理的道路,使代码更加健壮。

场景

  1. 服务器端处理api请求的框架:Rocket
  2. 服务器端处理数据持久化的框架:tokio_postgres

在api请求的框架中,我把返回类型定义成了Result<T, rocket::response::status::Custom\<String>>,即错误类型是rocket::response::status::Custom\<String>
在tokio_postgres中,直接使用tokio_postgres::error::Error

即如果要处理错误,就必须将tokio_postgres::error::Error转换成rocket::response::status::Custom\<String>。那么我们从下面的原理开始,逐一领略Rust的错误处理方式,通过对比找到最合适的方式吧。

原理

对错误的处理,Rust有3种可选的方式

  1. 使用match
  2. 使用if let
  3. 使用map_err

下面我结合场景,逐一演示各种方式是如何处理错误的。
下面的代码中涉及到2个模块(文件)。/src/routes/notes.rs是路由层,负责将api请求导向合适的service。/src/services/note_books.rs是service层,负责业务逻辑和数据持久化的处理。这里的逻辑也很简单,就是route层调用service层,将数据写入到数据库中。

使用match

src/routes/notes.rs

#[post("/api/notes", format = "application/json", data = "<note>")]
pub async fn post_notes(note: Json<Note>) -> Result<(), rocket::response::status::Custom<String>> {
    insert_or_update_note(&note.into_inner()).await
}

/src/services/note_book.rs

pub async fn insert_or_update_note(
    note: &Note,
) -> Result<(), rocket::response::status::Custom<String>> {
    let (client, connection) = match connect(
        "host=localhost dbname=notes_db user=postgres port=5432",
        NoTls,
    )
    .await
    {
        Ok(res) => res,
        Err(err) => {
            return Err(rocket::response::status::Custom(
                rocket::http::Status::ExpectationFailed,
                format!("{}", err),
            ));
        }
    };

    ...

    match client
        .execute(
            "insert into notes (id, title, content) values($1, $2, $3);",
            &[&get_system_seconds(), &note.title, &note.content],
        )
        .await
    {
        Ok(res) => Ok(()),
        Err(err) => Err(rocket::response::status::Custom(
            rocket::http::Status::ExpectationFailed,
            format!("{}", err),
        )),
    }
}

通过上面的代码我们可以读出一下内容:

  1. 在service层定义了route层相同的错误类型
  2. 在service层将持久层的错误转换成了route层的错误类型
  3. 使用match的代码量还是比较大

使用if let

/src/services/note_book.rs

pub async fn insert_or_update_note(
    note: &Note,
) -> Result<(), rocket::response::status::Custom<String>> {
    if let Ok((client, connection)) = connect(
        "host=localhost dbname=notes_db user=postgres port=5432",
        NoTls,
    )
    .await
    {
        ...

        if let Ok(res) = client
            .execute(
                "insert into notes (id, title, content) values($1, $2, $3);",
                &[&get_system_seconds(), &note.title, &note.content],
            )
            .await
        {
            Ok(())
        } else {
            Err(rocket::response::status::Custom(
                rocket::http::Status::ExpectationFailed,
                format!("{}", "unknown error"),
            ))
        }
    } else {
        Err(rocket::response::status::Custom(
            rocket::http::Status::ExpectationFailed,
            format!("{}", "unknown error"),
        ))
    }
}

src/routes/notes.rs

#[post("/api/notes", format = "application/json", data = "<note>")]
pub async fn post_notes(note: Json<Note>) -> Result<(), rocket::response::status::Custom<String>> {
    insert_or_update_note(&note.into_inner()).await
}

使用了if let ...,代码更加的别扭,并且在else分支中,拿不到具体的错误信息。

其实,不难看出,我们的目标是将api的请求,经过route层和service层,将数据写入到数据中。但这其中的错误处理代码的干扰就特别大,甚至要有逻辑嵌套现象。这种代码的已经离初衷比较远了,是否有更加简洁的方式,使代码能够最大限度的还原逻辑本身,把错误处理的噪音降到最低呢?
答案肯定是有的。那就是map_err

map_err

map_err是Result上的一个方法,专门用于错误的转换。下面的代码经过了map_err的改写,看上去是不是清爽了不少啊。
/src/services/note_book.rs

pub async fn insert_or_update_note(
    note: &Note,
) -> Result<(), rocket::response::status::Custom<String>> {
    let (client, connection) = connect(
        "host=localhost dbname=notes_db user=postgres port=5432",
        NoTls,
    )
    .await
    .map_err(|err| {
        rocket::response::status::Custom(
            rocket::http::Status::ExpectationFailed,
            format!("{}", err),
        )
    })?;

    ...

    let _ = client
        .execute(
            "insert into notes (id, title, content) values($1, $2, $3);",
            &[&get_system_seconds(), &note.title, &note.content],
        )
        .await
        .map_err(|err| {
            rocket::response::status::Custom(
                rocket::http::Status::ExpectationFailed,
                format!("{}", err),
            )
        })?;
    Ok(())
}

src/routes/notes.rs

#[post("/api/notes", format = "application/json", data = "<note>")]
pub async fn post_notes(note: Json<Note>) -> Result<(), rocket::response::status::Custom<String>> {
    insert_or_update_note(&note.into_inner()).await
}

经过map_err改写后的代码,代码的逻辑流程基本上还原了逻辑本身,但是map_err要额外占4行代码,且错误对象的初始化代码存在重复。在实际的工程项目中,service层的处理函数可能是成百上千,如果再乘以4,那多出来的代码量也不少啊,这会给后期的维护带来不小的压力。

那是否还有改进的空间呢?答案是Yes。
Rust为我们提供了From<T> trait,用于类型转换。它定义了从一种类型T到另一种类型Self的转换方法。我觉得这是Rust语言设计亮点之一。
但是,Rust有一个显示,即实现From<T> trait的结构,必须有一个在当前的crate中,也就是说我们不能直接通过From<T>来实现从tokio_postgres::error::Errorrocket::response::status::Custom<String>。也就是说下面的代码编译器会报错。

impl From<tokio_postgres::Error> for rocket::response::status::Custom<String> {}

报错如下:

32 | impl From<tokio_postgres::Error> for rocket::response::status::Custom<String> {}
   | ^^^^^---------------------------^^^^^----------------------------------------
   | |    |                               |
   | |    |                               `rocket::response::status::Custom` is not defined in the current crate
   | |    `tokio_postgres::Error` is not defined in the current crate
   | impl doesn't use only types from inside the current crate

因此,我们要定义一个类型MyError作为中间类型来转换一下。
/src/models.rs

pub struct MyError {
    pub message: String,
}
impl From<tokio_postgres::Error> for MyError {
    fn from(err: Error) -> Self {
        Self {
            message: format!("{}", err),
        }
    }
}
impl From<MyError> for rocket::response::status::Custom<String> {
    fn from(val: MyError) -> Self {
        status::Custom(Status::ExpectationFailed, val.message)
    }
}

/src/services/note_book.rs

pub async fn insert_or_update_note(
    note: &Note,
) -> Result<(), rocket::response::status::Custom<String>> {
    let (client, connection) = connect(
        "host=localhost dbname=notes_db user=postgres port=5432",
        NoTls,
    )
    .await
    .map_err(MyError::from)?;

    ...

    let _ = client
        .execute(
            "insert into notes (id, title, content) values($1, $2, $3);",
            &[&get_system_seconds(), &note.title, &note.content],
        )
        .await
        .map_err(MyError::from)?;
    Ok(())
}

src/routes/notes.rs

#[post("/api/notes", format = "application/json", data = "<note>")]
pub async fn post_notes(note: Json<Note>) -> Result<(), rocket::response::status::Custom<String>> {
    insert_or_update_note(&note.into_inner()).await
}

MyErrorrocket::response::status::Custom<String>之间的转换是隐式的,由编译器来完成。因此我们的错误类型的转换最终缩短为map_err(|err|MyError::from(err)),再简写为map_err(MyError::from)

关于错误处理中的类型转换应用解析就到这里。通过分析这个过程,我们可以看到,在设计模块时,我们应该确定一种错误类型,就像tokio_postgres库一样,只暴露了tokio_postgress::error::Error一种错误类型。这种设计既方便我们在设计模块时处理错误转换,也方便其我们的模块在被调用时,其它代码进行错误处理。

更多推荐

华清 Qt day5 9月21

QT+=coreguisqlnetwork/*****************************************************************/#ifndefWIDGET_H#defineWIDGET_H#include<QWidget>#include<QWidget>#include

为何学linux及用处

目前企业使用的操作系统无非就是国产类的,windows和linux类。我们要提升自己的技能,需要学习这两款。我记得在大学时期,学习过windows以及linux,但当时觉得又不常用,就学的模棱两可。毕业之后,你会发现,其实这两种操作系统是很主流的。为什么学?下面就是一些工作中遇到的例子分享一下。我记得在企业中有次遇到数

【python第7课 实例,类】

文章目录一、实例1.1实例的变量1.2实例方法1.3构造方法1.4析构函数1.4预置实例属性:二,类1.1类变量1.2类方法1.3静态方法1.4类属性的增删改查一、实例1.1实例的变量使用示例classdog:def__init__(self,k,c,a):self.kinds=kself.color=cself.ag

【Hash表】两数之和-力扣 1 题

💝💝💝欢迎来到我的博客,很高兴能够在这里和您见面!希望您在这里可以感受到一份轻松愉快的氛围,不仅可以获得有趣的内容和知识,也可以畅所欲言、分享您的想法和见解。推荐:kuan的首页,持续学习,不断总结,共同进步,活到老学到老导航檀越剑指大厂系列:全面总结java核心技术点,如集合,jvm,并发编程redis,kaf

Docker笔记

安装卸载旧版本以及相关的依赖项sudoyumremovedocker\docker-client\docker-client-latest\docker-common\docker-latest\docker-latest-logrotate\docker-logrotate\docker-engine安装所需的软件包

leetcode分类刷题:二叉树(一、简单的层序遍历)

二叉树的深度优先遍历题目是让我有点晕,先把简单的层序遍历总结下吧:配合队列进行的层序遍历在逻辑思维上自然直观,不容易出错102.二叉树的层序遍历本题是二叉树的层序遍历模板:每次循环将一层节点出队,再将一层节点入队,也是所有可用层序遍历解二叉树题目的模板,只需要在模板里稍加改动即可解题fromtypingimportLi

Docker学习大纲

Docker是一个用于自动部署应用程序在轻量级容器中的平台。下面列出一些Docker的基础和必知概念。1.容器(Containers)容器是独立的应用程序运行环境。命令:dockerrunhello-world解析:该命令会从DockerHub下载一个叫做“hello-world”的镜像,并运行一个容器。2.镜像(Im

模型分类model

模型可以按照多个维度进行分类,以下是常见的几种模型分类方式:(1)根据应用领域分类:数学模型:基于数学原理和方程式来描述和解决问题,如微积分模型、线性代数模型等。物理模型:基于物理原理和规律来模拟和解释现象,如力学模型、电路模型等。经济模型:用于研究和预测经济系统的行为和变化,如供求模型、消费者行为模型等。生物模型:用

token登录的实现

token登录的实现我这种token只是简单的实现token,就是后端利用UUID生成简单随机码,利用随机码作为在Redis中的键,然后存储的用户信息作为值,在每次合理请求的时候对token的有效时间进行刷新(利用拦截器),以确保用户信息的有效性。为什么要用token使用令牌(Token)进行身份验证和授权是一种常见的

Python vs C#:首先学习哪种编程语言最好?

进入编码可能很困难。最艰难的部分?决定先学什么语言。当谈到Python与C#时,可能很难知道在您的决定中要考虑哪些因素。我们为您提供了有关这些全明星编程语言的所有信息。什么是C#?自2000年作为MicrosoftVisualStudio的一部分开发C#以来,它一直是开发人员(包括新编码人员)的最爱。它标志着技术的一个

JAVA设计模式6:代理模式,用于控制对目标对象的访问

作者主页:Designer小郑作者简介:3年JAVA全栈开发经验,专注JAVA技术、系统定制、远程指导,致力于企业数字化转型,CSDN博客专家,阿里云社区专家博主,蓝桥云课讲师。目录一、什么是代理模式二、代理模式实例2.1静态代理2.2动态代理三、代理模式的应用场景四、代理模式面试题一、什么是代理模式代理模式是一种常用

热文推荐