net開發框架never

時間 2019-11-24

標籤開發框架简体版

原文原文鏈接

【一】摘要

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

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

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

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

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

【二】總體設計

一、以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);
}

咱們先對程序集過濾與開啓IoCjson

//註冊程序集過濾，由於整個啓動過程會分析程序集裏面的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"]));
    });

註冊各類組件c#

//使用環境下自動註冊組件，
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"));
    }
});
}

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

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;
}

三、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);
}

【三】組成部分

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

【四】快速開發

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

摘要裏面一些代碼展現：

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

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

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

//實際上這裏是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.註冊,
});

三、友好的參數驗證，用戶本身加驗證參數規則。

/// <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
}