微型 ORM-FluentData 例項詳解

阿新 • • 發佈：2019-01-25

前言：

最近專案中因使用FluentData，查閱部分部落格資料覺得不夠全面，所以把官網下的文件翻譯一下，供大家學習參考。

正文：

開始學習

環境要求

.NET 4.0.

支援資料庫

安裝

使用NuGet

搜尋FluentData並安裝。

不使用NuGet

下載zip檔案。

解壓檔案，並將檔案複製到您的解決方案或專案資料夾中。

專案中新增對fluentdata.dll引用。

核心概念

DbContext

這是fluentdata的核心類。可以通過配置ConnectionString來定義這個類，如何連線資料庫和具體資料庫資訊

DbCommand

這是負責對資料庫執行實際查詢的類。

Events

DbContext類有以下的Events(事件)支援：

OnConnectionClosed
OnConnectionOpened
OnConnectionOpening
OnErrorOnExecuted
OnExecuting

通過使用其中任何一個，可以在事件中，記錄每個SQL查詢錯誤或者SQL查詢執行的時間等資訊。

Builders

Builders(生成器)提供了一個非常好的API，用於生成SQL，用於插入、更新和刪除查詢。
Builder用來建立Insert, Update, Delete等相關的DbCommand例項。

Mapping

FluentData可以將SQL查詢結果自動對映成一個POCO(POCO - Plain Old CLR Object)實體類，也可以轉換成一個dynamic（new in .NET 4）型別：

自動對映為實體類：

如果欄位名稱不包含下劃線（“_”）將自動對映到具有相同名稱的屬性上。例如，一個名為“Name”的欄位將被自動對映到名也為“Name”的屬性上。

如果欄位名包含下劃線（“_”），將自動對映到巢狀屬性上。例如，例如，一個名為“Category_Name”的欄位值將自動對映到名為“Category.Name”的屬性上。

如果資料庫中的欄位和實體型別之間存在不匹配，則可以使用SQL中的別名關鍵字，也可以建立自己的對映方法。檢查下面的對映部分以獲取程式碼示例。

自動對映為dynamic（動態型別）

動態型別的每一個欄位都將被自動對映成具有有相同的名稱的屬性。例如，欄位名為Name會被自動對映成名為Name的屬性。

什麼時候需要釋放資源？

DbContext 需要主動釋放當你在啟用UseTransaction或者UseSharedConnection時
DbContext 需要主動釋放當你在啟用UseMultiResult (or MultiResultSql)時
StoredProcedureBuilder 需要主動釋放當你在啟用UseMultiResult時

在所有其他情況下處置將由fluentdata自動處理。這意味著在執行完查詢並關閉之前，資料庫連線一直是開啟狀態。

程式碼例項

建立和初始化一個DbContext

可以在*.config檔案中配置connection string，將connection string name或者將整個connection string作為引數傳遞給DbContext來建立DbContext。

重要的配置

IgnoreIfAutoMapFails – IDbContext.IgnoreIfAutoMapFails返回一個IDbContext，該例項中，如果在欄位不能與屬性正確對映時是否丟擲異常

建立和初始化一個DbContext

通過*.config中配置的ConnectionStringName:MyDatabase建立一個DbContext

public IDbContext Context()
{
    return new DbContext().ConnectionStringName("MyDatabase",
            new SqlServerProvider());
}

// *.config檔案中內容
<connectionStrings>
    <add name="MyDatabase" connectionString="server=MyServerAddress;uid=uid;pwd=pwd;database=MyDatabase;"  /> 
</connectionStrings>

呼叫DbContext的ConnectionString方法顯示設定connection string來建立

// 
public IDbContext Context()
{
    return new DbContext().ConnectionString(
    "Server=MyServerAddress;Database=MyDatabase;Trusted_Connection=True;", new SqlServerProvider());
}

其他可以使用的提供器

如果你想連線其他的非SqlServer的資料庫，這是非常簡單的，只需要替換上面程式碼中的“new SqlServerProvider()”為下面的資料提供器，比如 :AccessProvider, DB2Provider, OracleProvider, MySqlProvider, PostgreSqlProvider, SqliteProvider, SqlServerCompact, SqlAzureProvider, SqlServerProvider。

查詢一組資料（Query for a list of items）

返回一組dynamic物件

List<dynamic> products = Context.Sql("select * from Product").QueryMany<dynamic>();

返回一組強型別物件

List<Product> products = Context.Sql("select * from Product").QueryMany<Product>();

返回一組自定義的Collection

ProductionCollection products = Context.Sql("select * from Product").QueryMany<Product, ProductionCollection>();

返回DataTable型別:
檢視下方查詢單個物件（Query for a single item）

查詢單個物件（Query for a single item）

返回一個dynamic物件

dynamic product = Context.Sql(@"select * from Product
                where ProductId = 1").QuerySingle<dynamic>();

返回一個強型別物件

Product product = Context.Sql(@"select * from Product
            where ProductId = 1").QuerySingle<Product>();

返回一個DataTable

/**
 * 其實QueryMany<DataTable>和QuerySingle<DataTable>都可以用來返回DataTable，
 * 但考慮到QueryMany<DataTable>返回的是List<DataTable>，
 * 所以使用QuerySingle<DataTable>來返回DataTable更方便。 
 */
DataTable products = Context.Sql("select * from Product").QuerySingle<DataTable>();

查詢一個標量值

int numberOfProducts = Context.Sql(@"select count(*)
            from Product").QuerySingle<int>();

查詢一組標量值

List<int> productIds = Context.Sql(@"select ProductId
                from Product").QueryMany<int>();

查詢引數

索引形式引數：

dynamic products = Context.Sql(@"select * from Product
            where ProductId = @0 or ProductId = @1", 1, 2).QueryMany<dynamic>();

或者：

dynamic products = Context.Sql(@"select * from Product
            where ProductId = @0 or ProductId = @1")
            .Parameters(1, 2).QueryMany<dynamic>();

命名形式引數：

dynamic products = Context.Sql(@"select * from Product
            where ProductId = @ProductId1 or ProductId = @ProductId2")
            .Parameter("ProductId1", 1)
            .Parameter("ProductId2", 2)
            .QueryMany<dynamic>();

OutPut形式引數:

var command = Context.Sql(@"select @ProductName = Name from Product
            where ProductId=1")
            .ParameterOut("ProductName", DataTypes.String, 100);
command.Execute();

string productName = command.ParameterValue<string>("ProductName");

List形式引數-in查詢：

List<int> ids = new List<int>() { 1, 2, 3, 4 };
// 注意這裡,不要在"in(...)"周圍有任何空格的操作符.
dynamic products = Context.Sql(@"select * from Product
            where ProductId in(@0)", ids).QueryMany<dynamic>();

like查詢：

string cens = "%abc%";
Context.Sql("select * from Product where ProductName like @0",cens);

對映

自動對映-資料庫物件與.Net物件自動進行1：1匹配：

List<Product> products = Context.Sql(@"select *
            from Product")
            .QueryMany<Product>();

自動對映到一個自定義的Collection：

ProductionCollection products = Context.Sql("select * from Product").QueryMany<Product, ProductionCollection>();

如果資料庫欄位和.Net物件類屬性名不一致，使用SQL別名語法AS：

/*
 * 在這裡p.*中的ProductId和ProductName會自動對映到Prodoct.ProductId和Product.ProductName，
 * 而Category_CategoryId和Category_Name將對映到Product.Category.CategoryId和 Product.Category.Name
 */
List<Product> products = Context.Sql(@"select p.*,
            c.CategoryId as Category_CategoryId,
            c.Name as Category_Name
            from Product p
            inner join Category c on p.CategoryId = c.CategoryId")
                .QueryMany<Product>();

使用dynamic自定義對映規則：

List<Product> products = Context.Sql(@"select * from Product")
            .QueryMany<Product>(Custom_mapper_using_dynamic);

public void Custom_mapper_using_dynamic(Product product, dynamic row)
{
    product.ProductId = row.ProductId;
    product.Name = row.Name;
}

使用datareader進行自定義對映：

List<Product> products = Context.Sql(@"select * from Product")
            .QueryMany<Product>(Custom_mapper_using_datareader);

public void Custom_mapper_using_datareader(Product product, IDataReader row)
{
    product.ProductId = row.GetInt32("ProductId");
    product.Name = row.GetString("Name");
}

或者當你需要對映到一個複合型別時，可以使用QueryComplexMany或者QueryComplexSingle：

var products = new List<Product>();
Context.Sql("select * from Product").QueryComplexMany<Product>(products, MapComplexProduct);

private void MapComplexProduct(IList<Product> products, IDataReader reader)
{
    var product = new Product();
    product.ProductId = reader.GetInt32("ProductId");
    product.Name = reader.GetString("Name");
    products.Add(product);
}

多結果集

FluentData支援多結果集。也就是說，可以在一次資料庫查詢中返回多個查詢結果。使用該特性的時候，記得使用類似下面的語句對查詢語句進行包裝。需要在查詢結束後把連線關閉。

/**
 * 執行第一個查詢時，會從資料庫取回資料。
 * 執行第二個查詢的時候，FluentData可以判斷出這是一個多結果集查詢，所以會直接從第一個查詢裡獲取需要的資料。
 */
using (var command = Context.MultiResultSql)
{
    List<Category> categories = command.Sql(
            @"select * from Category;
            select * from Product;").QueryMany<Category>();

    List<Product> products = command.QueryMany<Product>();
}

選擇資料和分頁

選擇一個 builder使得選擇資料和分頁更簡單：

// 通過呼叫Paging(1, 10)，將返回前10個產品。
List<Product> products = Context.Select<Product>("p.*, c.Name as Category_Name")
                   .From(@"Product p 
                    inner join Category c on c.CategoryId = p.CategoryId")
                   .Where("p.ProductId > 0 and p.Name is not null")
                   .OrderBy("p.Name")
                   .Paging(1, 10).QueryMany();

插入資料

使用SQL：

int productId = Context.Sql(@"insert into Product(Name, CategoryId)
            values(@0, @1);")
            .Parameters("The Warren Buffet Way", 1)
            .ExecuteReturnLastId<int>();

使用builder：

int productId = Context.Insert("Product")
            .Column("Name", "The Warren Buffet Way")
            .Column("CategoryId", 1)
            .ExecuteReturnLastId<int>();

使用builder，並且自動對映：

Product product = new Product();
product.Name = "The Warren Buffet Way";
product.CategoryId = 1;

// 將ProductId作為AutoMap方法的引數，是要指明ProductId不需要進行對映，因為它是一個數據庫自增長欄位
product.ProductId = Context.Insert<Product>("Product", product)
            .AutoMap(x => x.ProductId)
            .ExecuteReturnLastId<int>();

更新資料

使用SQL：

int rowsAffected = Context.Sql(@"update Product set Name = @0
            where ProductId = @1")
            .Parameters("The Warren Buffet Way", 1)
            .Execute();

使用builder：

int rowsAffected = Context.Update("Product")
            .Column("Name", "The Warren Buffet Way")
            .Where("ProductId", 1)
            .Execute();

使用builder，並且自動對映：

Product product = Context.Sql(@"select * from Product
            where ProductId = 1")
            .QuerySingle<Product>();
product.Name = "The Warren Buffet Way";

// 將ProductId作為AutoMap方法的引數，是要指明ProductId不需要進行對映，因為它不需要被更新。 
int rowsAffected = Context.Update<Product>("Product", product)
            .AutoMap(x => x.ProductId)
            .Where(x => x.ProductId)
            .Execute();

設定對映失敗異常是否丟擲（IgnoreIfAutoMapFails）

當從資料庫中讀取，如果某些資料列不映出實體類，預設情況下，將丟擲異常。
如果你想忽略異常，或者屬性不需要和資料庫物件進行對映，你可以設定IgnoreIfAutoMapFails(true)，即可以在對映錯誤時不丟擲異常

context.IgnoreIfAutoMapFails(true);

插入和更新 - 常用填充方式

var product = new Product();
product.Name = "The Warren Buffet Way";
product.CategoryId = 1;

var insertBuilder = Context.Insert<Product>("Product", product).Fill(FillBuilder);

var updateBuilder = Context.Update<Product>("Product", product).Fill(FillBuilder);

public void FillBuilder(IInsertUpdateBuilder<Product> builder)
{
    builder.Column(x => x.Name);
    builder.Column(x => x.CategoryId);
}

刪除資料

使用SQL：

int rowsAffected = Context.Sql(@"delete from Product
            where ProductId = 1")
            .Execute();

使用builder：

int rowsAffected = Context.Delete("Product")
            .Where("ProductId", 1)
            .Execute();

儲存過程

使用SQL：

int rowsAffected = Context.Sql(@"delete from Product
            where ProductId = 1")
            .Execute();

使用builder：

var rowsAffected = Context.StoredProcedure("ProductUpdate")
            .Parameter("Name", "The Warren Buffet Way")
            .Parameter("ProductId", 1).Execute();

使用builder，並且自動對映：

var product = Context.Sql("select * from Product where ProductId = 1")
            .QuerySingle<Product>();

product.Name = "The Warren Buffet Way";

var rowsAffected = Context.StoredProcedure<Product>("ProductUpdate", product)
            .AutoMap(x => x.CategoryId).Execute();

使用builder，並且自動對映和表示式：

var product = Context.Sql("select * from Product where ProductId = 1")
            .QuerySingle<Product>();
product.Name = "The Warren Buffet Way";

var rowsAffected = Context.StoredProcedure<Product>("ProductUpdate", product)
            .Parameter(x => x.ProductId)
            .Parameter(x => x.Name).Execute();

使用事物

FluentData 支援事務。如果使用事務，最好使用using語句將程式碼包起來，已保證連線會被關閉。預設的，如果查詢過程發生異常，如事務不會被提交，會進行回滾。

using (var context = Context.UseTransaction(true))
{
    context.Sql("update Product set Name = @0 where ProductId = @1")
                .Parameters("The Warren Buffet Way", 1)
                .Execute();

    context.Sql("update Product set Name = @0 where ProductId = @1")
                .Parameters("Bill Gates Bio", 2)
                .Execute();

    context.Commit();
}

實體工廠

實體工廠負責在自動對映的時候，生成物件例項。如果需要生成複雜的例項，可以自定義實體工廠：

List<Product> products = Context.EntityFactory(new CustomEntityFactory())
            .Sql("select * from Product")
            .QueryMany<Product>();

public class CustomEntityFactory : IEntityFactory
{
    public virtual object Resolve(Type type)
    {
        return Activator.CreateInstance(type);
    }
}

該文件最後更新時間：Mar 2, 2015 at 4:36 AM by kindblad, version 52

微型 ORM-FluentData 例項詳解

前言：

正文：

開始學習

環境要求

支援資料庫

安裝

核心概念

DbContext

DbCommand

Events

Builders

Mapping

什麼時候需要釋放資源？

程式碼例項

建立和初始化一個DbContext

重要的配置

建立和初始化一個DbContext

其他可以使用的提供器

查詢一組資料（Query for a list of items）

查詢單個物件（Query for a single item）

查詢一個標量值

查詢一組標量值

查詢引數

對映

多結果集

選擇資料和分頁

插入資料

更新資料

設定對映失敗異常是否丟擲（IgnoreIfAutoMapFails）

插入和更新 - 常用填充方式

刪除資料

儲存過程

使用事物

實體工廠

相關推薦