TORM.SqlServer 2.0.16

<p align="center"> <img src="logo.svg" width = "400" height = "200" alt="TORM Logo"/> </p>

<h1 align="center">TORM - 高性能 .NET ORM 框架</h1>

<div align="center">

轻量级、高性能、功能丰富的对象关系映射框架

ThingsGateway 生态系统中的 ORM 组件，专为高性能场景设计。

</div>

中文

📖 项目简介

TORM 是一个为 .NET 平台设计的轻量级、高性能 ORM（对象关系映射）框架。它提供了简洁流畅的 API，支持多种数据库，并针对高性能场景进行了深度优化。

✨ 核心特性

🚀 高性能设计

• AOT：支持AOT编译
• 表达式树解析：高效的 LINQ 表达式到 SQL 转换
• 批量操作优化：支持 BulkCopy 高性能批量插入/更新

🗄️ 多数据库支持

💡 丰富的功能

基础 CRUD 操作

高级功能

• 🔹 Code First：自动创建/更新数据库表结构
• 🔹 分表分库：支持时间分表、数量分表策略
• 🔹 批量操作：BulkCopy 高性能批量导入
• 🔹 事务管理：支持同步/异步事务
• 🔹 AOP 拦截：SQL 执行前后拦截，日志记录
• 🔹 JSON 支持：原生 JSON 类型支持

📊 性能测试

TORM 与国内主流 ORM 框架 的Sqlite性能对比测试结果：

BenchmarkDotNet v0.15.8, Windows 11 (10.0.26200.8037/25H2/2025Update/HudsonValley2)
Intel Core Ultra 9 285H 2.90GHz, 1 CPU, 16 logical and 16 physical cores
.NET SDK 10.0.103
  [Host]    : .NET 10.0.3 (10.0.3, 10.0.326.7603), X64 RyuJIT x86-64-v3
  .NET 10.0 : .NET 10.0.3 (10.0.3, 10.0.326.7603), X64 RyuJIT x86-64-v3

Job=.NET 10.0  Runtime=.NET 10.0  

可以看出，TORM无论是速度还是内存占用都表现优异，得益于TORM是一个没有任何历史包袱的项目，其高性能设计和批量操作优化，在大数据量场景下表现尤为突出。

注：实际性能因数据库类型、数据量、硬件配置等因素会有所不同。建议在实际项目环境中进行测试。

运行性能测试

cd benchmark/TORM.Benchmark
dotnet run -c Release

🚀 快速开始

安装 NuGet 包

dotnet add package TORM

基础配置

using TORM;

// 创建 ORM 客户端
using var ormClient = new OrmClient(new OrmConnectionConfig
{
    DatabaseType = OrmDbType.MySql,
    ConnectionString = "Server=localhost;Database=test;Uid=root;Pwd=password;"
});

定义实体

[OrmTable(TableName = "users")]
public class User
{
    [OrmColumn(IsPrimaryKey = true, IsIdentity = true)]
    public long Id { get; set; }
    
    [OrmColumn(ColumnName = "user_name", Length = 50)]
    public string Name { get; set; }
    
    public int Age { get; set; }
    
    public DateTime CreateTime { get; set; }
}

Code First 自动建表

// 自动创建表结构
await ormClient.CodeFirst.InitTableAsync<User>();

📚 功能详解

查询操作

// 基础查询
var list = await ormClient.Queryable<User>().ToListAsync();

// 条件查询
var adults = await ormClient.Queryable<User>()
    .Where(u => u.Age >= 18)
    .ToListAsync();

// 分页查询（返回 PagedList<T>，包含总数）
var page = await ormClient.Queryable<User>()
    .Where(u => u.IsActive)
    .OrderByDescending(u => u.CreateTime)
    .ToPageListAsync(pageNumber: 1, pageSize: 20);

// 聚合查询
var count = await ormClient.Queryable<User>().CountAsync();
var exists = await ormClient.Queryable<User>().AnyAsync();

// 投影查询
var names = await ormClient.Queryable<User>()
    .Select(u => new { u.Id, u.Name })
    .ToListAsync();

// 流式查询（大数据量场景）
await foreach (var user in ormClient.Queryable<User>().ToAsyncEnumerable())
{
    // 逐行处理
}

批量操作

// 批量插入（高性能）
await ormClient.InsertableRange(users).ExecuteAsync();

// BulkCopy 批量导入（最高性能）
await ormClient.BulkCopy<User>().BulkInsertAsync(users);

// 批量更新
await ormClient.BulkCopy<User>().BulkUpdateAsync(users);

// 批量保存（自动判断插入/更新）
await ormClient.BulkCopy<User>().BulkMergeAsync(users);

分表操作

定义分表实体：

// 按月分表：表名后缀格式 _yyyyMM
[OrmTable(TableName = "logs", SplitType = SplitTableType.Month, SplitColumn = nameof(CreateTime))]
public class Log
{
    [OrmColumn(IsPrimaryKey = true, IsIdentity = true)]
    public long Id { get; set; }
    
    public string Message { get; set; }
    
    // 分表依据列（必须为 DateTime 类型）
    public DateTime CreateTime { get; set; }
}

// 按记录数分表：每 10000 条自动创建新表
[OrmTable(TableName = "sensor_data", MaxRowCount = 10000)]
public class SensorData
{
    [OrmColumn(IsPrimaryKey = true, IsIdentity = true)]
    public long Id { get; set; }
    
    public double Value { get; set; }
}

// 混合策略：按月分表 + 每月内按记录数分表
[OrmTable(TableName = "events", 
    SplitType = SplitTableType.Month, 
    SplitColumn = nameof(EventTime),
    MaxRowCount = 50000)]
public class Event
{
    [OrmColumn(IsPrimaryKey = true, IsIdentity = true)]
    public long Id { get; set; }
    
    public DateTime EventTime { get; set; }
}

分表操作示例：

// 分表查询（自动跨所有分表查询，可指定时间范围）
var list = await ormClient.SplitQueryableAsync<Log>(
    query => query.Where(l => l.Message.Contains("error")),
    startTime: DateTime.Now.AddDays(-30),
    endTime: DateTime.Now
);

// 分表插入（自动路由到正确的分表）
await ormClient.SplitInsertableAsync(logs);

// 分表更新
await ormClient.SplitUpdateableAsync(logs, update => update.Set(l => l.Message, "updated"));

// 分表删除
await ormClient.SplitDeleteableAsync(logs);

分表类型说明：

事务管理

await db.UseTranAsync(async () =>
{
    await db.InsertableRange(addModels).ExecuteAsync().ConfigureAwait(false);
}).ConfigureAwait(false);

AOP 日志拦截

// SQL执行前日志
ormClient.Aop.OnLogExecuting = (sql, parameters) =>
{
    Console.WriteLine($"执行SQL: {sql}");
};

// SQL执行后日志
ormClient.Aop.OnLogExecuted = (sql, parameters, elapsed) =>
{
    Console.WriteLine($"SQL执行耗时: {elapsed.TotalMilliseconds}ms");
};

// 插入/更新前修改值
ormClient.Aop.OnDataExecuting = (args) =>
{
    if (args.DataExecutingType == DataExecutingType.Insert)
    {
        // 自动填充创建时间
        if (args.Entity is BaseEntity entity)
        {
            entity.CreateTime = DateTime.Now;
        }
    }
};

🏗️ 项目结构

TORM/
├── src/TORM/                    # 核心库
│   ├── Ado/                     # ADO.NET 基础设施
│   ├── Aop/                     # AOP 拦截器
│   ├── Attributes/              # 实体特性
│   ├── BulkCopy/                # 批量操作
│   ├── Client/                  # ORM 客户端
│   ├── CodeFirst/               # Code First
│   ├── Queryable/               # 查询提供器
│   ├── Insertable/              # 插入提供器
│   ├── Updateable/              # 更新提供器
│   ├── Deletable/               # 删除提供器
│   ├── Saveable/                # 保存提供器
│   ├── SplitTable/              # 分表支持
│   ├── Sql/                     # SQL 构建
│   └── TaosData/                # TDengine 支持
│       ├── Driver/              # TDengine 驱动
│       └── TMQ/                 # TMQ 消息队列
├── benchmark/TORM.Benchmark/    # 性能测试
└── test/TORM.Test/              # 单元测试

📄 开源协议

本项目基于 Apache 2.0 协议开源。