Asp.Net Core入門之自定義服務注冊

談到服務注冊，首先我們先了解一下服務注冊時使用的三種方式，也代表了不同的服務生命周期：

 AddTransient
 
 AddScoped
 
 AddSingleton

AddSingleton生命周期最長，其生命周期范圍描述為：從應用程序啟動到應用程序結束。在第一次請求時會創建一個實例，之后的每次請求都會使用同一個實例。

AddTransient生命周期最短，在服務請求時會創建一個實例，服務請求結束生命周期即結束，之后的每一次請求都會創建不同的實例。

AddScoped生命周期介於上述兩者之間，這里用客戶端請求會話的概念來描述比較清晰一點，它也是在服務請求時創建實例，但是在同一個會話周期內，之后的每次請求都會使用同一個實例，直至會話結束才會創建新的實例。

ASP.Net Core框架支持我們以如下方式注冊我們自己的服務。

services.AddScoped<ITest, Test>();

其中第一個泛型類型(如：ITest)表示將要從容器中請求的類型（通常是一個接口）。第二個泛型類型(如：Test)表示將由容器實例化並且用於完成這些請求的具體實現類。

具體我們一起看下面的例子：

首先，我們創建一個需要實現查詢功能的服務接口ITest

   public interface ITest
    {
        Task<string> Get();
    }

然后，我們創建功能類Test實現這個接口

    public class Test : ITest
    {
        private readonly ILogger logger;
        public Test(ILogger<Test> _logger)
        {
            logger = _logger;
        }
        public Task<string> Get()
        {
            logger.LogInformation("自定義服務查詢");
            return Task.FromResult("Hello World");
        }
    }

最后，我們需要我們自己的服務注冊到容器中。

        public void ConfigureServices(IServiceCollection services)
        {
            services.AddScoped<ITest, Test>();
        }

以上我們便簡單完成了自定義服務的注冊。

隨后我這里創建了一個Controller用以使用該服務。

    [Route("api/[controller]")]
    [ApiController]
    public class ValuesController : ControllerBase
    {
        //聲明服務
        private readonly ITest service;

        /// <summary>
        /// 通過構造函數的方式注入自定義服務類
        /// </summary>
        /// <param name="_service"></param>
        public ValuesController(ITest _service)
        {
            service = _service;
        }

        /// <summary>
        /// 調用服務中實現的Get方法
        /// </summary>
        /// <returns></returns>
        [HttpGet]
        public Task<string> Get()
        {
            return service.Get();
        }
     }

ASP.Net Core框架默認支持我們以構造函數的方式注入我們的服務以使用。

我想寫到這里，大家也會有疑問，如果我們有很多service,這樣一個個注冊寫起來代碼很低效，這里我們簡單給大家介紹一種批量注冊的方式：

這里我們創建了一個批量注冊服務派生類：

public static class ServiceExtensions
    {
        /// <summary>
        /// 批量注冊程序集下的服務類
        /// </summary>
        /// <param name="services"></param>
        public static IServiceCollection AddBatchServices(this IServiceCollection services)
        {
            //根據指定程序集名稱獲取待注冊服務
            var batchServices = GetConfigureClass("WebApiApplication");
            foreach (var type in batchServices)
            {
                type.Value.ToList().ForEach(i =>
                {
                    //注冊服務類
                    services.AddScoped(i, type.Key);
                });
            }
            return services;
        }

        /// <summary>
        /// 根據程序集名稱獲取自定義服務
        /// </summary>
        /// <param name="assembly"></param>
        /// <returns></returns>
        public static Dictionary<Type, Type[]> GetConfigureClass(string assembly)
        {
            Dictionary<Type, Type[]> dic = new Dictionary<Type, Type[]>();
            if (!string.IsNullOrEmpty(assembly))
            {
                //獲取程序集對應的類型
                Assembly dll = Assembly.LoadFrom(assembly);
                List<Type> lstType = dll.GetTypes().ToList();
                lstType.ForEach(x =>
                {
                    //篩選滿足條件的服務類
                    if (x.IsClass && x.GetInterfaces().Length > 0)
                    {
                        dic.Add(x, x.GetInterfaces());
                    }
                });
            }
            return dic;
        }
   }

然后我們ConfigureServices方法中注冊：

        public void ConfigureServices(IServiceCollection services)
        {
            //批量注冊
            services.AddBatchServices();
        }

對於批量注冊，ASP.Net Core允許我們更換默認的IOC容器，感興趣的同學可以試試AutoFac容器支持的程序集掃描式注冊。

注冊我們自己的服務，往往在項目開發過程中是必要的，希望以上簡單的分享能給需要的小伙伴們帶來一點收貨。