C# DependencyInjection 避免踩坑事项

崇文馆居士

于 2024-08-09 18:11:18 发布

阅读量389

点赞数 3

文章标签： c# 开发语言

本文链接：https://blog.csdn.net/qq_34677276/article/details/141068549

版权

在使用 Microsoft.Extensions.DependencyInjection（也就是 ASP.NET Core 的依赖注入框架）时，有几个关键点需要注意，以避免常见的陷阱：

1. 服务生命周期管理

ASP.NET Core 提供了三种主要的服务生命周期：

Transient：每次请求都会创建一个新的实例。适用于无状态的轻量级服务。
Scoped：在每个请求的生命周期内创建一个实例。适用于需要在一个请求的上下文中共享的服务。
Singleton：应用程序启动后只创建一个实例，适用于整个应用程序中唯一的、无状态的服务。

注意事项：

线程安全：如果服务是 Singleton，需要确保其线程安全，因为多个请求会共享同一个实例。
依赖关系：避免将 Transient 或 Scoped 服务注入到 Singleton 服务中，这可能导致生命周期不一致的问题。

2. 避免使用 `Service Locator` 模式

虽然你可以通过 IServiceProvider 来获取服务实例，但这通常被认为是反模式（Service Locator 反模式）。正确的做法是使用构造函数注入或方法注入来请求依赖项。

// 不推荐的做法
public class MyService
{
    private readonly IServiceProvider _serviceProvider;

    public MyService(IServiceProvider serviceProvider)
    {
        _serviceProvider = serviceProvider;
    }

    public void DoWork()
    {
        var anotherService = _serviceProvider.GetRequiredService<AnotherService>();
        anotherService.PerformTask();
    }
}

// 推荐的做法
public class MyService
{
    private readonly AnotherService _anotherService;

    public MyService(AnotherService anotherService)
    {
        _anotherService = anotherService;
    }

    public void DoWork()
    {
        _anotherService.PerformTask();
    }
}

3. 避免内存泄漏

特别是在使用 Scoped 和 Singleton 服务时，需要小心内存泄漏。确保及时释放资源，特别是当使用了实现 IDisposable 的服务时。可以通过依赖注入的方式自动处理资源的释放。

public class MyDisposableService : IDisposable
{
    public void Dispose()
    {
        // 释放资源
    }
}

services.AddScoped<MyDisposableService>();

4. 避免依赖注入过度

虽然依赖注入是一个强大的工具，但过度使用可能会导致代码难以维护。如果某个类的依赖项过多（通常超过 3-4 个），可能意味着该类职责过多，应该考虑拆分。

5. 确保服务注册的顺序正确

某些服务可能依赖于其他服务的配置或存在顺序依赖。确保在 ConfigureServices 中按正确的顺序注册服务。

6. 服务注册时避免覆盖问题

如果你不小心多次注册了相同的服务类型，后注册的服务将覆盖前面的注册。这在复杂的应用程序中可能会引起意外的行为。

7. 使用 `IServiceCollection` 的扩展方法

创建自定义的 IServiceCollection 扩展方法，可以帮助保持 Startup 类的整洁，特别是当需要注册很多服务时。

public static class ServiceCollectionExtensions
{
    public static IServiceCollection AddMyCustomServices(this IServiceCollection services)
    {
        services.AddTransient<MyService>();
        services.AddScoped<AnotherService>();
        // 其他服务注册
        return services;
    }
}

// Startup.cs
public void ConfigureServices(IServiceCollection services)
{
    services.AddMyCustomServices();
}

8. 理解 DI 的延迟解析

有时你可能需要延迟解析依赖项，这可以通过在构造函数中注入 Func<T> 或 Lazy<T> 来实现。

public class MyService
{
    private readonly Func<AnotherService> _serviceFactory;

    public MyService(Func<AnotherService> serviceFactory)
    {
        _serviceFactory = serviceFactory;
    }

    public void DoWork()
    {
        var anotherService = _serviceFactory();
        anotherService.PerformTask();
    }
}