Aoite 系列(01) - 比 Dapper 更好用的 ORM

刺骨的言语ヽ痛彻心扉 2021-12-22 07:53 214阅读 0赞

> Aoite 是一个适于任何 .Net Framework 4.0+ 项目的快速开发整体解决方案。Aoite.Data 适用于市面上大多数的数据库提供程序，通过统一封装，可以在日常开发中简单便捷的操作数据库。

[【Aoite 系列 目录】][Aoite _]

没有使用 Aoite 之前是这样的：

![苦逼][o_kubi.jpg]

当你使用 Aoite 以后是这样的：

![爽][o_shuang.jpg]

hah~~~你还不赶紧加入 **[Aoite GitHub][]** 的大家庭吧！！

## 1. 快速入门 ##

本小节将会使用 Microsoft SQL Server Compact 数据库作，一步一步的讲解针对数据库的增删改查。

### 1.1 首先，我们需要创建一个实体 ###

class SimpleUser
    {
        [Column(true /* isPrimaryKey */)]
        public string Username { get; set; }
        public string Password { get; set; }
        public string Memo { get; set; }
    
        public override string ToString()
        {
            return "Username:{0}\tPassword:{1}\tMemo:{2}".Fmt(this.Username, this.Password, this.Memo ?? "<NULL>");
        }
    }

实体的主键必须通过 `Aoite.Data.ColumnAttribute` 指定，若找不到此特性，框架还会尝试找到 Id 属性。若以上条件均不满足，操作过程中便可能直接抛出错误。

### 1.2 创建一个数据库引擎 ###

var dbPath = GA.FullPath("Sample01.sdf");
    if(File.Exists(dbPath)) File.Delete(dbPath);
    
    MsSqlCeEngine engine = new MsSqlCeEngine(dbPath, null /* password*/);
    engine.CreateDatabase();

### 1.3 通过代码，创建一张表 ###

engine.Execute(@"CREATE TABLE [SimpleUser]"
        + "([Username] nvarchar(50) NOT NULL PRIMARY KEY"
        + ", [Password] nvarchar(50) NOT NULL"
        + ", [Memo] nvarchar(500))")
        .ToNonQuery()           /* 执行查询命令，并返回受影响的行数结果。 */
        .ThrowIfFailded();      /* 如果这个 SQL 语句出现异常，则直接抛出。 */

**ToNonQuery**：方法的内部原理是执行 [DbCommand.ExecuteNonQuery][]，一般的新增、删除、修改等操作均可用此方法。

**ThrowIfFailded**：任何方法的调用都会有一个 Result（结果），而这个结果包含了 Value(值)、Status（状态码）和Message（消息）。`ThrowIfFailded` 和 `UnsafeValue` 的作用一致，在结果捕获到错误时，将会直接抛出异常。

通常定义 `Result` 的方法里，是不会直接抛出业务逻辑上的异常。方法的内部自然会包装好的这个异常，再返回给调用方。也就是说，返回的数据类型若是继承 `System.Result`，表示这个方法具有**业务容错性**。

### 1.4 基本工作已完成。现在我们试着往数据库添加一条新纪录 ###

engine.Add(new SimpleUser { Username = "admin", Password = "123456" })
          .ThrowIfFailded();
    
    Console.WriteLine("Add -> {0}", engine.FindOne<SimpleUser>("admin").UnsafeValue);

**Add**：这是一个扩展方法，通过高性能的反射，将对应的实体生成 INSERT 语句。

**FindOne**：这也是一个扩展方法，默认情况下是根据 `Primary Key` 去查找一条记录。

对于添加对象，还要介绍一种非常好用的方式，匿名方式：

engine.AddAnonymous<SimpleUser>(new { Username = "admin", Password = "123456" })
          .ThrowIfFailded();

这样两种添加方式有什么区别吗？有！第一个生成的是完整的 INSERT 语句（包括 `Simple.Memo`），而 `AddAnonymous` 的 INSERT 语句**不含** `Simple.Memo`。

### 1.5 通过匿名方式，你还可以这样修改对象 ###

engine.ModifyAnonymous<SimpleUser>(new { Username = "admin", Memo = "haha" })
          .ThrowIfFailded();

匿名方式用于非常多的场景，最常见的比如：修改用户的密码，如果有 `Modify`，那么表里的这条记录所有数据都会被覆盖，而通过 `ModifyAnonymous` 方法，可以简单的 `new { Id = id, Password = passowrd }` 来生成更加简短的 UPDATE 语句。

同样，删除的时候，可以通过 `RemoveAnonymous` 删除指定主键的记录。

engine.RemoveAnonymous<SimpleUser>("admin")
          .ThrowIfFailded();

你看，Aoite.Data 就是这么**任性、好用、简单**。

## 2. 上下文 ##

显然，Aoite.Data 肯定不仅仅只有上个小节的那些内容。

**上下文**是 Aoite.Data 一个重要的概念。上个小节的所有执行的生命周期是这样的：

![简单连接的生命周期][o_Sofire.Data_20simple_20execute.png]

倘若采用以下代码进行数据库操作，将会极大的浪费数据库资源：

var r1 = engine.Execute("sql1.....").ToNonQuery();
    var r2 = engine.Execute("sql2.....").ToNonQuery();
    var r3 = engine.Execute("sql3.....").ToNonQuery();
    var r4 = engine.Execute("sql4.....").ToNonQuery();

显然，这种方式弱爆了。对于有严重开发洁癖的我们，怎能忍受这种代码呢？所以，上下文的目的是**实现一次打开连接，多次执行，最后关闭连接，从而达到节省数据库连接池资源**。可以通过以下方式：

using(var context = engine.Context)
    {
        //- context.Open(); 此句可以节省，在第一次执行命令时，如果连接还未打开，将会自动打开连接。
        var r1 = context.Execute("sql1.....").ToNonQuery();
        var r2 = context.Execute("sql2.....").ToNonQuery();
        var r3 = context.Execute("sql3.....").ToNonQuery();
        var r4 = context.Execute("sql4.....").ToNonQuery();
        //- using 释放时，将会自动关闭，从而保证无论在哪一种情况（哪里系统崩溃）下都可以关闭连接。
    }

开启事务有三种方式：

*  `context.OpenTransaction()`：手工开启事务。
 *  `using (var context = engine.ContextTransaction)`：指定当前范围内都是采用事务。
 *  [System.Transactions.TransactionScope][]

当然了，最重要的是，事务的结束之前，我们必须调用 `context.Commit()` 来提交事务，否则整个事务将会被丢弃。若希望手工回滚的话，可以调用 `context.Rollback()`。

![上下文生命周期][o_Sofire.Data_20context_20execute.png]

### 示例 ###

我们紧接着前面的示例代码，采用上下文批量添加 10 条记录：

using(var context = engine.Context)
    {
        for(int i = 0; i < 10; i++)
        {
            context.Add(new SimpleUser { Username = "user" + i, Password = "123456" })
                   .ThrowIfFailded();
            Console.WriteLine("数据库 RowCount -> {0}", engine.RowCount<SimpleUser>());
            Console.WriteLine("上下文 RowCount -> {0}", context.RowCount<SimpleUser>());
        }
    }

上方代码输出如下所示：

数据库 RowCount -> 1
    上下文 RowCount -> 1
    数据库 RowCount -> 2
    上下文 RowCount -> 2
    数据库 RowCount -> ...
    上下文 RowCount -> ...
    数据库 RowCount -> 10
    上下文 RowCount -> 10

我们来试着查询所有记录：

foreach(var item in engine.FindAllWhere<SimpleUser>().UnsafeValue)
    {
        Console.WriteLine(item);
    }

**FindAllWhere**：根据指定筛选条件，查询指定泛型表的所有记录。

而采用事务的代码：

using(var context = engine.ContextTransaction)
    {
        for(int i = 10; i < 20; i++)
        {
            context.Add(new SimpleUser { Username = "user" + i, Password = "123456" })
                   .ThrowIfFailded();
            Console.WriteLine("数据库 RowCOUNT -> {0}", engine.RowCount<SimpleUser>());
            Console.WriteLine("上下文 RowCOUNT -> {0}", context.RowCount<SimpleUser>());
        }
        Console.WriteLine("事务提交前 数据库 RowCOUNT -> {0}", engine.RowCount<SimpleUser>());
        context.Commit().ThrowIfFailded();
        Console.WriteLine("事务提交后 数据库 RowCOUNT -> {0}", engine.RowCount<SimpleUser>());
    }

以上代码的输出：

使用事务上下文...
    数据库 RowCOUNT -> 10
    上下文 RowCOUNT -> 11
    数据库 RowCOUNT -> 10
    上下文 RowCOUNT -> 12
    数据库 RowCOUNT -> 10
    上下文 RowCOUNT -> ...
    数据库 RowCOUNT -> 10
    上下文 RowCOUNT -> 20
    事务提交前 数据库 RowCOUNT -> 10
    事务提交后 数据库 RowCOUNT -> 20

## 3. 结束 ##

关于 Aoite.Data 的简单介绍，就到此结束了，如果你喜欢这个框架，不妨点个推荐吧！如果你非常喜欢这个框架，那请顺便到[Aoite GitHub][] Star 一下 ：）

[点此下载][Link 1]本文的所有示例代码。

问答：

1.  是否开源：**当然**。
2.  单元测试：**当然**。覆盖率没达到 100%，但基本上 80% 的逻辑都有了单元测试。
3.  有商用项目案例吗：**有**！如：亚XXX得综合管理系统、亚XXX得门店系统、短信删除助手、XX通讯录（擦，这个名字我忘了）、店X宝虚拟充值平台、店X宝O2O商城、遛XXX电子商城……很多。
4.  为什么现在不支持 ORACLE 或 Mysql 等数据库：**支持**。具体可参考 Aoite.Data 的前身 [Sofire.Data][]。只不过现在为了将 Aoite.dll 瘦身，这些功能可以通过简单扩展可以快速的实现……

转载于:https://www.cnblogs.com/sofire/p/aoite\_data.html

[Aoite _]: http://www.cnblogs.com/sofire/p/aoite_catalog.html
[o_kubi.jpg]: /images/20211220/3cf3c2d4a4304cc4923918ef1a54b5cc.png
[o_shuang.jpg]: /images/20211220/bf3765e9dd6045a381bb1514c8b07dd4.png
[Aoite GitHub]: https://github.com/treenew/Aoite
[DbCommand.ExecuteNonQuery]: https://msdn.microsoft.com/zh-cn/library/system.data.common.dbcommand.executenonquery.aspx
[o_Sofire.Data_20simple_20execute.png]: /images/20211220/afe8c1f9d6934d71a2fb5a3b8ca577fd.png
[System.Transactions.TransactionScope]: https://msdn.microsoft.com/zh-cn/library/system.transactions.transactionscope.aspx
[o_Sofire.Data_20context_20execute.png]: /images/20211220/9e4343480731476382107a1d255b0211.png
[Link 1]: http://files.cnblogs.com/files/sofire/Aoite.Samples-20150131.rar
[Sofire.Data]: http://www.cnblogs.com/sofire/archive/2012/06/04/2513867.html