ASP.NET Core搭建多層網站架構【6-註冊跨域、網站核心配置】

2020/01/29, ASP.NET Core 3.1, VS2019, NLog.Web.AspNetCore 4.9.0

摘要：基於ASP.NET Core 3.1 WebApi搭建後端多層網站架構【6-註冊跨域、網站核心配置】
統一封裝網站核心配置，註冊跨域策略，實例化雪花算法，後期可擴展添加多語言支持

文章目錄

此分支項目代碼

本章節介紹了統一封裝網站核心配置，註冊跨域策略，實例化雪花算法，後期可擴展添加多語言支持

添加網站配置及跨域配置

在MS.WebApi應用程序appsettings.json中添加如下節點：

"SiteSetting": {
    "WorkerId": 1, //for snowflake workerid
    "DataCenterId": 1, //for snowflake datacenterid
    "LoginFailedCountLimits": 3, //the number of login failed 
    "LoginLockedTimeout": 3 //(minutes) account locked timeout
},
"Startup": {
    "Cors": {
      "AllowOrigins": "http://localhost:8080,http://localhost:8081"
    }
}

添加完成後，以下圖所示：

說明：

• WorkerId、DataCenterId是雪花算法的兩個參數
• LoginFailedCountLimits是用戶登陸失敗的次數限制
• LoginLockedTimeout是用戶鎖定後，多久能夠從新登陸
• AllowOrigins中是容許跨域的源，逗號分隔

SiteSetting網站配置實體類

在MS.WebCore類庫中添加SiteSetting.cs類：

namespace MS.WebCore
{
    public class SiteSetting
    {
        public long WorkerId { get; set; }
        public long DataCenterId { get; set; }
        public int LoginFailedCountLimits { get; set; }
        public int LoginLockedTimeout { get; set; }
    }
}

其中的字段和appsettings.json中對應，能夠使用選擇性粘貼，將json粘貼爲類

添加包引用

向MS.WebCore類庫添加如下包引用：

<ItemGroup>
  <PackageReference Include="NLog.Web.AspNetCore" Version="4.9.0" />
</ItemGroup>

這裏引用的是NLog.Web.AspNetCore包是由於：

1. 後期咱們還要在MS.WebCore類庫中添加NLog的一些方法配置，須要依賴此包
2. 這個包正好也包含了Microsoft.Extensions.Configuration、Microsoft.Extensions.DependencyInjection兩個組件，因此這兩個組件就不須要單獨重複引用了

可是這裏我遇到一個問題，若是不使用NLog，可能不須要引用NLog.Web.AspNetCore包，而直接引用Microsoft.Extensions.Configuration、Microsoft.Extensions.DependencyInjection這兩個包

可是我在官網文檔中查到AddCors方法依賴的就是Microsoft.Extensions.DependencyInjection這個包，不知道爲何VS一直提示找不到？

若是大家不使用NLog可能須要自行解決下這個問題了~

封裝Ioc註冊

在MS.WebCore類庫中添加WebCoreExtensions.cs類：

using MS.Common.IDCode;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using System;

namespace MS.WebCore
{
    public static class WebCoreExtensions
    {
        public const string MyAllowSpecificOrigins = "_myAllowSpecificOrigins";

        /// <summary>
        /// 添加跨域策略，從appsetting中讀取配置
        /// </summary>
        /// <param name="services"></param>
        /// <param name="configuration"></param>
        /// <returns></returns>
        public static IServiceCollection AddCorsPolicy(this IServiceCollection services, IConfiguration configuration)
        {

            services.AddCors(options =>
            {
                options.AddPolicy(MyAllowSpecificOrigins,
                builder =>
                {
                    builder
                    .WithOrigins(configuration.GetSection("Startup:Cors:AllowOrigins").Value.Split(','))
                    .AllowAnyHeader()
                    .AllowAnyMethod();
                });
            });
            return services;
        }

        /// <summary>
        /// 註冊WebCore服務，配置網站
        /// do other things
        /// </summary>
        /// <param name="services"></param>
        /// <param name="configuration"></param>
        /// <returns></returns>
        public static IServiceCollection AddWebCoreService(this IServiceCollection services, IConfiguration configuration)
        {
            //綁定appsetting中的SiteSetting
            services.Configure<SiteSetting>(configuration.GetSection(nameof(SiteSetting)));

            #region 單例化雪花算法
            string workIdStr = configuration.GetSection("SiteSetting:WorkerId").Value;
            string datacenterIdStr = configuration.GetSection("SiteSetting:DataCenterId").Value;
            long workId;
            long datacenterId;
            try
            {
                workId = long.Parse(workIdStr);
                datacenterId = long.Parse(datacenterIdStr);
            }
            catch (Exception)
            {
                throw;
            }
            IdWorker idWorker = new IdWorker(workId, datacenterId);
            services.AddSingleton(idWorker);

            #endregion
            return services;
        }
    }
}

說明：

• 封裝了跨域策略AddCorsPolicy
• 綁定appsetting中的SiteSetting
• 實例化雪花算法IdWorker並註冊爲單例（保證全局只有一個單例）

註冊服務

在MS.WebApi應用程序Startup.cs類中，ConfigureServices方法裏添加如下代碼：

//using MS.WebCore;
//添加以上代碼至using引用
//註冊跨域策略
services.AddCorsPolicy(Configuration);
//註冊webcore服務（網站主要配置）
services.AddWebCoreService(Configuration);

完成後代碼以下圖所示

開啓跨域中間件

在Configure中，UseRouting和UseAuthorization之間加上app.UseCors(WebCoreExtensions.MyAllowSpecificOrigins);以開啓跨域中間件：

至此，WebCore核心配置完成，此時網站項目已支持跨域配置，已能夠經過ioc解析SiteSetting讀取網站配置和IdWorker生成雪花ID

項目完成後，以下圖所示