DH.MySql.EntityFramework
4.20.2026.303
See the version list below for details.
dotnet add package DH.MySql.EntityFramework --version 4.20.2026.303
NuGet\Install-Package DH.MySql.EntityFramework -Version 4.20.2026.303
<PackageReference Include="DH.MySql.EntityFramework" Version="4.20.2026.303" />
<PackageVersion Include="DH.MySql.EntityFramework" Version="4.20.2026.303" />
<PackageReference Include="DH.MySql.EntityFramework" />
paket add DH.MySql.EntityFramework --version 4.20.2026.303
#r "nuget: DH.MySql.EntityFramework, 4.20.2026.303"
#:package DH.MySql.EntityFramework@4.20.2026.303
#addin nuget:?package=DH.MySql.EntityFramework&version=4.20.2026.303
#tool nuget:?package=DH.MySql.EntityFramework&version=4.20.2026.303
DH.MySql — 纯国产高性能 MySQL 驱动
DH.MySql 是新生命团队出品的纯国产 MySQL 客户端驱动,基于 ADO.NET 标准接口,直接通过 TCP 实现 MySQL 协议层(Protocol Version 10)。仅依赖 DH.NCore,零第三方依赖、全链路真异步、MIT 协议商用无忧。
独创的管道化批量执行(Pipeline)在万级行批量写入场景下领先竞品 2×~3×,是大数据批量操作、信创国产化替代的理想选择。
设计目标
| 目标 | 说明 |
|---|---|
| 轻量极简 | 只做 ADO.NET 标准的增删改查、事务、参数化查询、存储过程和批量操作 |
| 高性能 | 零额外内存分配(ArrayPool / OwnerPacket)、真异步 IO、管道化批量执行 |
| 纯国产 | 核心代码完全自主可控,无 GPL 许可风险,适合信创环境 |
| 大数据友好 | 字典参数集 / 数组绑定 / 管道化 / 多行 VALUES / DbBatch,覆盖万级到百万级行 |
| 广泛兼容 | net45 ~ net10 全版本,MySQL 5.x ~ 9.0+,兼容 OceanBase / TiDB |
核心功能
| 功能 | 说明 |
|---|---|
| 连接管理 | MySQL 5.x / 8.0 / 9.0+,mysql_native_password + caching_sha2_password 双认证 |
| 查询执行 | ExecuteReader / ExecuteScalar / ExecuteNonQuery,完整 ADO.NET 接口 |
| 参数化查询 | 客户端参数替换,@参数名 语法,自动转义防注入 |
| 预编译语句 | Prepare() 走 COM_STMT_PREPARE 二进制协议,可选 UseServerPrepare 全局开关 |
| 批量操作 | ExecuteBatch / ExecuteArrayBatch / 管道化 / 多行 VALUES / DbBatch |
| 管道化执行 | Pipeline=true 批量发送后批量接收,网络延迟仅一次,万级行性能提升 3~10× |
| 事务支持 | BeginTransaction / Commit / Rollback,四种隔离级别,自动回滚 |
| 存储过程 | CommandType.StoredProcedure,支持 IN/OUT 参数 |
| SSL/TLS | SslMode=Preferred/Required,支持 TLS 1.2/1.3 |
| 连接池 | 默认开启,按连接字符串分池,自动健康检查与回收 |
| 异步方法 | 全链路 async/await,OpenAsync / ExecuteReaderAsync / ReadAsync 等 |
| Schema 查询 | Tables / Columns / Indexes / Databases 等元数据 |
| DbBatch | .NET 6+ ADO.NET 标准批量 API |
| EF Core | 通过 DH.MySql.EntityFrameworkCore 独立包支持 |
| XCode 集成 | 通过 MySqlClientFactory 自动注册,无缝对接 XCode ORM |
亮点特性
🚀 管道化批量执行(Pipeline)
独创的管道化模式,基于 COM_STMT_PREPARE + COM_STMT_EXECUTE 二进制协议:
- Phase 1:批量构建并发送所有 EXECUTE 包,仅最后一个包 Flush
- Phase 2:按顺序批量读取所有 OK/Error 响应,累加影响行数
- TCP 协议栈合并小包(Nagle 算法),网络往返仅一次
实测数据(.NET 10 + MySQL 8.0.26 本机,管道化+事务 vs 逐行基线):
| 场景 | 逐行基线 | 管道化+事务 | 加速比 |
|---|---|---|---|
| 1,000 行 INSERT | 437ms | 54ms | 8.1× |
| 10,000 行 INSERT | 3,150ms | 680ms | 4.6× |
| 10,000 行 UPDATE | 3,469ms | 757ms | 4.6× |
| 10,000 行 DELETE | 3,351ms | 673ms | 5.0× |
三驱动对比(10,000 行批量操作):
| 操作 | Pipeline(tx) | MySql.Data Batch(tx) | MySqlConnector Batch(tx) | 加速比 |
|---|---|---|---|---|
| INSERT | 899ms | 1,927ms | 1,906ms | 2.1× |
| UPDATE | 710ms | 2,265ms | 2,041ms | 2.9× |
| DELETE | 661ms | 1,961ms | 1,767ms | 2.7× |
本机内网已有 4×~8× 加速,跨机房场景收益更大。详细数据参见 性能测试报告。
🔧 五种批量操作方案
| 方案 | API | 适用场景 |
|---|---|---|
| 字典参数集 | ExecuteBatch |
动态参数,参数来自集合 |
| 数组绑定 | ExecuteArrayBatch |
大批量 DML,Oracle 风格 |
| 管道化 | Pipeline=true |
万级/十万级行,跨机房 |
| 多行 VALUES | 拼接 SQL | 纯 INSERT 批量 |
| DbBatch (.NET 6+) | CreateBatch |
不同 SQL 混合批量 |
🛡️ 零第三方依赖
仅依赖 DH.NCore(同为 PeiKeSmart 团队出品),无 GPL 许可风险,MIT 协议商用无忧,适合信创环境和安全审计严格的场景。
⚡ 极致性能优化
ArrayPool<T>+OwnerPacket零额外分配Pool.StringBuilder/Pool.MemoryStream全面池化- 全链路
async/await,无sync-over-async反模式 - 精简协议解析,只解析必要字段
🌐 广泛兼容
- 框架:
net45/net461/netstandard2.0/netstandard2.1/net6.0/net10.0 - MySQL:5.5 ~ 9.0+,
mysql_native_password+caching_sha2_password - 兼容库:OceanBase、TiDB(自动检测)、MariaDB(基础)
- 条件编译:针对不同框架自动选择最优实现
与主流驱动对比
| 功能 | DH.MySql | MySqlConnector | MySql.Data (Oracle) |
|---|---|---|---|
| 许可协议 | MIT | MIT | GPL (商用付费) |
| 国产自主 | ✅ | ❌ | ❌ |
| 第三方依赖 | 无 | 无 | 无 |
| 真异步 IO | ✅ | ✅ | ❌ |
| 管道化批量执行 | ✅ 独创 | ❌ | ❌ |
| 数组绑定批量 | ✅ | ❌ | ❌ |
| 字典参数集批量 | ✅ | ❌ | ❌ |
| DbBatch (.NET 6+) | ✅ | ✅ | ❌ |
| DataAdapter | ✅ | ❌ | ✅ |
| EF Core | ✅ | ✅ (Pomelo) | ✅ |
| XCode ORM 集成 | ✅ | ❌ | ❌ |
| 多目标框架 | net45~net10 | netstandard2.0+ | net462+ |
| OceanBase / TiDB | ✅ 自动检测 | ❌ | ❌ |
完整对比和架构分析参见 架构设计。
安装
dotnet add package DH.MySql
<PackageReference Include="DH.MySql" Version="1.0.*" />
快速开始
连接字符串
Server=localhost;Port=3306;Database=mydb;User Id=root;Password=pass;
| 参数 | 别名 | 默认值 | 说明 |
|---|---|---|---|
| Server | DataSource, Data Source | - | 服务器地址 |
| Port | - | 3306 | 端口号 |
| Database | - | - | 数据库名 |
| UserID | Uid, User Id, User | - | 用户名 |
| Password | Pass, Pwd | - | 密码 |
| ConnectionTimeout | Connection Timeout | 15 | 连接超时(秒) |
| CommandTimeout | Default Command Timeout | 30 | 命令超时(秒) |
| SslMode | Ssl Mode | None | SSL 模式(None/Preferred/Required) |
| UseServerPrepare | Use Server Prepare | false | 全局服务端预编译开关 |
| Pipeline | Pipelining | false | 管道化执行开关 |
打开连接
using var conn = new MySqlConnection("Server=localhost;Database=mydb;User Id=root;Password=pass;");
conn.Open();
// using 结束时自动关闭并归还连接池
查询结果集
using var conn = new MySqlConnection(connStr);
conn.Open();
using var cmd = new MySqlCommand(conn, "SELECT id, name, age FROM users WHERE age > 18");
using var reader = cmd.ExecuteReader();
while (reader.Read())
{
var id = reader.GetInt64(0);
var name = reader.GetString(1);
var age = reader.GetInt64(2);
Console.WriteLine($"{id}: {name}, {age}");
}
查询单值
using var cmd = new MySqlCommand(conn, "SELECT COUNT(*) FROM users");
var count = cmd.ExecuteScalar();
执行 DML
using var cmd = new MySqlCommand(conn, "INSERT INTO users(name, age) VALUES('Tom', 25)");
var affectedRows = cmd.ExecuteNonQuery();
// 快捷方式
var rows = conn.ExecuteNonQuery("DELETE FROM logs WHERE created < '2024-01-01'");
参数化查询
使用 @参数名 语法绑定参数,自动转义防注入:
using var cmd = new MySqlCommand(conn, "SELECT * FROM users WHERE name = @name AND age > @age");
cmd.Parameters.AddWithValue("name", "Tom");
cmd.Parameters.AddWithValue("age", 18);
using var reader = cmd.ExecuteReader();
while (reader.Read())
{
Console.WriteLine(reader.GetString(0));
}
// 参数化插入
using var cmd = new MySqlCommand(conn, "INSERT INTO users(name, age, created) VALUES(@name, @age, @dt)");
cmd.Parameters.AddWithValue("name", "Alice");
cmd.Parameters.AddWithValue("age", 30);
cmd.Parameters.AddWithValue("dt", DateTime.Now);
cmd.ExecuteNonQuery();
// NULL 值传递
cmd.Parameters.AddWithValue("email", DBNull.Value);
支持的参数类型:
| .NET 类型 | SQL 字面量示例 |
|---|---|
String |
'hello'(自动转义特殊字符) |
Int32 / Int64 等数字 |
42 |
Boolean |
1 或 0 |
DateTime |
'2025-07-01 12:30:00' |
Byte[] |
X'CAFE' |
Guid |
'01234567-89ab-cdef-...' |
Enum |
转为数字 |
null / DBNull.Value |
NULL |
事务
using var conn = new MySqlConnection(connStr);
conn.Open();
using var tr = conn.BeginTransaction();
try
{
conn.ExecuteNonQuery("INSERT INTO orders(product, qty) VALUES('Widget', 10)");
conn.ExecuteNonQuery("UPDATE inventory SET qty = qty - 10 WHERE product = 'Widget'");
tr.Commit();
}
catch
{
tr.Rollback();
throw;
}
支持四种隔离级别:ReadUncommitted / ReadCommitted / RepeatableRead(默认)/ Serializable
using var tr = conn.BeginTransaction(IsolationLevel.ReadCommitted);
事务 Dispose 时如果未提交也未回滚,会自动执行回滚。
存储过程
using var cmd = new MySqlCommand { Connection = conn, CommandType = CommandType.StoredProcedure };
cmd.CommandText = "my_proc";
cmd.Parameters.AddWithValue("p_id", 1);
var outParam = new MySqlParameter { ParameterName = "p_result", Direction = ParameterDirection.Output };
cmd.Parameters.Add(outParam);
cmd.ExecuteNonQuery();
var result = outParam.Value; // 输出参数值
预编译语句
通过 Prepare() 在服务端预编译 SQL,后续执行走二进制协议:
using var cmd = new MySqlCommand(conn, "INSERT INTO users(name, age) VALUES(@name, @age)");
cmd.Parameters.AddWithValue("name", "Tom");
cmd.Parameters.AddWithValue("age", 25);
cmd.Prepare(); // 服务端预编译
cmd.ExecuteNonQuery(); // 第一次执行
// 修改参数后再次执行(无需重新编译)
cmd.Parameters[0].Value = "Jerry";
cmd.Parameters[1].Value = 30;
cmd.ExecuteNonQuery();
也可通过连接字符串全局启用,所有参数化查询自动走二进制协议:
UseServerPrepare=true;
批量操作
方案 A:字典参数集
同一 SQL 绑定多组参数执行,内部自动预编译:
using var cmd = new MySqlCommand(conn, "INSERT INTO users(name, age) VALUES(@name, @age)");
cmd.Parameters.AddWithValue("name", "");
cmd.Parameters.AddWithValue("age", 0);
var paramSets = new List<IDictionary<String, Object?>>
{
new Dictionary<String, Object?> { ["name"] = "Alice", ["age"] = 25 },
new Dictionary<String, Object?> { ["name"] = "Bob", ["age"] = 30 },
new Dictionary<String, Object?> { ["name"] = "Charlie", ["age"] = 22 },
};
var totalAffected = cmd.ExecuteBatch(paramSets);
// 或 await cmd.ExecuteBatchAsync(paramSets);
方案 B:数组绑定(Oracle 风格)
参数值设为数组,指定执行次数:
using var cmd = new MySqlCommand(conn, "INSERT INTO users(name, age) VALUES(@name, @age)");
cmd.Parameters.AddWithValue("name", new[] { "Alice", "Bob", "Charlie" });
cmd.Parameters.AddWithValue("age", new[] { 25, 30, 22 });
var totalAffected = cmd.ExecuteArrayBatch(3);
// 或 await cmd.ExecuteArrayBatchAsync(3);
方案 C:管道化执行
连接字符串开启 Pipeline=true,批量发送后批量接收,网络往返仅一次:
var connStr = "Server=localhost;Database=mydb;User Id=root;Password=pass;Pipeline=true;";
using var conn = new MySqlConnection(connStr);
conn.Open();
using var cmd = new MySqlCommand(conn, "UPDATE users SET age=@age WHERE name=@name");
cmd.Parameters.AddWithValue("age", agesArray); // Int32[10000]
cmd.Parameters.AddWithValue("name", namesArray); // String[10000]
var totalAffected = cmd.ExecuteArrayBatch(10000);
管道化对 INSERT / UPDATE / DELETE 均有效,搭配字典参数集或数组绑定使用。网络延迟越高(如跨机房),收益越大。
方案 D:多行 VALUES
var sql = "INSERT INTO users(name, age) VALUES('Alice', 25), ('Bob', 30), ('Charlie', 22)";
conn.ExecuteNonQuery(sql);
方案 E:DbBatch API(.NET 6+)
var batch = conn.CreateBatch();
batch.BatchCommands.Add(new MySqlBatchCommand("INSERT INTO users(name, age) VALUES('X1', 10)"));
batch.BatchCommands.Add(new MySqlBatchCommand("INSERT INTO users(name, age) VALUES('X2', 20)"));
batch.BatchCommands.Add(new MySqlBatchCommand("UPDATE users SET age = age + 1 WHERE name = 'X1'"));
using var reader = batch.ExecuteReader();
EF Core 支持
NewLife.MySql.EntityFrameworkCore 包提供 EF Core 数据库提供程序,支持 .NET 6 / .NET 8 / .NET 10。
dotnet add package NewLife.MySql.EntityFrameworkCore
public class AppDbContext : DbContext
{
public DbSet<User> Users { get; set; } = null!;
public AppDbContext(DbContextOptions<AppDbContext> options) : base(options) { }
protected override void OnModelCreating(ModelBuilder modelBuilder)
{
modelBuilder.Entity<User>(entity =>
{
entity.ToTable("users");
entity.HasKey(e => e.Id);
entity.Property(e => e.Name).HasMaxLength(100).IsRequired();
});
}
}
var options = new DbContextOptionsBuilder<AppDbContext>()
.UseMySql("Server=localhost;Database=mydb;User Id=root;Password=pass;")
.Options;
using var context = new AppDbContext(options);
已支持功能:
| 功能 | 说明 |
|---|---|
| 类型映射 | Int / Long / String / DateTime / Decimal / Guid / Boolean / Byte[] |
| 查询翻译 | LINQ → MySQL 语法(反引号、LIMIT/OFFSET) |
| 方法翻译 | Contains / StartsWith / EndsWith / ToUpper / ToLower / Trim / Replace / Substring / Length |
| 成员翻译 | DateTime.Year / Month / Day / Hour / Minute / Second |
| 迁移支持 | CreateTable / AlterColumn / AddColumn / DropColumn / RenameTable / CreateIndex / DropIndex |
| 值生成策略 | AUTO_INCREMENT 自增主键 |
SSL/TLS 加密连接
// 服务器支持则加密,不支持则明文
var connStr = "Server=localhost;Database=mydb;User Id=root;Password=pass;SslMode=Preferred;";
// 必须加密,不支持则抛异常
var connStr2 = "Server=localhost;Database=mydb;User Id=root;Password=pass;SslMode=Required;";
| SslMode | 行为 |
|---|---|
None / Disabled |
不使用 SSL(默认) |
Preferred |
优先加密,不支持则明文 |
Required |
强制加密 |
Schema 信息查询
var databases = conn.GetSchema("Databases"); // 数据库列表
var tables = conn.GetSchema("Tables"); // 表列表
var columns = conn.GetSchema("Columns"); // 列信息
var indexes = conn.GetSchema("Indexes"); // 索引信息
异步方法
所有核心操作均支持异步版本:
using var conn = new MySqlConnection(connStr);
await conn.OpenAsync();
using var cmd = new MySqlCommand(conn, "SELECT * FROM users");
using var reader = await cmd.ExecuteReaderAsync();
while (await reader.ReadAsync())
{
Console.WriteLine(reader.GetString(0));
}
连接池
连接池默认启用,无需额外配置。每个唯一连接字符串对应独立连接池。
- 打开连接时自动从池中获取
- 关闭连接时自动归还(不断开 TCP)
- 无效连接自动剔除
- 新连接按需创建
XCode ORM 集成
通过 MySqlClientFactory 自动注册为 XCode 的 MySQL 驱动:
using XCode.DataAccessLayer;
DAL.AddConnStr("mysql", "Server=localhost;Database=mydb;User Id=root;Password=pass;", null, "MySql");
var dal = DAL.Create("mysql");
var tables = dal.Tables;
切换数据库
ChangeDatabase(推荐)
using var conn = new MySqlConnection("Server=localhost;Database=db1;...");
conn.Open();
conn.ChangeDatabase("db2"); // 内部 Close + Reopen
⚠️ 不支持在事务中途切换(事务会丢失),推荐为每个数据库创建独立连接。
SqlClient.SetDatabaseAsync(低级 API)
await conn.Client.SetDatabaseAsync("information_schema"); // COM_INIT_DB
不关闭连接,仅切换服务端当前数据库,适合临时查询场景。
OceanBase / TiDB 支持
驱动根据握手包版本字符串自动检测数据库类型,连接方式与 MySQL 完全相同:
// OceanBase
var connStr = "Server=oceanbase-host;Port=2881;Database=test;User Id=root;Password=pass;";
using var conn = new MySqlConnection(connStr);
conn.Open();
Console.WriteLine($"数据库类型: {conn.DatabaseType}"); // OceanBase
// TiDB
var connStr2 = "Server=tidb-host;Port=4000;Database=test;User Id=root;Password=pass;";
using var conn2 = new MySqlConnection(connStr2);
conn2.Open();
Console.WriteLine($"数据库类型: {conn2.DatabaseType}"); // TiDB
基础 SQL、事务、参数化查询、批量操作均兼容。
多目标框架
| 框架 | 说明 |
|---|---|
net45 / net461 |
.NET Framework,兼容老项目 |
netstandard2.0 / netstandard2.1 |
跨平台兼容,支持异步 Dispose |
net6.0 |
额外支持 DbBatch API |
net10.0 |
最新 .NET,最优性能 |
注意事项
- MySQL 版本:支持 5.x 及以上,推荐 8.0+
- 字符编码:默认 UTF-8
- ChangeDatabase:通过 Close/Reopen 实现,不支持事务中切换,推荐独立连接
- 管道化执行:仅适用于 DML 批量操作,不适用于 SELECT 查询
相关文档
| 文档 | 说明 |
|---|---|
| 需求文档 | 功能需求、验收条件、迭代计划 |
| 架构设计 | 架构概览、协议实现、技术选型、设计决策、驱动对比 |
| 性能测试报告 | 批量操作基准性能测试详细数据 |
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET Framework | net45 is compatible. net451 was computed. net452 was computed. net46 was computed. net461 is compatible. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
-
.NETFramework 4.5
- DH.MySql (>= 4.20.2026.303)
- EntityFramework (>= 6.5.1)
-
.NETFramework 4.6.1
- DH.MySql (>= 4.20.2026.303)
- EntityFramework (>= 6.5.1)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
| Version | Downloads | Last Updated |
|---|---|---|
| 4.21.2026.304-beta1127 | 77 | 3/4/2026 |
| 4.21.2026.304-beta0002 | 74 | 3/4/2026 |
| 4.21.2026.303-beta1338 | 74 | 3/3/2026 |
| 4.20.2026.303 | 79 | 3/3/2026 |
| 4.20.2026.303-beta1250 | 73 | 3/3/2026 |
| 4.19.2026.303 | 77 | 3/3/2026 |
| 4.19.2026.303-beta1248 | 73 | 3/3/2026 |
| 4.19.2026.303-beta1229 | 81 | 3/3/2026 |