Cola.ColaEF
1.0.3
dotnet add package Cola.ColaEF --version 1.0.3
NuGet\Install-Package Cola.ColaEF -Version 1.0.3
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Cola.ColaEF" Version="1.0.3" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Cola.ColaEF --version 1.0.3
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Cola.ColaEF, 1.0.3"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Cola.ColaEF as a Cake Addin #addin nuget:?package=Cola.ColaEF&version=1.0.3 // Install Cola.ColaEF as a Cake Tool #tool nuget:?package=Cola.ColaEF&version=1.0.3
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Cola.EF 框架
简介
框架使用仓储模式方便简单，实现了常用接口。并支持多租户，有 RouteValueTenant、HttpHeaderTenant、DomainTenant 以及 NoTenant 多种策略。
1. 注入
注入可以通过config配置文件形式注入（推荐）、也可以通过代码直接注入
{
"ColaOrm": {
"TenantResolutionStrategy": "NoTenant",
"ColaOrmConfig": [
{
// 多租户模式租户id传参方式
// NoTenant 不使用多租户 RouteValueTenant 路由形式 HttpHeaderTenant http头形式 DomainTenant 域名形式
// 路由形式 和 http头形式 都必须传递 tenantId: value
// 默认值 1
"ConfigId": "1",
"Domain": "www.odinsam.com",
"DbType": "MySql",
"ConnectionString": "server=xxx.xxx.xxx.xxx;Database=db;Uid=root;Pwd=pwd;AllowLoadLocalInfile=true;",
"IsAutoCloseConnection": true,
"EnableLogAop": true,
"EnableErrorAop": true,
"EnableGlobalFilter": true
}
]
}
}
// 注入 ColaSqlSugar
builder.Services.AddSingletonColaSqlSugar(config,new HttpContextAccessor(),
tableFilter:(new List<GlobalQueryFilter>()
{
new GlobalQueryFilter()
{
ConfigId = "1",
// 框架查询过滤标识删除的数据
QueryFilter = (provider => provider.AddTableFilter<IStatus>(t => t.IsDelete == false))
}
}),
aopOnLogExecutingModels:new List<AopOnLogExecutingModel>()
{
new AopOnLogExecutingModel()
{
ConfigId = "1",
// 框架操作 打印sql语句以及参数
AopOnLogExecuting = ((sql, parameters) =>
{
ConsoleHelper.WriteInfo($"sql is\n{sql}");
foreach (var sqlParameter in parameters)
{
Console.WriteLine($"sqlParameter.ParameterName: { sqlParameter.ParameterName } \t\t sqlParameter.Value: {sqlParameter.Value}");
}
})
}
},
aopOnErrorModels:new List<AopOnErrorModel>()
{
// 框架操作错误 aop处理
new AopOnErrorModel()
{
ConfigId = "1",
AopOnError = (ConsoleHelper.WriteException)
}
}
);
##### 2. 新建 IOdinLogRepository 和 OdinLogRepository
```csharp
public interface IOdinLogRepository : IBaseRepository<OdinLog>
{
}
public class OdinLogRepository : BaseRepository<OdinLog>, IOdinLogRepository
{
public OdinLogRepository(IUnitOfWork unitOfWork) : base(unitOfWork)
{
}
}
3. 新建 OdinLog 实体 和 其他相关定义
框架 SqlSugarEntityBase<T> 默认定义了实体的相关标识列。可以不使用自己定义。T 类型灵活定义实体的主键类型。 IDeleted 用来标识实体是否被删除。框架默认使用IsDelete字段。
/// <summary>
/// SqlSugarEntityBase
/// </summary>
/// <typeparam name="T"></typeparam>
public class SqlSugarEntityBase<T> : IEntityBase<T>, IDeleted
{
/// <summary>
/// Id主键
/// </summary>
public T? Id { get; set; }
/// <summary>
/// Remark
/// </summary>
public string? Remark { get; set; }
/// <summary>
/// CreateUser
/// </summary>
public string? CreateUser { get; set; }
/// <summary>
/// CreateTime
/// </summary>
public DateTime? CreateTime { get; set; }
/// <summary>
/// Remark
/// </summary>
public string? UpdateUser { get; set; }
/// <summary>
/// Remark
/// </summary>
public DateTime? UpdateTime { get; set; }
/// <summary>
/// isDelete 0 false other true
/// </summary>
public bool IsDelete { get; set; }
}
自定义 IStatus 标识实体是否被删除字段。
public interface IStatus
{
public bool IsDelete { get; set; }
}
[SugarTable("tb_OdinLog")]
public class OdinLog : SqlSugarEntityBase<long>, IStatus
{
public string? LogLevel { get; set; }
public string? LogContent { get; set; }
public string? ExceptionInfo { get; set; }
}
3. 新建 IOdinServices 和 OdinServices
public interface IOdinServices : IBaseServices<OdinLog>
{
// 模拟services业务接口
List<OdinLog> QueryLog();
}
public class OdinServices : BaseServices<OdinLog>, IOdinServices
{
private readonly IOdinLogRepository _odinLogRepository;
// 如果需要复杂操作 可以使用 ISqlSugarClient
private readonly ISqlSugarClient _sqlSugarClient;
public OdinServices(IOdinLogRepository odinLogRepository)
{
_odinLogRepository = odinLogRepository;
_sqlSugarClient = _odinLogRepository.DbClient;
}
// 模拟实现业务接口
public List<OdinLog> QueryLog()
{
return _odinLogRepository.Query();
}
}
4. 注入仓储
builder.Services.AddSingleton<IOdinLogRepository, OdinLogRepository>(); builder.Services.AddSingleton<IOdinServices, OdinServices>();
5. 模拟 controller 获取 IOdinServices
var odinServices = builder.Services.BuildServiceProvider().GetService<IOdinServices>();
6. 调用业务方法获取数据
var sqlResult = odinServices.QueryLog();
Console.WriteLine($"query count:{sqlResult.Count}");
if (sqlResult.Count > 0) Console.WriteLine(JsonConvert.SerializeObject(sqlResult[0]).ToJsonFormatString());
[2024-01-05 06:43:52] sql is
SELECT `LogLevel`,`LogContent`,`ExceptionInfo`,`Id`,`Remark`,`CreateUser`,`CreateTime`,`UpdateUser`,`UpdateTime`,`IsDelete` FROM `tb_OdinLog` WHERE ( `IsDelete` = @IsDelete0 )
sqlParameter.ParameterName: @IsDelete0 sqlParameter.Value: False
query count:7
{
"LogLevel": "Info",
"LogContent": "{\"ContentType\":null,\"SerializerSettings\":null,\"StatusCode\":null,\"Value\":{\"Data\":{\"t\":\"tt\"},\"Message\":null,\"Code\":0,\"Error\":null}}",
"ExceptionInfo": "null",
"Id": 337152753199616000,
"Remark": "",
"CreateUser": "OdinLog",
"CreateTime": "2022-07-19T16:44:40",
"UpdateUser": "OdinLog",
"UpdateTime": "2022-07-19T16:44:40",
"IsDelete": false
}
7. 仓储已经默认实现的接口
/// <summary>
/// IBaseServices
/// </summary>
/// <typeparam name="TEntity">BaseService TEntity</typeparam>
public interface IBaseServices<TEntity> where TEntity : class
{
/// <summary>
/// QueryPrimaryKey - query entity by primaryKey
/// </summary>
/// <param name="entity">e.g. new Order() { Id=1 }. the id column must has attr [SugarColumn(IsPrimaryKey=true)]）</param>
/// <param name="useSqlSugarCache">if <paramref name="useSqlSugarCache" /> was true; otherwise.default false</param>
/// <typeparam name="TEntity">The type of entity</typeparam>
/// <returns>TEntity</returns>
TEntity QueryPrimaryKey(TEntity entity, bool useSqlSugarCache = false);
/// <summary>
/// QueryPrimaryKeyAsync - query entity by primaryKey
/// </summary>
/// <param name="entity">e.g. new Order() { Id=1 }. the id column must has attr [SugarColumn(IsPrimaryKey=true)]）</param>
/// <param name="useSqlSugarCache">if <paramref name="useSqlSugarCache" /> was true; otherwise.default false</param>
/// <typeparam name="TEntity">The type of entity</typeparam>
/// <returns>Task<TEntity> </returns>
Task<TEntity> QueryPrimaryKeyAsync(TEntity entity, bool useSqlSugarCache = false);
/// <summary>
/// QueryPrimaryKeys - query entities by primaryKey
/// </summary>
/// <param name="entities">e.g. new List<Order>(){ new Order { Id = 1} } . the id column must has attr [SugarColumn(IsPrimaryKey=true)]）</param>
/// <param name="useSqlSugarCache">if <paramref name="useSqlSugarCache" /> was true; otherwise.default false</param>
/// <returns>List<TEntity></returns>
List<TEntity> QueryPrimaryKeys(List<TEntity> entities, bool useSqlSugarCache = false);
/// <summary>
/// QueryPrimaryKeysAsync - query entities by primaryKey
/// </summary>
/// <param name="entities">e.g. new List<Order>(){ new Order { Id = 1} } . the id column must has attr [SugarColumn(IsPrimaryKey=true)]）</param>
/// <param name="useSqlSugarCache">if <paramref name="useSqlSugarCache" /> was true; otherwise.default false</param>
/// <returns>Task<List<TEntity>></returns>
Task<List<TEntity>> QueryPrimaryKeysAsync(List<TEntity> entities, bool useSqlSugarCache = false);
/// <summary>
/// Query - query entities by whereExpression and sort result by strOrderByFields
/// </summary>
/// <param name="whereExpression">if <paramref name="whereExpression" /> is null then query all entities</param>
/// <param name="orderByExpression">if <paramref name="orderByExpression" /> is null then not sort</param>
/// <param name="isAsc">sort type default Asc.must has orderByExpression</param>
/// <param name="useSqlSugarCache">if <paramref name="useSqlSugarCache" /> was true; otherwise.default false</param>
/// <returns>List<TEntity></returns>
List<TEntity> Query(
Expression<Func<TEntity, bool>>? whereExpression = null,
Expression<Func<TEntity, object>>? orderByExpression = null,
bool isAsc = true,
bool useSqlSugarCache = false);
/// <summary>
/// QueryAsync - query entities by whereExpression and sort result by strOrderByFields
/// </summary>
/// <param name="whereExpression">if <paramref name="whereExpression" /> is null then query all entities</param>
/// <param name="orderByExpression">if <paramref name="orderByExpression" /> is null then not sort</param>
/// <param name="isAsc">sort type default Asc.must has orderByExpression</param>
/// <param name="useSqlSugarCache">if <paramref name="useSqlSugarCache" /> was true; otherwise.default false</param>
/// <returns>Task<List<TEntity>></returns>
Task<List<TEntity>> QueryAsync(
Expression<Func<TEntity, bool>>? whereExpression = null,
Expression<Func<TEntity, object>>? orderByExpression = null,
bool isAsc = true,
bool useSqlSugarCache = false);
/// <summary>
/// QuerySql - query by sql
/// </summary>
/// <param name="strSql">query sql</param>
/// <param name="parameters">query parameters</param>
/// <returns>List<TEntity></returns>
List<TEntity> QuerySql(string strSql, SugarParameter[]? parameters = null);
/// <summary>
/// Query entities by Sql
/// </summary>
/// <param name="strSql"></param>
/// <param name="parameters"></param>
/// <returns>Task<List<TEntity>></returns>
Task<List<TEntity>> QuerySqlAsync(string strSql, SugarParameter[]? parameters = null);
/// <summary>
/// query return dataTable
/// </summary>
/// <param name="strSql">query sql</param>
/// <param name="parameters">query parameters</param>
/// <returns>DataTable</returns>
DataTable QueryTable(string strSql, SugarParameter[]? parameters = null);
/// <summary>
/// query return dataTable async
/// </summary>
/// <param name="strSql">query sql</param>
/// <param name="parameters">query parameters</param>
/// <returns>Task<List<DataTable>></returns>
Task<DataTable> QueryTableAsync(string strSql, SugarParameter[]? parameters = null);
/// <summary>
/// QueryPaging - query entities by whereExpression and sort result by strOrderByFields then return toPageListAsync
/// </summary>
/// <param name="whereExpression">if <paramref name="whereExpression" /> is null then query all entities</param>
/// <param name="orderByExpression">if <paramref name="orderByExpression" /> is null then not sort</param>
/// <param name="isAsc">sort type default Asc.must has orderByExpression</param>
/// <param name="startPage">default 1,is not index start 1 not 0</param>
/// <param name="pageSize">pageSize</param>
/// <param name="useSqlSugarCache">if <paramref name="useSqlSugarCache" /> was true; otherwise.default false</param>
/// <returns>List<TEntity></returns>
List<TEntity> QueryPaging(
Expression<Func<TEntity, bool>>? whereExpression = null,
Expression<Func<TEntity, object>>? orderByExpression = null,
bool isAsc = true,
int startPage = 1,
int pageSize = 20,
bool useSqlSugarCache = false);
/// <summary>
/// QueryPagingAsync - query entities by whereExpression and sort result by strOrderByFields then return toPageListAsync
/// </summary>
/// <param name="whereExpression">if <paramref name="whereExpression" /> is null then query all entities</param>
/// <param name="orderByExpression">if <paramref name="orderByExpression" /> is null then not sort</param>
/// <param name="isAsc">sort type default Asc.must has orderByExpression</param>
/// <param name="startPage">default 1,is not index start 1 not 0</param>
/// <param name="pageSize">pageSize</param>
/// <param name="useSqlSugarCache">if <paramref name="useSqlSugarCache" /> was true; otherwise.default false</param>
/// <returns>Task<List<DataTable>></returns>
Task<List<TEntity>> QueryPagingAsync(
Expression<Func<TEntity, bool>>? whereExpression = null,
Expression<Func<TEntity, object>>? orderByExpression = null,
bool isAsc = true,
int startPage = 1,
int pageSize = 20,
bool useSqlSugarCache = false);
/// <summary>
/// QueryViewModelPaging - query ViewModel<TEntity> by whereExpression and sort result by strOrderByFields then return toPageListAsync
/// </summary>
/// <param name="whereExpression">if <paramref name="whereExpression" /> is null then query all entities</param>
/// <param name="orderByExpression">if <paramref name="orderByExpression" /> is null then not sort</param>
/// <param name="isAsc">sort type default Asc.must has orderByExpression</param>
/// <param name="startPage">default 1,is not index start 1 not 0</param>
/// <param name="pageSize">pageSize</param>
/// <param name="useSqlSugarCache">if <paramref name="useSqlSugarCache" /> was true; otherwise.default false</param>
/// <returns>List<TEntity></returns>
ViewModel<TEntity> QueryViewModelPaging(
Expression<Func<TEntity, bool>>? whereExpression = null,
Expression<Func<TEntity, object>>? orderByExpression = null,
bool isAsc = true,
int startPage = 1,
int pageSize = 20,
bool useSqlSugarCache = false);
/// <summary>
/// QueryViewModelPagingAsync - query ViewModel<TEntity> by whereExpression and sort result by strOrderByFields then return toPageListAsync
/// </summary>
/// <param name="whereExpression">if <paramref name="whereExpression" /> is null then query all entities</param>
/// <param name="orderByExpression">if <paramref name="orderByExpression" /> is null then not sort</param>
/// <param name="isAsc">sort type default Asc.must has orderByExpression</param>
/// <param name="startPage">default 1,is not index start 1 not 0</param>
/// <param name="pageSize">pageSize</param>
/// <param name="useSqlSugarCache">if <paramref name="useSqlSugarCache" /> was true; otherwise.default false</param>
/// <returns>Task<List<TEntity>></returns>
Task<ViewModel<TEntity>> QueryViewModelPagingAsync(
Expression<Func<TEntity, bool>>? whereExpression = null,
Expression<Func<TEntity, object>>? orderByExpression = null,
bool isAsc = true,
int startPage = 1,
int pageSize = 20,
bool useSqlSugarCache = false);
/// <summary>
/// Add - add entity
/// </summary>
/// <param name="entity">entity</param>
/// <returns>Identity</returns>
int Add(TEntity entity);
/// <summary>
/// AddAsync - add entity
/// </summary>
/// <param name="entity">entity</param>
/// <returns>Task<Identity></returns>
Task<int> AddAsync(TEntity entity);
/// <summary>
/// AddListEntities - add list entities
/// </summary>
/// <param name="entities">entities</param>
/// <returns>Identity</returns>
int AddListEntities(List<TEntity> entities);
/// <summary>
/// AddListEntitiesAsync - add list entities
/// </summary>
/// <param name="entities">entities</param>
/// <returns>Task<Identity></returns>
Task<int> AddListEntitiesAsync(List<TEntity> entities);
/// <summary>
/// AddBulkEntities - add bulk list entities
/// </summary>
/// <param name="entities">entities</param>
/// <param name="pageSize">pageSize</param>
/// <returns>Identity</returns>
int AddBulkEntities(List<TEntity> entities, int? pageSize = null);
/// <summary>
/// AddBulkEntitiesAsync - add bulk list entities
/// </summary>
/// <param name="entities">entities</param>
/// <param name="pageSize">pageSize</param>
/// <returns>Task<Identity></returns>
Task<int> AddBulkEntitiesAsync(List<TEntity> entities,int? pageSize=null);
/// <summary>
/// DeleteEntityById - delete entity
/// </summary>
/// <param name="id">the id column must has attr [SugarColumn(IsPrimaryKey=true)]）</param>
/// <returns>bool HasChange was true.otherwise</returns>
bool DeleteEntityById(object id);
/// <summary>
/// DeleteEntityByIdAsync - delete entity
/// </summary>
/// <param name="id">the id column must has attr [SugarColumn(IsPrimaryKey=true)]）</param>
/// <returns>Task<bool> HasChange was true.otherwise</returns>
Task<bool> DeleteEntityByIdAsync(object id);
/// <summary>
/// Delete - delete entity
/// </summary>
/// <param name="entity">entity</param>
/// <returns>bool HasChange was true.otherwise</returns>
bool Delete(TEntity entity);
/// <summary>
/// DeleteAsync - delete entity
/// </summary>
/// <param name="entity">entity</param>
/// <returns>Task<bool> HasChange was true.otherwise</returns>
Task<bool> DeleteAsync(TEntity entity);
/// <summary>
/// DeleteEntitiesByIds - delete entities by ids
/// </summary>
/// <param name="ids">ids</param>
/// <returns>bool HasChange was true.otherwise</returns>
bool DeleteEntitiesByIds(object[] ids);
/// <summary>
/// DeleteEntitiesByIdsAsync - delete entities by ids
/// </summary>
/// <param name="ids">ids</param>
/// <returns>Task<bool> HasChange was true.otherwise</returns>
Task<bool> DeleteEntitiesByIdsAsync(object[] ids);
/// <summary>
/// Update - update entity
/// </summary>
/// <param name="entity">entity</param>
/// <returns>bool HasChange was true.otherwise</returns>
bool Update(TEntity entity);
/// <summary>
/// UpdateAsync - update entity
/// </summary>
/// <param name="entity">entity</param>
/// <returns>Task<bool> HasChange was true.otherwise</returns>
Task<bool> UpdateAsync(TEntity entity);
/// <summary>
/// UpdateBulkEntities - update bulk entities
/// </summary>
/// <param name="entities">entities</param>
/// <param name="pageSize">pageSize</param>
/// <returns>Identity</returns>
int UpdateBulkEntities(List<TEntity> entities, int? pageSize = null);
/// <summary>
/// UpdateBulkEntitiesAsync - update bulk entities
/// </summary>
/// <param name="entities"></param>
/// <param name="pageSize"></param>
/// <returns>Task<Identity></returns>
Task<int> UpdateBulkEntitiesAsync(List<TEntity> entities, int? pageSize = null);
}
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net6.0
- Cola.Core (>= 1.0.3)
- Cola.CoreUtils (>= 1.0.1)
- Microsoft.AspNetCore.Routing (>= 2.2.2)
- Microsoft.EntityFrameworkCore (>= 6.0.0)
- SqlSugar.IOC (>= 2.0.0)
- SqlSugarCore (>= 5.1.4.60)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.