百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术文章 > 正文

C#.NET 依赖注入详解(c#依赖注入容器实现)

zhezhongyun 2025-07-10 22:05 35 浏览

简介

C#.NET 中,依赖注入(Dependency Injection,简称 DI) 是一种设计模式,用于实现控制反转(Inversion of Control,IoC),以降低代码耦合、提高可测试性和可维护性。

依赖注入是将一个对象的依赖(即它所需的其他对象或服务)通过外部提供(注入)的方式传递给它,而不是由对象自身创建或查找依赖。

其核心思想是将对象的创建和依赖管理交给容器(IoC 容器),从而解耦代码。DI 是现代 .NET 开发(尤其是 ASP.NET Core)的核心特性之一,广泛应用于企业级应用。

  • 传统模式(紧耦合):
public class UserService {
    private readonly DbContext _dbContext = new SqlDbContext(); // 直接创建依赖
    public void SaveUser(User user) { _dbContext.Save(user); }
}
  • 依赖注入模式(松耦合):
public class UserService {
    private readonly DbContext _dbContext;
    // 依赖通过构造函数注入
    public UserService(DbContext dbContext) { _dbContext = dbContext; }
    public void SaveUser(User user) { _dbContext.Save(user); }
}

NET DI 的核心实现机制

依赖注入(DI)三种形式

  • 构造函数注入(Constructor Injection)——最常用,依赖通过构造器参数传入。
  • 属性注入(Property Injection)——容器通过公有可写属性注入依赖。
  • 方法注入(Method Injection)——依赖作为某个方法的参数,由容器在调用时提供。
// 三种注入方式示例
public class SampleService {
    // 构造函数注入(必须依赖)
    private readonly ILogger _logger;
    public SampleService(ILogger logger) { _logger = logger; }
    
    // 属性注入(可选依赖)
    public ICache Cache { get; set; }
    
    // 方法注入(临时依赖)
    public void ProcessData(IDataProcessor processor) {
        processor.Process();
    }
}

IServiceProvider 与 ServiceCollection

.NETCore 3.0 开始内置依赖注入框架,核心组件包括:

  • IServiceCollection:用于注册服务的接口
  • IServiceProvider:用于解析服务的接口
  • ServiceLifetime:定义服务的生命周期

服务生命周期(Service Lifetime)

生命周期

实例作用域

典型场景

Transient

每次从容器解析(或每次注入)都会创建新实例

无状态、轻量、并发安全;如邮件发送、日志记录

Scoped

在同一个作用域(Scope)内重用,通常对应 HTTP 请求

Web 请求中同一 DbContext、同一事务

Singleton

容器生命周期内仅创建一次,所有请求共享同一实例

配置、缓存、跨请求共享的服务

// 注册示例(Startup.cs 或 Program.cs)
services.AddSingleton<AppConfig>();         // 单例
services.AddScoped<DbContext>();            // 作用域
services.AddTransient<IMailService, MailService>(); // 瞬时

// 配置选项模式
builder.Services.Configure<EmailSettings>(builder.Configuration.GetSection("Email"));

DI 容器工作流程(RRR 原则)

注册Register->解析Resolve->释放Release

  • 注册:在启动时配置服务与实现的映射(如 services.AddScoped<ILogger, FileLogger>()
  • 解析:容器自动构建依赖树,按需创建实例(递归解析构造函数参数)
  • 释放:对实现了 IDisposable 的服务,容器自动调用 Dispose()(作用域结束时释放作用域服务)

注入方式

构造函数注入

public class UserService : IUserService
{
    private readonly IUserRepository _repo;
    private readonly IEmailSender _email;

    public UserService(IUserRepository repo, IEmailSender email)
    {
        _repo   = repo;
        _email  = email;
    }
    // …
}
  • 优点:依赖清晰、强制性高,易于单元测试。
  • 缺点:参数过多时构造函数臃肿,可考虑组合参数对象或拆分职责。

属性注入

public class ReportGenerator
{
    [Inject]  // 或容器约定:仅对 public 可写属性注入
    public ILogger Logger { get; set; }

    public void Generate() => Logger.Log("Report");
}
  • 使用场景:当依赖为可选,或用在框架层(如 MVC Controller[FromServices] 注入)。

方法注入

public class DataImporter
{
    public void Import([FromServices] IDataReader reader)
    {
        reader.Read();
    }
}
  • 典型场景:ASP.NET Core 中的 Action 方法参数注入。

高级特性

工厂模式注册

services.AddTransient<IConnection>(sp =>
{
    var cfg = sp.GetRequiredService<IConfiguration>();
    return new SqlConnection(cfg.GetConnectionString("Default"));
});

// 注册工厂函数
services.AddTransient<IService>(provider => 
{
    var config = provider.GetRequiredService<IConfiguration>();
    return config["ServiceType"] == "A" 
        ? new ServiceA() 
        : new ServiceB();
});
  • 在注册时通过 IServiceProvider 动态创建实例。

装饰器模式与拦截器一

// 注册日志装饰器
services.AddScoped(typeof(ILogger<>), typeof(LoggingDecorator<>));

services.AddScoped<IService, CoreService>();
services.Decorate<IService, LoggingDecorator>();
services.Decorate<IService, CachingDecorator>();

装饰器模式与拦截器二

public interface ICommandHandler<T>
{
    void Handle(T command);
}

public class LoggingDecorator<T> : ICommandHandler<T>
{
    private readonly ICommandHandler<T> _inner;
    private readonly ILogger _logger;

    public LoggingDecorator(ICommandHandler<T> inner, ILogger<LoggingDecorator<T>> logger)
    {
        _inner = inner;
        _logger = logger;
    }

    public void Handle(T command)
    {
        _logger.LogInformation("Handling command");
        _inner.Handle(command);
    }
}

// 注册装饰器
builder.Services.AddScoped(typeof(ICommandHandler<>), typeof(LoggingDecorator<>));
builder.Services.AddScoped<ICommandHandler<MyCommand>, MyCommandHandler>();

泛型与开放式泛型注册

services.AddScoped(typeof(IRepository<>), typeof(Repository<>));

// 使用
public class ProductService
{
    public ProductService(IRepository<Product> productRepo)
    {
        // ...
    }
}
  • 支持同时注册一类类型的泛型接口与实现。

条件注册

根据环境或配置动态注册服务

if (builder.Environment.IsDevelopment())
{
    builder.Services.AddScoped<IUserService, MockUserService>();
}
else
{
    builder.Services.AddScoped<IUserService, UserService>();
}

多实现处理

// 注册多个实现
services.AddTransient<INotificationService, EmailNotification>();
services.AddTransient<INotificationService, SmsNotification>();
services.AddTransient<INotificationService, PushNotification>();

// 注入所有实现
public class NotificationManager
{
    private readonly IEnumerable<INotificationService> _services;
    
    public NotificationManager(IEnumerable<INotificationService> services)
    {
        _services = services;
    }
    
    public void SendAll(string message)
    {
        foreach (var service in _services)
        {
            service.Send(message);
        }
    }
}

选项模式(Options Pattern)

// 配置类
public class EmailSettings
{
    public string Host { get; set; }
    public int Port { get; set; }
}

// 注册配置
services.Configure<EmailSettings>(Configuration.GetSection("Email"));

// 注入使用
public class EmailService
{
    private readonly EmailSettings _settings;
    
    public EmailService(IOptions<EmailSettings> options)
    {
        _settings = options.Value;
    }
}

服务覆盖

// 默认注册
services.AddScoped<IService, DefaultService>();

// 环境特定覆盖
if (env.IsDevelopment())
{
    services.AddScoped<IService, MockService>();
}

生命周期验证

// 在开发环境启用验证
if (builder.Environment.IsDevelopment())
{
    builder.Services.AddOptions().ValidateOnStart();
}

避免服务定位器反模式

反模式示例(直接通过 ServiceProvider 解析服务)

破坏单一职责原则,导致代码难以测试和维护

public class BadService {
    private readonly IServiceProvider _provider;
    public BadService(IServiceProvider provider) { _provider = provider; }
    public void DoWork() {
        var logger = _provider.GetService<ILogger>(); // 服务定位器反模式
        logger.Log("Work done");
    }
}

依赖注入与异步初始化

当服务需要异步初始化时(如数据库连接),可使用工厂模式

public class AsyncService : IAsyncService {
    private readonly HttpClient _httpClient;
    private bool _isInitialized = false;
    
    public AsyncService(HttpClient httpClient) {
        _httpClient = httpClient;
    }
    
    public async Task InitializeAsync() {
        if (!_isInitialized) {
            // 异步初始化逻辑
            await _httpClient.GetStringAsync("https://api.example.com/init");
            _isInitialized = true;
        }
    }
}

// 注册时使用工厂确保异步初始化
services.AddTransient<IAsyncService>(provider => {
    var service = new AsyncService(provider.GetRequiredService<HttpClient>());
    _ = service.InitializeAsync(); // 非阻塞初始化
    return service;
});

性能优化

// 使用TryAdd防止重复注册
services.TryAddSingleton<ICacheService, MemoryCache>();

// 预编译服务提供者
var serviceProvider = services.BuildServiceProvider(
    new ServiceProviderOptions
    {
        ValidateScopes = true,
        ValidateOnBuild = true
    });

生命周期验证工具

// dotnet add package Microsoft.Extensions.DependencyInjection.Diagnostic
var analyzer = new DependencyInjectionDiagnosticAnalyzer();
analyzer.AnalyzeServices(builder.Services); // 检测生命周期冲突

异常处理

构造函数中检查依赖是否为 null

public MyService(IUserService userService)
{
    _userService = userService ?? throw new ArgumentNullException(nameof(userService));
}

模块化注册

将服务注册逻辑封装到扩展方法

public static class ServiceCollectionExtensions
{
    public static IServiceCollection AddMyServices(this IServiceCollection services)
    {
        services.AddScoped<IUserService, UserService>();
        return services;
    }
}

// 使用
builder.Services.AddMyServices();

依赖注入在ASP.NET Core中的应用

内置 DI 与中间件集成

// Program.cs 配置示例
var builder = WebApplication.CreateBuilder(args);

// 注册服务
builder.Services.AddControllers();
builder.Services.AddDbContext<AppDbContext>(); // 自动使用Scoped生命周期
builder.Services.AddSingleton<IConfiguration>(builder.Configuration);

var app = builder.Build();

// 在中间件中使用依赖注入
app.Use(async (context, next) => {
    var logger = context.RequestServices.GetRequiredService<ILogger<Program>>();
    logger.LogInformation("请求开始");
    await next();
    logger.LogInformation("请求结束");
});

控制器与依赖注入

ASP.NET Core 控制器自动支持构造函数注入

public class UserController : ControllerBase {
    private readonly IUserService _userService;
    private readonly ILogger<UserController> _logger;
    
    public UserController(IUserService userService, ILogger<UserController> logger) {
        _userService = userService;
        _logger = logger;
    }
    
    [HttpGet]
    public IActionResult GetAll() {
        var users = _userService.GetAll();
        _logger.LogInformation("获取用户列表");
        return Ok(users);
    }
}

典型 Web API 项目 示例

// 模型和接口
public record User(int Id, string Name);

public interface IUserRepository
{
    User GetUser(int id);
}

public interface IUserService
{
    string GetUserName(int id);
}

// 实现
public class UserRepository : IUserRepository
{
    public User GetUser(int id) => new User(id, #34;User_{id}");
}

public class UserService : IUserService
{
    private readonly IUserRepository _repository;

    public UserService(IUserRepository repository)
    {
        _repository = repository;
    }

    public string GetUserName(int id) => _repository.GetUser(id).Name;
}

// 注册服务
builder.Services.AddScoped<IUserRepository, UserRepository>();
builder.Services.AddScoped<IUserService, UserService>();

// 控制器
public class UsersController : ControllerBase
{
    private readonly IUserService _userService;

    public UsersController(IUserService userService)
    {
        _userService = userService;
    }

    [HttpGet("{id}")]
    public IActionResult Get(int id)
    {
        return Ok(_userService.GetUserName(id));
    }
}

依赖注入的测试与调试

单元测试中的依赖注入

使用 Moq 等框架模拟依赖

[Test]
public void UserService_ShouldSaveUser() {
    // 1. 创建模拟依赖
    var mockRepo = new Mock<IUserRepository>();
    var mockLogger = new Mock<ILogger<UserService>>();
    
    // 2. 注入模拟对象
    var service = new UserService(mockRepo.Object, mockLogger.Object);
    
    // 3. 设置预期行为
    mockRepo.Setup(x => x.Save(It.IsAny<User>())).Returns(true);
    
    // 4. 执行测试
    var result = service.Save(new User { Id = 1, Name = "Test" });
    
    // 5. 验证结果
    Assert.IsTrue(result);
    mockRepo.Verify(x => x.Save(It.IsAny<User>()), Times.Once);
}

运行时依赖注入调试

使用 .NET 内置的 IServiceProvider 诊断工具

// 打印所有注册的服务
var serviceDescriptors = builder.Services
    .Where(sd => sd.ImplementationType != null)
    .Select(sd => #34;{sd.Lifetime}: {sd.ServiceType.Name} -> {sd.ImplementationType.Name}");
foreach (var descriptor in serviceDescriptors) {
    Console.WriteLine(descriptor);
}

第三方容器集成

Autofac 集成

// 安装包: Autofac.Extensions.DependencyInjection
builder.Host.UseServiceProviderFactory(new AutofacServiceProviderFactory());

// 配置模块
builder.Host.ConfigureContainer<ContainerBuilder>(builder => 
{
    builder.RegisterModule<MyApplicationModule>();
});

DryIoc 集成

// 安装包: DryIoc.Microsoft.DependencyInjection
builder.Host.UseServiceProviderFactory(new DryIocServiceProviderFactory());

常见陷阱及解决方案

陷阱

现象

解决方案

生命周期不匹配

作用域服务注入单例服务

确保依赖的生命周期 <= 消费者

捕获依赖

单例服务持有瞬时服务引用

使用IServiceScopeFactory创建作用域

循环依赖

StackOverflow异常

重构设计,引入中介者模式

过多构造函数参数

类职责过重

应用领域驱动设计,拆分聚合

相关推荐

Python入门学习记录之一:变量_python怎么用变量

写这个,主要是对自己学习python知识的一个总结,也是加深自己的印象。变量(英文:variable),也叫标识符。在python中,变量的命名规则有以下三点:>变量名只能包含字母、数字和下划线...

python变量命名规则——来自小白的总结

python是一个动态编译类编程语言,所以程序在运行前不需要如C语言的先行编译动作,因此也只有在程序运行过程中才能发现程序的问题。基于此,python的变量就有一定的命名规范。python作为当前热门...

Python入门学习教程:第 2 章 变量与数据类型

2.1什么是变量?在编程中,变量就像一个存放数据的容器,它可以存储各种信息,并且这些信息可以被读取和修改。想象一下,变量就如同我们生活中的盒子,你可以把东西放进去,也可以随时拿出来看看,甚至可以换成...

绘制学术论文中的“三线表”具体指导

在科研过程中,大家用到最多的可能就是“三线表”。“三线表”,一般主要由三条横线构成,当然在变量名栏里也可以拆分单元格,出现更多的线。更重要的是,“三线表”也是一种数据记录规范,以“三线表”形式记录的数...

Python基础语法知识--变量和数据类型

学习Python中的变量和数据类型至关重要,因为它们构成了Python编程的基石。以下是帮助您了解Python中的变量和数据类型的分步指南:1.变量:变量在Python中用于存储数据值。它们充...

一文搞懂 Python 中的所有标点符号

反引号`无任何作用。传说Python3中它被移除是因为和单引号字符'太相似。波浪号~(按位取反符号)~被称为取反或补码运算符。它放在我们想要取反的对象前面。如果放在一个整数n...

Python变量类型和运算符_python中变量的含义

别再被小名词坑哭了:Python新手常犯的那些隐蔽错误,我用同事的真实bug拆给你看我记得有一次和同事张姐一起追查一个看似随机崩溃的脚本,最后发现罪魁祸首竟然是她把变量命名成了list。说实话...

从零开始:深入剖析 Spring Boot3 中配置文件的加载顺序

在当今的互联网软件开发领域,SpringBoot无疑是最为热门和广泛应用的框架之一。它以其强大的功能、便捷的开发体验,极大地提升了开发效率,成为众多开发者构建Web应用程序的首选。而在Spr...

Python中下划线 ‘_’ 的用法,你知道几种

Python中下划线()是一个有特殊含义和用途的符号,它可以用来表示以下几种情况:1在解释器中,下划线(_)表示上一个表达式的值,可以用来进行快速计算或测试。例如:>>>2+...

解锁Shell编程:变量_shell $变量

引言:开启Shell编程大门Shell作为用户与Linux内核之间的桥梁,为我们提供了强大的命令行交互方式。它不仅能执行简单的文件操作、进程管理,还能通过编写脚本实现复杂的自动化任务。无论是...

一文学会Python的变量命名规则!_python的变量命名有哪些要求

目录1.变量的命名原则3.内置函数尽量不要做变量4.删除变量和垃圾回收机制5.结语1.变量的命名原则①由英文字母、_(下划线)、或中文开头②变量名称只能由英文字母、数字、下画线或中文字所组成。③英文字...

更可靠的Rust-语法篇-区分语句/表达式,略览if/loop/while/for

src/main.rs://函数定义fnadd(a:i32,b:i32)->i32{a+b//末尾表达式}fnmain(){leta:i3...

C++第五课:变量的命名规则_c++中变量的命名规则

变量的命名不是想怎么起就怎么起的,而是有一套固定的规则的。具体规则:1.名字要合法:变量名必须是由字母、数字或下划线组成。例如:a,a1,a_1。2.开头不能是数字。例如:可以a1,但不能起1a。3....

Rust编程-核心篇-不安全编程_rust安全性

Unsafe的必要性Rust的所有权系统和类型系统为我们提供了强大的安全保障,但在某些情况下,我们需要突破这些限制来:与C代码交互实现底层系统编程优化性能关键代码实现某些编译器无法验证的安全操作Rus...

探秘 Python 内存管理:背后的神奇机制

在编程的世界里,内存管理就如同幕后的精密操控者,确保程序的高效运行。Python作为一种广泛使用的编程语言,其内存管理机制既巧妙又复杂,为开发者们提供了便利的同时,也展现了强大的底层控制能力。一、P...