Insql 是一个轻量级的.NET ORM类库 . 对象映射基于Dapper , Sql配置灵感来自于Mybatis。简单优雅是TA的追求。
github | gitee
闲聊以下可跳过 : )
自己为什么会开发Insql?
最初的自己一样是从写最基本的Sql代码来访问数据库
进而我们发现查询出的数据与保存的数据通常都是实体对象，而还需要跨不同类型数据库的需要。
这时ORM就成为了我们的工具。在使用ORM和Linq的出现让我迫切希望找到一款好用的支持Linq的ORM框架。这个过程中使用了微软的EntityFramework，还有各种同僚自己开发的ORM，有很多不错的作品。自己也用了很多。当然在这里面我的评判标准就是性能有限，无需中间缓存层。操作能以最直接的方式直达数据库。在Linq的支持上当然也需要丰富些。
我以为这就是我的归宿，可是Linq只能解决不同类型数据库的共性问题，有些ORM很难做到充分利用各个数据库的特性，例如独特的类型和独特的方法。当然不要告诉我自己遇到那种问题时再写原生SQL.我尽可能希望我使用工具时简单统一，不要有负担存在。
直到我开发Java项目时，遇到了Mybatis。可以说真的很好用。它以XML配置SQL的方式，自己可以自由灵活的写语句，当然数据库的独有方法特性都能使用。但是在dotnet core上我没有找到类似好用的组件。于是就有了Insql。
如何设计Insql?
整体功能架构就以下两块
语句解析
首先先加载xxx.insql.xml配置，加载方式支持扩展，目前实现以程序集嵌入式文件方式加载。
解析各种配置节点元素，最终生成可直接执行的sql语句和sql参数。
对象映射
在保存和查询时都需要实体对象的参与，这里对象映射就提供类这个功能。目前也有很多对象映射类库，我们这里直接使用Dapper。轮子就不重复造了。
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> select user_id as UserId,user_name as UserName,user_gender as UserGender from user_info </sql> <select> <include refid="selectUserColumns" /> <where> <if test="userName != null"> <bind 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> insert into user_info (user_name,user_gender) values (@UserName,@UserGender); select last_insert_rowid() from user_info; </insert> <update> update user_info set user_name=@UserName,user_gender=@UserGender where user_id = @userId </update> <update> 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"); } } 其他用法