[开源] .NET数据库ORM类库 Insql

介绍

新年之际，给大家介绍个我自己开发的orm类库insql。ta是一个轻量级的.net orm类库 . 对象映射基于dapper , sql配置灵感来自于mybatis。简单优雅性能是ta的追求。

|

闲聊

以下可跳过 : )

• 自己为什么会开发insql?

1. 最初的自己一样是从写最基本的sql代码来访问数据库
   进而我们发现查询出的数据与保存的数据通常都是实体对象，而还需要跨不同类型数据库的需要。
2. 这时orm就成为了我们的工具。在使用orm和linq的出现让我迫切希望找到一款好用的支持linq的orm框架。这个过程中使用了微软的entityframework，还有各种同僚自己开发的orm，有很多不错的作品。自己也用了很多。当然在这里面我的评判标准就是性能优先，无需中间缓存层。操作能以最直接的方式直达数据库。在linq的支持上当然也需要丰富些。
3. 我以为这就是我的归宿，可是linq只能解决不同类型数据库的共性问题，有些orm很难做到充分利用各个数据库的特性，例如独特的类型和独特的方法。当然不要告诉我自己遇到那种问题时再写原生sql.我尽可能希望我使用工具时简单统一，不要有负担存在。
4. 直到我开发java项目时，遇到了mybatis。可以说真的很好用。它以xml配置sql的方式，自己可以*灵活的写语句，当然数据库的独有方法特性都能使用。但是在dotnet core上我没有找到类似好用的组件。于是就有了insql。

• 如何设计insql?
  整体功能架构就以下两块

1. 语句解析
   首先先加载xxx.insql.xml配置，加载方式支持扩展，目前实现以程序集嵌入式文件方式加载。
   解析各种配置节点元素，最终生成可直接执行的sql语句和sql参数。
2. 对象映射
   在保存和查询时都需要实体对象的参与，这里对象映射就提供类这个功能。目前也有很多对象映射类库，我们这里直接使用dapper。*就不重复造了。

正题

安装

package	nuget install
insql	install-package insql
insql.mysql	install-package insql.mysql
insql.oracle	install-package insql.oracle
insql.postgresql	install-package insql.postgresql
insql.sqlite	install-package insql.sqlite

如何使用

add insql

public void configureservices(iservicecollection services)
{
    services.addinsql();

    services.addinsqldbcontext<userdbcontext>(options =>
    {
        options.usesqlite(this.configuration.getconnectionstring("sqlite"));
    });
}

create dbcontext

public class userdbcontext : insql.dbcontext  
{
    public userdbcontext(insql.dbcontextoptions<userdbcontext> options) 
        : base(options)
    {
    }

    public ienumerable<userinfo> getuserlist(string username)
    {
        //sqlid = "getuserlist"
        //sqlparam is plainobject or idictionary<string,object>
        return this.query<userinfo>(nameof(getuserlist), new { username, usergender = gender.w });
    }

    public void insertuser(userinfo info)
    {
        var userid = this.executescalar<int>(nameof(insertuser),info);

        info.userid = userid;
    }

    public void updateuserselective(userinfo info)
    {
        this.execute(nameof(updateuserselective), info);
    }
}

//user model
public class userinfo
{
    public int userid { get; set; }

    public string username { get; set; }

    public gender? usergender { get; set; }
}

public enum gender
{
    m,
    w
}

create dbcontext.insql.xml

创建 userdbcontext.insql.xml 文件并且修改这个文件的属性为嵌入式文件类型 . insql type 与 userdbcontext 类型对应.

<insql type="example.domain.contexts.userdbcontext,example.domain" >

  <sql id="selectusercolumns">
    select user_id as userid,user_name as username,user_gender as usergender from user_info
  </sql>

  <select id="getuserlist">
    <include refid="selectusercolumns" />
    <where>
      <if test="username != null">
        <bind name="likeusername" value="'%' + username + '%'" />
        user_name like @likeusername
      </if>
      <if test="usergender != null and usergender != 'm' ">
        and user_gender = @usergender
      </if>
    </where>
    order by  user_id
  </select>

  <insert id="insertuser">
    insert into user_info (user_name,user_gender) values (@username,@usergender);
    select last_insert_rowid() from user_info;
  </insert>
  <update id="updateuser">
    update user_info set user_name=@username,user_gender=@usergender where user_id = @userid
  </update>

  <update id="updateuserselective">
    update user_info
    <set>
      <if test="username != null">
        user_name=@username,
      </if>
      <if test="usergender != null">
        user_gender=@usergender
      </if>
    </set>
    where user_id = @userid
  </update>

</insql>

use dbcontext

public class valuescontroller : controllerbase
{
    private readonly userdbcontext userdbcontext;

    public valuescontroller(userdbcontext userdbcontext)
    {
        this.userdbcontext = userdbcontext;
    }

    [httpget]
    public actionresult<ienumerable<string>> get()
    {
        //可以这样简单的使用事务
        this.userdbcontext.dowithtransaction(() =>
        {
            this.userdbcontext.insertuser(new domain.userinfo
            {
                username = "lovew",
                usergender = domain.gender.m
            });

            this.userdbcontext.updateuserselective(new domain.userinfo
            {
                userid = 1,
                username = "lovewww",
            });
        });

        var list = this.userdbcontext.getuserlist("love");
    }
}

其他用法

create common dbcontext

public class sqlitedbcontext<t> : dbcontext where t : class
{
    public sqlitedbcontext(dbcontextoptions<sqlitedbcontext<t>> options) : base(options)
    {
    }

    protected override void onconfiguring(dbcontextoptions options)
    {
        var configuration = options.serviceprovider.getrequiredservice<iconfiguration>();

        //t type mapping to insql.xml type
        options.usesqlresolver<t>();

        options.usesqlite(configuration.getconnectionstring("sqlite"));
    }
}

create domain service

public interface iuserservice
{
    ienumerable<userinfo> getuserlist(string username,gender? usergender);
}

public class userservice : iuserservice
{
    private readonly dbcontext dbcontext;

    //t is userservice
    public userservice(sqlitedbcontext<userservice> dbcontext)
    {
        this.dbcontext = dbcontext;
    }

    public ienumerable<userinfo> getuserlist(string username, gender? usergender)
    {
        return this.dbcontext.query<userinfo>(nameof(getuserlist), new { username, usergender });
    }
}

create service.insql.xml

创建 userservice.insql.xml 文件并且修改这个文件的属性为嵌入式文件类型 . insql type 与 userservice 类型对应.

<insql type="example.domain.services.userservice,example.domain" >

  <sql id="selectusercolumns">
    select user_id as userid,user_name as username,user_gender as usergender from user_info
  </sql>

  <select id="getuserlist">
    <include refid="selectusercolumns" />
    <where>
      <if test="username != null">
        <bind name="likeusername" value="'%' + username + '%'" />
        user_name like @likeusername
      </if>
      <if test="usergender != null ">
        and user_gender = @usergender
      </if>
    </where>
    order by  user_id
  </select>

</insql>

add insql

public void configureservices(iservicecollection services)
{
    services.addinsql();

    services.addscoped(typeof(dbcontextoptions<>));
    services.addscoped(typeof(sqlitedbcontext<>));

    services.addscoped<iuserservice, userservice>();
}

use domain service

public class valuescontroller : controllerbase
{
    private readonly iuserservice userservice;

    public valuescontroller(iuserservice userservice)
    {
        this.userservice = userservice;
    }

    [httpget]
    public actionresult<ienumerable<string>> get()
    {
        var list = this.userservice.getuserlist("11", domain.gender.m);
    }
}

@谢谢大家支持！