spring-sea-orm插件

spring-sea-orm是针对sea-orm的自动装配

依赖

spring-sea-orm = { version = "0.1.1", features = ["postgres"] }
sea-orm = { version = "1.0" }    # 主要为了适配sea-orm-cli生成的entity代码

可以替换postgres、mysql、sqlitefeature来选择合适的数据库驱动。

配置项

[sea-orm]
uri = "postgres://root:123456@localhost:5432/pg_db"  # 数据库地址
min_connections = 1                                  # 连接池的最小连接数，默认值为1
max_connections = 10                                 # 连接池的最大连接数，默认值为10
acquire_timeout = 30000                              # 占用连接超时时间，单位毫秒，默认30s
idle_timeout = 600000                                # 连接空闲时间，单位毫秒，默认10min
connect_timeout = 1800000                            # 连接的最大存活时间，单位毫秒，默认30min
enable_logging = true                                # 打印sql日志

组件

配置完上述配置项后，插件会自动注册一个DbConn连接池对象。该对象是sea_orm::DbConn的别名。

pub type DbConn = sea_orm::DbConn;

模型生成

sea-orm-cli提供了非常棒的模型代码生成的功能。你只需在数据库内定义好表结构，经过简单的配置就能生成与数据库结构对应的模型代码，这可以节省大量的代码编写工作。

提取插件注册的Component

SeaOrmPlugin插件为我们自动注册了一个连接池组件，我们可以使用Component从AppState中提取这个连接池，Component是一个axum的extractor。

use spring_sqlx::{sqlx::{self, Row}, ConnectPool};
use spring_web::get;
use spring_web::extractor::Component;
use spring_web::error::Result;
use anyhow::Context;

#[get("/:id")]
async fn get_todo_list(
    Component(db): Component<DbConn>,
    Path(id): Path<i32>
) -> Result<String> {
    let rows = TodoItem::find()
        .filter(todo_item::Column::ListId.eq(id))
        .all(&db)
        .await
        .context("query todo list failed")?;
    Ok(Json(rows))
}

翻页支持

spring-sea-orm为SeaOrm的Select扩展了PaginationExt特征。

另外还提供了web翻页参数的解析，只需在依赖中添加with-web功能即可。

spring-sea-orm = { version = "<version>", features = ["postgres", "with-web"] }

配置方式如下：

# sea-orm-web配置
[sea-orm-web]
one_indexed = false     # 基于1的索引，默认关闭
max_page_size = 2000    # 支持的最大页大小，避免服务器攻击出现OOM，默认值2000
default_page_size = 20  # 默认页大小，20

使用方式如下：

#[get("/")]
async fn get_todo_list(
    Component(db): Component<DbConn>,
    Query(query): Query<TodoListQuery>,
    pagination: Pagination,
) -> Result<impl IntoResponse> {
    let rows = TodoList::find()
        .filter(query)
        .page(&db, pagination)
        .await
        .context("query todo list failed")?;
    Ok(Json(rows))
}

完整代码参考sea-orm-example