【从零开始的rust web开发之路 三】orm框架sea-orm入门使用教程

2024-02-01 05:36
文章标签 rust 使用 入门 教程 开发 web 框架 从零开始 orm sea

本文主要是介绍【从零开始的rust web开发之路 三】orm框架sea-orm入门使用教程，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

【从零开始的rust web开发之路 三】orm框架sea-orm入门使用教程

文章目录

  • 前言
  • 一、引入依赖
  • 二、创建数据库连接
    • 简单链接
    • 连接选项
    • 开启日志调试
  • 三、生成实体
    • 安装sea-orm-cli
    • 创建数据库表
    • 使用sea-orm-cli命令生成实体文件代码
  • 四、增删改查实现
    • 新增数据
    • 主键查找
    • 条件查找
      • 查找用户名是admin的一条用户
      • 查找地址是郑州的所有用户
      • 查找地址是郑州并且用户名包含admin的所有用户
      • 分页查找
    • 修改数据
    • 删除数据
    • 数据库事务操作
  • 总结

前言

前两篇文件主要降了axum相关使用，这篇文章来讲讲orm相关框架。目前rust orm相关框架不多，比较主流的是sqlx，本文介绍的框架实在此基础上封装的一层，sql-orm同样也支持rust异步。

一、引入依赖

sea-orm = { version = "0.12", features = [ <DATABASE_DRIVER>, <ASYNC_RUNTIME>, "macros" ] }  #DATABASE_DRIVER和ASYNC_RUNTIME参数需要替换

DATABASE_DRIVER参数

  • sqlx-mysql-SQLx的MySQL
  • sqlx-postgres-SQLx
  • PostgreSQL的 sqlx-sqlite

ASYNC_RUNTIME参数

  • runtime-async-std-native-tls
  • runtime-tokio-native-tls
  • runtime-async-std-rustls
  • runtime-tokio-rustls
    这里我们选择引入tokio异步支持的，还要引入tokio
[dependencies]
sea-orm = { version = "0.12", features = [ "sqlx-mysql", "runtime-tokio-native-tls", "macros" ] }
tokio = { version = "1.35.1", features = ["full"] }

二、创建数据库连接

简单链接

let db: DatabaseConnection = Database::connect("protocol://username:password@host/database").await?;

举例子mysql数据库连接

   let db: DatabaseConnection = Database::connect("mysql://root:root@127.0.0.1:3307/test").await.unwrap();

后续查询选相关操作每次调用DatabaseConnection ，都会从池中获取和释放连接。
连接别的数据库可以看官方文档https://www.sea-ql.org/SeaORM/docs/next/install-and-config/connection/

连接选项

若要配置连接，请使用 ConnectOptions 接口

let mut opt = ConnectOptions::new("mysql://root:root@127.0.0.1:3307/test");
opt.max_connections(100).min_connections(5).connect_timeout(Duration::from_secs(8)).acquire_timeout(Duration::from_secs(8)).idle_timeout(Duration::from_secs(8)).max_lifetime(Duration::from_secs(8)).sqlx_logging(true).sqlx_logging_level(log::LevelFilter::Info).set_schema_search_path("my_schema"); // Setting default PostgreSQL schemalet db = Database::connect(opt).await?;

可以看ConnectOptions接口文档https://docs.rs/sea-orm/0.12.12/sea_orm/struct.ConnectOptions.html

开启日志调试

开发阶段需要打印相关日志，可以开启调试模式
features当中多一个[“debug-print”]

[dependencies]
sea-orm = { version = "0.12", features = [ "sqlx-mysql", "runtime-tokio-native-tls", "macros" ,"debug-print","with-chrono"] }
tokio = { version = "1.35.1", features = ["full"] }
chrono = "0.4.33"
tracing = "0.1.40"
tracing-subscriber = { version = "0.3.18",features = ["env-filter","time","local-time", ]}

然后需要执行一段初始化tracing-subscriber代码

    // 设置全局日志级别为 infolet env_filter = EnvFilter::try_from_default_env().unwrap_or_else(|_| EnvFilter::new("info"))//单独设置sea_orm.add_directive("sea_orm::driver=debug".parse().unwrap())//关闭sqlx自带的日志.add_directive("sqlx::query=off".parse().unwrap());

三、生成实体

安装sea-orm-cli

运行命令

cargo install sea-orm-cli

创建数据库表

CREATE TABLE `user` (`id` int NOT NULL AUTO_INCREMENT,`username` varchar(32) NOT NULL COMMENT '用户名称',`birthday` datetime DEFAULT NULL COMMENT '生日',`sex` char(1) DEFAULT NULL COMMENT '性别',`address` varchar(256) DEFAULT NULL COMMENT '地址',PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=49 DEFAULT CHARSET=utf8mb3

使用sea-orm-cli命令生成实体文件代码

在项目文件夹下运行命令，-o 是输出文件目录。相关参数配置可看文档https://www.sea-ql.org/SeaORM/docs/next/generate-entity/sea-orm-cli/

sea-orm-cli generate entity -u mysql://root:root@127.0.0.1:3307/test -o src/entity

在这里插入图片描述
在main文件加入entity模块即可。
生成的文件内容
在这里插入图片描述

在这里插入图片描述
指定表名

#[sea_orm(table_name = "cake", schema_name = "public")]
pub struct Model { ... }

指定列名

#[sea_orm(column_name = "name")]
pub name: String

四、增删改查实现

新增数据

先了解ActiveValue和ActiveModel

use entity::user::ActiveModel as UserModel;
let user: UserModel =  UserModel{id: ActiveValue::NotSet,username: ActiveValue::Set("你好".to_owned()),birthday: ActiveValue::Set(Some(Local::now().naive_local())),sex: ActiveValue::Set(Some("1".to_owned())),address: ActiveValue::Set(Some("address".to_owned())),};

这里我们创建UserModel的ActiveModel模型，里面的值是ActiveValue类型，NotSet是不设置值。
创建ActiveModel方法还有别的，比如通过JSON字符，具体的可以看文档https://www.sea-ql.org/SeaORM/docs/next/basic-crud/insert/#convert-activemodel-back-to-model
然后执行插入方法，具体代码如下

use chrono::{ Local};
use sea_orm::{ActiveModelTrait, ActiveValue, Database, DatabaseConnection, IntoActiveModel};pub mod entity;
use entity::user::Entity as UserDao;
use entity::user::ActiveModel as UserModel;
use entity::user::Model as Model;
#[tokio::main]
async fn main(){let db: DatabaseConnection = Database::connect("mysql://root:root@127.0.0.1:3307/test").await.unwrap();let user: UserModel =  UserModel{id: ActiveValue::NotSet,username: ActiveValue::Set("你好".to_owned()),birthday: ActiveValue::Set(Some(Local::now().naive_local())),sex: ActiveValue::Set(Some("1".to_owned())),address: ActiveValue::Set(Some("address".to_owned())),};
/*    let user: Model = Model{id: 1,username: "admin".to_string(),birthday: Some(Local::now().naive_local()),sex: Some("1".to_owned()),address: Some("address".to_owned()),};let active_model = user.into_active_model();*/let result = user.insert(&db).await.unwrap();println!("插入成功！：{:?}",result);
}

多个插入可以调用上述代码UserDao中的insert_many方法，传入ActiveModel数组

主键查找

use entity::user::Entity as UserDao;let option = UserDao::find_by_id(1).one(&db).await.unwrap();match option {None => {}Some(user) => println!("查询成功！：{:?}",user)}

条件查找

查找用户名是admin的一条用户

use crate::entity::user;use entity::user::Entity as UserDao;let result = UserDao::find().filter(user::Column::Username.eq("admin")).one(&db).await.unwrap();match result {None => {}Some(user) => println!("查询成功！：{:?}",user)}

查找地址是郑州的所有用户

    use crate::entity::user;use entity::user::Entity as UserDao;let result = UserDao::find().filter(user::Column::Address.eq("郑州")).all(&db).await.unwrap();println!("查询成功！：{:?}",result)

查找地址是郑州并且用户名包含admin的所有用户

    use crate::entity::user;use entity::user::Entity as UserDao;let result = UserDao::find().filter(Condition::all().add(user::Column::Address.eq("郑州")).add(user::Column::Username.like("%admin%"))).all(&db).await.unwrap();println!("查询成功！：{:?}",result)

分页查找

 
use crate::entity::user;use entity::user::Entity as UserDao;let mut paginator = UserDao::find().filter(Condition::all().add(user::Column::Address.eq("郑州")).add(user::Column::Username.like("%admin%"))).paginate(&db,50);//paginate(&db,50)此处第二个参数表示设置单页数量，此方法会返回Paginator对象。while let Some(user) = paginator.fetch_and_next().await.unwrap() {//循环从paginate取数据，每次取50条，页数加一，直到没有数据println!("查询成功！：{:?}",user)}

如果直接获取第几页数据怎么做，下面有方法

    use crate::entity::user;use entity::user::Entity as UserDao;let mut paginator = UserDao::find().filter(Condition::all().add(user::Column::Address.eq("郑州")).add(user::Column::Username.like("%admin%"))).paginate(&db,50);//此方法可直接取具体页数，注意是从零开始，需要前端页数加一let result = paginator.fetch_page(0).await;match result{Ok(vec_user) => {println!("{:?}", vec_user)}Err(_) => {}}

修改数据

修改主键为1的用用户名

    use entity::user::Entity as UserDao;let user = UserDao::find_by_id(1).one(&db).await.unwrap().unwrap();let mut active_model = user.into_active_model();active_model.username = ActiveValue::Set("修改后的用户名".to_owned());active_model.update(&db).await.unwrap();

如果想强制更新某个字段可以调用。

active_model.reset(user::Column::Address); //这样更新时字段就会强制带上，可以实现把字段置空

删除数据

很简单

    use entity::user::Entity as UserDao;let res = UserDao::delete_by_id(1).exec(&db).await.unwrap();

或者还有一种方法

    use entity::user::Entity as UserDao;let res = UserDao::find_by_id(1).one(&db).await.unwrap().unwrap();let active_model = res.into_active_model();active_model.delete(&db).await.unwrap();

数据库事务操作

可以手动调用db的begin和commit方法，以下是官方例子

let txn = db.begin().await?;bakery::ActiveModel {name: Set("SeaSide Bakery".to_owned()),profit_margin: Set(10.4),..Default::default()
}
.save(&txn)
.await?;bakery::ActiveModel {name: Set("Top Bakery".to_owned()),profit_margin: Set(15.0),..Default::default()
}
.save(&txn)
.await?;txn.commit().await?;

总结

以上就是sea-orm入门使用教程，更具体的可以查看sea-orm官方文档https://www.sea-ql.org/SeaORM/docs/index/。后续我可能会再出一篇sea-orm的高级使用教程

这篇关于【从零开始的rust web开发之路 三】orm框架sea-orm入门使用教程的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/666225。

相关文章

如何使用celery进行异步处理和定时任务(django)

如何使用celery进行异步处理和定时任务(django)

《如何使用celery进行异步处理和定时任务(django)》文章介绍了Celery的基本概念、安装方法、如何使用Celery进行异步任务处理以及如何设置定时任务,通过Celery,可以在Web应用中... 目录一、celery的作用二、安装celery三、使用celery 异步执行任务四、使用celery
阅读更多...
使用Python绘制蛇年春节祝福艺术图

使用Python绘制蛇年春节祝福艺术图

《使用Python绘制蛇年春节祝福艺术图》：本文主要介绍如何使用Python的Matplotlib库绘制一幅富有创意的“蛇年有福”艺术图,这幅图结合了数字,蛇形,花朵等装饰,需要的可以参考下... 目录1. 绘图的基本概念2. 准备工作3. 实现代码解析3.1 设置绘图画布3.2 绘制数字“2025”3.3
阅读更多...
Jsoncpp的安装与使用方式

Jsoncpp的安装与使用方式

《Jsoncpp的安装与使用方式》JsonCpp是一个用于解析和生成JSON数据的C++库,它支持解析JSON文件或字符串到C++对象,以及将C++对象序列化回JSON格式,安装JsonCpp可以通过... 目录安装jsoncppJsoncpp的使用Value类构造函数检测保存的数据类型提取数据对json数
阅读更多...
python使用watchdog实现文件资源监控

python使用watchdog实现文件资源监控

《python使用watchdog实现文件资源监控》watchdog支持跨平台文件资源监控,可以检测指定文件夹下文件及文件夹变动,下面我们来看看Python如何使用watchdog实现文件资源监控吧... python文件监控库watchdogs简介随着Python在各种应用领域中的广泛使用，其生态环境也
阅读更多...
Python中构建终端应用界面利器Blessed模块的使用

Python中构建终端应用界面利器Blessed模块的使用

《Python中构建终端应用界面利器Blessed模块的使用》Blessed库作为一个轻量级且功能强大的解决方案,开始在开发者中赢得口碑,今天,我们就一起来探索一下它是如何让终端UI开发变得轻松而高... 目录一、安装与配置：简单、快速、无障碍二、基本功能：从彩色文本到动态交互1. 显示基本内容2. 创建链
阅读更多...
基于Qt开发一个简单的OFD阅读器

基于Qt开发一个简单的OFD阅读器

《基于Qt开发一个简单的OFD阅读器》这篇文章主要为大家详细介绍了如何使用Qt框架开发一个功能强大且性能优异的OFD阅读器,文中的示例代码讲解详细,有需要的小伙伴可以参考一下... 目录摘要引言一、OFD文件格式解析二、文档结构解析三、页面渲染四、用户交互五、性能优化六、示例代码七、未来发展方向八、结论摘要
阅读更多...
springboot整合 xxl-job及使用步骤

springboot整合 xxl-job及使用步骤

《springboot整合xxl-job及使用步骤》XXL-JOB是一个分布式任务调度平台,用于解决分布式系统中的任务调度和管理问题,文章详细介绍了XXL-JOB的架构,包括调度中心、执行器和Web... 目录一、xxl-job是什么二、使用步骤1. 下载并运行管理端代码2. 访问管理页面，确认是否启动成功
阅读更多...
使用Nginx来共享文件的详细教程

使用Nginx来共享文件的详细教程

《使用Nginx来共享文件的详细教程》有时我们想共享电脑上的某些文件,一个比较方便的做法是,开一个HTTP服务,指向文件所在的目录,这次我们用nginx来实现这个需求,本文将通过代码示例一步步教你使用... 在本教程中，我们将向您展示如何使用开源 Web 服务器 Nginx 设置文件共享服务器步骤 0 —
阅读更多...
Java中switch-case结构的使用方法举例详解

Java中switch-case结构的使用方法举例详解

《Java中switch-case结构的使用方法举例详解》：本文主要介绍Java中switch-case结构使用的相关资料,switch-case结构是Java中处理多个分支条件的一种有效方式,它... 目录前言一、switch-case结构的基本语法二、使用示例三、注意事项四、总结前言对于Java初学者
阅读更多...
Golang使用minio替代文件系统的实战教程

Golang使用minio替代文件系统的实战教程

《Golang使用minio替代文件系统的实战教程》本文讨论项目开发中直接文件系统的限制或不足,接着介绍Minio对象存储的优势,同时给出Golang的实际示例代码,包括初始化客户端、读取minio对... 目录文件系统 vs Minio文件系统不足：对象存储：miniogolang连接Minio配置Min
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2