用轻量级ORM--Dapper实现泛型仓储

2023-12-29 20:44

本文主要是介绍用轻量级ORM--Dapper实现泛型仓储,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

阅读本文你的收获

  1. 了解Dapper的适用场景
  2. 了解Dapper的本质其实是一些扩展方法
  3. 学会使用Dapper的扩展Domel来实现泛型仓储

一、什么是Dapper?

Dapper是一个轻量级的ORM(对象关系映射)工具,用于简化数据库操作。它和Entity Framework 不同,它属于轻量级的,并且是半自动的。

Dapper的优势:

  • Dapper非常小巧,只有一个帮助类,完全开源。
  • Dapper以性能优异著称。一般的ORM框架,性能和直接写原生的SQL语句比都差不少,但是Dapper执行SQL语句的性能非常好。

Dapper的使用场景:

  1. 快速的数据访问:Dapper提供了简单、快速的方法来执行数据库查询操作,可以有效地减少代码量和开发时间。

  2. 大数据量的操作:Dapper在处理大数据量的操作时表现出色,相比其他ORM工具,它具有更低的内存占用和更高的性能。

  3. 原始SQL查询:Dapper允许开发人员编写和执行原生SQL查询,可以灵活地处理复杂的查询需求。

  4. 存储过程的调用:Dapper支持存储过程的调用,并提供了简便的方式来执行存储过程并获取返回结果。

总之,Dapper适用于需要快速、高性能的数据访问的场景,尤其适用于对数据库操作要求较高的应用程序。

二、Dapper的本质

Dapper库对IDbConnection接口扩展了许多方法,使得与数据库交互变得更加方便和高效。下面是Dapper中定义的Query方法,它是一个扩展方法,扩展的目标类型是IDbConnection。

public static IEnumerable<T> Query<T>(this IDbConnection cnn, string sql, object param = null, IDbTransaction transaction = null, bool buffered = true, int? commandTimeout = null, CommandType? commandType = null)

以下是Dapper扩展的一些常用方法(包括但不限于):

  1. Query方法:用于执行SQL查询并返回结果集。
  2. QueryFirstOrDefault方法:用于执行SQL查询并返回结果集中的第一行记录,如果结果集为空则返回默认值。
  3. QuerySingleOrDefault方法:用于执行SQL查询并返回唯一一条记录,如果结果集为空则返回默认值。
  4. Execute方法:用于执行SQL语句并返回受影响的行数。
  5. ExecuteScalar方法:用于执行SQL语句并返回受影响的行数。

这些方法还有与之对应的异步方法(Async结尾的方法)。

此外,Dapper还提供了一些类型用于处理与参数有关的操作,例如:DynamicParameters类:用于动态创建参数。该类的Add方法:用于向参数集合中添加参数,而Get方法:用于获取参数的值。

三、Dapper的入门案例

开发环境:

平台版本是:.NET6
开发框架:ASP.NET Core WebApi
开发工具:Visual Studio 2022
数据库版本:MS SQL Server 2014

3.1 安装Dapper

通过NuGet包管理器安装Dapper
安装Dapper

3.2 用Dapper执行SQL语句

以下案例用Dapper实现查询用户是否存在。

//头上引用命名空间
using Dapper;//获取连接字符串(本例中是硬编码的,最好写在appsettings.json中)
private const string CONNECT_STRING = "Data Source=.;Initial Catalog=shoppingdb1;User ID=sa;Password=123abc!";/// <summary>
/// 检查登录的账号和密码
/// </summary>
/// <param name="UserName"></param>
/// <param name="Password"></param>
/// <returns></returns>
public bool Login(string userName, string password)
{using(var conn = new SqlConnection(CONNECT_STRING)){string sql = "select * from [dbo].[User] where UserName=@UserName and Password=@Password";//Query<>方法用户执行select语句,获取结果集List<User> users = conn.Query<User>(sql, new { UserName=userName, Password=password}).ToList();return users.Count > 0;}
}//或者也可以使用ExecuteScalar扩展方法
public bool Login(string userName, string password)
{using (var conn = new SqlConnection(CONNECT_STRING)){string sql = "select count(*) from [dbo].[User] where UserName=@UserName and Password=@Password";//ExecuteScalar<>方法用于执行返回标量类型的sql语句如count(*)返回的就是标量值int count  = conn.ExecuteScalar<int>(sql, new { UserName = userName, Password = password});return count > 0;}
}

四、Dapper的常用扩展库

看了以上案例,是不是觉得Dapper不就是一个执行SQL语句的帮助类,哪里是一个ORM?ORM不是应该可以减少开发人员手动编写SQL语句的工作量,提高开发效率吗?

对的,作为ORM的Dapper本身并没有带太多的功能,但是Dapper有很多扩展库(官方的和第三方的),使用这些扩展库可以自动映射对象到数据库表、自动生成CRUD操作语句、批量操作等。

Dapper的扩展库有:

  • Dapper.SimpleCRUD : 提供了一套CRUD方法,可以直接传对象,不用自己写SQL
  • Dapper.FluentMap : 提供了一套方法,可以实现实体类与数据库类型之间的映射
  • Dapper.FluentMap.Dommel : 使用Dapper进行CRUD操作变得更为简单
  • Dapper.Contrib : 是Dapper官方提供的扩展库,提供了一些实用的功能和扩展方法,使得在使用Dapper和数据库进行操作时更加方便和高效

五、用Dapper实现仓储模式

ASP.NET Core WebApi的项目中,我们可以用EF/EF Core来实现仓储模式,当然作为轻量级的ORM之王,Dapper也可以实现仓储模式;

下面我们将用Dapper和他的扩展组件Domel来封装仓储模式;

  1. 在基础设施层,NuGet包里面添加Dapper和Dapper.FluentMap.Dommel
    安装Dommel

  2. 用工厂模式和单例模式,来创建一个DapperFactory工厂类,实现灵活切换MySql和SqlServer,后续还可以支持更多数据库

    //需要引用一下命名空间
    using System.Data;
    using MySql.Data.MySqlClient;
    using Microsoft.Extensions.Configuration;
    using Microsoft.Extensions.Configuration.Json;
    using System.Data.SqlClient;/// <summary>
    /// Dapper实例(采用单例模式)
    /// </summary>
    public class DapperFactory
    {/// <summary>/// 读取配置文件用/// </summary>private IConfiguration Configuration { get; set; }// 静态变量保存类的实例    private static DapperFactory uniqueInstance;// 定义一个标识确保线程同步     private static readonly object locker = new object();/// <summary>/// 私有构造方法,使外界不能创建该类的实例,以便实现单例模式/// </summary>private DapperFactory(){Configuration = new ConfigurationBuilder().Add(new JsonConfigurationSource{Path = "appsettings.json",ReloadOnChange = true}).Build();}/// <summary>/// 获取实例,这里为单例模式,保证只存在一个实例/// </summary>/// <returns></returns>public static DapperFactory GetInstance(){// 双重锁定实现单例模式,在外层加个判空条件主要是为了减少加锁、释放锁的不必要的损耗if (uniqueInstance == null){lock (locker){if (uniqueInstance == null){uniqueInstance = new DapperFactory(); //懒汉模式}}}return uniqueInstance;}/// <summary>/// 创建数据库连接对象(采用了设计模式 之 简单工厂模式)/// </summary>/// <returns></returns>public IDbConnection CreateDbConnection(){IDbConnection dbConnection = null;//读取配置文件中的数据库服务器类型 mysql或sqlserverstring dbType = Configuration["DbServerType"];//读取配置文件中的连接字符串string _connectionString = Configuration.GetConnectionString("Default");switch (dbType){case "MySql":dbConnection = new MySqlConnection(_connectionString);break;case "SqlServer":dbConnection = new SqlConnection(_connectionString);break;}//判断连接状态(Dapper内部会自动打开数据库连接,所以无需以下下代码)//if (dbConnection.State == ConnectionState.Closed)//{//    dbConnection.Open();//}return dbConnection;}
    }
    
  3. 编写泛型仓储接口

    using Dommel; //该库为Dapper扩展了CRUD方法/// <summary>
    /// 仓储抽象基类
    /// </summary>
    /// <typeparam name="T"></typeparam>
    public abstract class BaseRepository<T>: IBaseRepository<T> where T:class, new()
    {//获取数据库连接对象  DapperSingleton这个类是第2步写的protected IDbConnection _db = DapperFactory.GetInstance().CreateDbConnection();/// <summary>/// 添加一条实体数据/// </summary>/// <param name="entity"></param>/// <returns></returns>public int Insert(T entity) {return (int)_db.Insert(entity); }/// <summary>///  更新实体数据/// </summary>/// <param name="entity"></param>/// <returns></returns>public bool Update(T entity){return _db.Update(entity);}/// <summary>/// 删除数据/// </summary>/// <param name="entity">实体类</param>/// <returns></returns>public bool Delete(T entity){return _db.Delete(entity);}/// <summary>///  删除指定ID的数据/// </summary>/// <param name="objId"></param>/// <returns></returns>public bool DeleteById(object objId){return Delete(_db.Get<T>(objId));}/// <summary>/// 根据主值查询单条数据/// </summary>/// <param name="objId">主键值</param>/// <returns>泛型实体</returns>public T GetById(object objId){return _db.Get<T>(objId);}/// <summary>/// 获取全部数据/// </summary>/// <returns></returns>public List<T> GetList(){return _db.GetAll<T>().ToList();}}
    
  4. 在appsettings.json中配置你要用的数据库和连接字符串

      "ConnectionStrings": {"Default": "server=127.0.0.1;database=superhousedb;user=root;password=root"},"DbServerType": "MySql" //MySql数据库 或  SqlServer
    

以上,借助Dapper扩展Domel是不是就能实现不用写SQL语句就能实现增删改查了??
好,今天就分享到这里,更多高级用法以后有机会再分享。如果本文对你有帮助的话,请点赞+评论+关注,或者转发给需要的朋友。


参考链接:

Dapper官网

这篇关于用轻量级ORM--Dapper实现泛型仓储的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/550660

相关文章

使用animation.css库快速实现CSS3旋转动画效果

《使用animation.css库快速实现CSS3旋转动画效果》随着Web技术的不断发展,动画效果已经成为了网页设计中不可或缺的一部分,本文将深入探讨animation.css的工作原理,如何使用以及... 目录1. css3动画技术简介2. animation.css库介绍2.1 animation.cs

Java进行日期解析与格式化的实现代码

《Java进行日期解析与格式化的实现代码》使用Java搭配ApacheCommonsLang3和Natty库,可以实现灵活高效的日期解析与格式化,本文将通过相关示例为大家讲讲具体的实践操作,需要的可以... 目录一、背景二、依赖介绍1. Apache Commons Lang32. Natty三、核心实现代

SpringBoot实现接口数据加解密的三种实战方案

《SpringBoot实现接口数据加解密的三种实战方案》在金融支付、用户隐私信息传输等场景中,接口数据若以明文传输,极易被中间人攻击窃取,SpringBoot提供了多种优雅的加解密实现方案,本文将从原... 目录一、为什么需要接口数据加解密?二、核心加解密算法选择1. 对称加密(AES)2. 非对称加密(R

基于Go语言实现Base62编码的三种方式以及对比分析

《基于Go语言实现Base62编码的三种方式以及对比分析》Base62编码是一种在字符编码中使用62个字符的编码方式,在计算机科学中,,Go语言是一种静态类型、编译型语言,它由Google开发并开源,... 目录一、标准库现状与解决方案1. 标准库对比表2. 解决方案完整实现代码(含边界处理)二、关键实现细

python通过curl实现访问deepseek的API

《python通过curl实现访问deepseek的API》这篇文章主要为大家详细介绍了python如何通过curl实现访问deepseek的API,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编... API申请和充值下面是deepeek的API网站https://platform.deepsee

SpringBoot实现二维码生成的详细步骤与完整代码

《SpringBoot实现二维码生成的详细步骤与完整代码》如今,二维码的应用场景非常广泛,从支付到信息分享,二维码都扮演着重要角色,SpringBoot是一个非常流行的Java基于Spring框架的微... 目录一、环境搭建二、创建 Spring Boot 项目三、引入二维码生成依赖四、编写二维码生成代码五

MyBatisX逆向工程的实现示例

《MyBatisX逆向工程的实现示例》本文主要介绍了MyBatisX逆向工程的实现示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学... 目录逆向工程准备好数据库、表安装MyBATisX插件项目连接数据库引入依赖pom.XML生成实体类、

C#实现查找并删除PDF中的空白页面

《C#实现查找并删除PDF中的空白页面》PDF文件中的空白页并不少见,因为它们有可能是作者有意留下的,也有可能是在处理文档时不小心添加的,下面我们来看看如何使用Spire.PDFfor.NET通过C#... 目录安装 Spire.PDF for .NETC# 查找并删除 PDF 文档中的空白页C# 添加与删

Java实现MinIO文件上传的加解密操作

《Java实现MinIO文件上传的加解密操作》在云存储场景中,数据安全是核心需求之一,MinIO作为高性能对象存储服务,支持通过客户端加密(CSE)在数据上传前完成加密,下面我们来看看如何通过Java... 目录一、背景与需求二、技术选型与原理1. 加密方案对比2. 核心算法选择三、完整代码实现1. 加密上

Java使用WebView实现桌面程序的技术指南

《Java使用WebView实现桌面程序的技术指南》在现代软件开发中,许多应用需要在桌面程序中嵌入Web页面,例如,你可能需要在Java桌面应用中嵌入一部分Web前端,或者加载一个HTML5界面以增强... 目录1、简述2、WebView 特点3、搭建 WebView 示例3.1 添加 JavaFX 依赖3