Error message here!

Hide Error message here!

忘记密码?

Error message here!

请输入正确邮箱

Hide Error message here!

密码丢失?请输入您的电子邮件地址。您将收到一个重设密码链接。

Error message here!

返回登录

Close

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

rainrcn 2019-02-03 13:13:00 阅读数:127 评论数:0 点赞数:0 收藏数:0

介绍

新年之际,给大家介绍个我自己开发的ORM类库Insql。TA是一个轻量级的.NET ORM类库 . 对象映射基于Dapper , Sql配置灵感来自于Mybatis。简单优雅性能是TA的追求。

站点首页:https://rainrcn.github.io/insql

闲聊

以下可跳过

  • 自己为什么会开发Insql?
  1. 最初的自己一样是从写最基本的Sql代码来访问数据库
    进而我们发现查询出的数据与保存的数据通常都是实体对象,而还需要跨不同类型数据库的需要。
  2. 这时ORM就成为了我们的工具。在使用ORM和Linq的出现让我迫切希望找到一款好用的支持Linq的ORM框架。这个过程中使用了微软的EntityFramework,还有各种同僚自己开发的ORM,有很多不错的作品。自己也用了很多。当然在这里面我的评判标准就是性能优先,无需中间缓存层。操作能以最直接的方式直达数据库。在Linq的支持上当然也需要丰富些。
  3. 我以为这就是我的归宿,可是Linq只能解决不同类型数据库的共性问题,有些ORM很难做到充分利用各个数据库的特性,例如独特的类型和独特的方法,并且将Linq转为Sql的支持能力也各个类库不相同。当然不要告诉我自己遇到那种问题时再写原生SQL.我尽可能希望我使用工具时简单统一,不要有负担存在。
  4. 直到我开发Java项目时,遇到了Mybatis。可以说真的很好用。它以XML配置SQL的方式,自己可以自由灵活的写语句,当然数据库的独有方法特性都能使用。但是在dotnet core上我没有找到类似好用的组件。于是就有了Insql。
  • 如何设计Insql?
    整体功能架构就以下两块
  1. 语句解析
    首先先加载xxx.insql.xml配置,加载方式支持扩展,目前实现以程序集嵌入式文件方式加载。
    解析各种配置节点元素,最终生成可直接执行的sql语句和sql参数。
  2. 对象映射
    在保存和查询时都需要实体对象的参与,这里对象映射就提供类这个功能。目前也有很多对象映射类库,我们这里直接使用Dapper。轮子就不重复造了。

正题

安装

Package Nuget Stable Downloads
Insql Insql Insql
Insql.MySql Insql.MySql Insql.MySql
Insql.Oracle Insql.Oracle Insql.Oracle
Insql.PostgreSql Insql.PostgreSql Insql.PostgreSql
Insql.Sqlite Insql.Sqlite Insql.Sqlite

功能

  • 支持 DoNet Core 2.0+ && DotNet Framework 4.6.1+
  • 支持依赖注入系统
  • MyBatis sql xml 语法
  • 多数据库支持
  • 灵活扩展性
  • 使用简单直观

精简用法

只将Insql用作加载和解析Sql语句来使用。

注入ISqlResolver

在Domain Service中使用语句解析器,将ISqlResolver<T>注入到UserService中,其中T类型我们指定为UserService类型

public class UserService : IUserService
{
private readonly ISqlResolver<UserService> sqlResolver;
public UserService(ISqlResolver<UserService> sqlResolver)
{
this.sqlResolver = sqlResolver;
}
public void DeleteUser(int userId)
{
var resolveResult = this.sqlResolver.Resolve("DeleteUser", new { userId });
//如果需要指定数据库(匹配SqlId后缀为.SqlServer),则需要设置DbType的参数
//var resolveResult = this.sqlResolver.Resolve("SqlServer", "DeleteUser", new { userId });
//connection.Execute(resolveResult.Sql,resolveResult.Param) ...
}
}

创建UserService.insql.xml

创建UserService.insql.xml,用作Sql语句配置,insql type 指定为ISqlResolver<T>T类型

<insql type="Insql.Tests.Domain.Services.UserService,Insql.Tests" >
<delete id="DeleteUser">
delete from user_info where user_id = @userId
</delete>
</insql>

添加 Insql

public void ConfigureServices(IServiceCollection services)
{
services.AddInsql();
services.AddScoped<IUserService, UserService>();
}

基本用法

基本用法可以通过创建DbContext来使用

添加 Insql

public void ConfigureServices(IServiceCollection services)
{
services.AddInsql();
services.AddInsqlDbContext<UserDbContext>(options =>
{
//options.UseSqlServer(this.Configuration.GetConnectionString("sqlserver"));
options.UseSqlite(this.Configuration.GetConnectionString("sqlite"));
});
}

创建 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
}

创建 DbContext.insql.xml

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

<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="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>

使用 DbContext

使用 UserDbContext 在Domain Service中或者Web Controller中

public class ValuesController : ControllerBase
{
private readonly UserDbContext userDbContext;
public ValuesController(UserDbContext userDbContext)
{
this.userDbContext = userDbContext;
}
[HttpGet]
public ActionResult<IEnumerable<string>> Get()
{
//可以这样使用事务
this.userDbContext.DoWithTransaction(() =>
{
var userInfo = new Domain.UserInfo
{
UserName = "loveW",
UserGender = Domain.Gender.M
};
this.userDbContext.InsertUser(userInfo);
this.userDbContext.UpdateUserSelective(new Domain.UserInfo
{
UserId = userInfo.UserId,
UserName = "loveWWW",
});
});
var list = this.userDbContext.GetUserList("love");
//todo return
}
}

也可以只创建一个公用的DbContext,而不需要创建多个DbContext类型来使用

多数据库支持功能

多数据库支持为默认启用,使用时非常简单。

xxx.insql.xml中如果当前使用的是SqlServer数据库,则会优先使用InsertUser.SqlServer,如果未找到后缀是.SqlServer的配置节,则使用默认的InsertUser

<insert id="InsertUser">
insert into user_info (user_name,user_gender) values (@UserName,@UserGender);
select last_insert_rowid() from user_info;
</insert>
<insert id="InsertUser.SqlServer">
insert into user_info (user_name,user_gender) values (@UserName,@UserGender);
select SCOPE_IDENTITY();
</insert>

其他功能可以看详细文档。

当前源码托管在 Github,或者国内的 码云

@谢谢大家支持!!

版权声明
本文为[rainrcn]所创,转载请带上原文链接,感谢
https://www.cnblogs.com/rainrcn/p/10350163.html

编程之旅,人生之路,不止于编程,还有诗和远方。
阅代码原理,看框架知识,学企业实践;
赏诗词,读日记,踏人生之路,观世界之行;

支付宝红包,每日可领