算起来,从真正开始用Rust进行项目开发已经快一年了,对Rust也愈发青睐;在这过程中踩了很多坑,由于Rust的变态也不得不恶补了很多被废弃的知识;当然对计算机的理解也更深了,头发自然也越发稀疏了。

”圆“规正传

今天给大家分享一个自己的一个crate,因为近几年转Rust的小伙伴越来越多,很多都是从Java岗转的,他们转过来的第一件事就是疯狂的寻找一个好用的ORM框架,但是Rust中目前比较好用的相关数据库框架有dieselsqlx等,基本上都能满足日常的工作需求。为了方便更多小伙伴过渡Rust,就手撸了一个小框架,参考MyBatisPlus的相关API,相信只要用过该框架的小伙伴应该基本可以无缝过渡。目前已经过渡到0.2.0版本,基本上更新还是比较频繁,因为前期想法比较多,也没有一个固定的方向所以经常推翻重来。

这个crate叫做akita,翻译过来就是秋田犬的意思,也代表了呆萌可爱的意思。基本的实现思路就是通过Rust的过程宏来完成对数据库表结构的映射,然后封装了一些便捷的SQL组装的工具方法。目前项目暂时只支持MySQL,所使用的线程池为r2d2,即将计划支持ClickHouseSQLiteMSSQLORACLE等数据库。

直接开码

话不多说咱直接码,好不好用咱用一个试试。首先添加依赖,现在目前版本在0.2.4。

[dependencies]

# The core APIs, including the Table traits. Always
# required when using Akita. using #[derive(Table)]
# to make Akita work with structs defined in your crate.
akita = { version = "0.2.0"] }

首先我们定义一个结构体SystemUserAkita提供了三个trait,分别是FromAkitaToAkita还有Table,主要是用来解析结构体的字段结构以及生成基本的CRUD成员方法。另外提供了table注解用来标注数据库表名,fieldtable_id标注列名和主键,分别都有name属性,同时保留了MyBatisPlus中的exist属性。


#[derive(Debug, FromAkita, ToAkita, Table, Clone)]
#[table(name="t_system_user")]
struct SystemUser {
    #[field = "name"]
    id: Option<i32>,
    #[table_id]
    username: String,
    #[field(name="ages", exist = "false")]
    age: i32,
}

来来来,Akita中提供了两个公共的管理器,AkitaManagerAkitaEntityManager,前者主要封装了一些原始的SQL操作,后者则加入了比较完整的API,同时在结构体中也实现了这些API。我们以CRUD操作举例:


use akita::*;
use akita::prelude::*;

fn main() {
    let mut pool = Pool::new(AkitaConfig{ max_size: None, url: String::from("mysql://root:password@localhost:3306/akita"), log_level: None }).unwrap();
    let mut em = pool.entity_manager().expect("must be ok");
    let user = SystemUser { id: 1.into(), username: "fff".to_string(), age: 1 };

    // 新增
    match em.save(&user) {
        Ok(res) => { }
        Err(err) => { }
    }
    /// 结构体示例
    match user.insert(&mut em) {
        Ok(res) => { }
        Err(err) => { }
    }

    // 删除
    match em.remove_by_id::<SystemUser, String>("id".to_string()) {
        Ok(res) => { }
        Err(err) => { }
    }

    // 修改
    match em.update_by_id(&user, "id") {
        Ok(res) => { }
        Err(err) => { }
    }

    // 查询分页
    let mut wrapper = UpdateWrapper::new();
    wrapper.eq( "username", "ussd").eq("id", 1);
    match em.page::<SystemUser, UpdateWrapper>(1, 10,&mut wrapper) {
        Ok(res) => { }
        Err(err) => { }
    }
    // 查询单条
    match em.select_one::<SystemUser, UpdateWrapper>(&mut wrapper) {
        Ok(res) => { }
        Err(err) => { }
    }

    ...
}

看完是不是很感动,对于手写了大半年SQL的我,简直是个福音...另外性能方面的话还有很多我们正在优化,比如大数据量的分页以及相关慢SQL的拦截以及一些其他的优化。

计划

项目目前只有几个人进行维护,所以未来更新速度并不会很快,我们也会在生产上使用这个框架,逐步的去优化。未来我们计划做的事:

  • 支持ORACLEClickHouseSQLiteMSSQL多个feature
  • 强化注解,增加配置映射,支持更多自定义的注解
  • 支持更多数据结构,优化内部参数处理
  • 完善自动代码生成工具,减少重复工作

码完跑路(偷懒)

所以接下来就是你们的时间了,该抄的抄,该溜的溜了。(逃

03-05 23:37