Dapper ORM 使用教程

最新推荐文章于 2023-08-02 09:03:34 发布
最新推荐文章于 2023-08-02 09:03:34 发布
阅读量1.4k 收藏 5
点赞数
分类专栏： Microsoft .Net 文章标签： winform
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/stone0823/article/details/107837493
版权

Dapper 是一个开源的、轻量级的 ORM 框架，性能出色，关于它的特点不必多说，网上到处都是。个人比较喜欢它基于 SQL 语句的方式。本博文讲解 Dapper 的用法。

开发环境：

  • Microsoft Visual Studio Community 2019
  • Database: SQL Server 2019 Express

Dapper 的安装

新建一个 Class Library 项目，通过菜单： Tools -> NuGet Package Manager -> Manage NuGet packages for Solution，打开 第三方 package 的浏览界面，在搜索框中输入 Dapper，选中右边的项目，然后点击 Install 按钮即可以安装。

准备数据

本文的示例数据是通过 https://mockaroo.com/ 网站提供的模拟数据生成。我利用该网站生成了 employees 表的模拟数据，并且将创建表的 SQL 语句和创建模拟数据的 SQL 语句下载为 sql 脚本。示例数据我将和本文的源码一起上传到 Github，供小伙伴们参考。emp_master 表结构如下：

CREATE TABLE emp_master(
	[EMP_ID] [int] NOT NULL,
	[GENDER] [varchar](10) NULL,
	[AGE] [int] NULL,
	[EMAIL] [varchar](50) NULL,
	[PHONE_NR] [varchar](20) NULL,
	[EDUCATION] [varchar](20) NULL,
	[MARITAL_STAT] [varchar](20) NULL,
	[NR_OF_CHILDREN] [int] NULL,
	CONSTRAINT pk_employee primary key(EMP_ID));

连接字符串

在 .Net 平台编写数据库程序，都需要针对不同数据库的连接字符串，我使用的是 sql server express，连接字符串如下，sql server 其它版本类似。

private String connStr = @"Server=localhost\sqlexpress;Database=stonetest;Integrated Security=True;";

// 使用用户名和密码连接
private String connStr = @"Server=localhost\sqlexpress;Database=stonetest;uid=sa;pwd=123456;";

Domain 类

在项目中新建一个 Employee 类，将表的字段映射为属性：

namespace EmployeeMgr.Domain
{
    public class Employee
    {
        public int EMP_ID { get; set; }
        public String GENDER { get; set; }
        public int AGE { get; set; }
        public String EMAIL { get; set; }
        public String PHONE_NR { get; set; }
        public String EDUCATION { get; set; }
        public String MARITAL_STAT { get; set; }
        public int NR_OF_CHILDREN { get; set; }

        public Employee ShallowCopy()
        {
            return (Employee)this.MemberwiseClone();
        }
    }
}

使用 Dapper 实现 CRUD

新建 EmployeeDao 类，在类中实现 CRUD 操作。ListAll() 方法：

public List<Employee> ListAll()
{
    String sql = "select * from emp_master order by emp_id";
    using (IDbConnection db = new SqlConnection(connStr)) {                
        var emps = db.Query<Employee>(sql);
        return emps.ToList();
    }
}
  • 方法返回 List 的泛型接口，这是一个常规的处理方式，展示层可以直接将控件绑定到 List<T>
  • IDbConnection 是 Ado.Net 的接口类型，Dapper 的方法都是基于 IDbConnection 接口类型实现了扩展方法
  • 本例后台数据库为 sql server/sql server express，所以实际的连接对象为 System.Data.SqlClient.SqlConnection 对象
  • IDbConnection 的 Query<T>() 方法，返回值类型为 IEnumerable<T>, 通过 ToList() 方法转换为 List<T>。

其它方法：

public int Insert(Employee emp)
{
    String sql = $@"insert into emp_master
                        (EMP_ID, GENDER, AGE, EMAIL, EDUCATION, PHONE_NR, MARITAL_STAT, NR_OF_CHILDREN) 
                        values(@EMP_ID, @GENDER, @AGE, @EMAIL, @EDUCATION, 
                        @PHONE_NR, @MARITAL_STAT, @NR_OF_CHILDREN)";
    using (IDbConnection db = new SqlConnection(connStr)) { 
        return db.Execute(sql, emp);
    }
}

public int Update(Employee emp)
{
    String sql = $@"update emp_master 
                        set gender=@gender, 
                        age=@age,
                        email=@email, 
                        education=@education,
                        phone_nr=@phone_nr, 
                        marital_stat=@marital_stat
                        where emp_id=@emp_id";
    using (IDbConnection db = new SqlConnection(connStr)) {                
        return db.Execute(sql, emp);
    }
}

public int Delete(int empId)
{
    var sql = "delete from emp_master where emp_id=@emp_id";
    using (IDbConnection db = new SqlConnection(connStr)) {
        var parameters = new { emp_id = empId };                
        return db.Execute(sql, parameters);
    }
}

我们注意到，在这些方法中，插入和修改都是传入一个 Employee 对象，Dapper 自动在对象中找到匹配的属性，将其作为 sql 语句的参数值，极大减少了开发人员的手工代码。规则是要求 entity 类的属性名称与参数名称相同。

单元测试

创建一个 Unit Test Project，编写如下测试代码，测试 CRUD 功能：

namespace UnitTest1
{
    [TestClass]
    public class DapperCrudTest
    {
        private EmployeeDao empDao;

        public DapperCrudTest()
        {
            empDao = new EmployeeDao();
        }

        [TestMethod]
        public void TestListAll()
        {
            var employees = empDao.ListAll();

            foreach (var emp in employees) {
                Console.WriteLine(String.Format("{0}, {1}", emp.EMP_ID, emp.EMAIL));
            }
        }

        [TestMethod]
        public void TestFindByName()
        {
            var employees = empDao.FindByName("Sh");
            foreach (var emp in employees) {
                Console.WriteLine($"{ emp.EMP_ID } { emp.EMAIL }");
            }
        }

        [TestMethod]
        public void TestFindById()
        {
            Employee emp = empDao.FindById(1001);
            Console.WriteLine($"{ emp.EMP_ID } { emp.EMAIL }");
        }

        [TestMethod]
        public void TestInsert()
        {
            var emp = new Employee
            {
                EMP_ID = 9002,
                GENDER = null,
                AGE = 19,
                EMAIL = "test@qq.com",
                PHONE_NR = "13800-138000",
                EDUCATION = "Bachelor",
                MARITAL_STAT = "Single",
                NR_OF_CHILDREN = 0
            };

            int rv = empDao.Insert(emp);
            Console.WriteLine(rv);
        }

        [TestMethod]
        public void TestUpdate()
        {
            var emp = new Employee
            {
                EMP_ID = 9002,
                GENDER = "Male",
                AGE = 21,
                EMAIL = "test@qq.com",
                PHONE_NR = "13800-138000",
                EDUCATION = "Bachelor",
                MARITAL_STAT = "Single",
                NR_OF_CHILDREN = 0
            };

            int rv = empDao.Update(emp);
            Assert.AreEqual(rv, 1);
        }

        [TestMethod]
        public void TestDelete()
        {
            int rv = empDao.Delete(9002);
            Assert.AreEqual(rv, 1);
        }
    }
}

WinForm 程序示例

接下来使用 WinForm 作界面，用两个 Form 来完成对 employee 表的 CRUD：EmpListForm 列示所有的 employees，使用 BindingNavigator 控件用于导航，基于 BindingSource 的方式实现数据绑定。

主要控件的属性设置说明：

bindingNavigator:

  • AddNewItem: 设置为 none，目的是取消控件的默认行为，用自己的代码来代替。
  • DeleteItem: 设置为 none，目的是取消控件的默认行为，用自己的代码来代替
  • Dock: Bottom，显示在表单的下方

bindingSource1:

  • Modifier: 默认为 private，更改为 public。目的是在不用的 Form 中，通过 bindingSource 实现表单记录同步，这是一种常用的方法，请参考本文的参考部分。

DataGridView:

  • Dock: Fill，让 DataGridView 填满表单。

以下是 EmpListForm 的代码：

namespace SqlSugarTest {
    public partial class EmpListForm : Form {
        private EmployeeRepository empRepo;

        public EmpListForm() {
            InitializeComponent();
            empRepo = new EmployeeRepository();
        }

        private void EmpListForm_Load(object sender, EventArgs e) {
            this.Text = "Employee Master";

            // Get employee list 
            List<Employee> emps = empRepo.ListAll();

            // Data binding
            bindingSource1.DataSource = emps;
            dataGridView1.DataSource = bindingSource1;
            bindingNavigator1.BindingSource = bindingSource1;
        }       

        private void bindingNavigatorDeleteItem_Click(object sender, EventArgs e) {
            // Execute deletion
            if (bindingSource1.Current == null) return;


            if (MessageBox.Show("确定删除此笔记录吗?", "删除确认",
                MessageBoxButtons.YesNo, MessageBoxIcon.Question) == DialogResult.Yes) {

                int empid = (bindingSource1.Current as Employee).EMP_ID;
                int count = empRepo.Delete(empid);
                if (count > 0) {
                    bindingSource1.RemoveCurrent(); // 从数据库删除后保持界面同步
                }
            }
        }

        private void dataGridView1_CellDoubleClick(object sender, DataGridViewCellEventArgs e) {
            // Open sinle form
            var singleForm = new EmpSingleForm(this.bindingSource1, 2);
            singleForm.Show();
        }

        private void bindingNavigatorAddNewItem_Click(object sender, EventArgs e) {
            bindingSource1.AddNew();
            var singleForm = new EmpSingleForm(this.bindingSource1, 1);
            singleForm.Show();
        }
    }
}

新建 EmpSingleForm，设计时界面如下：


该表单的完整代码：

namespace SqlSugarTest {
    public partial class EmpSingleForm : Form {
        private EmployeeRepository empRepo;
        private int actionType;         // 1: insert, 2: update
        private Employee empForRestore; // 用于用户点击取消的时候恢复到之前状态

        public EmpSingleForm() {
            InitializeComponent();

            empRepo = new EmployeeRepository();            
        }

        public EmpSingleForm(BindingSource bs, int actionType) : this() {
            this.bindingSource1 = bs;
            this.actionType = actionType;
        }

        private void SetBinding() {
            // data binding
            txtEmpID.DataBindings.Add("Text", bindingSource1, "EMP_ID", true);
            cboSex.DataBindings.Add("Text", bindingSource1, "GENDER", true);
            txtAge.DataBindings.Add("Text", bindingSource1, "AGE", true);
            txtEMail.DataBindings.Add("Text", bindingSource1, "EMAIL", true);
            txtPhone.DataBindings.Add("Text", bindingSource1, "PHONE_NR", true);
            txtEducation.DataBindings.Add("Text", bindingSource1, "EDUCATION", true);
            txtMaritalStat.DataBindings.Add("Text", bindingSource1, "MARITAL_STAT", true);
            txtNumOfChildren.DataBindings.Add("Text", bindingSource1, "NR_OF_CHILDREN", true);
        }

        private void Backup() {
            var old = empForRestore = this.bindingSource1.Current as Employee;
            empForRestore = old.ShallowCopy();
        }

        private void CancelUpdate()
        {
            if (empForRestore == null) return;
            var current = bindingSource1.Current as Employee;
            current.EMP_ID = empForRestore.EMP_ID;
            current.AGE = empForRestore.AGE;
            current.EDUCATION = empForRestore.EDUCATION;
            current.EMAIL = empForRestore.EMAIL;
            current.GENDER = empForRestore.GENDER;
            current.MARITAL_STAT = empForRestore.MARITAL_STAT;
            current.NR_OF_CHILDREN = empForRestore.NR_OF_CHILDREN;
            current.PHONE_NR = empForRestore.PHONE_NR;

            bindingSource1.ResetBindings(false);
        }

        private void SaveUpdate()
        {
            var employee = bindingSource1.Current as Employee;
            empRepo.Update(employee);
        }

        private void SaveInsert()
        {
            var employee = bindingSource1.Current as Employee;
            empRepo.Insert(employee);
        }


        private void btnSave_Click(object sender, EventArgs e) {
            try {
                if (actionType == 1) {
                    SaveInsert();
                }else if(actionType == 2) {
                    SaveUpdate();
                }
            }
            catch (Exception ex) {
                MessageBox.Show(ex.Message);
            }

            this.Close();
        }
               
        private void btnCancel_Click(object sender, EventArgs e) {
            CancelUpdate();
            this.Close();
        }

        private void EmpSingleForm_Load(object sender, EventArgs e)
        {
            this.SetBinding();
            this.Backup();
        }
    }
}

源码

github - dotnet_practice_projects/Data Access Model/DotNet-Data-Access-Model

参考

stone0823
关注
  • 0
    点赞
  • 踩
  • 5
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
【Dapper封装类】
08-16
Dapper封装类，对dapper的增删查改和存储过程进行封装
Dapper - 微型 ORM 之王 (C#.NET)
ruanjimu的博客
02-16 409
ORM 直接将数据库与 C# 对象映射的对象关係映射器。 有许多可用的 ORM 工具。其中之一是 Dapper。Dapper 被称为 ORM 之王。 以下是 Dapper 的主要功能： 速度快，性能快。 更少的代码行。 对象映射器。 静态对象绑定。 动态对象绑定。 轻松处理 SQL 查询。 易于处理存储过程。 直接对 IDBConnection 类进行操作，该类提供平滑性并直接对数据库运行查询，而不是像我们在 EF 和..
Dappers : 基于Dapper.net 扩展的Dao
angzhijian7003的博客
09-28 100
某天在园里看到Dapper.net , 终于发现找到我一致梦寐的 OM (Object Mapping) (某人,你知道的....). 从Java到.Net , 从spring.net 0.6 到 spring.net 1.3.2 , 一直在使用Hibernate, 但这个 ORM - Relation 处理却一直被我唾弃. 如今终于如愿以偿,...
ibatis的sqlmap.xml中id可以传入一个参数_C# 数据操作系列 - 17 Dapper ——号称可以与ADO.NET 同台飙车的ORM...
weixin_39902875的博客
11-27 102
0. 前言 之前四篇介绍了一个国内开发者开发的优秀框架SqlSugar，给我们眼前一亮的感觉。这一篇，我们将试试另一个出镜率比较高的ORM框架-Dapper。 Dapper是一个轻量级的ORM框架，其以高速、简单易用为特点。在某些时候，效率甚至可以与http://ADO.NET 媲美。那么，吹得天花乱坠，就让我们实际看看它的表现吧。 1. 开始使用 照例，先创建一个项目：DapperDemo do...
ORM框架 Dapper
你要明白，任何问题都不是孤立存在的，一定有人曾经遇到过，并且已经有更好的解决办法了，只是我还不知道。我不应该在黑暗中独自前行，去重新发明轮子，也许我的顿悟，只是别人的基本功！我应该要站在巨人的肩膀上，学习更成熟的经验和方法，然后再来解决这个问题
06-17 6110
一，介绍：Dapper是一款轻量级ORM工具。如果你在小的项目中，使用Entity Framework、NHibernate 来处理大数据访问及关系映射，未免有点杀鸡用牛刀。你又觉得ORM省时省力，这时Dapper 将是你不二的选择。 　　---ORM框架的核心思想是对象关系映射，ORM是将表与表之间的操作，映射成对象和对象之间的操作，就是通过操作实体类来达到操作表的目的。从数据库提取的数据会自动按你设置的映射要求封装成特定的对象。之后你就可以通过对对象进行操作来修改数据库中的数据。这时候你面对的不是信息
Dapper入门
mwcxz的博客
11-17 6272
dapper如门
.Net使用Dapper框架(快速上手)
夜飞鼠的专栏
03-10 5850
在.net6快速使用Dapper，本文从Dapper的方法使用、参数、事务和存储过程等方法，提供Dapper框架的代码使用示例使我们快速便捷地使用该ROM框架。
C#实战：Dapper操作PostgreSQL笔记
IT技术分享社区
06-13 1716
它提供了许多功能，例如创建，修改和删除数据库，创建和管理表和索引，备份和恢复数据库，检查和修复错误等。它使用C语言编写，并提供了许多高级功能，例如复制，分区，事务，视图和索引等。数据库应用程序：PostgreSQL可用于构建各种类型的数据库应用程序，例如企业应用程序，电子商务应用程序和金融应用程序等。其他应用程序：PostgreSQL适用于各种应用程序和场景，例如医疗保健，物流，教育和政府等。：PostgreSQL提供了多种安全措施，例如用户身份验证，数据加密和备份，以确保数据安全。
加速开发！C#高效数据库操作库——Dapper
最新发布
MrQinin的博客
08-02 1371
Dapper是C#中的轻量级ORM（对象关系映射）库，它由Stack Overflow开发团队创建。Dapper允许开发人员直接执行SQL查询，将查询结果映射到.NET对象中，避免了繁琐的手动数据映射工作。
以下是一些常用Dapper拓展框架的调用例子：
qq_41320744的博客
04-28 225
Dapper各个拓展
ORM-Dapper
06-29
纯手工搭建的基于Dapper实现的ORM框架，支持三种数据库访问，只需要在UI层的配置文件中，配置一下数据库连接即可切换数据库类型，不需要改任何框架中提供的类，工具类的增删改查已经写好，也测试成功，并且支持事务处理。在这里奉献了。
Dapper源码-ORM
03-04
SqlMapper.cs简洁明了,Dapper的源码直接拉项目中使用,特别方便，喜欢可以下载。 十分轻量，便于集成
.netCore ORM之Dapper.zip
06-09
基于.netcore 的orm框架封装，dapper
ORM-Dapper示例全代码
04-14
ORM-Dapper示例全代码,可以在基础上继续开发，里面包括ORM框架，有model，有service，仓储层。可以学习，可以在此框架上修改开发。
ORM-Dapper+DapperExtensions 示例全代码
02-26
ORM-Dapper+DapperExtensions 示例全代码
Dapper.net 入门demo 轻量级ORM框架
weixin_33674976的博客
03-30 244
1、conn(DAO)项目引用Dapper.dll (测试版本1.50.2.0) 　2、StudentDAO.cs 代码附上 public class StudentDAO { public List<StudentModel> SearchStudentList() { List<Stude...
Java笔记
ACTYQW的博客
10-07 365
Java笔记 文章目录Java笔记前言 前言 没来得及整理的一些琐碎的知识 提示：以下是本篇文章正文内容，下面案例可供参考 size()是获取泛型集合的长度 length是获取数组的长度 length()是获取字符串的长度。 类是public的，那么文件名要和类名一致。不是public类的可以不一致（建议一致）。 一个java的源程序中可以包含多个类，但只能有一个public的类 类的命名规则：大驼峰 每个单词的首字母大写 HelloWorld Test Student 方法命名规则：从第二个单词
Dapper ORM 用法
weixin_30613433的博客
08-13 299
假如你喜欢原生的Sql语句，又喜欢ORM的简单，那你一定会喜欢上Dapper这款ROM.点击下载 Dapper的优势： 1，Dapper是一个轻型的ORM类。代码就一个SqlMapper.cs文件，编译后就40K的一个很小的Dll. 2，Dapper很快。Dapper的速度接近与IDataReader，取列表的数据超过了DataTable。 3，Dapper支持什么数据库。Dapper支持...
NFT巨头Dapper Labs 收购 Brud，将重心转移到DAO上
weixin_44383880的博客
10-07 238
DAO是否能成为未来社会互动的主要形式？DapperLabs可能是这样认为的，近期该平台收购了初创公司Brud，将DAO作为了该公司的新业务部门。新的业务部门被命名为“DapperColl...
Dapper 使用方法
06-02
Dapper 是一个轻量级的 ORM 框架，使用起来非常简单。下面是一个使用 Dapper 查询数据的示例： 1. 首先，需要在项目中引入 Dapper 库。可以通过 NuGet 包管理器安装 Dapper。 2. 然后，在代码中使用以下语句引入 Dapper 命名空间： ```csharp using Dapper; ``` 3. 接下来，可以使用 Dapper 提供的 `SqlConnection` 类来连接数据库。例如： ```csharp var connectionString = "Data Source=myserver;Initial Catalog=mydatabase;User ID=myusername;Password=mypassword;"; using (var connection = new SqlConnection(connectionString)) { // ... } ``` 4. 在 `SqlConnection` 对象中，可以使用 `Query` 方法来执行查询操作。例如： ```csharp var sql = "SELECT * FROM Customers WHERE Country = @Country"; var customers = connection.Query<Customer>(sql, new { Country = "USA" }); ``` 上面的代码将查询所有国家为 USA 的客户，并将结果映射到 `Customer` 类型的对象列表中。 在查询语句中，可以使用命名参数来传递参数。Dapper 会自动将参数转换为 SQL 参数，从而防止 SQL 注入攻击。 5. 可以使用 `Execute` 方法来执行更新、插入和删除操作。例如： ```csharp var sql = "UPDATE Customers SET Name = @Name WHERE Id = @Id"; var affectedRows = connection.Execute(sql, new { Id = 1, Name = "John" }); ``` 上面的代码将更新 Id 为 1 的客户的名称为 John。 这只是 Dapper 的一些基本用法，Dapper 还提供了许多其他功能，如事务处理、存储过程调用等。需要了解更多信息，请查看 Dapper 的文档。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值