C# ORM模式之 SqlSugar使用

一锦一瑟思华年 2023-11-11 原文

一、SqlSugar介绍及分析

SqlSugar是一款老牌 .NET 开源ORM框架，连接DB特别方便

支持数据库：MySql、SqlServer、Sqlite、Oracle 、 postgresql、达梦、人大金仓

官方文档：http://www.donet5.com/Home/Doc

SqlSugar的优点：

1、高性能：不夸张的说，去掉Sql在数据库执行的时间，SqlSugar是EF数倍性能，另外在批量操作和一对多查询上也有不错的SQL优化；

2、高扩展性：支持自定义拉姆达函数解析、扩展数据类型、支持自定义实体特性，外部缓存等；

3、稳定性和技术支持：虽然不是官方ORM, 但在稳定性上也是有着数年用户积累，如果遇到问题可以在GITHUB提出来，会根据紧急度定期解决；

4、功能全面：虽然SqlSugar小巧可功能并不逊色于EF框架

5、创新、持续更新，向下兼容

二、SqlSugar项目中的使用

1、包的引用：

2、全局引用：

3、接口中常用方法封装

1）、ISqlSugarRepository接口封装

public interface ISqlSugarRepository<TEntity> : IBaseRepository where TEntity : class
{
    /// <summary>
    /// 
    /// </summary>
    ISqlSugarClient Db { get; }

    /// <summary>
    /// 执行查询SQL语句
    /// 只支持查询操作，并且支持拉姆达分页
    /// </summary>
    /// <param name="sql"></param>
    /// <returns></returns>
    Task<List<TEntity>> ExecuteSql(string sql);

    /// <summary>
    /// 通过Ado方法执行SQL语句
    /// 支持任何SQL语句
    /// </summary>
    /// <param name="sql"></param>
    /// <param name="whereObj"></param>
    /// <returns></returns>
    Task<List<TEntity>> ExecuteAllSql(string sql, object whereObj = null);

    /// <summary>
    /// 插入实体
    /// </summary>
    /// <param name="model"></param>
    /// <returns></returns>
    Task<int> Add(TEntity model);

    /// <summary>
    /// 批量插入实体
    /// </summary>
    /// <param name="listEntity"></param>
    /// <returns></returns>
    Task<int> Add(List<TEntity> listEntity);

    /// <summary>
    /// 根据实体删除数据
    /// </summary>
    /// <param name="model"></param>
    /// <returns></returns>
    Task<bool> Delete(TEntity model);

    /// <summary>
    /// 根据实体集合批量删除数据
    /// </summary>
    /// <param name="models"></param>
    /// <returns></returns>
    Task<bool> Delete(List<TEntity> models);

    /// <summary>
    /// 根据ID删除数据
    /// </summary>
    /// <param name="id"></param>
    /// <returns></returns>
    Task<bool> DeleteById(object id);

    /// <summary>
    /// 根据IDs批量删除数据
    /// </summary>
    /// <param name="ids"></param>
    /// <returns></returns>
    Task<bool> DeleteByIds(List<object> ids);

    /// <summary>
    /// 更新实体
    /// </summary>
    /// <param name="model"></param>
    /// <returns></returns>
    Task<bool> Update(TEntity model);

    /// <summary>
    /// 批量更新实体
    /// </summary>
    /// <param name="listEntity"></param>
    /// <returns></returns>
    Task<int> Update(List<TEntity> listEntity);

    /// <summary>
    /// 根据ID查询一条数据
    /// </summary>
    /// <param name="objId"></param>
    /// <returns></returns>
    Task<TEntity> GetById(object objId);

    /// <summary>
    /// 根据条件查询数据是否存在
    /// </summary>
    /// <param name="whereExpression"></param>
    /// <returns></returns>
    Task<bool> GetAnyByFilter(Expression<Func<TEntity, bool>> whereExpression);

    /// <summary>
    /// 根据IDs查询数据
    /// </summary>
    /// <param name="lstIds"></param>
    /// <returns></returns>
    Task<List<TEntity>> GetByIds(List<object> lstIds);

    /// <summary>
    /// 根据条件查询一条数据
    /// </summary>
    /// <param name="whereExpression"></param>
    /// <returns></returns>
    Task<TEntity> GetSingleByFilter(Expression<Func<TEntity, bool>> whereExpression);

    /// <summary>
    /// 查询所有数据
    /// </summary>
    /// <returns></returns>
    Task<List<TEntity>> Get();

    /// <summary>
    /// 查询数据列表
    /// </summary>
    /// <param name="whereExpression">条件表达式</param>
    /// <returns>数据列表</returns>
    Task<List<TEntity>> Get(Expression<Func<TEntity, bool>> whereExpression);


    /// <summary>
    /// 查询数据列表
    /// </summary>
    /// <param name="whereExpression">条件表达式</param>
    /// <param name="orderByExpression">排序表达式</param>
    /// <param name="isAsc">是否升序排序</param>
    /// <returns></returns>
    Task<List<TEntity>> Get(Expression<Func<TEntity, bool>> whereExpression, Expression<Func<TEntity, object>> orderByExpression = null, bool isAsc = true);

    /// <summary>
    /// 分页查询
    /// </summary>
    /// <param name="selector"></param>
    /// <param name="whereExpression"></param>
    /// <param name="intPageIndex"></param>
    /// <param name="intPageSize"></param>
    /// <param name="orderDescSelector"></param>
    /// <returns></returns>
    Task<PaginatedViewModel<TResult>> Get<TResult>(Expression<Func<TEntity, TResult>> selector, Expression<Func<TEntity, bool>> whereExpression, int intPageIndex, int intPageSize, Expression<Func<TEntity, object>> orderDescSelector = null);


    /// <summary>
    /// 分页查询
    /// </summary>
    /// <param name="selector"></param>
    /// <param name="whereExpression"></param>
    /// <param name="intPageIndex"></param>
    /// <param name="intPageSize"></param>
    /// <param name="orderDescSelector"></param>
    /// <returns></returns>
    Task<PaginatedViewModel<TEntity>> Get(Expression<Func<TEntity, bool>> whereExpression, int intPageIndex, int intPageSize, Expression<Func<TEntity, object>> orderDescSelector = null);
}

public interface IBaseRepository { }

事务接口：

public interface IUnitOfWork
{
    /// <summary>
    /// 
    /// </summary>
    /// <returns></returns>
    SqlSugarClient GetDbClient();
    /// <summary>
    /// 
    /// </summary>
    void BeginTran();
    /// <summary>
    /// 
    /// </summary>
    void CommitTran();
    /// <summary>
    /// 
    /// </summary>
    void RollbackTran();
}

2）、SqlSugarRepository接口实现


/// <summary>
/// 
/// </summary>
/// <typeparam name="TEntity"></typeparam>
public class SqlSugarRepository<TEntity> : ISqlSugarRepository<TEntity> where TEntity : class, new()
{
    private readonly SqlSugarClient _dbBase;

    public ISqlSugarClient Db
    {
        get { return _dbBase; }
    }

    /// <summary>
    /// 
    /// </summary>
    /// <param name="unitOfWork"></param>
    public SqlSugarRepository(IUnitOfWork unitOfWork)
    {
        _dbBase = unitOfWork.GetDbClient();
    }

    /// <summary>
    /// 执行查询SQL语句
    /// 只支持查询操作，并且支持拉姆达分页
    /// </summary>
    /// <param name="sql"></param>
    /// <returns></returns>
    public async Task<List<TEntity>> ExecuteSql(string sql)
    {
        return await Db.SqlQueryable<TEntity>(sql).ToListAsync();
    }


    /// <summary>
    /// 通过Ado方法执行SQL语句
    /// 支持任何SQL语句
    /// </summary>
    /// <param name="sql"></param>
    /// <param name="whereObj">参数</param>
    /// <returns></returns>
    public async Task<List<TEntity>> ExecuteAllSql(string sql, object whereObj = null)
    {
        return await Task.Run(() => Db.Ado.SqlQuery<TEntity>(sql, whereObj));
    }

    /// <summary>
    /// 根据ID查询一条数据
    /// </summary>
    /// <param name="objId"></param>
    /// <returns></returns>
    public async Task<TEntity> GetById(object objId)
    {
        return await Db.Queryable<TEntity>().In(objId).SingleAsync();
    }

    /// <summary>
    /// 根据IDs查询数据
    /// </summary>
    /// <param name="lstIds">id列表</param>
    /// <returns>数据实体列表</returns>
    public async Task<List<TEntity>> GetByIds(List<object> lstIds)
    {
        return await Db.Queryable<TEntity>().In(lstIds).ToListAsync();
    }

    /// <summary>
    /// 插入实体
    /// </summary>
    /// <param name="entity">实体类</param>
    /// <returns></returns>
    public async Task<int> Add(TEntity entity)
    {
        var insert = Db.Insertable(entity);
        return await insert.ExecuteCommandAsync();
    }

    /// <summary>
    /// 批量插入实体
    /// </summary>
    /// <param name="listEntity">实体集合</param>
    /// <returns>影响行数</returns>
    public async Task<int> Add(List<TEntity> listEntity)
    {
        return await Db.Insertable(listEntity.ToArray()).ExecuteCommandAsync();
    }

    /// <summary>
    /// 更新实体
    /// </summary>
    /// <param name="entity">实体类</param>
    /// <returns></returns>
    public async Task<bool> Update(TEntity entity)
    {
        return await Db.Updateable(entity).ExecuteCommandHasChangeAsync();
    }

    /// <summary>
    /// 批量更新实体
    /// </summary>
    /// <param name="listEntity">实体类</param>
    /// <returns></returns>
    public async Task<int> Update(List<TEntity> listEntity)
    {
        return await Db.Updateable(listEntity).ExecuteCommandAsync();
    }

    /// <summary>
    /// 根据实体删除数据
    /// </summary>
    /// <param name="entity">实体</param>
    /// <returns></returns>
    public async Task<bool> Delete(TEntity entity)
    {
        return await Db.Deleteable(entity).ExecuteCommandHasChangeAsync();
    }

    /// <summary>
    /// 根据实体集合批量删除数据
    /// </summary>
    /// <param name="models"></param>
    /// <returns></returns>
    public async Task<bool> Delete(List<TEntity> models)
    {
        return await Db.Deleteable(models).ExecuteCommandHasChangeAsync();
    }

    /// <summary>
    /// 根据ID删除数据
    /// </summary>
    /// <param name="id">ID</param>
    /// <returns></returns>
    public async Task<bool> DeleteById(object id)
    {
        return await Db.Deleteable<TEntity>(id).ExecuteCommandHasChangeAsync();
    }

    /// <summary>
    /// 根据IDs批量删除数据
    /// </summary>
    /// <param name="ids">ID集合</param>
    /// <returns></returns>
    public async Task<bool> DeleteByIds(List<object> ids)
    {
        return await Db.Deleteable<TEntity>().In(ids).ExecuteCommandHasChangeAsync();
    }

    /// <summary>
    /// 根据条件查询数据是否存在
    /// </summary>
    /// <param name="whereExpression"></param>
    /// <returns></returns>
    public async Task<bool> GetAnyByFilter(Expression<Func<TEntity, bool>> whereExpression)
    {
        return await Db.Queryable<TEntity>().AnyAsync(whereExpression);
    }

    /// <summary>
    /// 根据条件查询一条数据
    /// </summary>
    /// <param name="whereExpression"></param>
    /// <returns></returns>
    public async Task<TEntity> GetSingleByFilter(Expression<Func<TEntity, bool>> whereExpression)
    {
        return await Db.Queryable<TEntity>().FirstAsync(whereExpression);
    }

    /// <summary>
    /// 查询所有数据
    /// </summary>
    /// <returns></returns>
    public async Task<List<TEntity>> Get()
    {
        return await Db.Queryable<TEntity>().ToListAsync();
    }

    /// <summary>
    /// 查询数据列表----按条件表达式
    /// </summary>
    /// <param name="whereExpression">条件表达式</param>
    /// <returns>数据列表</returns>
    public async Task<List<TEntity>> Get(Expression<Func<TEntity, bool>> whereExpression)
    {
        return await Db.Queryable<TEntity>().WhereIF(whereExpression != null, whereExpression).ToListAsync();
    }

    /// <summary>
    /// 查询数据列表----按条件表达式、排序表达式
    /// </summary>
    /// <param name="whereExpression">条件表达式</param>
    /// <param name="orderByExpression">排序表达式</param>
    /// <param name="isAsc">是否升序排序</param>
    /// <returns></returns>
    public async Task<List<TEntity>> Get(Expression<Func<TEntity, bool>> whereExpression, Expression<Func<TEntity, object>> orderByExpression = null, bool isAsc = true)
    {
        return await Db.Queryable<TEntity>().OrderByIF(orderByExpression != null, orderByExpression, isAsc ? OrderByType.Asc : OrderByType.Desc).WhereIF(whereExpression != null, whereExpression).ToListAsync();
    }

    /// <summary>
    /// 分页查询
    /// </summary>
    /// <param name="selector"></param>
    /// <param name="whereExpression">条件表达式</param>
    /// <param name="intPageIndex">页码</param>
    /// <param name="intPageSize">页大小</param>
    /// <param name="orderDescSelector">排序字段</param>
    /// <returns></returns>
    public async Task<PaginatedViewModel<TResult>> Get<TResult>(Expression<Func<TEntity, TResult>> selector, Expression<Func<TEntity, bool>> whereExpression, int intPageIndex, int intPageSize, Expression<Func<TEntity, object>> orderDescSelector = null)
    {
        var query = Db.Queryable<TEntity>().WhereIF(whereExpression != null, whereExpression);

        query = query.OrderByIF(orderDescSelector != null, orderDescSelector);

        var totalCount = 0;
        var results = query.Select(selector).ToPageList(intPageIndex, intPageSize, ref totalCount).ToList();

        var basePage = new PaginatedViewModel<TResult>(intPageIndex, intPageSize, totalCount, results);

        return await Task.FromResult(basePage);
    }

    /// <summary>
    /// 分页查询
    /// </summary>
    /// <param name="selector"></param>
    /// <param name="whereExpression">条件表达式</param>
    /// <param name="intPageIndex">页码</param>
    /// <param name="intPageSize">页大小</param>
    /// <param name="orderDescSelector">排序字段</param>
    /// <returns></returns>
    public async Task<PaginatedViewModel<TEntity>> Get(Expression<Func<TEntity, bool>> whereExpression, int intPageIndex, int intPageSize, Expression<Func<TEntity, object>> orderDescSelector = null)
    {
        var query = Db.Queryable<TEntity>().WhereIF(whereExpression != null, whereExpression);

        query = query.OrderByIF(orderDescSelector != null, orderDescSelector);

        var totalCount = 0;

        var results = query.ToPageList(intPageIndex, intPageSize, ref totalCount).ToList();

        var basePage = new PaginatedViewModel<TEntity>(intPageIndex, intPageSize, totalCount, results);

        return await Task.FromResult(basePage);
    }
}

事务接口实现：

public class UnitOfWork : IUnitOfWork, IDisposable
{
    private readonly ISqlSugarClient _sqlSugarClient;

    private bool _disposed = false;

    public UnitOfWork(ISqlSugarClient sqlSugarClient)
    {
        _sqlSugarClient = sqlSugarClient;
    }

    public SqlSugarClient GetDbClient()
    {
        return (SqlSugarClient)_sqlSugarClient;
    }

    public void BeginTran()
    {
        GetDbClient().BeginTran();
    }

    public void CommitTran()
    {
        try
        {
            GetDbClient().CommitTran();
            Dispose();
        }
        catch
        {
            GetDbClient().RollbackTran();
            Dispose();
        }
    }

    public void RollbackTran()
    {
        GetDbClient().RollbackTran();
        Dispose();
    }

    public void Dispose()
    {
        Dispose(true);
        GC.SuppressFinalize(this);
    }

    public void Dispose(bool disposing)
    {
        if (_disposed) return;

        if (disposing)
        {
            GetDbClient()?.Dispose();
        }

        _disposed = true;
    }

    ~UnitOfWork() => Dispose(false);
}

分页查询模型：

public class PaginatedViewModel<T>
{
    public int PageIndex { get; private set; }

    public int PageSize { get; private set; }

    public long Count { get; private set; }

    public IEnumerable<T> Data { get; private set; }

    public PaginatedViewModel(int pageIndex, int pageSize, long count, IEnumerable<T> data)
    {
        PageIndex = pageIndex;
        PageSize = pageSize;
        Count = count;
        Data = data;
    }
}

3、SqlSugar在项目中的使用

1）、定义及初始化

private readonly ISqlSugarRepository<StatEquipmentInfo> _statEquipmentInfoRepository;

public GetStatusInfoHandler(ISqlSugarRepository<StatEquipmentInfo> statEquipmentInfoRepository)
{
   _statEquipmentInfoRepository = statEquipmentInfoRepository;
}

2)、使用

var infos = await _statEquipmentInfoRepository.GetSingleByFilter(s => s.EId == requestDtoModel.EId && s.StatDate == requestDtoModel.StatDate && s.ETypeId == requestDtoModel.ETypeId);

其他函数的使用，按照接口规范要求使用即可，在这里就不过多赘叙了。

C#SqlSugar gt lt param 数据库 sqlserver postgresql

有关C# ORM模式之 SqlSugar使用的更多相关文章

ruby - 如何使用 Nokogiri 的 xpath 和 at_xpath 方法 - 2
我正在学习如何使用Nokogiri，根据这段代码我遇到了一些问题:require'rubygems'require'mechanize'post_agent=WWW::Mechanize.newpost_page=post_agent.get('http://www.vbulletin.org/forum/showthread.php?t=230708')puts"\nabsolutepathwithtbodygivesnil"putspost_page.parser.xpath('/html/body/div/div/div/div/div/table/tbody/tr/td/div
ruby - 使用 RubyZip 生成 ZIP 文件时设置压缩级别 - 2
我有一个Ruby程序，它使用rubyzip压缩XML文件的目录树。gem。我的问题是文件开始变得很重，我想提高压缩级别，因为压缩时间不是问题。我在rubyzipdocumentation中找不到一种为创建的ZIP文件指定压缩级别的方法。有人知道如何更改此设置吗？是否有另一个允许指定压缩级别的Ruby库？最佳答案这是我通过查看rubyzip内部创建的代码。level=Zlib::BEST_COMPRESSIONZip::ZipOutputStream.open(zip_file)do|zip|Dir.glob("**/*")d
ruby - 为什么我可以在 Ruby 中使用 Object#send 访问私有(private)/ protected 方法？ - 2
类classAprivatedeffooputs:fooendpublicdefbarputs:barendprivatedefzimputs:zimendprotecteddefdibputs:dibendendA的实例a=A.new测试a.foorescueputs:faila.barrescueputs:faila.zimrescueputs:faila.dibrescueputs:faila.gazrescueputs:fail测试输出failbarfailfailfail.发送测试[:foo,:bar,:zim,:dib,:gaz].each{|m|a.send(m)resc
ruby-on-rails - 使用 Ruby on Rails 进行自动化测试 - 最佳实践 - 2
很好奇，就使用rubyonrails自动化单元测试而言，你们正在做什么？您是否创建了一个脚本来在cron中运行rake作业并将结果邮寄给您？git中的预提交Hook？只是手动调用？我完全理解测试，但想知道在错误发生之前捕获错误的最佳实践是什么。让我们理所当然地认为测试本身是完美无缺的，并且可以正常工作。下一步是什么以确保他们在正确的时间将可能有害的结果传达给您？最佳答案不确定您到底想听什么，但是有几个级别的自动代码库控制:在处理某项功能时，您可以使用类似autotest的内容获得关于哪些有效，哪些无效的即时反馈。要确保您的提
ruby - 在 Ruby 中使用匿名模块 - 2
假设我做了一个模块如下:m=Module.newdoclassCendend三个问题:除了对m的引用之外，还有什么方法可以访问C和m中的其他内容？我可以在创建匿名模块后为其命名吗(就像我输入“module...”一样)？如何在使用完匿名模块后将其删除，使其定义的常量不再存在？最佳答案三个答案:是的，使用ObjectSpace.此代码使c引用你的类(class)C不引用m:c=nilObjectSpace.each_object{|obj|c=objif(Class===objandobj.name=~/::C$/)}当然这取决于
ruby - 使用 ruby 和 savon 的 SOAP 服务 - 2
我正在尝试使用ruby和Savon来使用网络服务。测试服务为http://www.webservicex.net/WS/WSDetails.aspx?WSID=9&CATID=2require'rubygems'require'savon'client=Savon::Client.new"http://www.webservicex.net/stockquote.asmx?WSDL"client.get_quotedo|soap|soap.body={:symbol=>"AAPL"}end返回SOAP异常。检查soap信封，在我看来soap请求没有正确的命名空间。任何人都可以建议我
python - 如何使用 Ruby 或 Python 创建一系列高音调和低音调的蜂鸣声？ - 2
关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题？更新问题，以便editingthispost可以用事实和引用来回答它.关闭4年前。Improvethisquestion我想在固定时间创建一系列低音和高音调的哔哔声。例如:在150毫秒时发出高音调的蜂鸣声在151毫秒时发出低音调的蜂鸣声200毫秒时发出低音调的蜂鸣声250毫秒的高音调蜂鸣声有没有办法在Ruby或Python中做到这一点？我真的不在乎输出编码是什么(.wav、.mp3、.ogg等等)，但我确实想创建一个输出文件。
ruby-on-rails - Rails - 子类化模型的设计模式是什么？ - 2
我有一个模型:classItem项目有一个属性“商店”基于存储的值，我希望Item对象对特定方法具有不同的行为。Rails中是否有针对此的通用设计模式？如果方法中没有大的if-else语句，这是如何干净利落地完成的？最佳答案通常通过Single-TableInheritance. 关于ruby-on-rails-Rails-子类化模型的设计模式是什么？，我们在StackOverflow上找到一个类似的问题： https://stackoverflow.co
ruby-on-rails - 'compass watch' 是如何工作的/它是如何与 rails 一起使用的 - 2
我在我的项目目录中完成了compasscreate.和compassinitrails。几个问题:我已将我的.sass文件放在public/stylesheets中。这是放置它们的正确位置吗？当我运行compasswatch时，它不会自动编译这些.sass文件。我必须手动指定文件:compasswatchpublic/stylesheets/myfile.sass等。如何让它自动运行？文件ie.css、print.css和screen.css已放在stylesheets/compiled。如何在编译后不让它们重新出现的情况下删除它们？我自己编译的.sass文件编译成compiled/t
ruby - 使用 ruby 将 HTML 转换为纯文本并维护结构/格式 - 2
我想将html转换为纯文本。不过，我不想只删除标签，我想智能地保留尽可能多的格式。为插入换行符标签，检测段落并格式化它们等。输入非常简单，通常是格式良好的html(不是整个文档，只是一堆内容，通常没有anchor或图像)。我可以将几个正则表达式放在一起，让我达到80%，但我认为可能有一些现有的解决方案更智能。最佳答案首先，不要尝试为此使用正则表达式。很有可能你会想出一个脆弱/脆弱的解决方案，它会随着HTML的变化而崩溃，或者很难管理和维护。您可以使用Nokogiri快速解析HTML并提取文本:require'nokogiri'h

C# ORM模式之 SqlSugar使用

有关C# ORM模式之 SqlSugar使用的更多相关文章

随机推荐