overtly / Core Data

项目层次说明

Overt.Core.Data v2.1.3
如有疑问可直接加QQ：2292709323，微信：yaofengv，联系

1. 项目目录

|-Attrubute                     特性
|  |-SubmeterAttrubute.cs       分表标识特性 (已废弃)
|
|-Contract                      契约层
|  |-IPropertyAssist.cs         统一的接口定义文件，所有的数据层接口均继承
|  |-IBaseRepository<T>.cs      基础接口类，包含增删改查，以及继承IDbRepository
|
|-DataContext                   数据库连接层
|  |-DataContext.cs             数据库连接工厂类
|  |-DataContextConfig.cs       数据库配置信息获取类
|
|-Enums                         枚举
|  |-DatabaseType.cs            数据库类型
|  |-FieldSortType.cs           Asc / Desc
|
|-Expressions                   表达式解析器（略）
|
|-Extensions                    Dapper扩展
|  |-Dapper.Extension.cs        扩展类
|
|-Params                        参数实体
|  |-OrderByField.cs            排序类
|
|-Repositry                     契约实现层
|  |-PropertyAssist.cs          抽象类，继承IPropertyAssist，virtual 
|  |-BaseRepository<T>.cs       抽象类，实现 IBaseRepository<T>，virtual

2. 版本及支持

• Nuget版本：V2.1.3
• 框架支持： Framework4.6.1 - NetStandard 2.0
• 数据库支持：MySql / SqlServer / SQLite [使用详见下文]

3. 项目依赖

• Framework 4.6.1

Dapper 2.0.35  
MySql.Data 8.0.20
System.Data.SqlClient 4.8.1
System.Data.SQLite 1.0.113.1
System.ComponentModel.DataAnnotations 4.7.0

• NetStandard 2.0

Dapper 2.0.35  
Microsoft.Data.Sqlite 3.1.5
MySql.Data 8.0.20
System.Data.SqlClient 4.8.1
System.ComponentModel.DataAnnotations 4.7.0
Microsoft.Extensions.Configuration 2.0.0

使用

1. 配置信息

• 支持 IConfiguration 对象注入
• 支持默认配置文件appsettings.json
• 支持环境变量，或者使用外部的第三方配置中心（appolo），最终还是依赖于微软自身Configuration
• Core(DbType=MySql|SqlServer|SQLite):

[mysql]: DataSource=127.0.0.1;Database=TestDb;uid=root;pwd=123456;Allow Zero Datetime=True;DbType=MySql
[sqlserver]: Data Source=127.0.0.1;Initial Catalog=TestDb;Persist Security Info=True;User ID=sa;Password=123456;DbType=SqlServer  
[sqlite]: Data Source=testdb.db;DbType=SQLite; // 默认使用App_Data目录

• Framework: 正常的连接字符串，使用ProviderName来区分数据库类型

2. Nuget包引用

Install-Package Overt.Core.Data -Version 2.1.3

3. 约定

• 服务层契约需继承IBaseRepository<>
• 服务层契约实现实现自定义契约，并继承BaseRepository
• 外部执行Sql使用 BaseRepository 中 Execute 方法 内部管理连接

return await Execute(async (connection) =>
{
    // 执行方法
}, true);

4. 分表实现

IBaseRepository的实现

// 自定义重写TableNameFunc
// 使用GetTableName()可获取到实际的表名
// 内置方法均从上述方法中获取表名，默认表名为实体定义的[Table("主表名")]
public override Func<string> TableNameFunc => () =>
{
    var tableName = $"{GetMainTableName()}_{DateTime.Now.ToString("yyyyMMdd")}";
    return tableName;
};
        
// 重写创建表的脚本，可在调用过程中，自动创建表，一般用于动态分表
public override Func<string, string> CreateScriptFunc => (tableName) =>
{
    return "创建表的Sql脚本"; // 将在增删改操作中执行，查询操作中，表不存在则直接返回空数据  
}        

5. 分库实现

• 连接字符串配置中以key - value 模式定义，key使用默认的读写分离关键字【master / secondary】表示写入连接字符串和读取连接字符串
• 前缀添加 xxx.即可简单定义不同数据库，代码中，对于IBaseRepository的实现，在构造函数中直接常量定义 xxx，如下所示

using Overt.Core.Data;
using Overt.User.Domain.Contracts;
using Overt.User.Domain.Entities;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Dapper;
using System.Linq;
using Microsoft.Extensions.Configuration;

namespace Overt.User.Domain.Repositories
{
    public class UserRepository : BaseRepository<UserEntity>, IUserRepository
    {
        public UserRepository(IConfiguration configuration) 
            : base(configuration, "xxx") // dbStoreKey 可用于不同数据库切换，连接字符串key前缀：xxx.master xxx.secondary
        {
        }
    }
}

6. 事务实现

• Framework: 使用TransactionScope
• DotNetCore: 使用TransactionScope

// Service层
public async Task<bool> ExecuteInTransactionAsync()
{
    // 分布式事务
    // 异步中需要增加该参数：TransactionScopeAsyncFlowOption.Enabled
    using (var scope = new TransactionScope(TransactionScopeAsyncFlowOption.Enabled))
    {
        var result = false;
        try
        {
            result = await _userRepository.AddAsync(new UserEntity());
            result &= await _subUserRepository.AddAsync(new SubUserEntity());

            scope.Complete();
            return result;
        }
        catch
        {
            // logger
        }
        return false;
    }
}

7. Lambda表达式支持

• ==
• !
• !=
• null
• In
• Equals
• Contains
• !Contains
• StartWith
• EndWith
• &&
• ||

不支持案例

var list = _repository.GetList(1, 1, oo=>"test".Contains(oo.UserName));
var list = _repository.GetList(1, 1, oo=>oo.UserName.IndexOf("abc") > -1);

8. 案例使用

• 添加记录

// 单条记录插入
_repository.Add(obj);

// 多条记录批量插入，建议不要超过500条
_repository.Add(obj0, obj1, ...);

• 修改记录

// 修改整份数据
_repository.Set(obj);

// 修改部分字段（基于字典对象）
var setDic = new Dictionary<string, object>()
{
    { "UserName", "1" }
};
_repository.Set(() => setDic, oo => oo.UserId == 1);

// 修改部分字段（基于匿名对象）
var setObj = new 
{
    UserName = "1"
};
_repository.Set(() => setObj, oo => oo.UserId == 1);

// 修改值类型字段进行增减，比如数量的增减，年龄的增减等
_repository.Incr("Age", 1, oo => oo.UserId == 1);

• 删除记录

_repository.Delete(oo => oo.UserId == 1);

• 单记录查询

var entity = _repository.Get(oo => oo.UserId == 1);

• 列表记录查询

var ary = new string[]{ "1", "2" };
var list = _repository.GetList(1, 1, oo=>ary.Contains(oo.UserId));

var ary = new List<string>(){ "1", "2" };
var list = _repository.GetList(1, 1, oo=>ary.Contains(oo.UserId));

var key = "abc";
var list = _repository.GetList(1, 1, oo=>oo.UserName.Contains(key));

var list = _repository.GetList(1, 1, oo=>oo.UserName.Equals(key));

var list = _repository.GetList(1, 1, oo=>oo.UserName.Contains("abc"));

var list = _repository.GetList(1, 1, oo=>oo.UserName.StartWith("abc"));

var list = _repository.GetList(1, 1, oo=>oo.UserName.EndWith("abc"));

var list = _repository.GetList(1, 1, oo=>ary.Contains(oo.UserId) && !IsSex);

var list = _repository.GetList(1, 1, oo=>oo.UserName != null);

var list = _repository.GetList(1, 1, oo=>oo.UserName == null);

9. 更新说明

• 2021-02-24 v2.1.3

1. 基础方法增加根据某个字段增减数据的方法：IncrAsync(string field, TValue value, Expression<Func<TEntity, bool>> whereExpress)

• 2021-01-14 v2.0.1

1. 修复多数据库情况下并发查询切换数据库导致连接字符串混乱的问题
2. Repository层回执SQL脚本的位置调整，防止数据库执行异常无法获知实际的SQL脚本

• 2020-06-30 v2.0.0

1. 升级底层依赖的驱动：Dapper、SqlClient、MySql、SQLite
2. 去除原有老版本中使用的Transaction属性，全部统一使用TransactionScope实现事务业务。PS：DotNetCore中的事务只支持单服务器数据，Framework支持分布式数据库！！！
3. 如需兼容老版本的的代码，请使用v1.x.x版本的驱动或者代码