PetaPoco入门

1. ORM概括

1.1. ORM简介

ORM 对象-关系映射（Object/Relation Mapping，简称ORM），是随着面向对象的软件开发方法发展而产生的。面向对象的开发方法是当今企业级应用开发环境中的主流开发方法，关系数据库是企业级应用环境中永久存放数据的主流数据存储系统。对象和关系数据是业务实体的两种表现形式，业务实体在内存中表现为对象，在数据库中表现为关系数据。内存中的对象之间存在关联和继承关系，而在数据库中，关系数据无法直接表达多对多关联和继承关系。因此，对象-关系映射(ORM)系统一般以中间件的形式存在，主要实现程序对象到关系数据库数据的映射。

面向对象是从软件工程基本原则(如耦合、聚合、封装)的基础上发展起来的，而关系数据库则是从数学理论发展而来的，两套理论存在显著的区别。为了解决这个不匹配的现象,对象关系映射技术应运而生。

让我们从O/R开始。字母O起源于"对象"(Object),而R则来自于"关系"(Relational)。几乎所有的程序里面，都存在对象和关系数据库。在业务逻辑层和用户界面层中，我们是面向对象的。当对象信息发生变化的时候，我们需要把对象的信息保存在关系数据库中。

如果打开你最近的程序(如，PetShop4.0)，看看DAL(数据库访问层)代码，你肯定会看到很多近似的通用的模式。我们以保存对象的方法为例，你传入一个对象，为SqlCommand对象添加SqlParameter，把所有属性和对象对应，设置SqlCommand的CommandText属性为存储过程，然后运行SqlCommand。对于每个对象都要重复的写这些代码。除此之外，还有更好的办法吗？有，引入一个O/R Mapping。实质上，一个O/R Mapping会为你生成DAL。与其自己写DAL代码，不如用O/R Mapping。你用O/R Mapping保存，删除，读取对象，O/R Mapping负责生成SQL，你只需要关心对象就好。

1.2. Petapoco简介

PetaPoco是一个微小的，快速的，单个文件的微型ORM，可以运行在.NET和Mono平台上。对象/关系数据库映射（object/relational mapping，ORM）这个术语表示一种技术，用来把对象模型表示的对象映射到基于SQL的关系模型数据结构中去。

PetaPoco是一款适用于.NET应用程序的轻型对象关系映射器（ORM, Object Relational Mapper）。与那些功能完备的ORM（如NHibernate或Entity Framework）不同的是，PetaPoco更注重易用性和性能，而非丰富的功能。使用PetaPoco只需要引入一个C#文件，可以使用强类型的 POCO（Plain Old CLR Object），并支持使用T4模板生成的类等等。

在今日的企业环境中，把面向对象的软件和关系数据库一起使用可能是相当麻烦和浪费时间的。而PetaPoco不仅仅管理.NET类到数据库表的映射（包括.NET 数据类型到SQL数据类型的映射），还提供数据查询和获取数据的方法，可以大幅度减少开发时人工使用SQL和ADO.NET处理数据的时间。

PetaPoco的目标主要是用于与数据持久化相关的编程任务，能够使开发人员从原来枯燥的SQL语句的编写中解放出来，解放出来的精力可以让开发人员投入到业务逻辑的实现上。对于以数据为中心的程序，开发人员往往是在数据库中使用存储过程来实现商业逻辑，这种情况下PetaPoco可能不是最好的解决方案，但对于那些基于.NET，并且能够实现OO业务模型和商业逻辑的中间层应用，PetaPoco是最有用的。PetaPoco可以帮助用户消除或者包装那些针对特定厂商的SQL代码，并且帮用户把结果集从表格式的表示形式转换成一系列的对象。

PetaPoco功能包括：

微小，没有依赖项……单个的C#文件可以方便的添加到任何项目中。
Insert/Delete/Update/Save and IsNew 等帮助方法。
分页支持：自动得到总行数和数据
支持简单的事务
部分记录更新
更好的支持参数替换，包括从对象属性中抓取命名的参数（named parameters）。
T4模板自动生成Poco类
包含一个低耦合的Sql Builder类，让内联的Sql更容易书写
为异常信息记录、值转换器安装和数据映射提供钩子。（Hooks for logging exceptions, installing value converters and mapping columns to properties without attributes.）
兼容SQL Server, SQL Server CE, MySQL, PostgreSQL and Oracle。
可以在.NET 3.5 或Mono 2.6或更高版本上运行
在.NET 4.0 和Mono 2.8下支持dynamic
NUnit单元测试
开源（Apache License）
所有功能大约用了1500行代码

在性能方面，PetaPoco仅次于Dapper，速度只稍逊于手工编码的数据访问层（DAL, Data Access Layer）。此外，由于PetaPoco是开源项目，因此添加条件来处理如空间数据等特定情况会很容易。

最近，随着许多开源项目的发布，微型ORM已开始成为一种流行趋势。其他一些众所周知的适用于.NET的项目有Dapper和Massive。那些微型ORM相对于功能完备的ORM而言，会更简单、更高效，微型ORM通常要求开发人员手动编写SQL语句，而非完全动态生成。它们同样不需要冗长的映射文件，因为对于维护和调试而言，那些映射文件只会让过程变得单调乏味。

1.3. 获取Petapoco

1) •NuGet - http://nuget.org/List/Packages/PetaPoco

2) •GitHub - https://github.com/toptensoftware/petapoco

代码展示：

首先，定义一个Poco类：

// Represents a record in the "articles" table
public class article
{
    public long article_id { get; set; }
    public string title { get; set; }
    public DateTime date_created { get; set; }
    public bool draft { get; set; }
    public string content { get; set; }
}

接下来，创建一个PetaPoco.Database，来执行查询：

// Create a PetaPoco database object
var db=new PetaPoco.Database("connectionStringName");

// Show all articles    
foreach (var a in db.Query<article>("SELECT * FROM articles"))
{
    Console.WriteLine("{0} - {1}", a.article_id, a.title);
}

得到一个scalar：

long count=db.ExecuteScalar<long>("SELECT Count(*) FROM articles");

得到一行记录：

var a = db.SingleOrDefault<article>("SELECT * FROM articles WHERE article_id=@0", 123));

获取分页数据：

PetaPoco能够自动完成分页请求

var result=db.Page<article>(1, 20, // <-- page number and items per page
        "SELECT * FROM articles WHERE category=@0 ORDER BY date_posted DESC", "coolstuff");

你将会得到一个PagedFetch对象：

public class Page<T> where T:new()
{
    public long CurrentPage { get; set; }
    public long ItemsPerPage { get; set; }
    public long TotalPages { get; set; }
    public long TotalItems { get; set; }
    public List<T> Items { get; set; }
}

PetaPoco在背后为我们做了一下处理：

生成并执行一个查询，得到匹配的数据行数
修改原始的查询语句，使其只得到所有匹配数据的一个子集

你现在已经拥有了一个展示单页数据的一切东西和一个分页控制器，他们被封装在一个现成的小对象中。（You now have everything to display a page of data and a pager control all wrapped up in one handy little object!）

Query vs Fetch

Database 对象有两个获取数据的方法：Query 和Fetch。这两个方法非常相似，不同的是Fetch方法返回一个POCO类的List<>，而Query使用 yield return 迭代所有数据，这些数据并没有加载到内存中。

不带查询的命令

使用Execute 方法执行一个不带查询的命令：

db.Execute("DELETE FROM articles WHERE draft<>0");

Inserts、Updates 和 Deletes

PetaPoco提供了insert、update和delete操作的帮助。

在插入一条记录时，你需要指定插入的表名和主键：

// Create the article
var a=new article();
a.title="My new article";
a.content="PetaPoco was here";
a.date_created=DateTime.UtcNow;

// Insert it
db.Insert("articles", "article_id", a);

// by now a.article_id will have the id of the new article

更新记录也一样：

// Get a record
var a=db.SingleOrDefault<article>("SELECT * FROM articles WHERE article_id=@0", 123);

// Change it
a.content="PetaPoco was here again";

// Save it
db.Update("articles", "article_id", a);

或者你可以传一个匿名类来更新一部分字段。下面的代码只更新article的title字段：

db.Update("articles", "article_id", new { title="New title" }, 123);

删除：

// Delete an article extracting the primary key from a record
db.Delete("articles", "article_id", a);

// Or if you already have the ID elsewhere
db.Delete("articles", "article_id", null, 123);

修饰POCO类

在上面的例子中，必须指明表名和主键是很烦人的，你可以在你的Poco类中附加这些信息：

// Represents a record in the "articles" table
[PetaPoco.TableName("articles")]
[PetaPoco.PrimaryKey("article_id")]
public class article
{
    public long article_id { get; set; }
    public string title { get; set; }
    public DateTime date_created { get; set; }
    public bool draft { get; set; }
    public string content { get; set; }
}

简化后的insert、update、delete：

// Insert a record
var a=new article();
a.title="My new article";
a.content="PetaPoco was here";
a.date_created=DateTime.UtcNow;
db.Insert(a);

// Update it
a.content="Blah blah";
db.Update(a);

// Delete it
db.Delete(a);

delete和update的其它方式

// Delete an article
db.Delete<article>("WHERE article_id=@0", 123);

// Update an article
db.Update<article>("SET title=@0 WHERE article_id=@1", "New Title", 123);

你还可以告诉POCO忽略某列

public class article
{
    [PetaPoco.Ignore]
    public long SomeCalculatedFieldPerhaps
    { 
        get; set; 
    }
}

或许你喜欢一点更详细的描述。和自动映射所有列相比，你可以通过使用类和列的属性来指明哪些列需要映射。

// Represents a record in the "articles" table
[PetaPoco.TableName("articles")]
[PetaPoco.PrimaryKey("article_id")]
[PetaPoco.ExplicitColumns]
public class article
{
    [PetaPoco.Column]publiclong article_id { get; set;}
    [PetaPoco.Column]publicstring title { get; set;}
    [PetaPoco.Column]publicDateTime date_created { get; set;}
    [PetaPoco.Column]public bool draft { get; set;}
    [PetaPoco.Column]publicstring content { get; set;}
}

它可以结合partial class 很好的工作，把需要绑定的字段放在一个.cs文件中，把计算得到的和别的有用的属性添加到分开的文件中，而不用去考虑DAL。

T4 模板

Writing all those POCO objects can soon get tedious and error prone... so PetaPoco includes a T4 template that can automatically write classes for all the tables in your your SQL Server, SQL Server CE, MySQL, PostgreSQL or Oracle database.

Using the T4 template is pretty simple. The git repository includes three files (The NuGet package adds these to your project automatically in the folder \Models\Generated).

PetaPoco.Core.ttinclude - includes all the helper routines for reading the DB schema
PetaPoco.Generator.ttinclude - the actual template that defines what's generated
Database.tt - the template itself that includes various settings and includes the two other ttinclude files.

自动Select子句

使用PetaPoco时，大多数查询以”select * from table”开始。可以省略掉SELECT * FROM table子句，因为petapoco会自动帮我们构建。

例如下句：

// Get a record
var a=db.SingleOrDefault<article>("SELECT * FROM articles WHERE article_id=@0", 123);

可简写为：

// Get a record
var a=db.SingleOrDefault<article>("WHERE article_id=@0", 123);

IsNew 及 Save 方法

使用IsNew可以检测记录是否在数据表中存在：

// Is this a new record 
if (db.IsNew(a))
{
    // Yes it is...
}

Save方法会自动发送Insert（如果表中不存在）或Update子句。

// Save a new or existing record
db.Save(a);

事务Transactions

使用事务非常简单，只需要声明如下:

using (var scope=db.Transaction)
{
    // 其他任务处理 …

    // Commit
    scope.Complete();
}

事务可以嵌套，只有当事务中的所有语句成功执行时才会commit，否则rollback。

PetaPoco的SQL Builder

下面是最简单的形式：

var id=123;
var a=db.Query<article>(PetaPoco.Sql.Builder
    .Append("SELECT * FROM articles")
    .Append("WHERE article_id=@0", id)
)

var id=123;
var a=db.Query<article>(PetaPoco.Sql.Builder
    .Append("SELECT * FROM articles")
    .Append("WHERE article_id=@0", id)
    .Append("AND date_created<@0", DateTime.UtcNow)
)

可以附加条件判断动态生成子句

var id=123;
var sql=PetaPoco.Sql.Builder
    .Append("SELECT * FROM articles")
    .Append("WHERE article_id=@0", id);

if (start_date.HasValue)
    sql.Append("AND date_created>=@0", start_date.Value);

if (end_date.HasValue)
    sql.Append("AND date_created<=@0", end_date.Value);

var a=db.Query<article>(sql)

注意每个append子句使用参数： @0? PetaPoco构建参数列表并自动完成赋值。

可以使用命名参数，如下示例。

sql.Append("AND date_created>=@start AND date_created<=@end", 
                new 
                { 
                    start=DateTime.UtcNow.AddDays(-2), 
                    end=DateTime.UtcNow 
                }
            );

var sql=PetaPoco.Sql.Builder()
            .Select("*")
            .From("articles")
            .Where("date_created < @0", DateTime.UtcNow)

posted @ 2018-07-31 15:08 finicy 阅读(86) 评论(0) 收藏举报

刷新页面返回顶部