Easy-DotNET Easy-DotNET
🏠首页
  • 知识地图
  • 源码脑图

    • 总览
    • Program
    • WebApplication
    • Host主机
    • WebHost主机
    • 依赖注入
    • Autofac
    • Middleware中间件
    • RateLimiter限制速率
    • 响应缓存、请求解压缩
  • 设计初衷
  • 克隆
  • 类型转换
  • 日期时间
  • IO流
  • 工具类
  • 语言特性
  • 集合类
  • Codec编码
  • 文本操作
  • 数学
  • 图片
  • 网络
  • Emoji表情
  • C# 12
  • C# 11
  • C# 10
  • C# 9.0
  • C# 8.0
  • C# 早期版本
  • C# 教程
  • ORM
  • 定时任务
  • 日志
  • 认证与授权
  • Swagger
  • 对象映射
  • 熔断重试限流
  • 缓存
  • 注册发现
  • 网关
  • GraphQL
  • 更多
  • Docker

    • 简介
    • Adminer
    • Apisix
    • Apollo
    • Cassandra
    • Cerebro
    • ClickHouse
    • Consul
    • EasyMock
    • Elasticsearch
    • Emqx
    • FastDFS
    • Flink
    • Gitlab
    • Jenkins
    • Jrebel
    • MariaDB
    • MySQL
    • Percona
    • Phpmyadmin
    • PostgreSQL
    • Redis
  • Linux

    • 查看Linux系统信息
    • CentOS7调整磁盘分区
    • IO压测
    • 图形化监控工具Cockpit
  • 总览
  • 列表

    • 算法数据结构
    • API
    • 应用框架
    • 应用模板
    • 操作系统
    • 工作流
    • 入门套件
    • 示例
    • 人工智能
    • 程序集
    • Assets
    • 认证授权
    • Blazor
    • 区块链
    • 书籍
    • 自动构建
    • 报表
    • 缓存
    • 日历
    • 聊天
    • CLI
    • CLR
    • CMS
    • 代码分析和指标
    • 代码片段
    • 压缩
    • 持续集成
    • 密码学
    • 数据库
    • 数据库驱动
    • 日期时间
    • 反编译
    • 部署
    • DirectX
    • 分布式计算
    • DLR
    • 文档
    • 电商支付
    • 模拟器
    • 环境管理
    • ETL
    • 事件消息
    • Exception
    • 扩展
    • 函数式编程
    • 游戏引擎
    • GIS
    • Git工具
    • 绘图
    • GraphQL
    • GUI
    • HTML-CSS
    • HTTP
    • IDE
    • 图片处理
    • 安装工具
    • 交互式编程
    • 国际化
    • 互操作性
    • IoC
    • JS引擎
    • 日志
    • 机器学习和数据科学
    • Markdown
    • 邮件
    • 数学
    • 媒体
    • 指标
    • 微型框架
    • 最小化器
    • MVVM
    • 网络
    • 对象映射
    • Office
    • OpenAI
    • ORM
    • 包管理器
    • PDF
    • 性能分析工具
    • 协议
    • 推送通知
    • SQL构建器
    • 消息队列
    • RPC
    • 响应式编程
    • 实时通信
    • 正则表达式
    • 任务调度
    • SDK和API
    • 搜索引擎
    • 序列化
    • SMS
    • 状态机
    • 静态站点生成
    • 强命名
    • 风格指南
    • 模板引擎
    • 测试
    • 工具
    • 交易
    • UI自动测试
    • Visual Studio 插件
    • Web浏览器
    • Web框架
    • WebServers
    • WebSocket
    • Windows服务
    • WPF
    • 解析器
    • 源码生成
    • 其他
    • 资源
  • AspNetCore面试题
  • Elasticsearch面试题
  • MongoDB面试题
  • MySql面试题
  • Nginx面试题
  • RabbitMQ面试题
  • Redis面试题
  • 设计模式
  • 微服务
🧑‍💻.NET Blog
GitHub (opens new window)
🏠首页
  • 知识地图
  • 源码脑图

    • 总览
    • Program
    • WebApplication
    • Host主机
    • WebHost主机
    • 依赖注入
    • Autofac
    • Middleware中间件
    • RateLimiter限制速率
    • 响应缓存、请求解压缩
  • 设计初衷
  • 克隆
  • 类型转换
  • 日期时间
  • IO流
  • 工具类
  • 语言特性
  • 集合类
  • Codec编码
  • 文本操作
  • 数学
  • 图片
  • 网络
  • Emoji表情
  • C# 12
  • C# 11
  • C# 10
  • C# 9.0
  • C# 8.0
  • C# 早期版本
  • C# 教程
  • ORM
  • 定时任务
  • 日志
  • 认证与授权
  • Swagger
  • 对象映射
  • 熔断重试限流
  • 缓存
  • 注册发现
  • 网关
  • GraphQL
  • 更多
  • Docker

    • 简介
    • Adminer
    • Apisix
    • Apollo
    • Cassandra
    • Cerebro
    • ClickHouse
    • Consul
    • EasyMock
    • Elasticsearch
    • Emqx
    • FastDFS
    • Flink
    • Gitlab
    • Jenkins
    • Jrebel
    • MariaDB
    • MySQL
    • Percona
    • Phpmyadmin
    • PostgreSQL
    • Redis
  • Linux

    • 查看Linux系统信息
    • CentOS7调整磁盘分区
    • IO压测
    • 图形化监控工具Cockpit
  • 总览
  • 列表

    • 算法数据结构
    • API
    • 应用框架
    • 应用模板
    • 操作系统
    • 工作流
    • 入门套件
    • 示例
    • 人工智能
    • 程序集
    • Assets
    • 认证授权
    • Blazor
    • 区块链
    • 书籍
    • 自动构建
    • 报表
    • 缓存
    • 日历
    • 聊天
    • CLI
    • CLR
    • CMS
    • 代码分析和指标
    • 代码片段
    • 压缩
    • 持续集成
    • 密码学
    • 数据库
    • 数据库驱动
    • 日期时间
    • 反编译
    • 部署
    • DirectX
    • 分布式计算
    • DLR
    • 文档
    • 电商支付
    • 模拟器
    • 环境管理
    • ETL
    • 事件消息
    • Exception
    • 扩展
    • 函数式编程
    • 游戏引擎
    • GIS
    • Git工具
    • 绘图
    • GraphQL
    • GUI
    • HTML-CSS
    • HTTP
    • IDE
    • 图片处理
    • 安装工具
    • 交互式编程
    • 国际化
    • 互操作性
    • IoC
    • JS引擎
    • 日志
    • 机器学习和数据科学
    • Markdown
    • 邮件
    • 数学
    • 媒体
    • 指标
    • 微型框架
    • 最小化器
    • MVVM
    • 网络
    • 对象映射
    • Office
    • OpenAI
    • ORM
    • 包管理器
    • PDF
    • 性能分析工具
    • 协议
    • 推送通知
    • SQL构建器
    • 消息队列
    • RPC
    • 响应式编程
    • 实时通信
    • 正则表达式
    • 任务调度
    • SDK和API
    • 搜索引擎
    • 序列化
    • SMS
    • 状态机
    • 静态站点生成
    • 强命名
    • 风格指南
    • 模板引擎
    • 测试
    • 工具
    • 交易
    • UI自动测试
    • Visual Studio 插件
    • Web浏览器
    • Web框架
    • WebServers
    • WebSocket
    • Windows服务
    • WPF
    • 解析器
    • 源码生成
    • 其他
    • 资源
  • AspNetCore面试题
  • Elasticsearch面试题
  • MongoDB面试题
  • MySql面试题
  • Nginx面试题
  • RabbitMQ面试题
  • Redis面试题
  • 设计模式
  • 微服务
🧑‍💻.NET Blog
GitHub (opens new window)
npm
  • 简介
  • ORM

    • EFCore
    • Dapper
    • FreeSql
    • SqlSugar
      • 安装
      • 快速入门
        • 连接数据库
        • 实体类
        • CRUD操作
        • 高级查询
        • 事务
        • 高级特性
      • 总结
  • 任务调度

    • Hangfire
    • Quartz
    • FluentScheduler
    • Coravel
    • Quartzmin
  • 日志

    • Serilog
    • NLog
    • Log4Net
    • Stackdriver
    • ExceptionLess
  • 身份认证与授权

    • IdentityServer4
    • Identity
    • JWTBearer
    • Auth0
    • OpenIddict
  • Swagger文档

    • Swagger
    • Swashbuckle
    • NSwag
    • ReDoc
  • 对象映射

    • AutoMapper
    • EmitMapper
    • AgileMapper
    • Mapster
  • 消息传递

    • MediatR
    • MassTransit
    • Rebus
    • NServiceBus
  • 熔断重试限流

    • Polly
    • Resilience4j
    • AkkaNET
  • 缓存

    • CsRedis
    • FreeRedis
    • EasyCaching
    • StackExchangeRedis
    • CacheCow
    • NCache
    • Memory
  • 注册发现

    • Consul
    • Nacos
    • Apollo
  • 网关

    • Ocelot
    • Kong
    • Traefik
    • Zuul
  • GraphQL

    • GraphQLPlatform
    • GraphQLdotnet
  • 更多

    • NodaTime
    • FluentAssertions
    • Humanizer
    • 爬虫-AngleSharp
    • 邮件-MailKit
  • NET微服务
  • ORM
一个大西瓜
2023-04-18
目录

SqlSugar

SqlSugar是一个开源的ORM框架,支持.NET Core/.NET Framework/Mono/Xamarin。它是一个轻量级、易于使用、高性能的ORM框架,具有较强的扩展性。SqlSugar不仅提供基础的CRUD操作,还提供了更高级的查询操作,如多表联查、分页、分组、聚合等功能。

# 安装

可以通过NuGet进行安装:


Install-Package SqlSugar

也可以通过.NET CLI进行安装:


dotnet add package SqlSugar

# 快速入门

# 连接数据库

在使用SqlSugar之前,需要先建立一个数据库连接。以下是一个连接SQL Server数据库的示例:


using SqlSugar;

// 创建数据库连接对象
var db = new SqlSugarClient(new ConnectionConfig {
    ConnectionString = "Server=localhost;Database=mydatabase;User ID=myuser;Password=mypassword;Trusted_Connection=False;",
    DbType = DbType.SqlServer,
    IsAutoCloseConnection = true
});

// 测试连接是否成功
if (db.Ado.ConnectServer()) {
    Console.WriteLine("连接成功!");
} else {
    Console.WriteLine("连接失败!");
}

上述代码首先创建了一个SqlSugarClient对象,它包含一个数据库连接,然后使用该连接进行测试。

# 实体类

使用SqlSugar时,需要定义一个实体类来映射数据库中的表。以下是一个示例:


public class User
{
    [SugarColumn(IsPrimaryKey = true, IsIdentity = true)]
    public int Id { get; set; }

    public string Name { get; set; }

    public int Age { get; set; }
}

在上述示例中,User类映射了一个名为user的表,包含了Id、Name、Age三个字段。需要注意的是,Id字段被标记为主键,并且自增。

# CRUD操作

以下是一些基本的CRUD操作示例:


// 添加
var user = new User { Name = "张三", Age = 18 };
var result = db.Insertable(user).ExecuteReturnIdentity();

// 修改
user.Name = "李四";
result = db.Updateable(user).ExecuteCommand();

// 删除
result = db.Deleteable<User>().Where(u => u.Age == 18).ExecuteCommand();

// 查询
var list = db.Queryable<User>().Where(u => u.Age > 20).ToList();

在上述示例中,Insertable、Updateable、Deleteable、Queryable都是SqlSugar提供的一些操作方法,它们用于构建SQL语句。其中,ToList用于将查询结果转换为一个列表。

# 高级查询

SqlSugar还提供了更高级的查询功能,如多表联查、分页、分组、聚合等。以下是一些示例:


// 多表联查
var list = db.Queryable<User, Department>((u, d) => new JoinQueryInfos(
        JoinType.Inner, u.Id == d.UserId
    ))
    .Select((u, d) => new {
    UserId = u.Id,
    UserName = u.Name,
    DepartmentName = d.Name
})
.ToList();

// 分页
var page = db.Queryable<User>()
.Where(u => u.Age > 20)
.OrderBy(u => u.Id)
.ToPageList(1, 10);

// 分组
var group = db.Queryable<User>()
.GroupBy(u => u.Age / 10)
.Select(u => new {
AgeRange = u.Age / 10 * 10,
Count = u.Count()
})
.ToList();

// 聚合
var maxAge = db.Queryable<User>()
.Max(u => u.Age);

var minAge = db.Queryable<User>()
.Min(u => u.Age);

var avgAge = db.Queryable<User>()
.Where(u => u.Age > 20)
.Average(u => u.Age);

var total = db.Queryable<User>()
.Sum(u => u.Age);

在上述示例中,JoinQueryInfos用于指定多表联查的条件;ToPageList用于分页查询;GroupBy用于分组查询;Max、Min、Average、Sum用于聚合查询。

# 事务

SqlSugar支持事务处理。以下是一个示例:

// 创建事务对象
var tran = db.Ado.BeginTran();

try
{
    // 执行一些操作
    var user = new User { Name = "张三", Age = 18 };
    db.Insertable(user).ExecuteCommand();

    user.Name = "李四";
    db.Updateable(user).ExecuteCommand();

    db.Deleteable<User>().Where(u => u.Age == 18).ExecuteCommand();

    // 提交事务
    tran.Commit();
}
catch (Exception ex)
{
    // 回滚事务
    tran.Rollback();

    throw ex;
}

在上述示例中,使用BeginTran创建一个事务对象,然后在需要进行事务处理的操作中使用该对象,最后使用Commit提交事务或使用Rollback回滚事务。

# 高级特性

SqlSugar还提供了一些高级特性,如自动过滤、多语言支持等。以下是一些示例:


// 自动过滤
var db = new SqlSugarClient(new ConnectionConfig {
    ConnectionString = "Server=localhost;Database=mydatabase;User ID=myuser;Password=mypassword;Trusted_Connection=False;",
    DbType = DbType.SqlServer,
    IsAutoCloseConnection = true,
    IsAutoRewriteSql = true
});

// 多语言支持
SqlSugarTool.AddLanguageConditional("en", () => {
    SqlFuncExtensions.IsNullDefaultString = "IsNull";
});

var list = db.Queryable<User>()
    .Where(u => u.Name == null)
    .ToList();

在上述示例中,使用IsAutoRewriteSql启用自动过滤,用于过滤一些无用的查询条件;使用AddLanguageConditional添加多语言支持,用于根据不同的语言环境输出不同的SQL语句。

# 总结

SqlSugar是一个轻量级、易于使用、高性能的ORM框架,支持.NET Core/.NET Framework/Mono/Xamarin,它提供了基本的CRUD操作和更高级的查询功能,如多表联查、分页、分组、聚合等。SqlSugar还支持事务处理和一些高级特性,如自动过滤、多语言支持等。

使用SqlSugar可以极大地简化数据库操作,提高开发效率。但是需要注意的是,在使用SqlSugar时,需要先了解基本的SQL语句,以及如何构建高效的数据库模式。

如果您想要更深入地了解SqlSugar,可以参考官方文档,了解更多的使用方法和高级特性。

上次更新: 2023/04/26, 22:10:06
FreeSql
Hangfire

← FreeSql Hangfire→

Theme by Vdoing | Copyright © 2019-2024 一个大西瓜 | MIT License | 苏ICP备2023013501号
  • 跟随系统
  • 浅色模式
  • 深色模式
  • 阅读模式