ORMX是一个轻量级、高性能的.NET ORM框架，支持多种数据库，提供简洁的API和强大的查询功能。 关键字:ORMX, .NET, 轻量级ORM, 数据库访问, 查询构建

第一章：ORMX简介

1.1 什么是 ORMX

ORMX 是一个专为 .NET 平台设计的轻量级对象关系映射（ORM）框架，它提供了简洁、高效的数据库访问方式。ORMX 的设计理念是"简单而不简陋"，通过精简的 API 设计和强大的功能实现，让开发者能够快速上手，同时满足各种复杂的数据操作需求。

社会主流观点

目前主流的 ORM 框架如 Entity Framework 功能强大但学习曲线陡峭，Dapper 性能优秀但需要手写 SQL。开发者普遍认为，一个理想的 ORM 应该在易用性和性能之间取得平衡，既不需要复杂的配置，又能提供类型安全的查询能力。

核心观点

ORMX 的核心价值在于"约定优于配置"的设计哲学和链式查询 API 的创新。它通过自动化的类型映射、智能的 SQL 生成和统一的接口设计，让开发者用最少的代码完成最多的工作。更重要的是，ORMX 在保持简洁的同时，并未牺牲性能和扩展性，这使其成为中小型项目和快速原型开发的理想选择。

1.2 设计理念

1.2.1 简单易用

ORMX 遵循"约定优于配置"的原则，减少样板代码的编写。开发者只需定义实体类，通过简单的特性标注，即可完成对象与数据库表的映射。无需复杂的 XML 配置文件，无需繁琐的映射设置，一切都在代码中直观地呈现。

1.2.2 高性能

ORMX 在设计之初就将性能作为核心考量。通过优化的 SQL 生成、高效的连接池管理、智能的查询缓存等技术，ORMX 能够在各种应用场景下提供出色的性能表现。批量操作经过特别优化，能够显著减少数据库往返次数，提高大数据量处理的效率。

1.2.3 灵活可扩展

虽然 ORMX 是轻量级框架，但它并不简单。它支持多种主流数据库（SQLite、MySQL、PostgreSQL、SQL Server、MongoDB、Rides），并集成了 Redis 缓存支持，提供了丰富的查询功能、事务支持、连接查询、缓存失效、健康检查等高级特性。同时，ORMX 保持了良好的扩展性，开发者可以根据需要进行定制和扩展。

1.3 核心特性

1.3.1 直观的实体映射

通过简单的特性标注，即可完成实体与数据库表的映射。ORMX 会自动处理数据类型转换、主键生成等细节。

[Table(Name = "Users")]
public class User
{
    [Column(IsPrimaryKey = true, IsAutoIncrement = true)]
    public int Id { get; set; }
    
    public string Name { get; set; }
    
    public string Email { get; set; }
    
    public int Age { get; set; }
}

1.3.2 流畅的查询 API

ORMX 提供了流畅、直观的查询 API，支持 Lambda 表达式，编译时类型检查，避免了传统字符串拼接 SQL 的错误风险。

// 基本查询
var users = userTable.Where(u => u.Age > 25).GetList();

// 复杂查询
var result = userTable
    .Where(u => u.Status == UserStatus.Active)
    .OrderByDesc(u => u.CreatedAt)
    .Limit(10)
    .GetList();

1.3.3 强大的批量操作

// 批量插入
userTable.InsertAll(users);

// 批量更新
userTable.UpdateAll(users);

// 批量删除
userTable.DeleteAll(users);

1.3.4 Redis 缓存集成

ORMX 集成了 Redis 缓存功能，提供了高性能的查询缓存和数据缓存能力。通过 Redis 缓存，可以显著减少数据库访问次数，提高应用性能。

主要特性：

• 自动缓存查询结果
• 支持缓存失效策略
• 集成健康检查功能
• 高性能序列化（使用 System.Text.Json）

使用示例：

// 启用 Redis 缓存
var cacheOptions = new RedisCacheOptions
{
    ConnectionString = "localhost:6379"
};

// 在数据库提供程序中配置缓存
var provider = new SqliteDatabaseProvider("Data Source=test.db")
    .WithRedisCache(cacheOptions);

// 缓存会自动应用到查询操作
var users = userTable.Where(u => u.Age > 25).GetList(); // 首次查询会缓存结果
var cachedUsers = userTable.Where(u => u.Age > 25).GetList(); // 后续查询会使用缓存

1.3.5 可靠的事务支持

try
{
    using var transaction = new Transaction(tableManager);
    transaction.Begin(IsolationLevel.ReadCommitted);
    
    // 执行多个操作
    userTable.Insert(user);
    orderTable.Insert(order);
    
    transaction.Commit();
}
catch (Exception ex)
{
    transaction.Rollback();
}

1.3.5 智能的 SQL 调试

ORMX 提供了 SQL 调试功能，可以实时查看生成的 SQL 语句和参数：

table.Debug((sql, parameters) => 
{
    Console.WriteLine(<div class="latex">$"SQL: {sql}");
    Console.WriteLine($</div>"参数: {string.Join(", ", parameters)}");
})
.Where(u => u.Age > 25)
.GetList();

1.3.6 分布式数据库支持

ORMX 内置了强大的分布式数据库支持，包括数据分片、读写分离、健康检查和分布式事务等功能：

// 创建分片
var shards = new List<IDbProvider>
{
    new SqliteDatabaseProvider("Data Source=shard1.db"),
    new SqliteDatabaseProvider("Data Source=shard2.db"),
    new SqliteDatabaseProvider("Data Source=shard3.db")
};

// 创建带读写分离的分布式提供者
var slaveDbs = new List<IDbProvider>
{
    new SqliteDatabaseProvider("Data Source=slave1.db"),
    new SqliteDatabaseProvider("Data Source=slave2.db")
};

var distributedProvider = shards.CreateDistributedProviderWithReadWriteSeparation(
    masterDb: shards.First(),
    slaves: slaveDbs,
    strategyType: ShardStrategyType.Hash,
    enableHealthCheck: true
);

// 使用分布式表
var userTable = distributedProvider.GetTable<User>();

// 写入操作（使用主库）
userTable.Insert(new User { Name = "张三", Email = "zhangsan@example.com" });

// 读取操作（使用从库）
var users = userTable.Where(u => u.Age > 18).ToList();

分布式数据库支持包括：

• 数据分片：支持哈希、范围、一致性哈希等多种分片策略
• 读写分离：主库负责写入，从库负责读取，提高系统性能
• 健康检查：自动监控分片状态，自动剔除不健康的分片
• 分布式事务：支持跨分片的事务操作
• 负载均衡：自动在多个从库之间分配读取请求

1.4 安全性

ORMX 将数据安全放在首位，提供了多层次的安全防护机制，确保您的应用程序数据安全可靠。

1.4.1 参数化查询防护 SQL 注入

ORMX 自动使用参数化查询，彻底防止 SQL 注入攻击：

// 安全的参数化查询
var user = userTable.Where(u => u.Email == emailInput).FirstOrDefault();

// 生成的 SQL 会自动参数化
// SELECT * FROM Users WHERE Email = @p0

1.4.2 连接安全

ORMX 支持所有主流数据库的安全连接配置：

// SQL Server 安全连接
var dbProvider = new SqlServerDatabaseProvider(
    "Server=myServer;Database=myDb;User Id=myUser;Password=myPass;Encrypt=True;"
);

// PostgreSQL 安全连接
var dbProvider = new PostgresDatabaseProvider(
    "Host=myHost;Database=myDb;Username=myUser;Password=myPass;SSL Mode=Require;"
);

1.4.3 资源回收的安全性

ORMX 实现了完善的资源管理机制，确保数据库连接和资源的安全回收，防止资源泄漏和潜在的安全风险。

// 使用 using 语句自动管理连接
using var connection = new SqliteConnection("Data Source=:memory:");
connection.Open();

// 连接会在 using 块结束时自动关闭和释放

1.5 适用场景

ORMX 适用于各种规模的 .NET 应用程序：

• 小型应用：SQLite 支持，无需额外配置，适合桌面应用、移动应用
• Web 应用：MySQL、PostgreSQL 支持，高并发处理，适合企业级 Web 应用
• 微服务：轻量级设计，低资源占用，适合微服务架构
• 快速原型：简单易用，快速开发，适合 MVP 和原型验证
• 分布式应用：内置分布式数据库支持，包括数据分片、读写分离、健康检查，适合高并发、大数据量的分布式系统

1.6 与其他 ORM 的比较

1.7 开始使用 ORMX

1.7.1 安装

通过 NuGet 包管理器安装 ORMX：

# 使用 .NET CLI
dotnet add package JCode.ORMX

# 或使用 NuGet 包管理器控制台
Install-Package JCode.ORMX

1.7.2 快速上手

using JCode.ORMX.DataProviders.SQLite;
using Microsoft.Data.Sqlite;

// 方式一：传入连接字符串（推荐）
using var provider = new SqliteDatabaseProvider("Data Source=:memory:");
var tableManager = provider.GetTableManager();

// 获取表对象
var userTable = tableManager.Table<User>();

// 插入数据
var user = userTable.Insert(new User { Name = "张三", Email = "zhangsan@example.com", Age = 25 });

// 查询数据
var foundUser = userTable.Where(u => u.Id == user.Id).FirstOrDefault();

方式二：传入已创建的连接实例

// 创建数据库连接
using var connection = new SqliteConnection("Data Source=:memory:");
connection.Open();

// 创建数据库提供程序
using var provider = new SqliteDatabaseProvider(connection);
var tableManager = provider.GetTableManager();

// 获取表对象
var userTable = tableManager.Table<User>();

// 插入数据
var user = userTable.Insert(new User { Name = "李四", Email = "lisi@example.com", Age = 30 });

只需几行代码，即可完成数据库操作，这就是 ORMX 的简洁之处。

总结

ORMX 是一个专为 .NET 平台设计的轻量级 ORM 框架，它以"简单而不简陋"为设计理念，通过约定优于配置的原则和直观的链式查询 API，让开发者能够快速上手。ORMX 支持多种主流数据库，包括关系型数据库（SQL Server、MySQL、PostgreSQL、SQLite）和 NoSQL 数据库（MongoDB），提供了强大的查询功能、批量操作、事务支持、SQL 调试和分布式数据库支持等特性。同时通过参数化查询和完善的资源管理机制确保数据安全。无论是小型应用、Web 应用、微服务、快速原型开发还是分布式系统，ORMX 都能提供出色的性能和开发体验。

扩展思考

随着微服务架构和云原生应用的普及，轻量级 ORM 框架的需求日益增长。ORMX 已经内置了分布式数据库支持，包括数据分片、读写分离、健康检查和分布式事务等功能，能够很好地适应分布式场景。未来，我们可以进一步探索以下方向：

• 多租户架构：如何在保持简洁性的同时，支持多租户数据隔离和路由
• 云原生集成：如何更好地与 Kubernetes、Service Mesh 等云原生技术集成
• 智能缓存：如何结合分布式缓存，进一步提升查询性能
• 数据库适配器：如何支持更多类型的数据库，如时序数据库、图数据库等
• 监控和可观测性：如何提供更完善的性能监控和诊断能力

这些问题值得我们深入思考和探索，以推动 ORMX 持续演进，更好地满足现代应用的需求。