net開發框架never

【一】 摘要

never是純c#語言開發的一個框架，同時可在netcore下運行。 該框架github地址：https://github.com/shelldudu/never

同時，配合never_web，never_component，never_application （demo）可對比代碼學習。

引用其圖片說明該構架所涉及到的工具

      

使用emit技術所實現的核心功能點   

其中使用包含了一些開發設計模式，比如message的訂閱與發布，熔斷機制等。

【二】整體設計

1、以ApplicationStartup開始，啟動服務，注冊不同組件，這里是netcore的部分代碼

/// <summary>
/// 該方法被ConfigureServices里面的base.ConfigureServicese調用，由於ConfigureServices方法會使用不同的組件方案，所以在其后面啟支，是將這些組件方案所注冊的ioc規則加入到自己的ioc規則里面去
/// 同時替換了系統IServiceCollection自己生成的IServiceProvider對象
/// </summary>
/// <param name="sender"></param>
/// <param name="e"></param>
private void Startup_OnStarting(object sender, Never.StartupEventArgs e)
{
    //ddd的command里面使用了恢復（即一些命令出錯后被保存后過段時間再執行），當前使用sqlite本地數據庫方式
    var commandfile = new FileInfo(AppContext.BaseDirectory + "\\App_Data\\command_demo.db");
    //ddd的event跟上面的一樣
    var eventfile = new FileInfo(AppContext.BaseDirectory + "\\App_Data\\event_demo.db");
    //使用nlog組件
    var logfile = new FileInfo(AppContext.BaseDirectory + "\\App_Config\\nlog.config");
    //配置文件的讀取
    var configReader = new AppConfigReader(this.Configuration);
}

 我們先對程序集過濾與開啟IoC

//注冊程序集過濾，因為整個啟動過程會分析程序集里面的Type對象，很多dll我們不用分析，只焦點到我們現在注入的2個規則就行，"Never" + "B2C",正則只要匹配到該字符就加加載到待分析的dll集合中
e.Startup.RegisterAssemblyFilter("B2C".CreateAssemblyFilter()).RegisterAssemblyFilter("Never".CreateAssemblyFilter());
//ioc分2種啟動方法，主要原因如下：（1）服務啟動有先后順序，不同的系統組件所注冊的順序不同的，但有些組件要求在所有環境下都只有第一或最后啟動（2）由於使用環境自動注冊這種設計下，一些組件要手動注冊會帶自己的規則就會被自動注冊覆蓋
e.Startup.UseEasyIoC(
    (x, y, z) =>
    {
        //先啟動該服務注冊組件，
    },
    (x, y, z) =>
    {
        //再按自己的個性化注冊組件，比如Controller在下面UseApiDependency后會自動注入，但是我想HomeController注入的時候使用memecahed，這種情況就要手動注入了
        //x.RegisterType<Controllers.HomeController, Controllers.HomeController>().WithParameter<Never.Caching.ICaching>("memcached");
        //注入query與repository實例，為什么不用自動注入？哈哈，因為在framework或netcore等各種不同的環境下大家讀取配置文件是不同的，一旦寫死在B2C.Message.SqlData.Query里面讀取配置文件，則使用不同的host技術就出現極大問題，
        //比如netcore沒有connectionString這種配置（或者有人說可以手動引用System.Configuration，這不是嫌麻煩嗎）
        x.RegisterInstance(new B2C.Message.SqlData.Query.QueryDaoBuilder(Infrastructure.SqldbType.sqlserver, () => configReader["message_conn"]));
        x.RegisterInstance(new B2C.Message.SqlData.Repository.RepositoryDaoBuilder(Infrastructure.SqldbType.sqlserver, () => configReader["message_conn"]));
    });

注冊各種組件

//使用環境下自動注冊組件，
e.Startup.UseAutoInjectingAttributeUsingIoC(new IAutoInjectingEnvironmentProvider[]
{
    //在message該環境下，所有單例注冊組件只有匹配message的才注冊，（1）有些組件是線程的，那么不會被描述和注入中，除非再加個線程provider；（2）即使是單例provider,但所運行不是message環境，所以也不會注入
    SingletonAutoInjectingEnvironmentProvider.UsingRuleContainerAutoInjectingEnvironmentProvider("message"),
})
//使用統一配置中心讀取配置文件，實用性在后面有講到
.UseConfigClient(new IPEndPoint(IPAddress.Parse(configReader["config_host"]), configReader.IntInAppConfig("config_port")), out var configFileClient);
configFileClient.Startup(TimeSpan.FromMinutes(10), new[] { new ConfigFileClientRequest { FileName = "message_api" } }, (c, t) =>
{
    var content = t;
    if (c != null && c.FileName == "message_api")
    {
        System.IO.File.WriteAllText(System.IO.Path.Combine(this.Environment.ContentRootPath, "appsettings.app.json"), content);
    }
}).Push("message_api").GetAwaiter().GetResult();
e.Startup
    .UseCounterCache() //使用countcache
    .UseConcurrentCache() //使用安全countcache
    .UseDataContractJson() //使用datacontract技術的序列化，實現了IJsonSerialize接口
    .UseEasyJson(string.Empty) //使用easyjson技術的序列化，實現了IJsonSerialize接口
    .UseNLog(logfile) //使用nlog
    .UseAppConfig(configReader) //將IConfigReader注入
    .UseForceCheckAggregateRootImplIHandle() //這幾個Force都是為了檢查ddd開發一些要求，比如是否繼承某個類，某些接口
    .UseForceCheckCommandAppDomainAttribute() //檢查所有的command是否帶了特定attribute
    .UseForceCheckCommandEvenWithNoParamaterCtor() //檢查所有的commandhandler所要的構造參數是否被注入中
    .UseForceCheckCommandHandlerCtor() //檢查所有的eventhandler所要的構造參數是否被注入中
    .UseForceCheckEventAppDomainAttribute()//檢查所有的event是否帶了特定attribute
    .UseForceCheckEventHandlerCtor() //檢查所有的eventhandler所要的構造參數是否被注入中
    .UseForceCheckMessageSubscriberCtor() //使用消息的訂單與發布
    .UseInjectingCommandHandlerEventHandler(Never.IoC.ComponentLifeStyle.Singleton) //注入所有的commandhandler，在commandbus執行其對象行為
    .UseSqliteEventProviderCommandBus<DefaultCommandContext>(new SqliteFailRecoveryStorager(commandfile, eventfile)) //使用cqrs組件，指定sqlite作為恢復組件，
    .UseApiModelStateValidation() //mvc,webapi的模型參數驗證
    .UseApiActionCustomRoute(e.Collector as IServiceCollection) //自定義路由，相同於在controller可以使用httpget等route技術
    .UseApiDependency(e.Collector as IServiceCollection);//注入所有的controller

最后啟動過程中檢查整個系統是否正常

//配置中心更新配置文件后，系統不一定馬上能重新加載
e.Startup.Startup(TimeSpan.FromSeconds(1), (x) =>
{
    //我們在此啟動看看所使用組件是否正常啟動
    using (var sc = x.ServiceLocator.BeginLifetimeScope())
    {
        sc.Resolve<ICommandBus>();
        sc.Resolve<ILoggerBuilder>();
        sc.Resolve<IJsonSerializer>();
        var home = sc.Resolve<Controllers.MessageController>();

        var logger = sc.Resolve<ILoggerBuilder>().Build(typeof(Startup));
        logger.Info("startup at " + DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss"));
    }
});
}

2、Controller的注入，使用構造函數的方法注入

private readonly IEmailCodeQuery emailCodeQuery = null;
private readonly IMobileCodeQuery mobileCodeQuery = null;
private readonly ICommandBus commandBus = null;
private readonly ILoggerBuilder loggerBuilder = null;
private readonly IJsonSerializer jsonSerializer = null;
public VCodeController(ICommandBus commandBus,
    ILoggerBuilder loggerBuilder,
    IJsonSerializer jsonSerializer,
    IEmailCodeQuery emailCodeQuery,
    IMobileCodeQuery mobileCodeQuery)
{
    this.commandBus = commandBus;
    this.loggerBuilder = loggerBuilder;
    this.jsonSerializer = jsonSerializer;
    this.emailCodeQuery = emailCodeQuery;
    this.mobileCodeQuery = mobileCodeQuery;
}

3、Action代碼處理

/// <summary>
/// 校驗郵箱驗證碼
/// </summary>
/// <param name="reqs"></param>
/// <returns></returns>
[ApiActionRemark("a9a900aee8c6", "HttpPost"), HttpPost]
public ApiResult<string> CheckEmailValidateCode(CheckEmailValidateCodeReqs reqs)
{
    if (!this.TryValidateModel(reqs))
    {
        return Anonymous.NewApiResult(ApiStatus.Fail, string.Empty, this.ModelErrorMessage);
    }

    //實際上不用try + catch了，因為在startup統一日志處理了。
    //發送命令后交給commandhandler去處理領域，commandbus + eventbus
    var handler = this.commandBus.Send(new DestroyEmailCodeCommand(NewId.GenerateGuid())
    {
        Email = reqs.Email,
        UsageType = reqs.UsageType,
        VCode = reqs.VCode,
    });

    if (handler == null)
    {
        return Anonymous.NewApiResult(ApiStatus.Fail, string.Empty, "驗證失敗");
    }

    if (handler.Status != CommandHandlerStatus.Success)
    {
        return Anonymous.NewApiResult(ApiStatus.Error, string.Empty, this.HandlerMerssage(handler));
    }

    return Anonymous.NewApiResult(ApiStatus.Success, string.Empty);
}

【三】組成部分

1. ApplicationStartup 整個系統的初始化中心點，可以是Web環境，也可以是Service環境。
   
2. Emit 避免使用反射帶來的損耗，並且對OpCode的使用封裝變成方法的調用，可容易理解與使用，是后面所有技術的支撐點。
   
3. IoC 簡單實現三種生命周期，單例 + 作用域 + 短暫，注入指定參數，可以生成代理注入攔截器。
4. Aop 加入上下文日志跟蹤（如LoggerAttribte自動寫日志）；Mock對象等。
5. CQRS 實現了一套commandbus + eventbus設計，commandbus執行命令后，若聚合對象有事件，則通過eventbus發布到訂閱者；中間使用sqlite來保存訂閱失敗的隊列，用於后期的恢復發布訂閱。
6. SqlClient 配置極其簡單，使用也很容易的一個sql執行方法，使用xml文件配置管理sql語句，可執行事務，對xml內容進行縮進使得好看；也可以直接寫sql語句。使用typehander，用於處理阻抗失敗的情況。
7. Mapper 直接映射對象，效率比emitmapper差一點。
8. Message 消息的發布與訂閱，可以在內存，mq方式發布到不同的機器。
9. Socket 使用SocketAsyncEventArgs實現的一套高性能方案，讀取與發送分開隊列，可以設置心跳。
10. Remoting 在socket的基礎上實現一套通訊。
11. Configuration 配置中心，對文件（夾）進行監控，修改文件會觸發所有應用程序的配置更新；設置了共享級+應用級配置文件，不用的應用級配置文件可以直接link共享級的配置，共享級的配置可以讀取文件，也可以到數據庫查詢。
12. Deployment 對WebApi里面的Service直接生成代理類，封裝了web請求的參數，路由等信息，還可以使用熔斷機制，在客戶端發現服務不可用的時候自動返回友好結果。
13. Workflow 實現了一套工作流內容，每一步驟都可以獨立為插件或一個類，並且可組合不同步驟，包含等待，重試，中斷等不同狀態。
14. Memcached 一個memcached客戶端，文本協議+二進制協議，還有Gzip壓縮，Binary序列化；定義的接口可以很方便使用protobuf等技術的自由擴展。
15. JsonSerializerjson 序列化，可動態配置不用類型的輸出結構，通過emit后緩存提高性能，還能支持用戶自定義序列接口。

【四】快速開發

我們打開startup文件或global文件來看看，整個構架的初始化都在global或startup里面實現的，環境的搭建比較簡單，可以直接開發業務而不關心組件實現方式。

摘要里面一些代碼展示：

1、接口與實現使用IoC管理，加上靈活的AOP，可統一日志管理的管理

[Logger]
public class EmailCodeCommandHandler : ICommandHandler<CreateEmailCodeCommand>, ICommandHandler<DestroyEmailCodeCommand> { }

2、對遠程方法的調用，封裝成本地調用方式

//實際上這里是web遠程方法,使用代理生成類，帶熔斷，
var api = this.validateCodeService.CreateMobileValidateCode(new Message.Contract.Request.CreateMobileValidateCodeReqs()
{
    Mobile = model.UserName,
    ClientIP = this.GetAppIP(),
    Platform = this.GetAppPlatform(),
    Length = 4,
    UsageType = Message.Contract.EnumTypes.UsageType.注冊,
});

3、友好的參數驗證，用戶自己加驗證參數規則。

/// <summary>
/// 用戶Model
/// </summary>
[Serializable, Validator(typeof(RequestValidator))]
public class UserViewModel
{
    #region prop

    /// <summary>
    /// 用戶名
    /// </summary>
    [DisplayName("用戶名")]
    public string UserName { get; set; }

    #endregion prop

    #region validator

    private class RequestValidator : Validator<UserViewModel>
    {
        public override IEnumerable<KeyValuePair<Expression<Func<UserViewModel, object>>, string>> RuleFor(UserViewModel target)
        {
            if (target.UserName.IsNullOrWhiteSpace())
                yield return new KeyValuePair<Expression<Func<UserViewModel, object>>, string>(m => m.UserName, "手機號碼為空");
        }
    }

    #endregion validator
}

4、可靠的性能：json的序列化與反序列化，在反序列化timespan下（字符串："00:10:00")， 2700x + 32g內存1000萬次測試，jsonnet 使用12.6秒（GC=3.7萬），easyser使用2.6秒（GC=3.7K)，jil使用0.8秒（GC=1.2k）

5、簡單的配置：系統初始化過程風格統一，還有組件eqsysql只需要xml文件 + 鏈接字符串，就可以實現ORM管理（如QueryForObject<T>，QueryForEnumerable<T>）