基于SqlSugar的开发框架循序渐进介绍（5）-- 在服务层使用接口注入方式实现IOC控制反转

在前面随笔，我们介绍过这个基于SqlSugar的开发框架，我们区分Interface、Modal、Service三个目录来放置不同的内容，其中Modal是SqlSugar的映射实体，Interface是定义访问接口，Service是提供具体的数据操作实现。在Service层中，往往除了本身的一些增删改查等处理操作外，也需要涉及到相关业务的服务接口，这些服务接口我们通过利用.net 的接口注入方式，实现IOC控制反转的处理的。

1、框架Service层的模块

如下面的VS中的项目服务层，包含很多业务表的服务接口实现，如下所示。

我们以其中简单的Customer业务表为例，它的服务类代码如下所示（主要关注服务类的定义即可）。

    /// <summary>
    /// 客户信息应用层服务接口实现
    /// </summary>
    public class CustomerService : MyCrudService<CustomerInfo, string, CustomerPagedDto>, ICustomerService
    {
       ...............
    }

它除了在泛型约束中增加SqlSugar实体类，主键类型，分页条件对象外，还继承接口 ICustomerService ，这个接口就是我们实现IOC的第一步，服务层继承指定的接口实现，对我们实现IOC控制反转提供便利。

    /// <summary>
    /// 客户信息服务接口
    /// </summary>
    public interface ICustomerService : IMyCrudService<CustomerInfo, string, CustomerPagedDto>, ITransientDependency
    {

    }

这个客户信息业务处理，是比较典型的单表处理案例，它没有涉及到相关服务接口的整合，如果我们在其中服务接口中需要调用其他服务接口，那么我们就需要通过构造函数注入接口对象的方式获得对象的实例，如下我们说介绍的就是服务调用其他相关接口的实现。

2、服务层的接口注入

如对于角色服务接口来说，它往往和用户、机构有关系，因此我们在角色的服务接口层，可以整合用户、机构的对应服务接口，如下代码所示。

    /// <summary>
    /// 角色信息 应用层服务接口实现
    /// </summary>
    public class RoleService : MyCrudService<RoleInfo,int, RolePagedDto>, IRoleService
    {
        private IOuService _ouService;
        private IUserService _userService;

        /// <summary>
        /// 默认构造函数
        /// </summary>
        /// <param name="ouService">机构服务接口</param>
        /// <param name="userService">用户服务接口</param>
        public RoleService(IOuService ouService, IUserService userService)
        {
            this._ouService = ouService;
            this._userService = userService;
        }

}

通过构造函数的注入，我们就可以获得对应接口实现的实例，进行调用它的服务层方法使用了。

这样我们在角色的服务接口实现中，就可以调用其他如用户、机构相关的服务接口了。

其他模块的处理方式也是类似，如字典项目中，使用字典类型的服务接口。

    /// <summary>
    /// 应用层服务接口实现
    /// </summary>
    public class DictDataService : MyCrudService<DictDataInfo, string, DictDataPagedDto> , IDictDataService
    {
        /// <summary>
        /// 测试字典类型接口
        /// </summary>
        protected IDictTypeService _dictTypeService;

        /// <summary>
        /// 注入方式获取接口
        /// </summary>
        /// <param name="dictTypeService">字典类型处理</param>
        public DictDataService(IDictTypeService dictTypeService)
        {
            this._dictTypeService = dictTypeService;
        }
}

这里值得注意的是，由于接口层是同级对象，因此要避免接口的相互引用而导致出错，依赖关系要清晰，才不会发生这个情况。

3、服务接口的实例的容器注册

在服务层中，我们是通过参数化构造函数的方式，引入对应的接口的，这个操作方式是构造函数的注入处理。

不过在此之前，我们需要在.net 的内置IOC容器中注册对应的接口实例，否则参数化构造函数会因为找不到接口实例而出错。

.net 的内置Ioc容器及注册处理，我们需要在nuget引入下面两个引用。

1、Microsoft.Extensions.DependencyInjection
2、Microsoft.Extensions.DependencyInjection.Abstractions

.net 中 负责依赖注入和控制反转的核心组件有两个：IServiceCollection和IServiceProvider。其中，IServiceCollection负责注册，IServiceProvider负责提供实例。

在注册接口和类时，IServiceCollection提供了三种注册方法，如下所示：

1、services.AddTransient<IDictDataService, DictDataService>();  // 瞬时生命周期
2、services.AddScoped<IDictDataService, DictDataService>();     // 域生命周期
3、services.AddSingleton<IDictDataService, DictDataService>();  // 全局单例生命周期

如果使用AddTransient方法注册，IServiceProvider每次都会通过GetService方法创建一个新的实例；

如果使用AddScoped方法注册， 在同一个域（Scope）内，IServiceProvider每次都会通过GetService方法调用同一个实例，可以理解为在局部实现了单例模式；

如果使用AddSingleton方法注册， 在整个应用程序生命周期内，IServiceProvider只会创建一个实例。

我们为了在注册的时候方便通过遍历方式处理接口实例的注册，因此我们根据这几种关系定义了几个基类接口，便于根据特定的接口方式来构建接口实例。

namespace WHC.Framework.ControlUtil
{
    //用于定义这三种生命周期的标识接口

    /// <summary>
    /// 三种标识接口的基类接口
    /// </summary>
    public interface IDependency
    {
    }
    /// <summary>
    /// 瞬时（每次都重新实例）
    /// </summary>
    public interface ITransientDependency : IDependency
    {
    }
    /// <summary>
    /// 单例（全局唯一）
    /// </summary>
    public interface ISingletonDependency : IDependency
    {
    }
    /// <summary>
    /// 一个请求内唯一（线程内唯一）
    /// </summary>
    public interface IScopedDependency : IDependency
    {
    }
}

这样我们在定义注册类型的时候，通过它的接口指定属于上面那种类型。如对于字典项目的服务层，我们约定采用瞬时的注册方式，那么它的接口定义如下所示。

    /// <summary>
    /// 字典项目服务接口
    /// </summary>
    public interface IDictDataService : IMyCrudService<DictDataInfo, string, DictDataPagedDto>, ITransientDependency
    {
    }

配置自动注册接口的时候，我们添加如下函数处理即可。

        /// <summary>
        /// 配置依赖注入对象
        /// </summary>
        /// <param name="services"></param>
        public static void ConfigureRepository(IServiceCollection services)
        {
            #region 自动注入对应的服务接口
            //services.AddSingleton<IDictDataService, DictDataService>();//services.AddScoped<IUserService, UserService>();

            var baseType = typeof(IDependency);
            var path = AppDomain.CurrentDomain.RelativeSearchPath ?? AppDomain.CurrentDomain.BaseDirectory;
            var getFiles = Directory.GetFiles(path, "*.dll").Where(Match);  //.Where(o=>o.Match())
            var referencedAssemblies = getFiles.Select(Assembly.LoadFrom).ToList();  //.Select(o=> Assembly.LoadFrom(o))         

            var ss = referencedAssemblies.SelectMany(o => o.GetTypes());

            var types = referencedAssemblies
                .SelectMany(a => a.DefinedTypes)
                .Select(type => type.AsType())
                .Where(x => x != baseType && baseType.IsAssignableFrom(x)).ToList();
            var implementTypes = types.Where(x => x.IsClass).ToList();
            var interfaceTypes = types.Where(x => x.IsInterface).ToList();
            foreach (var implementType in implementTypes)
            {
                if (typeof(IScopedDependency).IsAssignableFrom(implementType))
                {
                    var interfaceType = interfaceTypes.FirstOrDefault(x => x.IsAssignableFrom(implementType));
                    if (interfaceType != null)
                        services.AddScoped(interfaceType, implementType);
                }
                else if (typeof(ISingletonDependency).IsAssignableFrom(implementType))
                {
                    var interfaceType = interfaceTypes.FirstOrDefault(x => x.IsAssignableFrom(implementType));
                    if (interfaceType != null)
                        services.AddSingleton(interfaceType, implementType);
                }
                else
                {
                    var interfaceType = interfaceTypes.FirstOrDefault(x => x.IsAssignableFrom(implementType));
                    if (interfaceType != null)
                        services.AddTransient(interfaceType, implementType);
                }
            }
            #endregion
        }

上面根据我们自定义接口的不同，适当的采用不同的注册方式来加入Ioc容器中，从而实现了接口的注册，在服务层中就可以通过构造函数注入的方式获得对应的接口实例了。

这样，不管是在WInform的启动模块中，还是在Web API的启动模块中，我们在IOC容器中加入对应的接口即可，如下所示。

/// <summary>
/// 应用程序的主入口点。
/// </summary>
[STAThread]
static void Main()
{
    // IServiceCollection负责注册
    IServiceCollection services = new ServiceCollection();
    //services.AddSingleton<IDictDataService, DictDataService>();
    //services.AddSingleton<IDictTypeService, DictTypeService>();

    //添加IApiUserSession实现类
    services.AddSingleton<IApiUserSession, ApiUserPrincipal>();

    //调用自定义的服务注册
    ServiceInjection.ConfigureRepository(services);

    // IServiceProvider负责提供实例
    IServiceProvider provider = services.BuildServiceProvider();
    services.AddSingleton(provider);//注册到服务集合中,需要可以在Service中构造函数中注入使用

Web API中的代码如下所示

//添加HTTP上下文访问
builder.Services.AddHttpContextAccessor();

//配置依赖注入访问数据库
ServiceInjection.ConfigureRepository(builder.Services);

//添加IApiUserSession实现类
builder.Services.AddSingleton<IApiUserSession, ApiUserPrincipal>();

var app = builder.Build();

都是类似的处理方式。

同样在Web API项目中的控制器处理中，也是一样通过构造函数注入的方式使用接口的，如下所示。

namespace WebApi.Controllers
{
    /// <summary>
    /// 客户信息的控制器对象
    /// </summary>
    public class CustomerController : BusinessController<CustomerInfo, string, CustomerPagedDto>
    {
        private ICustomerService _customerService;

        /// <summary>
        /// 构造函数，并注入基础接口对象
        /// </summary>
        /// <param name="customerService"></param>
        public CustomerController(ICustomerService customerService) :base(customerService)
        {
            this._customerService = customerService;
        }
    }
}

或者登录处理的控制器定义如下。

    /// <summary>
    /// 登录获取令牌授权的处理
    /// </summary>
    [Route("api/[controller]")]
    [ApiController]
    public class LoginController : ControllerBase
    {
        private readonly IHttpContextAccessor _contextAccessor;
        private readonly IConfiguration _configuration;
        private readonly IUserService _userService;

        /// <summary>
        /// 令牌失效天数，默认令牌7天有效期
        /// </summary>
        protected const int expiredDays = 7;

        /// <summary>
        /// 构造函数，注入所需接口
        /// </summary>
        /// <param name="configuration">配置对象</param>
        /// <param name="httpContext">HTTP上下文对象</param>
        /// <param name="userService">用户信息</param>
        public LoginController(IConfiguration configuration, IHttpContextAccessor httpContext,
            IUserService userService)
        {
            this._configuration = configuration;
            this._contextAccessor = httpContext;
            this._userService = userService;
        }

系列文章：

《基于SqlSugar的开发框架的循序渐进介绍（1）--框架基础类的设计和使用》

《基于SqlSugar的开发框架循序渐进介绍（2）-- 基于中间表的查询处理》

《基于SqlSugar的开发框架循序渐进介绍（3）-- 实现代码生成工具Database2Sharp的整合开发》

《基于SqlSugar的开发框架循序渐进介绍（4）-- 在数据访问基类中对GUID主键进行自动赋值处理》

《基于SqlSugar的开发框架循序渐进介绍（5）-- 在服务层使用接口注入方式实现IOC控制反转》