SmartSql完全指南：从环境搭建到实战应用的5个关键步骤

2026-04-30 10:34:21作者：牧宁李

SmartSql是一款基于.NET Core的ORM（对象关系映射）框架，融合了MyBatis的XML SQL管理模式与.NET生态的特性，提供缓存、读写分离、动态仓库等企业级功能。本文将通过5个关键步骤，帮助开发者快速掌握这一高效数据访问优化工具，提升** .NET开发**效率。

如何快速了解SmartSql的核心价值？

SmartSql定位为"MyBatis in C#"，核心优势在于将SQL与业务代码解耦，同时保持.NET生态特有的强类型特性。项目架构包含四大支柱：

XML驱动的SQL管理：通过配置文件集中管理SQL语句，支持动态SQL生成
多维度缓存体系：内存缓存+Redis分布式缓存双重保障
读写分离机制：自动路由读写请求至不同数据源
动态仓库模式：接口自动实现，无需编写具体数据访问代码

功能优势对比

特性	SmartSql	Dapper	Entity Framework Core
SQL控制力	完全控制（XML配置）	手动编写	自动生成（难定制）
性能	接近原生	优秀	中等
缓存支持	内置多级缓存	需手动实现	有限支持
读写分离	原生支持	需扩展	需扩展
学习曲线	中等（XML配置）	低	中高

3步完成SmartSql开发环境准备

步骤1：安装基础依赖

确保系统已安装：

.NET Core SDK 3.1+（推荐5.0+版本）
任意代码编辑器（VS 2022/VS Code）
目标数据库（SQL Server/MySQL/PostgreSQL等）

💡 技巧提示：使用dotnet --list-sdks命令检查已安装的SDK版本，确保满足项目要求。

步骤2：获取项目代码

git clone https://gitcode.com/gh_mirrors/smar/SmartSql

步骤3：还原依赖并构建

cd SmartSql
dotnet restore
dotnet build --configuration Release

⚠️ 注意事项：若构建失败，检查是否安装了所有必要的SDK版本，可通过dotnet workload install命令补充缺失组件。

5分钟上手SmartSql基础操作

创建配置文件

在项目根目录创建SmartSqlMapConfig.xml：

<SmartSqlMapConfig>
  <Database>
    <DbProvider Name="SqlServer"/>
    <WriteDataSource ConnectionString="Server=.;Database=TestDB;Trusted_Connection=True"/>
  </Database>
  <SqlMaps>
    <SqlMap Path="Maps" Type="Directory"/>
  </SqlMaps>
</SmartSqlMapConfig>

定义数据实体

public class User
{
    public long Id { get; set; }
    public string Name { get; set; }
    public DateTime CreateTime { get; set; }
}

编写SQL映射文件

在Maps目录创建User.xml：

<SqlMap Scope="User">
  <Statement Id="Query" >
    SELECT * FROM User WHERE Id = @Id
  </Statement>
</SqlMap>

执行数据操作

var sqlMapper = new SmartSqlBuilder()
    .UseXmlConfig()
    .Build();
    
var user = sqlMapper.QuerySingle<User>(new { Id = 1 });

💡 技巧提示：使用SmartSql.DyRepository可以进一步简化代码，通过接口自动生成实现类，无需手动编写数据访问代码。

深入理解SmartSql核心功能

多级缓存策略

SmartSql提供灵活的缓存配置，支持内存缓存和Redis分布式缓存：

<Statement Id="Query" Cache="True" CacheNamespace="User" CacheExpire="3600">
  SELECT * FROM User WHERE Id = @Id
</Statement>

读写分离实现

通过配置即可实现读写分离：

<ReadDataSources>
  <ReadDataSource ConnectionString="Server=slave1;Database=TestDB;Trusted_Connection=True"/>
  <ReadDataSource ConnectionString="Server=slave2;Database=TestDB;Trusted_Connection=True"/>
</ReadDataSources>

动态SQL构建

利用XML标签构建动态SQL：

<Statement Id="QueryByPage">
  SELECT * FROM User
  <Where>
    <IsNotEmpty Property="Name">AND Name LIKE CONCAT('%',@Name,'%')</IsNotEmpty>
    <IsGreaterThan Property="Age">AND Age > @Age</IsGreaterThan>
  </Where>
  ORDER BY Id DESC
  LIMIT @PageSize OFFSET @Offset
</Statement>