.net 溫故知新【13】：Asp.Net Core WebAPI 使用依賴注入DI

XSpringSun發表於2023-11-09
ASP.NETWebAPI依賴注入

一、使用DI注入

在之前的文章中已經講過DI的概念（.net 溫故知新：【7】IOC控制反轉，DI依賴注入），基於控制檯程式演示了DI依賴注入的使用，基於Microsoft.Extensions.DependencyInjection完成。那在WebAPI中如何使用依賴注入呢？

首先新建一個WebAPI專案WebAPI_DI，框架.net 7，其實 webapi 專案也是控制檯應用程式，只是在Asp.Net Core webapi框架中很多基礎工作已經幫我們封裝配置好了。

專案新建完成後在Program.cs 中自動生成如下程式碼：

namespace WebAPI_DI
{
    public class Program
    {
        public static void Main(string[] args)
        {
            var builder = WebApplication.CreateBuilder(args);

            // Add services to the container.

            builder.Services.AddControllers();
            // Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle
            builder.Services.AddEndpointsApiExplorer();
            builder.Services.AddSwaggerGen();

            var app = builder.Build();

            // Configure the HTTP request pipeline.
            if (app.Environment.IsDevelopment())
            {
                app.UseSwagger();
                app.UseSwaggerUI();
            }

            app.UseHttpsRedirection();

            app.UseAuthorization();


            app.MapControllers();

            app.Run();
        }
    }
}

builder.Services 則是幫我已經建立好的IServiceCollection 物件。

我們再新建一個測試類 DITestClass：

    public class DITestClass
    {
        public int Add(int i, int n)
        {
            return i + n;
        }
    }

然後我們在builder.Services中進行註冊

image

最後我們在預設的WeatherForecastController控制器裡面加一個post方法，並用建構函式注入的方式將DITestClass注入進去。

image

swagger中呼叫測試：

image

二、[FromService] 注入

FromServicesAttribute 允許將服務直接注入到操作方法，而無需使用建構函式注入。
改屬性的作用主要針對我們在依賴注入初始化物件（該物件初始化很耗時），這個時候不管請求的api方法有沒有用到該物件都會等待很長時間。
所以使用FromService讓介面在請求的時候再注入，從而不影響其他介面

image

三、多層架構注入

在多層架構中我們如果引用了其他專案，要使用其他專案中的類，那麼要在主專案中進行DI注入，這樣相當於所有其他模組或者其他人寫的專案都需要主專案來維護注入，比如：

新建一個ClassLibrary1專案，Class1類，方法Sub：

image

我們在web專案裡面引用ClassLibrary1專案，如果要使用Class1類就需要在 Programe.cs裡面註冊

builder.Services.AddScoped(typeof(Class1));

image

那麼有沒有方法讓他們自己的專案自己管理註冊呢，我們可以簡單改造一下

  • 新建一個類庫，定義一個公共介面，安裝Microsoft.Extensions.DependencyInjection 包

image

  • 在ClassLibarary1裡面定義實現介面類
    public class ModulInit : IModuleInit
    {
        public void Init(IServiceCollection service)
        {
            //所有需要DI的在此處注入
            service.AddScoped<Class1>();
        }
    }
  • 在Programe.cs裡面呼叫引用專案的註冊類

image

這樣其他專案也按照這種方式，在主專案中只要呼叫一次註冊管理。不過這是最簡單的方式，你也可以使用反射來查詢引用的專案繼承了IModuleInit的類，然後進行Init方法呼叫，這樣會更優雅一些。
當然你還可以使用其他依賴注入框架來取代Microsoft.Extensions.DependencyInjection，也學這個問題就不再是問題！

相關文章