PetaPoco入门

（转自：http://www.cnblogs.com/tinyhu/archive/2013/06/02/3113652.html）

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功能包括：

1) 可与SQL Server、SQL Server CE、MySQL、PostgreSQL以及Oracle数据库协同工作。

2) 包含针对Insert/Delete/Update/Save以及IsNew的多个辅助方法。

3) 支持简单事务

4) 对于翻页请求会自动计算总记录数，并获取特定分页。

5) 支持参数替换，能够从对象属性中抓取命名参数（named parameters）

6) 包括一个消耗资源很少的SQL Builder类

7) 部分记录更新

8) 包括T4 Templates，可以用于基于数据库结构生成POCO类。

在性能方面，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

2. Petapoco基本用法

2.1. 创建示例工程

首先创建一个工程文件，为了便于展示数据这里创建一个类型为:WindowsApplication的工程文件。命名为：PetapocoTest。

程序最终布局及功能预览如下：

2.2. 添加petapoco包

在项目文件的Reference上右键， 选择“管理NuGet程序包”，并搜索Petapoco，安装之。　　

2.3. 添加数据库连接

在app.config或web.config文件中添加数据库连接串。　　

下面是连接SQL Server：

  <connectionStrings>
    <add name="DefaultConnection" connectionString="Data Source=huhm\sqlexpress;Initial Catalog=Northwind;Persist Security Info=True;User ID=aspnet;Password=***;" providerName="System.Data.SqlClient" />
  </connectionStrings>

下面是连接MySQL：

 <add name="DefaultConnection" connectionString="Server=huhm;Port=3306;Database=Northwind;Uid=aspnet;Pwd=***;pooling=false;" providerName="MySql.Data.MySqlClient"/>

下面是连接Oracle：

<add name="DefaultConnection" connectionString="Data Source=orcl; User ID=aspnet; Password=***;"  providerName="Oracle.DataAccess.Client" />

<system.data>
　　<DbProviderFactories>
　　　　<add name="Oracle Data Provider for .NET" invariant="Oracle.DataAccess.Client" description="Oracle Data Provider for .NET" type="Oracle.DataAccess.Client.OracleClientFactory, Oracle.DataAccess, Version=2.112.1.0, Culture=neutral, PublicKeyToken=89b483f429c47342"/>
　　</DbProviderFactories>
</system.data>

注意：

　　如安装的ODP.net中的Oracle.DataAccess.dll是.net Framework2.0版本的，

　　则Oracle.DataAccess相关的provider信息只在C:\Windows\Microsoft.NET\Framework\v2.0.50727\CONFIG中的machine.config里面有记录。

　　而在~\Framework\v4.0.30319\Config中的machine.config里面没有记录。

　　因此针对.net Framework4.0的WPF工程，在C:\Windows\Microsoft.NET\Framework\v4.0.30319\Config中的machine.config将里面无法找到相应的Provider信息。

　　可将~\v2.0.50727\CONFIG中的machine.config里的Oracle.DataAccess相关provider信息拷入~\v4.0.30319\Config中的machine.config的对应位置，以处理无法找到Provider的问题；

　　或在工程web.config中进行添加，如例所示。

　　（问题详细参阅：http://www.cnblogs.com/wang_yb/archive/2011/07/12/2104788.html）

由于petapoco是与面向数据库无关的ORM组件，故对DB的增、删、改、查的代码与具体连接哪个物理数据库类型无关。

2.4. 定义POCO-实体类

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; }
}

2.5. 创建petapoco操作对象

接下来创建一个PetaPoco.Database对象。

var db=new PetaPoco.Database("DefaultConnection ");

2.6. 查询数据

// 查询所有数据
foreach (var a in db.Query<article>("SELECT * FROM articles"))
{
    Console.WriteLine("{0} - {1}", a.article_id, a.title);
}
//查询标量
long count=db.ExecuteScalar<long>("SELECT Count(*) FROM articles");

//查询单条数据
var a = db.SingleOrDefault<article>("SELECT * FROM articles WHERE article_id=@0", 123));

 

2.7. 分页查询

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; }
}

2.8. Query 与Fetch 方法

Petapoco支持2种查询数据的方法：Query及Fetch。Fetch返回的是List<T>数据对象，而Query使用了yield迭代器，返回IEnumerable，并且不是一次性全部将数据获取到内存。

2.9. 非查询命令

执行非查询语句，使用Execute 方法。

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

2.10. 增删改查

Petapoco很好地支持了增删改查。

插入一条记录，需要声明表名及主键：

// Create the article
var a=new article();
a.title="我的标题";
a.content="测试数据 by tinyhu";
a.date_created=DateTime.UtcNow;

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

更新数据：

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

// Change it
a.content="测试数据 by tinyhu";

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

可以传入一个匿名类型只更新部分部分字段。例如，下面只更新标题title列。

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

删除有2种方法：

// 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);

2.11. 声明POCO对象

上述例子中需要声明表名及主键来增删除改，简化起见，可以在poco对象添加TableName及PrimarKey属性，这样做CRUD操作时不再需要声明表名及主键了。

[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 a record
var a=new article();
a.title="测试标题";
a.content="测试数据 by tinyhu ";
a.date_created=DateTime.UtcNow;
db.Insert(a);

// Update it
a.content="修改，修改 …";
db.Update(a);

// Delete it
db.Delete(a);

可以声明一些字段忽略更新，如下例：

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

2.12. 自动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);

2.13. 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);

2.14. 事务Transactions

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

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

    // Commit
    scope.Complete();
}

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

2.15. 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)

出处： http://www.cnblogs.com/tinyhu/archive/2013/06/02/3113692.html