Rust 使用SeaORM

简介

SeaORM 是一个开源的、类型安全的 ORM 库，专为 Rust 语言设计。它提供了一种简洁的方式来与数据库交互，并支持多种数据库系统，如 MySQL、PostgreSQL 和 SQLite。通过使用 SeaORM，开发者可以更方便地进行数据查询、插入和更新等操作。

安装 SeaORM

在开始使用 SeaORM 之前，你需要将其添加到你的项目中。可以通过编辑 Cargo.toml 文件来完成这一步骤。首先确保你的项目是一个 Cargo 项目，然后在 [dependencies] 部分添加 SeaORM 及其相关依赖项：

[dependencies]
sea-orm = "0.10"
tokio = { version = "1", features = ["full"] }

这里我们选择了 sea-orm 的版本 0.10，同时为了异步操作的需求，引入了 tokio 异步运行时库。

创建实体模型

在使用 SeaORM 之前，需要定义实体模型。实体模型是描述数据库表结构的数据结构。通常，这些模型会映射到数据库中的表，并且可以包含字段和关联关系。

定义实体

假设我们有一个 User 表，它有 id, username, email 字段。我们可以这样定义实体模型：

// www.javascriptcn.com code example
use sea_orm::entity::prelude::*;

#[derive(Clone, Debug, PartialEq, DeriveEntityModel)]
#[sea_orm(table_name = "user")]
pub struct Model {
    #[sea_orm(primary_key)]
    pub id: i32,
    pub username: String,
    pub email: String,
}

#[derive(Copy, Clone, Debug, EnumIter, DeriveRelation)]
pub struct Relation;

impl ActiveModelBehavior for ActiveModel {}

在这个例子中，Entity 代表了数据库中的一个表，而 Model 则表示表中的每一行数据。#[sea_orm(table_name = "user")] 指定了对应的数据库表名。

定义关联

如果我们的应用程序中有用户和帖子之间的关系，那么可以定义如下：

// www.javascriptcn.com code example
use sea_orm::entity::prelude::*;

#[derive(Clone, Debug, PartialEq, DeriveEntityModel)]
#[sea_orm(table_name = "post")]
pub struct Model {
    #[sea_orm(primary_key)]
    pub id: i32,
    pub user_id: i32,
    pub content: String,
}

#[derive(Copy, Clone, Debug, EnumIter, DeriveRelation)]
pub enum Relation {
    #[sea_orm(has_many = "super::comment::Entity")]
    Comment,
    #[sea_orm(belongs_to = "super::user::Entity", from = "Column::UserId", to = "super::user::Column::Id")]
    User,
}

impl Related<super::comment::Entity> for Entity {
    fn to() -> RelationDef {
        Relation::Comment.def()
    }
}

impl Related<super::user::Entity> for Entity {
    fn to() -> RelationDef {
        Relation::User.def()
    }
}

这里的 Relation 定义了 Post 实体与 Comment 和 User 实体的关系。

执行数据库操作

一旦有了实体模型，就可以开始执行基本的 CRUD（创建、读取、更新、删除）操作了。

创建记录

// www.javascriptcn.com code example
use sea_orm::{entity::*, query::*, DatabaseConnection};
use tokio;

#[tokio::main]
async fn main() -> Result<(), DbErr> {
    let db: DatabaseConnection = /* 连接数据库 */;
    
    let new_user = user::ActiveModel {
        username: Set("test_user".to_owned()),
        email: Set("test@example.com".to_owned()),
        ..Default::default()
    };

    let created_user = new_user.insert(&db).await?;

    println!("Created user: {:?}", created_user);

    Ok(())
}

查询记录

// www.javascriptcn.com code example
use sea_orm::{entity::*, query::*, DatabaseConnection};
use tokio;

#[tokio::main]
async fn main() -> Result<(), DbErr> {
    let db: DatabaseConnection = /* 连接数据库 */;

    let users = user::Entity::find().all(&db).await?;

    println!("All users: {:?}", users);

    Ok(())
}

更新记录

// www.javascriptcn.com code example
use sea_orm::{entity::*, query::*, DatabaseConnection};
use tokio;

#[tokio::main]
async fn main() -> Result<(), DbErr> {
    let db: DatabaseConnection = /* 连接数据库 */;

    let mut user = user::Entity::find_by_id(1).one(&db).await?.unwrap();

    // 更新用户名
    user.username = Set("new_username".to_owned());

    let updated_user = user.update(&db).await?;

    println!("Updated user: {:?}", updated_user);

    Ok(())
}

删除记录

// www.javascriptcn.com code example
use sea_orm::{entity::*, query::*, DatabaseConnection};
use tokio;

#[tokio::main]
async fn main() -> Result<(), DbErr> {
    let db: DatabaseConnection = /* 连接数据库 */;

    let user = user::Entity::find_by_id(1).one(&db).await?.unwrap();

    user.delete(&db).await?;

    Ok(())
}

以上就是使用 Rust 和 SeaORM 进行基本数据库操作的简要介绍。通过这些基础步骤，你可以构建出更复杂的应用程序逻辑。希望这篇教程对你有所帮助！