第2章 逻辑分页、AutoFac注入、工作单元与仓储
1 CoreCms.Net.Model.ViewModels.Basics.IPageList
namespace CoreCms.Net.Model.ViewModels.Basics
{
///
///
/// 【逻辑分页列表--接口】
///
/// 摘要：
/// 通过继承该接口的具体实现类中的属性成员实例，逻辑的从数据源中加载指定1页中的数据，存储到1逻辑页中，从而尽量少的从指定表加载数据，从而尽量降低内存的消耗。
/// 说明：
/// 逻辑分页交互操作对象是当前程序与数据库的指定表。
///
///
public interface IPageList<T> : IList<T>
{
#region 属性
///
/// 【当前页】
///
/// 摘要：
/// 获取/设置当前页，当前逻辑(内存)页面的整型索引值，从“0”开始计算。
///
///
int PageIndex { get; }
///
/// 【页面大小】
///
/// 摘要：
/// 获取/设置页面大小，即1逻辑(内存)页面最多所存储的实例项的整型个数值。
///
///
int PageSize { get; }
///
/// 【总计值】
///
/// 摘要：
/// 获取/设置数据源实例项的整型总计值。
///
///
int TotalCount { get; }
///
/// 【总页数】
///
/// 摘要：
/// 获取/设置总页数，即数据源实例项，可以分为逻辑页数的总计值。
///
///
int TotalPages { get; }
///
/// 【上1页？】
///
/// 摘要：
/// 获取1个值false(没有)/true(有)，该值指示在逻辑(内存)分页操作中当前页是否有上1页(第1页之前没有上1页)。
///
///
bool HasPreviousPage { get; }
///
/// 【下1页？】
///
/// 摘要：
/// 获取1个值false(没有)/true(有)，该值指示在逻辑(内存)分页操作中当前页是否有下1页(最后1页之后没有下1页)。
///
///
bool HasNextPage { get; }
#endregion
}
}
2 CoreCms.Net.Model.ViewModels.Basics.PageList
namespace CoreCms.Net.Model.ViewModels.Basics
{
///
///
/// 【逻辑分页列表--类】
///
/// 摘要：
/// 通过该类及其属性成员实例，只逻辑的从数据源中加载指定1页中的数据，存储到1(逻辑)页中，从而尽量少的从指定表加载数据，从而尽量降低内存的消耗。
/// 说明：
/// (逻辑)分页交互操作对象是当前程序与数据库的指定表。
/// [Serializable]：
/// 序列化可以对象的状态信息转换成可以持久化或者可以传输形式的过程。一般是转为字节数据。而把字节数组还原成原来同等对象的过程成为反序列化。
/// 这里特指把逻辑分页实体中的所有数据换成可以进行网络传输的形式。
///
///
[Serializable]
public class PageList<T> : List<T>, IPageList<T>
{
#region 拷贝构造方法
///
///
///
///
///
/// 【拷贝构造方法】
///
/// 摘要：
/// 通过拷贝构造方法为该类中的属性成员赋值实例化初始值，并获取1逻辑(内存)页面内的所有数据。
///
///
public PageList(IQueryable<T> source, int pageIndex, int pageSize)
{
var total = source.Count();
TotalCount = total;
TotalPages = total / pageSize;
if (total % pageSize > 0)
TotalPages++;
PageSize = pageSize;
PageIndex = pageIndex;
AddRange(source.Skip(pageIndex * pageSize).Take(pageSize).ToList());
}
///
///
///
///
/// 【拷贝构造方法】
///
/// 摘要：
/// 通过拷贝构造方法为该类中的属性成员赋值实例化初始值，并获取1逻辑(内存)页面内的所有数据。
///
///
public PageList(IList<T> source, int pageIndex, int pageSize)
{
TotalCount = source.Count();
TotalPages = TotalCount / pageSize;
if (TotalCount % pageSize > 0)
TotalPages++;
PageSize = pageSize;
PageIndex = pageIndex;
AddRange(source.Skip(pageIndex * pageSize).Take(pageSize).ToList());
}
///
///
///
///
///
/// 【拷贝构造方法】
///
/// 摘要：
/// 通过拷贝构造方法为该类中的属性成员赋值实例化初始值，并获取1逻辑(内存)页面内的所有数据。
///
///
public PageList(IEnumerable<T> source, int pageIndex, int pageSize, int totalCount)
{
TotalCount = totalCount;
TotalPages = TotalCount / pageSize;
if (TotalCount % pageSize > 0)
TotalPages++;
PageSize = pageSize;
PageIndex = pageIndex;
AddRange(source);
}
#endregion
#region 属性
///
/// 【当前页】
///
/// 摘要：
/// 获取/设置当前页，当前逻辑(内存)页面的整型索引值，从“0”开始计算。
///
///
public int PageIndex { get; }
///
/// 【页面大小】
///
/// 摘要：
/// 获取/设置页面大小，即1逻辑(内存)页面最多所存储的实例项的整型个数值。
///
///
public int PageSize { get; private set; }
///
/// 【总计值】
///
/// 摘要：
/// 获取/设置数据源实例项的整型总计值。
///
///
public int TotalCount { get; }
///
/// 【总页数】
///
/// 摘要：
/// 获取/设置总页数，即数据源实例项，可以分为逻辑页数的总计值。
///
///
public int TotalPages { get; }
///
/// 【上1页？】
///
/// 摘要：
/// 获取1个值false(没有)/true(有)，该值指示在逻辑(内存)分页操作中当前页是否有上1页(第1页之前没有上1页)。
///
///
public bool HasPreviousPage => PageIndex > 0;
///
/// 【下1页？】
///
/// 摘要：
/// 获取1个值false(没有)/true(有)，该值指示在逻辑(内存)分页操作中当前页是否有下1页(最后1页之后没有下1页)。
///
///
public bool HasNextPage => PageIndex + 1 < TotalPages;
#endregion
}
}
3 CoreCms.Net.Core.AutoFac.AutofacModuleRegister
using Autofac;
using System.Reflection;
namespace CoreCms.Net.Core.AutoFac
{
///
/// 【Autofac模型注入--类】
///
/// 摘要：
/// 通过该类中的方法成员把指定的程序集(*.dll)依赖注入到Autofac容器中。
///
///
public class AutofacModuleRegister : Autofac.Module
{
///
///
/// 【载入】
///
/// 摘要：
/// 通过该方法把指定程序集中的所有实例依赖注入到Autofac容器中。
///
///
protected override void Load(ContainerBuilder builder)
{
//获取当前程序启动项程序集(*.dll)文件所在目录(文件夹)的绝对路径字符串(这里特指“..\bin\Debug\net7.0”)。
var basePath = AppContext.BaseDirectory;
#region 带有接口层的服务注入
//var servicesDllFile = Path.Combine(basePath, "CoreCms.Net.Services.dll");
var repositoryDllFile = Path.Combine(basePath, "CoreCms.Net.Repository.dll");
/* if (!(File.Exists(servicesDllFile) && File.Exists(repositoryDllFile)))
{
var msg = "Repository.dll和Services.dll 丢失，因为项目解耦了，所以需要先F6编译，再F5运行，请检查 bin 文件夹，并拷贝。";
throw new Exception(msg);
}*/
// 获取 Service.dll 程序集服务，并注册
/*var assemblysServices = Assembly.LoadFrom(servicesDllFile);
//支持属性注入依赖重复
builder.RegisterAssemblyTypes(assemblysServices).AsImplementedInterfaces().InstancePerDependency()
.PropertiesAutowired(PropertyWiringOptions.AllowCircularDependencies);
*/
// 获取 Repository.dll 程序集服务，并注册
var assemblysRepository = Assembly.LoadFrom(repositoryDllFile);
//支持属性注入依赖重复
builder.RegisterAssemblyTypes(assemblysRepository).AsImplementedInterfaces().InstancePerDependency()
.PropertiesAutowired(PropertyWiringOptions.AllowCircularDependencies);
#endregion
}
}
}
4 Program.cs
#region AutoFac注册============================================================================
builder.Host.UseServiceProviderFactory(new AutofacServiceProviderFactory());
builder.Host.ConfigureContainer<ContainerBuilder>(containerBuilder =>
{
//获取所有控制器类型并使用属性注入
var controllerBaseType = typeof(ControllerBase);
containerBuilder.RegisterAssemblyTypes(typeof(Program).Assembly)
.Where(t => controllerBaseType.IsAssignableFrom(t) && t != controllerBaseType)
.PropertiesAutowired();
containerBuilder.RegisterModule(new AutofacModuleRegister());
});
#endregion
5 CoreCms.Net.IRepository.UnitOfWork.IUnitOfWork
using SqlSugar;
namespace CoreCms.Net.IRepository.UnitOfWork
{
///
/// 【工作单元--类】
///
/// 摘要：
/// 通过继承该接口的具体实现类中的方法成员，获取SqlSugarScope(用单例AddSingleton 单例)上下文中间件实例，从而为实现实体与表的CURD操作提供支撑。
///
///
public interface IUnitOfWork
{
#region 方法
///
/// 【获取数据库数据端】
///
/// 摘要：
/// 获取SqlSugarScope(用单例AddSingleton 单例)上下文中间件实例，该实例为通过 SqlSugar中间件实现实体与表的CURD操作提供支撑。
///
///
SqlSugarScope GetDbClient();
///
/// 【事务开始】
///
/// 摘要：
/// 该方法通过事务操作实现实现实体与表的CURD操作提供支撑，该方法主要指开启1个事务。
///
///
void BeginTran();
///
/// 【事务提交】
///
/// 摘要：
/// 该方法通过事务操作实现实现实体与表的CURD操作提供支撑，该方法主要指把1个事务中的所有操作进行提交到指定的数据库中。
///
///
void CommitTran();
///
/// 【事务回滚】
///
/// 摘要：
/// 该方法通过事务操作实现实现实体与表的CURD操作提供支撑，当把1个事务中的所有操作进行提交到指定的数据库的过程中如果出现异常时，则通过该方法实现回滚。
///
///
void RollbackTran();
#endregion
}
}
6 CoreCms.Net.IRepository.UnitOfWork.UnitOfWork
using CoreCms.Net.IRepository.UnitOfWork;
//using CoreCms.Net.Loging;
//using NLog;
using SqlSugar;
using SqlSugar.IOC;
namespace CoreCms.Net.Repository.UnitOfWork
{
///
/// 【工作单元--类】
///
/// 摘要：
/// 通过该类中的成员获取SqlSugarScope(用单例AddSingleton 单例)上下文中间件实例，从而为实现实体与表的CURD操作提供支撑。
///
///
public class UnitOfWork : IUnitOfWork
{
#region 拷贝构造方法与变量
///
/// 【上下文中间件实例】
///
/// 摘要：
/// ISqlSugarClient(用 AddScoped 每次请求一个实例)上下文中间件实例，该实例为通过 SqlSugar中间件实现实体与表的CURD操作提供支撑。
///
///
private readonly ISqlSugarClient _sqlSugarClient;
///
/// 【拷贝构造方法】
///
/// 摘要：
/// 通过该拷贝构造方法，对当前类中变量成员进行实例化。
///
///
public UnitOfWork()
{
_sqlSugarClient = DbScoped.SugarScope;
}
#endregion
#region 方法
///
/// 【获取数据库数据端】
///
/// 摘要：
/// 获取SqlSugarScope(用单例AddSingleton 单例)上下文中间件实例，该实例为通过 SqlSugar中间件实现实体与表的CURD操作提供支撑。
///
///
public SqlSugarScope GetDbClient()
{
// 必须要as，后边会用到切换数据库操作
return _sqlSugarClient as SqlSugarScope;
}
///
/// 【事务开始】
///
/// 摘要：
/// 该方法通过事务操作实现实现实体与表的CURD操作提供支撑，该方法主要指开启1个事务。
///
///
public void BeginTran()
{
GetDbClient().BeginTran();
}
///
/// 【事务提交】
///
/// 摘要：
/// 该方法通过事务操作实现实现实体与表的CURD操作提供支撑，该方法主要指把1个事务中的所有操作进行提交到指定的数据库中。
///
///
public void CommitTran()
{
try
{
GetDbClient().CommitTran();
}
catch (Exception ex)
{
GetDbClient().RollbackTran();
// NLogUtil.WriteFileLog(LogLevel.Error, LogType.Web, "事务提交异常", "事务提交异常", new Exception("事务提交异常", ex));
throw;
}
}
///
/// 【事务回滚】
///
/// 摘要：
/// 该方法通过事务操作实现实现实体与表的CURD操作提供支撑，当把1个事务中的所有操作进行提交到指定的数据库的过程中如果出现异常时，则通过该方法实现回滚。
///
///
public void RollbackTran()
{
GetDbClient().RollbackTran();
}
#endregion
}
}
12 CoreCms.Net.Web.Admin.Controllers.SysRoleController
using Microsoft.AspNetCore.Mvc;
using System.ComponentModel;
using CoreCms.Net.IRepository;
namespace CoreCms.Net.Web.Admin.Controllers
{
[ApiController]
[Route("[controller]/[action]")]
public class SysRoleController : ControllerBase
{
private readonly ISysRoleRepository _dal;
public SysRoleController(ISysRoleRepository dal)
{
_dal = dal;
}
#region 获取列表============================================================
[HttpPost]
[Description("获取列表")]
public async Task</*AdminUiCallBack*/ bool> GetPageList()
{
var v = await _dal.QueryPageAsync(null,"");
return true;
}
#endregion
}
}
对以上功能更为具体实现和注释见：230727_002CoreShop230628(逻辑分页、AutoFac注入、工作单元与仓储)。