简介

NPoco 是 PetaPoco 的一个分支,具有一些额外的功能,截至现在 github 星数 839。NPoco 中文资料没多少,我是被博客园群友推荐的,这几天简单尝试了一下:

github: https://github.com/schotime/NPoco

wiki: https://github.com/schotime/NPoco/wiki

NPoco 支持多种数据库系统,包括但不限于以下几种:

  • Microsoft SQL Server
  • SQLite
  • MySQL
  • PostgreSQL
  • Oracle
  • Firebird
  • DB2
  • SQL CE (SQL Compact Edition)

快速入门

本文使用SQLite数据库作为示例,创建一个控制台项目,尝试一些简单的用法。

安装 NuGet 包

对于使用 NPoco 和 SQLite 的情况,只需要安装两个 NuGet 包:

  • NPoco - 这是 NPoco ORM 的核心库。
  • System.Data.SQLite 或 Microsoft.Data.Sqlite - 这是用于连接 SQLite 数据库的 ADO.NET 提供程序。

选择 System.Data.SQLite 或 Microsoft.Data.Sqlite 主要取决于正在使用的 .NET 平台:

  • .NET Core 3.1 或 .NET 5/6/7 的项目选择 Microsoft.Data.Sqlite
  • .NET Framework 或早期的 .NET Core 版本的项目选择 System.Data.SQLite

这里使用 Microsoft.Data.Sqlite ,NuGet 包安装如下:

实体类User

新建一个实体类 User ,并定义实体类和字段的映射关系,参考 官方文档 Mapping

  1. //为了演示 TableName、Column ,表名和列名故意和实体类的属性名设置的不同
  2. [TableName("Users")]
  3. [PrimaryKey("UserId", AutoIncrement = true)]
  4. public class User
  5. {
  6. public int UserId { get; set; }
  7. [Column("Email")]
  8. public string UserEmail { get; set; }
  9. [ComputedColumn]
  10. public DateTime CreateTime{ get; set; }
  11. [ComputedColumn]
  12. public DateTime UpdateTime { get;set; }
  13. // 重写 ToString 方法,打印实体类信息
  14. public override string ToString()
  15. {
  16. //SQLite存储日期和时间的方式是以UTC(协调世界时)为基准的,打印时需要转换成本地时间
  17. return $"UserId: {UserId}, " +
  18. $"Email: {UserEmail}," +
  19. $" CreatedTime: {CreateTime.ToLocalTime()}," +
  20. $" UpdateTime: {UpdateTime.ToLocalTime()}";
  21. }
  22. }

上面用到的 TableName、PrimaryKey、Column 特性根据字面意思很容易理解,需要特别注意 ComputedColumn 相关的三个特性:

  • [Ignore] :此属性将被忽略,并且无法映射到此属性,可以定义一些跟数据库无关但业务需要的属性。
  • [ResultColumn] :可以映射到标有 ResultColumn 列的属性,但这些属性不会包含在插入或更新中。需要在 SQL 中显式指定这些列,它不会包含在自动生成的 SQL 中
  • [ComputedColumn] :具有 Computed 列属性的属性的工作方式与 Result 列属性相同,但是它们将在 SQL 中自动选择

数据库类DbFactory

定义一个 DbFactory 类管理连接字符串和数据库实例,映射部分请参考 基于 Fluent / Convention 的映射

  1. public static class DbFactory
  2. {
  3. private static DatabaseFactory dbFactory;
  4. public static Database GetDatabase()
  5. {
  6. return dbFactory.GetDatabase();
  7. }
  8. static DbFactory()
  9. {
  10. dbFactory = DatabaseFactory.Config(x =>
  11. {
  12. // 也可以在这里配置实体的映射关系
  13. x.UsingDatabase(() => new Database(
  14. "Data Source=mydatabase.db;",
  15. DatabaseType.SQLite,
  16. SqliteFactory.Instance)
  17. );
  18. });
  19. InitDB();
  20. }
  21. static void InitDB()
  22. {
  23. // 创建数据库文件
  24. File.Create("mydatabase.db").Close();
  25. // 创建表
  26. using (IDatabase db = dbFactory.GetDatabase())
  27. {
  28. db.Execute(@"
  29. -- 创建Users表
  30. CREATE TABLE IF NOT EXISTS Users (
  31. UserId INTEGER PRIMARY KEY AUTOINCREMENT,
  32. Email TEXT,
  33. CreateTime TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
  34. UpdateTime TIMESTAMP DEFAULT CURRENT_TIMESTAMP
  35. );
  36. -- 创建触发器,在Users 表上的数据更新后自动更新 UpdateTime 字段
  37. CREATE TRIGGER IF NOT EXISTS update_user_time
  38. AFTER UPDATE OF Email, CreateTime ON Users
  39. BEGIN
  40. UPDATE Users SET UpdateTime = CURRENT_TIMESTAMP WHERE rowid = NEW.rowid;
  41. END;"
  42. );
  43. }
  44. }
  45. }

SQLite 并不直接支持在列定义中使用 ON UPDATE 语法,需要创建一个触发器在 Users 表上更新操作发生时自动更新 UpdateTime 字段。触发器触发时为了避免重新触发自身(递归触发),触发器要仅在 UpdateTime 之外的字段被更新时才触发

增删改查

下面演示一下 Insert、Update、Delete、Query 等操作,简单的项目完全够用了,主程序如下:

  1. static void Main(string[] args)
  2. {
  3. Insert();
  4. Select();
  5. Thread.Sleep(3000);
  6. Update();
  7. Delete();
  8. }

Insert

创建一个 Insert 方法,实现单次插入和批量插入:

  1. static void Insert()
  2. {
  3. using (IDatabase db = DbFactory.GetDatabase())
  4. {
  5. Console.WriteLine("单次插入:");
  6. var user = new User { UserEmail = $"test@example.com" };
  7. db.Insert(user);
  8. Console.WriteLine(user.ToString());
  9. Console.WriteLine("批量插入:");
  10. List<User> users = new List<User>();
  11. for (int i = 0; i < 5; i++)
  12. {
  13. user = new User { UserEmail = $"test{i}@example.com" };
  14. users.Add(user);
  15. }
  16. var count = db.InsertBatch(users);
  17. Console.WriteLine($"批量插入 {count} 条记录");
  18. Console.WriteLine();
  19. }
  20. }

Select

创建一个 Select 方法,实现常见的查询方法:

  1. static void Select()
  2. {
  3. using (IDatabase db = DbFactory.GetDatabase())
  4. {
  5. Console.WriteLine("查询所有用户:");
  6. var users = db.Fetch<User>();
  7. users.ForEach(user => Console.WriteLine(user.ToString()));
  8. Console.WriteLine("使用SQL语句查询:");
  9. //下面两种方式都可以
  10. users = db.Query<User>("SELECT * FROM Users WHERE Email LIKE @0", "%@example.com").ToList();
  11. users = db.Query<User>("WHERE Email LIKE @0", "%@example.com").ToList();
  12. users.ForEach(user => Console.WriteLine(user.ToString()));
  13. Console.WriteLine("使用LINQ语句查询ID大于1的用户,并按ID排序:");
  14. //推荐用法LINQ语句查询
  15. users = db.Query<User>()
  16. .Where(x => x.UserId > 1)
  17. .OrderBy(x => x.UserId)
  18. .ToList();
  19. users.ForEach(user => Console.WriteLine(user.ToString()));
  20. Console.WriteLine("通过ID查询单个用户:");
  21. //SingleById还有很多变体,这里不在单独举例
  22. var user = db.SingleOrDefaultById<User>(1);
  23. Console.WriteLine(user.ToString());
  24. Console.WriteLine();
  25. }
  26. }

注意:如果找不到记录,SingleById()方法会抛出异常,而 SingleOrDefaultById() 方法会返回 null,推荐使用 SingleOrDefaultById() 方法

Update

创建一个 Update 方法,实现单个用户更新和批量更新:

  1. static void Update()
  2. {
  3. using (IDatabase db = DbFactory.GetDatabase())
  4. {
  5. Console.WriteLine("更新单个用户:");
  6. var user = db.SingleById<User>(1);
  7. user.UserEmail = "updated@example.com";
  8. db.Update(user);
  9. Console.WriteLine(db.SingleById<User>(1).ToString());
  10. Console.WriteLine("批量更新 ID > 3 的用户:");
  11. var users = db.Query<User>()
  12. .Where(x => x.UserId > 3).ToList()
  13. .Select(x => UpdateBatch.For(x, db.StartSnapshot(x))).ToList()
  14. .Select(x => { x.Poco.UserEmail = "updated@example.com"; return x; })
  15. .ToList();
  16. db.UpdateBatch(users, new BatchOptions { BatchSize = 50 });
  17. db.Fetch<User>().ForEach(user => Console.WriteLine(user.ToString()));
  18. Console.WriteLine();
  19. }
  20. }

注意:关于 UpdateBatch 方法的使用,官方文档没有详细说明,使用方法可以参考 UpdateTests

Delete

创建一个 Delete 方法,实现单个用户删除和批量删除:

  1. static void Delete()
  2. {
  3. using (IDatabase db = DbFactory.GetDatabase())
  4. {
  5. Console.WriteLine("删除单个用户:");
  6. var user = db.SingleById<User>(1);
  7. db.Delete(user);
  8. Console.WriteLine($"删除用户 {user.ToString()} 成功");
  9. Console.WriteLine("使用SQL构造器删除 Id > 4 的:");
  10. var sql = new Sql();
  11. sql.Append("DELETE FROM Users WHERE UserId > @0", 4);
  12. var count=db.Execute(sql);
  13. Console.WriteLine($"删除 {count} 条记录");
  14. Console.WriteLine("使用SQL语句删除 Id > 3 的:");
  15. count = db.Delete<User>("WHERE UserId > @0", 3);
  16. Console.WriteLine($"删除 {count} 条记录");
  17. }
  18. }

总结

一些简单功能上手比较容易,代码侵入性也比较小。复杂一点的功能上手比较难,因为中文资料少、官方文档也有点落后。

一般的小项目或者小功能模块可以使用NPoco,大项目还是建议使用国产的FreeSQLSqlSugar

C# 轻量级 ORM 框架 NPoco 的简单应用的更多相关文章

  1. c# 轻量级ORM框架 实现(一)

    发布一个自己写的一个轻量级ORM框架,本框架设计期初基于三层架构.所以从命名上来看,了解三层的朋友会很好理解. 设计该框架的目的:不想重复的写增删改查,把精力放到功能实现上. 发布改框架的原因:希望给 ...

  2. 轻量级ORM框架 QX_Frame.Bantina(二、框架使用方式介绍)

    轻量级ORM框架QX_Frame.Bantina系列讲解(开源) 一.框架简介 http://www.cnblogs.com/qixiaoyizhan/p/7417467.html 二.框架使用方式介 ...

  3. 轻量级ORM框架 QX_Frame.Bantina(一、框架简介)

    轻量级ORM框架QX_Frame.Bantina系列讲解(开源) 一.框架简介 http://www.cnblogs.com/qixiaoyizhan/p/7417467.html 二.框架使用方式介 ...

  4. .NET轻量级ORM框架Dapper入门精通

    一.课程介绍 本次分享课程包含两个部分<.NET轻量级ORM框架Dapper修炼手册>和<.NET轻量级ORM框架Dapper葵花宝典>,阿笨将带领大家一起领略轻量级ORM框架 ...

  5. C# 性能优化 之 秒表 Stopwatch。 Dapper一个和petapoco差不多的轻量级ORM框架

    Sweet小马 小马同学的编程日记. C# 性能优化 之 秒表 Stopwatch. 生词解释:Diagnostics[,daɪəg'nɑstɪks] n.诊断学 using System.Diagn ...

  6. 轻量级ORM框架初探-Dapper与PetaPoco的基本使用

    一.EntityFramework EF是传统的ORM框架,也是一个比较重量级的ORM框架.这里仍然使用EF的原因在于为了突出轻量级ORM框架的性能,所谓有对比才有更优的选择. 1.1 准备一张数据库 ...

  7. 轻量级ORM框架Dapper应用一:Dapper安装

    一.Dapper简介 Dapper是一款轻量级ORM框架,为解决网站访问流量极高而产生的性能问题而构造,主要通过执行TSQL表达式而实现数据库的CQRS. 如果你在项目中遇到性能访问问题,选择Dapp ...

  8. 分享自己写的基于Dapper的轻量级ORM框架~

    1.说明 本项目是一个使用.NET Standard 2.0开发的,基于 Dapper 的轻量级 ORM 框架,包含基本的CRUD以及根据表达式进行一些操作的方法,目前只针对单表,不包含多表连接操作. ...

  9. c# 轻量级 ORM 框架 之 Model解析 (四)

    关于orm框架设计,还有必要说的或许就是Model解析了,也是重要的一个环节,在实现上还是相对比较简单的. Model解析,主要用到的技术是反射了,即:把类的属性与表的字段做映射. 把自己的设计及实现 ...

  10. 轻量级ORM框架 Bankinate

    [前言] 前面讲过ORM的前世今生,对ORM框架不了解的朋友可以参考博文:https://www.cnblogs.com/7tiny/p/9551754.html 今天,我们主要通过设计一款轻量级的O ...

随机推荐

  1. 降本提效 | AIRIOT设备运维管理解决方案

      传统运维多是使用在本地化系统,以人工运维和独立系统执行运维工作,重点关注的是设施运行,存在以下几个问题:   1.信息孤岛:本地化系统的接口不同,功能单一独立,各个系统之间的数据无法对接.交互,形 ...

  2. TypingLearn解决了我在学习英语中的一大痛点

    上一次在博客园发贴还是在上一次(2021年),那个时候博客园就遇到了危机(被罚款).彼时在疫情期间,我个人生活也受到了影响,先后去了多个城市,最终在上海找到了 .NET Web开发的岗位,还是比较幸运 ...

  3. k8s集群下node节点使用kubectl命令

    问题描述:The connection to the server localhost:8080 was refused - did you specify the right host or por ...

  4. 腾讯蓝鲸平台部署v5.1版本[去坑]

    腾讯蓝鲸平台部署 1. 环境准备 #1. 基础优化 ulimit -SHn 655360 yum remove mysql-devel -y && yum install mysql- ...

  5. nginx通过geo做访问限制

    user nginx; worker_processes 1; error_log /var/log/nginx/error.log warn; pid /var/run/nginx.pid; eve ...

  6. xshell 自动断开连接的解决方法

    1. 问题分析 本文Xshell连接自动断开的原因是SSH配置文件的ClientAliveInterval字段设置的超时断开时间小于Xshell的检查断开连接时间. 2. SSH配置文件中的字段详解 ...

  7. 一种基于E3处理器平台的NAS完整方案(从电脑组装到网站部署)

    一种基于E3处理器平台的NAS完整方案(从电脑组装到网站部署) 本文将简要简要介绍本人自建NAS的完整配置,截至发文此NAS已经连续良好运行一年,应当说具有良好的稳定性. 本文所述配置包含洋垃圾成分, ...

  8. 夜莺项目发布 v6.5.0 版本,暗黑菜单来了

    大家好,夜莺项目发布 v6.5.0 版本,启用新 logo,菜单支持换肤,支持了暗黑版本的菜单,下一步会支持全站暗黑主题,敬请期待,下面是新 logo. 暗黑菜单 页面右上角点击用户名,在下拉框里会有 ...

  9. HBase2版本的修复工具HBCK2

    一.hbase出现的问题 1.元数据表hbase:namespace 不在线 导致查询数据时 master is initing 2.一些表的region一直处于opening状态 3.region ...

  10. sqlUtil

    package com.cmbchina.monitor.utils;import com.alibaba.druid.sql.ast.SQLStatement;import com.alibaba. ...