genies

Genies (神灯) 框架的主入口 crate，提供所有子 crate 的统一 re-export 和便捷宏，用于 Rust 中的 DDD + Dapr 开发。

概述

genies 是整合所有 Genies 框架组件的中心枢纽 crate，开发者只需添加一个依赖即可访问整个框架。它还提供了数据库事务、对象复制、Dapr 网关配置等常用操作的实用宏。

核心特性

• 统一 Re-export：通过单一导入访问所有子 crate（core、config、context、cache、dapr、ddd、k8s）
• 多数据库支持：通过 feature flags 支持 MySQL、PostgreSQL、SQLite、MSSQL、Oracle、TDengine（透传至 genies_context）
• 数据库宏：RBatis 连接池和事务管理的便捷宏
• 对象复制：基于 JSON 的不同结构体类型间字段复制
• Dapr 集成：服务间通信的网关 URL 配置
• Topic 收集：重新导出的 Dapr topic 订阅路由函数

架构设计

依赖关系图

genies (主入口)
  ├── genies_core      # 核心工具（JWT、错误处理、条件构建）
  ├── genies_config    # 配置管理
  ├── genies_context   # 应用上下文和认证
  ├── genies_cache     # Redis/内存缓存
  ├── genies_dapr      # Dapr 集成（PubSub、CloudEvent）
  ├── genies_ddd       # DDD 原语（聚合根、领域事件）
  └── genies_k8s       # Kubernetes 工具

Re-export 模块

快速开始

1. 添加依赖

cargo add genies genies_derive

也可以手动在 Cargo.toml 中添加依赖，请前往 crates.io 查看最新版本。

2. 访问子模块

use genies::core;       // JWT、错误处理
use genies::config;     // 配置管理
use genies::context::CONTEXT;  // 全局应用上下文
use genies::cache;      // 缓存服务
use genies::dapr;       // Dapr 集成
use genies::ddd;        // DDD 原语

3. 数据库 Feature Flags

genies 将数据库 feature flags 透传至 genies_context：

切换数据库：

# 使用 PostgreSQL 代替默认的 MySQL

[dependencies]

genies = { version = "1.5", default-features = false, features = ["postgres"] }

宏参考

pool!() - 获取数据库连接

从全局上下文返回克隆的 RBatis 连接。

use genies::pool;

async fn query_users() -> Result<Vec<User>, Error> {
    let users = User::select_all(pool!()).await?;
    Ok(users)
}

tx_defer!() - 带自动回滚守卫的事务

创建一个事务，如果未显式提交则自动回滚。

use genies::tx_defer;

async fn transfer_funds(from: u64, to: u64, amount: f64) -> Result<(), Error> {
    let mut tx = tx_defer!();
    
    // 从源账户扣款
    Account::deduct(&mut tx, from, amount).await?;
    
    // 向目标账户入账
    Account::credit(&mut tx, to, amount).await?;
    
    // 提交事务（未调用则自动回滚）
    tx.commit().await?;
    Ok(())
}

使用自定义 RBatis 实例：

let custom_rb = get_custom_rbatis();
let mut tx = tx_defer!(custom_rb);
// ... 操作 ...
tx.commit().await?;

copy!() - 对象字段复制

通过 JSON 序列化将字段从一个结构体复制到另一个。适用于 DTO 转换。

use genies::copy;
use serde::{Deserialize, Serialize};

#[derive(Serialize, Deserialize)]
struct UserEntity {
    id: u64,
    name: String,
    email: String,
    password_hash: String,
}

#[derive(Serialize, Deserialize)]
struct UserDto {
    id: u64,
    name: String,
    email: String,
}

let entity = UserEntity { /* ... */ };
let dto: UserDto = copy!(&entity, UserDto);

config_gateway!() - Dapr/Gateway URL 配置

配置服务调用的网关 URL，支持 Dapr sidecar 和直接 HTTP 网关两种模式。

use genies::config_gateway;

// 定义服务网关
static PATIENT_SERVICE: Lazy<String> = config_gateway!("/patient");

// 在 HTTP 客户端中使用
let url = format!("{}/api/patients/{}", *PATIENT_SERVICE, patient_id);

行为说明：

• 如果 gateway 配置包含 http:// 或 https://，使用直接网关 URL
• 否则，使用 Dapr 服务调用 URL：http://localhost:3500/v1.0/invoke{service}/method

Dapr Topic 函数

从 genies_dapr 重新导出，方便使用：

use genies::{
    collect_topic_routers,      // 收集所有 topic 处理路由
    collect_topic_subscriptions, // 收集所有 topic 订阅
    dapr_subscribe_handler,      // Dapr 订阅端点处理器
    dapr_event_router,           // 事件路由处理器
};

// 在 main.rs 中
let topic_routers = collect_topic_routers();
let subscriptions = collect_topic_subscriptions();

集成示例

use genies::context::CONTEXT;
use genies::{pool, tx_defer, copy};
use genies_derive::{Aggregate, DomainEvent};

#[derive(Aggregate)]
#[aggregate_type("Order")]
#[id_field(id)]
struct Order {
    id: String,
    status: String,
    items: Vec<OrderItem>,
}

async fn create_order(cmd: CreateOrderCommand) -> Result<Order, Error> {
    // 初始化上下文（根据 database_url 自动选择驱动）
    CONTEXT.init_database().await;
    
    // 使用带自动回滚的事务
    let mut tx = tx_defer!();
    
    let order = Order {
        id: generate_id(),
        status: "CREATED".to_string(),
        items: cmd.items,
    };
    
    Order::insert(&mut tx, &order).await?;
    tx.commit().await?;
    
    Ok(order)
}

依赖项

• rbatis - 数据库操作 ORM 框架
• serde / serde_json - copy!() 宏的序列化支持
• once_cell - config_gateway!() 的延迟静态初始化
• log - 事务守卫中的日志记录

相关 Crate

• genies_derive - 过程宏（#[derive(Aggregate)]、#[topic] 等）
• genies_auth - 基于 Casbin 的权限管理
• genies_context - 应用上下文和全局状态

许可证

MIT/Apache-2.0