当前位置：首页 > news >正文

NopCommerce 4.9.3全栈开发实战 - 6.3 服务注册与依赖注入

news 2026/7/13 12:36:08

1. 依赖注入概述

依赖注入（Dependency Injection，DI）是NopCommerce架构的核心设计模式之一，它允许对象通过构造函数、属性或方法接收其依赖项，而不是自己创建或查找依赖项。这种设计模式可以提高代码的可测试性、可维护性和可扩展性能

1.1 核心概念

*服务（Service：提供特定功能的对象
**依赖项（Dependency）*：对象所依赖的其他对）- *注入容器（DI Container：负责管理服务的生命周期和依赖关系- *服务注册（Service Registration：将服务类型注册到DI容器- *服务解析（Service Resolution：从DI容器中获取服务实现

1.2 依赖注入的优化

松耦合：降低对象之间的直接依赖
*可测试：便于替换依赖项为模拟对- *可维护：集中管理依赖关系，便于修改和扩展性- *可扩展性：便于添加新的服务和功能
生命周期管理：自动管理服务对象的创建和销

2. NopCommerce依赖注入容器

NopCommerce使用ASP.NET Core内置的依赖注入容器，它是一个轻量级的DI容器，支持构造函数注入、属性注入和方法注入）

2.1 核心接口

ASP.NET Core DI容器的核心接口包括：

IServiceCollection：用于注册服务-IServiceProvider：用于解析服务-IServiceScope：用于管理服务的作用途

2.2 服务生命周期

ASP.NET Core DI容器支持三种服务生命周期）

Singleton：单例模式，整个应用程序生命周期内只创建一个实现2.Scoped：作用域模式，每个请求生命周期内创建一个实现3.Transient：瞬态模式，每次请求时创建一个新实例

3. 服务注册

3.1 核心服务注册

NopCommerce的核心服务注册主要在Startup.cs文件中进行：

publicclassStartup{publicvoidConfigureServices(IServiceCollectionservices){// 添加MVC服务services.AddControllersWithViews();// 添加Razor Pages服务services.AddRazorPages();// 添加NopCommerce核心服务services.AddNopCore();// 添加数据访问服务services.AddNopDataAccess();// 添加认证服务services.AddNopAuthentication();// 添加其他核心服务services.AddNopServices();// 注册自定义服务 RegisterCustomServices(services);}privatevoidRegisterCustomServices(IServiceCollectionservices){// 注册自定义服务 services.AddScoped<ICustomService, CustomService>();services.AddSingleton<ISingletonService,SingletonService>();services.AddTransient<ITransientService,TransientService>();}}

3.2 服务注册方式

3.2.1 基本注册

// 注册接口和实现类services.AddScoped<IProductService,ProductService>();// 注册具体类型services.AddScoped<ProductService>();// 注册实例varsingletonInstance=newSingletonService();services.AddSingleton<ISingletonService>(singletonInstance);// 注册工厂方法services.AddScoped<IProductService>(provider=>{varrepository=provider.GetRequiredService<IRepository<Product>>();varmapper=provider.GetRequiredService<IMapper>();returnnewProductService(repository,mapper);});

3.2.2 泛型服务注册

// 注册泛型服务services.AddScoped(typeof(IRepository<>),typeof(Repository<>));// 注册带约束的泛型服务services.AddScoped(typeof(IBaseService<>),typeof(BaseService<>));

3.2.3 插件服务注册

NopCommerce的插件系统支持动态注册服务，插件可以通过IDependencyInjection接口注册自己的服务：

publicclassDependencyInjection:IDependencyInjection{publicvoidRegister(IServiceCollectionservices,IConfigurationconfiguration){// 注册插件服务services.AddScoped<IPluginService,PluginService>();services.AddScoped<IProductPluginService,ProductPluginService>();// 注册插件视图组件services.AddScoped<ProductPluginViewComponent>();// 注册插件事件消费） services.AddScoped<IEventConsumer<ProductCreatedEvent>, ProductPluginEventConsumer>();}}

3.3 服务注册最佳实现

**使用构造函数注）*：优先使用构造函数注入，避免属性注）2.注册抽象类型：优先注册接口或抽象类，而不是具体类型3.选择合适的生命周期：根据服务的特性选择合适的生命周期
*避免服务定位器模式：尽量避免直接使用IServiceProvider解析服务
集中注册服务：将服务注册集中管理，便于维护和修改

4. 服务解析

4.1 构造函数注）

构造函数注入是NopCommerce中最常用的服务解析方式：

publicclassProductController:Controller{privatereadonlyIProductService_productService;privatereadonlyICustomerService_customerService;// 构造函数注） public ProductController(IProductService productService, ICustomerService customerService){_productService=productService;_customerService=customerService;}publicasyncTask<IActionResult>Index(){varproducts=await_productService.GetAllProductsAsync();returnView(products);}}

4.2 属性注）

属性注入适用于可选依赖项，使用[FromServices]属性标记：

publicclassProductController:Controller{// 属性注） [FromServices]publicILogger<ProductController>Logger{get;set;}privatereadonlyIProductService_productService;publicProductController(IProductServiceproductService){_productService=productService;}publicasyncTask<IActionResult>Index(){Logger.LogInformation("Product index page requested");varproducts=await_productService.GetAllProductsAsync();returnView(products);}}

4.3 方法注入

方法注入适用于在方法执行时获取依赖项）

publicclassProductController:Controller{publicasyncTask<IActionResult>Index([FromServices]IProductServiceproductService){varproducts=awaitproductService.GetAllProductsAsync();returnView(products);}}

4.4 直接解析服务

在某些特殊情况下，可以直接使用IServiceProvider解析服务）

publicclassCustomMiddleware{privatereadonlyRequestDelegate_next;publicCustomMiddleware(RequestDelegatenext){_next=next;}publicasyncTaskInvokeAsync(HttpContextcontext){// 直接解析服务varlogger=context.RequestServices.GetRequiredService<ILogger<CustomMiddleware>>();varproductService=context.RequestServices.GetRequiredService<IProductService>();logger.LogInformation("Custom middleware invoked");// 处理请求await_next(context);}}

4.5 作用域服务解）

对于Scoped服务，需要在作用域内解析）

publicclassSingletonService:ISingletonService{privatereadonlyIServiceProvider_serviceProvider;publicSingletonService(IServiceProviderserviceProvider){_serviceProvider=serviceProvider;}publicasyncTaskDoWorkAsync(){// 创建作用途 using (var scope = _serviceProvider.CreateScope()){// 在作用域内解析Scoped服务varscopedService=scope.ServiceProvider.GetRequiredService<IScopedService>();awaitscopedService.DoWorkAsync();}}}

5. 服务生命周期管理

5.1 生命周期选择原则

服务类型	推荐生命周期	示例
无状态服务	Transient	工具类、辅助服务
有状态服务	Scoped	数据库上下文、业务服务
共享服务	Singleton	配置服务、缓存服务
轻量级服务	Transient	简单的辅助服务
重量级服务	Singleton	资源密集型服务

5.2 生命周期注意事项

避免在Singleton服务中依赖Scoped服务：这会导致Scoped服务的生命周期延长，可能引发线程安全问题
正确管理资源：对于实现了IDisposable接口的服务，DI容器会自动调用Dispose方法
**避免长生命周期服务持有短生命周期服务的引）：这会导致内存泄）4. **使用作用域管理临时资）：对于需要在多个服务之间共享的临时资源，使用作用域管理

6. 依赖注入最佳实现

6.1 设计原则

依赖倒置原则：依赖于抽象，而不是具体实现2.接口隔离原则：服务接口应小而专业性3.单一职责原则：每个服务只负责一个特定的功能
*最少知识原理：服务应只依赖于直接需要的其他服务

6.2 实现最佳实现

**优先使用构造函数注）*：构造函数注入使依赖关系明确，便于测试2.避免过多依赖：一个服务的依赖项不应超）个，否则应考虑拆分服务
使用接口注册服务：便于替换实现和测试
选择合适的生命周期：根据服务的特性选择合适的生命周期
*避免服务定位器模式：尽量避免直接使用IServiceProvider解析服务
集中注册服务：将服务注册集中管理，便于维护和修改
*使用依赖注入容器的功能：充分利用DI容器的生命周期管理、自动注入等功能
**测试时使用模拟对）*：在单元测试中，使用模拟对象替换真实依赖）

6.3 常见问题与解决方案

循环依赖） - 问题：两个或多个服务相互依赖，导致DI容器无法解析
- 解决方案：重构代码，打破循环依赖，或使用属性注入（不推荐）
**服务未注）*） - 问题：尝试解析未注册的服务，导致InvalidOperationException
- 解决方案：确保所有依赖项都已正确注册
*生命周期不匹配） - 问题：在Singleton服务中依赖Scoped服务，导致线程安全问） - 解决方案：重构代码，或使用IServiceScopeFactory创建作用途
过度依赖） - 问题：一个服务依赖过多的其他服务，导致代码难以维护 - 解决方案：拆分服务，减少依赖项数）

7. 自定义依赖注入容）

虽然NopCommerce默认使用ASP.NET Core内置的DI容器，但也支持替换为其他DI容器，如Autofac、Unity、StructureMap等）

7.1 使用Autofac替换默认DI容器

publicclassStartup{publicIServiceProviderConfigureServices(IServiceCollectionservices){// 注册服务services.AddControllersWithViews();services.AddNopCore();// 其他服务注册// 创建Autofac容器构建） var builder = new ContainerBuilder();// 将已注册的服务导入到Autofacbuilder.Populate(services);// 注册Autofac特定的服务 builder.RegisterType<CustomService>().As<ICustomService>().InstancePerLifetimeScope();// 构建Autofac容器varcontainer=builder.Build();// 返回Autofac服务提供程序returnnewAutofacServiceProvider(container);}}