==== 目錄 ====

  跟我學: 使用 fireasy 搭建 asp.net core 專案系列之一 —— 開篇

  跟我學: 使用 fireasy 搭建 asp.net core 專案系列之二 —— 準備

  跟我學: 使用 fireasy 搭建 asp.net core 專案系列之三 —— 配置

 

    其實從 mvc5 遷移到 core,專案的差異化主要就體現在配置上。在 core 的世界裡,萬物都依賴於 ioc,因此,對於初學 core 的人來說,首先要搞懂的一個知識點就是 ioc。

    fireasy 支援 core 專案,因此在配置上也有一些特殊的地方。

 

    一、appsettings.json

    appsettings.json 是 core 專案的標準配置檔案,你當然可以使用其他的檔名來儲存,但應注意要在 Program.cs 中手動指定檔案路徑。

        public static IWebHost BuildWebHost(string[] args)
        {
            var config = new ConfigurationBuilder()
                .SetBasePath(Directory.GetCurrentDirectory())
                .AddJsonFile("appsettings.json", optional: true)
                .AddJsonFile("hosting.json", optional: true)
                .AddCommandLine(args)
                .Build();

            return WebHost.CreateDefaultBuilder(args)
                .UseConfiguration(config)
                .UseStartup<Startup>()
                .Build();
        }

    fireasy 將日誌、快取、訂閱釋出、資料庫連線、ioc等全放在 appsettings.json 裡,以下是一個完整的配置例項:

{
  "fireasy": {
    "dataGlobal": { //資料層的全域性設定
      "options": {
        "attachQuote": true //是否在sql語句中自動附加逃逸符,即[]、``等
      }
    },
    "dataInstances": { //資料庫連線例項
      "default": "sqlite", //預設使用的例項,如果沒有指定,則使用 settings 中的第一項
      "settings": {
        "sqlite": {
          "providerType": "SQLite",
          "connectionString": "Data source=|datadirectory|../../../../database/zero.db3;version=3;tracking=true"
        },
        "mysql": {
          "providerType": "MySql",
          "connectionString": "Data Source=localhost;database=zero;User Id=root;password=faib;pooling=true;charset=utf8;Treat Tiny As Boolean=false;tracking=true"
        },
        "sqlserver": {
          "providerType": "MsSql",
          "connectionString": "data source=.;user id=sa;password=123;initial catalog=zero;tracking=true"
        },
        "oracle": {
          "providerType": "Oracle",
          "connectionString": "Data Source=orcl;User ID=ZERO;Password=123;tracking=true"
        }
      }
    },
    "dataConverters": { //資料轉換器
      "settings": [
        {
          "sourceType": "Fireasy.Data.CodedData, Fireasy.Data",
          "converterType": "Fireasy.Zero.Infrastructure.CodedDataConverter, Fireasy.Zero.Infrastructure"
        }
      ]
    },
    "loggings": { //日誌元件
      "settings": {
        "db": {
          "type": "Fireasy.Zero.Services.Impls.LogService, Fireasy.Zero.Services"
        }
      }
    },
    "cachings": { //快取元件
      "settings": {
        "redis": {
          "type": "Fireasy.Redis.CacheManager, Fireasy.Redis",
          "config": {
            "defaultDb": 1,
            "password": "test",
            "host": [
              {
                "server": "localhost"
              }
            ]
          }
        }
      }
    },
    "subscribers": { //訂閱釋出
      "default": "rabbit", //預設使用的例項
      "settings": {
        "redis": { //使用redis
          "type": "Fireasy.Redis.RedisSubscribeManager, Fireasy.Redis",
          "config": {
            "host": [
              {
                "server": "localhost"
              }
            ]
          }
        },
        "rabbit": { //使用rabbit
          "type": "Fireasy.RabbitMQ.SubscribeManager, Fireasy.RabbitMQ",
          "config": {
            "userName": "test",
            "password": "test",
            "server": "amqp://localhost:5672"
          }
        }
      }
    },
    "containers": { //ioc配置
      "settings": {
        "default": [
          {
            "assembly": "Fireasy.Zero.Services" //整個程式集匯入
          },
          {
            "serviceType": "Fireasy.Zero.Infrastructure.IFileStorageProvider, Fireasy.Zero.Infrastructure",
            "implementationType": "Fireasy.Zero.Infrastructure.FileServerStorageProvider, Fireasy.Zero.Infrastructure"
          }
        ]
      }
    }
  }
}

 

    二、基本配置

    定位到 Fireasy.Zero.Web 專案的 Startup.cs 檔案,找到 ConfigureServices 方法,將以下程式碼加入到方法裡面:

        // This method gets called by the runtime. Use this method to add services to the container.
        public void ConfigureServices(IServiceCollection services)
        {
            services.AddFireasy(Configuration)
                .AddIoc(ContainerUnity.GetContainer()); //新增 appsettings.json 裡的 ioc 配置

            services.AddMvc()
                .ConfigureFireasyMvc() // fireasy.web.mvc 相關的配置
                .ConfigureEasyUI();  //easyui 相關的配置
        }

    擴充套件方法 AddFireasy 為的是將 appsettings.json 中的相關配置載入到到環境中。這裡它的原理可以多給大家說一下,以便了解它是如何工作的。檢視 AddFireasy 方法,原始碼如下:

        public static IServiceCollection AddFireasy(this IServiceCollection services, IConfiguration configuration, Action<Fireasy.Common.CoreOptions> setupAction = null)
        {
            ConfigurationUnity.Bind(Assembly.GetCallingAssembly(), configuration, services);

            var options = new Fireasy.Common.CoreOptions();
            setupAction?.Invoke(options);

            return services;
        }

    檢視 ConfigurationUnity.Bind 方法:

        public static void Bind(Assembly callAssembly, IConfiguration configuration, IServiceCollection services = null)
        {
            var assemblies = new List<Assembly>();

            FindReferenceAssemblies(callAssembly, assemblies);

            foreach (var assembly in assemblies)
            {
                var type = assembly.GetType("Microsoft.Extensions.DependencyInjection.ConfigurationBinder");
                if (type != null)
                {
                    var method = type.GetMethod("Bind", BindingFlags.Static | BindingFlags.NonPublic, null, new[] { typeof(IServiceCollection), typeof(IConfiguration) }, null);
                    if (method != null)
                    {
                        method.Invoke(null, new object[] { services, configuration });
                    }
                }
            }

            assemblies.Clear();
        }

    它實際上是遍列當前程式集所引用的所有程式集,檢視每個程式集下的特定類 Microsoft.Extensions.DependencyInjection.ConfigurationBinder,然後進行反射呼叫 Bind 方法。因此,每一個 fireasy 的類庫都會有這樣一個類,來接收 AddFireasy 的統一配置。

    比如 Fireasy.Common 下的這個類的內容為:

internal class ConfigurationBinder
{
    internal static void Bind(IServiceCollection services, IConfiguration configuration)
    {
        ConfigurationUnity.Bind<LoggingConfigurationSection>(configuration);
        ConfigurationUnity.Bind<CachingConfigurationSection>(configuration);
        ConfigurationUnity.Bind<ContainerConfigurationSection>(configuration);
        ConfigurationUnity.Bind<SubscribeConfigurationSection>(configuration);
        ConfigurationUnity.Bind<ImportConfigurationSection>(configuration);

        if (services != null)
        {
            services.AddLogger().AddCaching().AddSubscriber();
        }
    }
}

    比如 Fireasy.Data 下的這個類的內容為:

internal class ConfigurationBinder
{
    internal static void Bind(IServiceCollection services, IConfiguration configuration)
    {
        ConfigurationUnity.Bind<GlobalConfigurationSection>(configuration);
        ConfigurationUnity.Bind<ProviderConfigurationSection>(configuration);
        ConfigurationUnity.Bind<ConverterConfigurationSection>(configuration);
        ConfigurationUnity.Bind<InstanceConfigurationSection>(configuration);
    }
}

    可見它們實際上將 IConfiguration 物件進行配置,將日誌、快取、ioc容器、訂閱釋出等從配置中讀出,放到記憶體當中。這樣,在專案中的任何地方,都可以使用以下的方法來獲取相對應的物件:

        private class TestClass
        {
            void Test()
            {
                //獲取日誌的配置
                var logCfg = ConfigurationUnity.GetSection<Fireasy.Common.Logging.Configuration.LoggingConfigurationSection>();

                //獲取預設日誌記錄物件
                var log = Fireasy.Common.Logging.LoggerFactory.CreateLogger();

                //獲取快取的配置
                var cacheCfg = ConfigurationUnity.GetSection<Fireasy.Common.Caching.Configuration.CachingConfigurationSection>();

                //獲取預設快取管理物件
                var cache = Fireasy.Common.Caching.CacheManagerFactory.CreateManager();
            }
        }

    擴充套件方法 AddIoc 是將 fireasy 中的 ioc 容器中的相關抽象與實現對映新增到 core 本身的 ioc 集合中,使兩者融合為一體,在 fireasy 中,ioc 是由 ContainerUnity 來管理的,它可以配置多個容器。原始碼如下:

        public static IServiceCollection AddIoc(this IServiceCollection services, Container container = null)
        {
            container = container ?? ContainerUnity.GetContainer();
            foreach (AbstractRegistration reg in container.GetRegistrations())
            {
                if (reg is SingletonRegistration singReg)
                {
                    services.AddSingleton(singReg.ServiceType, CheckAopProxyType(singReg.ImplementationType));
                }
                else if (reg.GetType().IsGenericType && reg.GetType().GetGenericTypeDefinition() == typeof(FuncRegistration<>))
                {
                    services.AddTransient(reg.ServiceType, s => reg.Resolve());
                }
                else
                {
                    services.AddTransient(reg.ServiceType, CheckAopProxyType(reg.ImplementationType));
                }
            }

            return services;
        }

 

    二、mvc 配置

    擴充套件方法 ConfigureFireasyMvc 中本 mvc 的一些配置。

        public void ConfigureServices(IServiceCollection services)
        {
            services.AddMvc()
                .ConfigureFireasyMvc(options =>
                    {
                        options.DisableModelValidator = true;
                        options.UseErrorHandleFilter = true;
                        options.UseJsonModelBinder = true;
                        options.UseTypicalJsonSerializer = true;
                        options.JsonSerializeOption.IgnoreNull = true;
                        options.JsonSerializeOption.Converters.Add(new Fireasy.Data.Entity.LightEntityJsonConverter());
                        options.JsonSerializeOption.Converters.Add(new Common.Serialization.FullDateTimeJsonConverter());
                    });
        }

    可以設定 MvcOptions 引數物件中的某些屬性來達到不同的效果:

    DisableModelValidator 覆蓋本身 mvc 自帶的 IObjectModelValidator 物件,使它在呼叫 action 時不對 model 進行驗證。因為在此示例中,我們使用 easyui 前端框架,在 ui 上就有資料的驗證,並且在 Entity 層還有一次驗證,因此將其關閉。

    UseJsonModelBinder 是使用 fireasy 特有的 model 繫結方式,即使用 json 充序列化的方式傳遞複雜的物件及集合,眾所周知,在 mvc 裡要傳遞一個物件,或一個集合,只能使用 name=hxd&sex=1&birthday=2019-1-1 這種方式,因此對於複雜的物件來說,就先麻煩了。使用此開關後,只需要傳遞 info={ name: "hxd", sex: 1, birthday: "2019-1-1" } 就行了。

    UseErrorHandleFilter 使用自定義的異常處理過濾器。在 HandleErrorAttribute 這個類中,當異常型別是 ClientNotificationException 時,將直接返回其 Message,否則記錄日誌,並返回友好的錯誤提示資訊。因此,在業務層,可以多使用 ClientNotificationException  來通知前端具體的異常資訊。

    UseTypicalJsonSerializer 使用 fireasy 的 json 序列化方法,它將拋棄 Newtonsoft。原因是,Entity 返回時不再做 ViewModel 的對映處理,那麼不可避免地,在 Entity 物件中會包含一些延遲載入的屬性,在使用 Newtonsoft 時將發生不可原諒的迴圈引用異常,造成程式崩潰。fireasy 中引入了一個 ILazyManager 介面,Entity 受此管理後,那些未加載出來的屬性,則不會被序列化。另外一種解決辦法是,引入 Fireasy.Fireasy.Newtonsoft,將 LazyObjectJsonConverter 新增到 Converters 中去。

    services.AddMvc()
        .AddJsonOptions(options =>
            {
                options.SerializerSettings.Converters.Add(new Fireasy.Newtonsoft.LazyObjectJsonConverter());
                options.SerializerSettings.ContractResolver = new DefaultContractResolver();
            });

  JsonSerializeOption 即 fireasy json 序列化的一些全域性配置,尤其要注意的是,這裡在 Converters 裡添加了一個 LightEntityJsonConverter ,它的目的是在 action model 繫結時,通過它來進行反序列化,這是為什麼呢,後面的章節中會提到。

 

    擴充套件方法 ConfigureEasyUI 主要是用來配置 easyui 的一些資料驗證規則,它預設綁定了ValidateBoxSettingBinder 和 NumberBoxSettingBinder 兩種規則,這裡就不再介紹了。

 

    三、資料庫配置

    資料庫配置是核心,所以著重說一下。參見 appsettings.json 檔案中的 fireasy:dataInstances 節點,它的配置其實很易懂,無非就是指定 providerType 和 connectionString。

    providerType 是資料庫的提供者,對應不同的資料庫,這裡可以取 MsSql、MySQL、Oracle、SQLite、Firebird、PostgreSql、以及 OleDb。

    如果這些都還不能滿足你,你可以自行去實現 provider ,然後通過 providerName 來進行指定。這個暫時先不說了,後面有一個 Mongodb 的章節介紹。

    不同的 provider 需要從 nuget 裡引用相對應的程式集,從上至下優先,可對照下表:

providerType .net core .net framework
MsSql 不需要 不需要
MySQL MySql.Data
MySqlConnector
同 .net core
SQLIte System.Data.SQLite
Microsoft.Data.Sqlite
Spreads.SQLite
System.Data.SQLite
Oracle Oracle.ManagedDataAccess
Mono.Data.OracleClientCore
Oracle.ManagedDataAccess
Oracle.DataAccess
System.Data.OracleClient
Firebird FirebirdSql.Data.FirebirdClient 同 .net core
PostgreSql Npgsql 同 .net core
OleDb 不需要 不需要

 

 

    四、DbContext 配置

    DbContext 與 上節的資料庫配置息息相關。DbContext 是繼承自 EntityContext 的,EntityContext 有兩個建構函式。

    public class DbContext : EntityContext
    {
        /// <summary>
        /// 自定義 EntityContextOptions 引數方式
        /// </summary>
        /// <param name="options"></param>
        public DbContext(EntityContextOptions options)
            : base (options)
        {
        }

        /// <summary>
        /// 使用資料庫配置例項名方式
        /// </summary>
        /// <param name="name"></param>
        public DbContext(string name)
            : base (name)
        {
        } 
}

    一般是使用第二種方式,name 即資料庫配置中的例項名,如果不指定,則由 default 來決定,從 appsettings.json 可得知,預設是使用 sqlite 資料庫,如果這裡使用了 mysql 則會使用 MySQL 資料庫。

    第一種方式則用在需要在程式中動態指定 provider 和 connection string 的時候使用,它主要通過 ContextFactory 這個委託來指定。下面就是一個很好的例子。

    public class TestClass
    {
        void Test()
        {
            var providerName = "SQLite";
            var connectionStr = "Data source=|datadirectory|../../../../database/zero.db3;version=3;tracking=true";

            using (var db = new DbContext(new EntityContextOptions
                {
                    ContextFactory = () => new EntityContextInitializeContext(Data.Provider.ProviderHelper.GetDefinedProviderInstance(providerName), connectionStr)
                }))
            {

            }
        }
    }

    原來業務層中使用 DbContext 是在每個方法裡 using (var db = new DbContext()) 來使用的,當時是對於 ioc 物件的釋放機制不是太瞭解。經過測試後,將 DbContext 通過構造器注入的方式注入也是完全沒有問題的。修改一下 Startup.cs  中的 ConfigureServices 方法,與 Entity Framework 類似的,使用 AddEntityContext 方法(Entity Framework 中是 AddDbContext 方法)。

        public void ConfigureServices(IServiceCollection services)
        {
            services.AddEntityContext<DbContext>(options =>
                    {
                        options.AutoCreateTables = true; //此項為 true 時, 採用 codefirst 模式維護資料庫表
                        options.NotifyEvents = true; //此項設為 true 時, 上面的實體持久化訂閱通知才會觸發
                    });
        }

 這裡的 EntityContextOptions 引數有以下幾個設定項:

    AutoCreateTables 使用類似於 CodeFirlst 的方式,檢查實體對映的資料表是否存在,沒有的話則建立,同時對於已經存在的資料表,會對屬性進行比對,增加新的欄位,刪除的欄位不進行處理。

    NotifyEvents 是否觸發持久化事件,比如實體的建立之前、建立之後、修改之前、修改之後等等,都會以事件訊息的方式通過訊息訂閱進行釋出,定義一個消費者來接收進行處理。

    RecompileAssembly 是否重新編譯實體程式集。由於 fireasy 中的實體類的屬性使用了 virtual 修飾,此開關開啟時,將使用 aop 技術對實體類進行動態編譯,使之在屬性被修改時能夠記錄下來,達到按需更新的效果。

    ValidateEntity 是否在持久化之前進行實體的驗證,如果前端把控嚴格的話,可以將此開關關閉,免得影響效能。

 

    上面的 AddEntityContext 還存在一個問題,即 DbContext 的引用,你也可以將 DbContext 放到 appsettings.json 的 ioc 配置節中,這樣 core 專案就不必要引用 DbContext 的專案了。如下配置後,可以直接使用 services.AddEntityContext() 方法。

{
  "fireasy": {
    "containers": { //ioc配置
      "settings": {
        "default": [
          {
            "serviceType": "Fireasy.Zero.Services.Impls.DbContext, Fireasy.Zero.Services"
          }
        }
      }
    }
  }
}

  

    好了,配置這塊還是算比較複雜的了,但是通過這樣的配置,專案的靈活度卻是提高了不少。寫這篇的目的,其實更多的目的是給大家提供一種思路,使大家對 .net core 有一個更深一步的了