天天看点
返回

一个开源的ORM框架——Light.Data介绍如何使用

目录

介绍

支持的数据库

如何使用

数据库配置

使用方法

对象映射

子表映射

基本操作

数据聚合

Join表查询

执行SQL

单元测试

性能测试

介绍

Light.Data 是一个基于dotnet standard 2.0的轻量级ORM框架  ，通过实体模型类  Attribute 或配置文件关联数据表。使用核心类  DataContext 在表上进行  CURD 操作。

PM> Install-Package Light.Data

支持的数据库

数据库 介绍
SqlServer的 需要安装  nuget 安装  Light.Data.Mssql 库，支持SqlServer 2008或以上版本
Mysql的 需要安装  nuget 安装  Light.Data.Mysql 库，支持Mysql5.5或以上版本
Postgre 需要安装  nuget 安装  Light.Data.Postgre 库，支持PostgreSQL9.3或以上版本
  • 文件：https://aquilahkj.github.io/Light.Data.Site/
  • Github：https://github.com/aquilahkj/Light.Data2

如何使用

数据库配置 

{
  "lightData": {
      "connections": [
          {
             "name": "mssql_db",
             "connectionString": "...",
             "providerName": "Light.Data.Mssql.MssqlProvider, Light.Data.Mssql"
          },
          {
             "name": "mysql_db",
             "connectionString": "...",
             "providerName": "Light.Data.Mysql.MysqlProvider, Light.Data.Mysql"
           }
       ]
    }
}

使用方法 

// direct use
DataContext context = new DataContext("mssql");

// create subclass
public class MyDataContext : DataContext
{
    public MyDataContext() : base("mssql")
    {

    }
}

// create subclass with options
public class MyDataContext : DataContext
{
    public MyDataContext(DataContextOptions<MyDataContext> options) : base(options)
    {

    }
}

// direct config connect string and params （IServiceCollection）
service.AddDataContext<MyDataContext>(builder => {
    builder.UseMssql(connectionString);
    builder.SetTimeout(2000);
    builder.SetVersion("11.0");
}, ServiceLifetime.Transient);

// use default configuration file to config （IServiceCollection）
service.AddDataContext<MyDataContext>(DataContextConfiguration.Global, config => {
       config.ConfigName = "mssql";
}, ServiceLifetime.Transient);

对象映射 

[DataTable("Te_User", IsEntityTable = true)]
public class TeUser
{
    /// <summary>
    /// Id
    /// </summary>
    /// <value></value>
    [DataField("Id", IsIdentity = true, IsPrimaryKey = true)]
    public int Id
    {
        get;
        set;
    }

    /// <summary>
    /// Account
    /// </summary>
    /// <value></value>
    [DataField("Account")]
    public string Account
    {
        get;
        set;
    }

    /// <summary>
    /// Telephone
    /// </summary>
    /// <value></value>
    [DataField("Telephone", IsNullable = true)]
    public string Telephone
    {
        get;
        set;
    }
    ....
}

子表映射

在派生类TeUserAndExtend中添加类型为TeUserExtend的公共属性Extend，并添加特性RelationFieldAttribute。在查询TeUserAndExtend中，还将检测关联的TeUserExtend 数据。并且还支持一对多。

[DataTable("Te_UserExtend", IsEntityTable = true)]
public class TeUserExtend
{
    [DataField("Id", IsIdentity = true, IsPrimaryKey = true)]
    public int Id
    {
        get;
        set;
    }

    [DataField("MainId")]
    public int MainId
    {
        get;
        set;
    }
    
    [DataField("Data", IsNullable = true)]
    public string Data
    {
        get;
        set;
    }
}

public class TeUserAndExtend : TeUser
{
    [RelationField("Id", "MainId")]
    public TeUserExtend Extend
    {
        get;
        set;
    }
}

基本操作

  • 基本CURD
  • 批量CUD
  • 支持事务处理
  • 支持数据字段默认值和自动时间戳
  • 支持数据字段读写控制
  • 查询结果指定类或匿名类输出
  • 查询结果直接插入数据表 
var context = new DataContext();
// query single data
var item = context.Query<TeUser>().Where(x => x.Id == 10).First();
// query collection datas
var list = context.Query<TeUser>().Where(x => x.Id > 10).ToList();
// create date
var user = new TeUser() {
  Account = "foo",
  Password = "bar"
};
context.Insert(user);
// update data
user.Password = "bar1";
context.Update(user);
// delete data
context.Delete(user);

数据聚合

  • 单列数据直接聚合
  • 多列数据分组聚合
  • 格式化分组字段
  • 聚合数据直接插入数据表 
// basic
var list = context.Query<TeUser> ()
         .Where (x => x.Id >= 5)
         .GroupBy (x => new LevelIdAgg () {
           LevelId = x.LevelId,
           Data = Function.Count ()
          })
         .ToList ();

// date format
var list = context.Query<TeUser> ()
         .GroupBy (x => new RegDateFormatAgg () {
           RegDateFormat = x.RegTime.ToString("yyyy-MM-dd"),
           Data = Function.Count ()
          })
         .ToList ();

Join表查询

  • 多表连接，支持内连接，左连接和右连接
  • 支持查询结果和聚合数据连接在一起
  • 连接查询结果指定类或匿名类输出
  • 连接查询结果直接插入数据表 
// inner join
var join = context.Query<TeUser> ()
                  .Join<TeUserExtend>((x,y) => x.Id == y.Id);

// aggregate data join entity table             
var join = context.Query<TeMainTable>()
                  .GroupBy(x => new {
                      MId = x.MId,
                      Count = Function.Count(),
                   })
                  .Join<TeSubTable>((x, y) => x.MId == y.Id);

执行SQL

  • 直接使用SQL和存储过程
  • 支持对象参数
  • 查询结果指定类或匿名类输出
  • 存储过程支持使用输出参数 
// basic parameter
var sql = "update Te_User set [email protected] where [email protected]";
var ps = new DataParameter[2];
ps[0] = new DataParameter("P1", 5);
ps[1] = new DataParameter("P2", "abc");
var executor = context.CreateSqlStringExecutor(sql, ps);
var ret = executor.ExecuteNonQuery();

// object parameter
var sql = "update Te_User set NickName={nickname} where Id={id}";
var executor = context.CreateSqlStringExecutor(sql, new { nickname = "abc", id = 5 });
var ret = executor.ExecuteNonQuery();

单元测试

该项目使用xUnit进行单元测试，测试代码地址：https：//github.com/aquilahkj/Light.Data2/tree/master/test

每个数据库有超过300组测试，包含1,000个案例，涵盖了大部分代码。

性能测试

目前只在同一台计算机上使用EF Core，为Linux做Docker Sql Server 2017做简单的CURD性能测试代码地址https://github.com/aquilahkj/OrmTest

1000次CUD和单个数据查询

共有5轮，每轮1000次CUD和1000次数据查询

EF测试结果

一个开源的ORM框架——Light.Data介绍如何使用

Light.Data测试结果

一个开源的ORM框架——Light.Data介绍如何使用

从比较来看，查询性能几乎相同，插入性能Light.Data略胜一筹，批量更新也略胜一筹。

本文仅作简要介绍，您可以参考文档和测试用例以了解具体的使用方法。

原文地址：https://www.codeproject.com/Articles/4649209/A-open-source-ORM-framework-Light-Data

CSharp.NET 架构及框架 Light.Data ORM框架 开源 .net
上一篇: django orm级联_Django系列文章：（一）使用ORM新增、更新和删除记录
下一篇: 文物里的二十四节气·清明

继续阅读