從零開始搭建.NET Core 2.0 API(學習筆記一)

来源:https://www.cnblogs.com/Dpgg/archive/2018/09/05/9595221.html
-Advertisement-
Play Games

從零開始搭建.NET Core 2.0 API(學習筆記一) 一、 VS 2017 新建一個項目 選擇ASP.NET Core Web應用程式，再選擇Web API,選擇ASP.NET Core 2.0版本 二、 添加API幫助頁面 API項目添加 NuGet NSwag.AspNetCore 引用 ...


　　從零開始搭建.NET Core 2.0 API(學習筆記一)

一、 VS 2017 新建一個項目 選擇ASP.NET Core Web應用程式，再選擇Web API,選擇ASP.NET Core 2.0版本

二、 添加API幫助頁面 API項目添加 NuGet NSwag.AspNetCore 引用， 然後在添加NSwag設置

運行項目 http://localhost:prot/swagger 即可打開幫助頁。

public void Configure(IApplicationBuilder app, IHostingEnvironment env)

{
　　if (env.IsDevelopment())
　　{
　　　　app.UseDeveloperExceptionPage();
　　　　app.UseBrowserLink();
　　}
　　else
　　{
　　　　app.UseExceptionHandler("/Home/Error");
　　}

　　app.UseStaticFiles();


app.UseSwaggerUi(typeof(Startup).GetTypeInfo().Assembly, settings =>
{
　　settings.GeneratorSettings.DefaultPropertyNameHandling = PropertyNameHandling.CamelCase;
});

app.UseMvc(route =>
{
　　route.MapRoute(name: "default", template: "{controller=Home}/{action=Get}/{id?}");
});

}

三、 Startup 類ConfigureServices方法中，添加配置中心初始化；配置中心統一管理配置，便於維護

public IServiceProvider ConfigureServices(IServiceCollection services)
        {
            ConfigHelper.Init(Configuration["ConfigZookeeperAddress"], Configuration["ConfigNodePath"]);
            services.AddSingleton<ILogWrite, LogWrite>();

            services.AddMvc(options =>
            {
                options.Filters.Add<AuthorizationFilter>();
                options.Filters.Add<ExceptionFilter>();
                options.Filters.Add<PerformanceLogFilter>();
            });

            var builder = new ContainerBuilder();//實例化 AutoFac  容器            
            builder.Populate(services);

            // TODO: 這裡添加其他需要註入類的註冊

            ApplicationContainer = builder.Build();
            return new AutofacServiceProvider(ApplicationContainer);
        }

四、添加一個基礎設置項目，添加一個日誌介面 ILogWrite,一個記錄日誌實現類 LogWrite 在Startup 類ConfigureServices方法中添加日誌 Ioc

因為日誌攔截器和異常攔截器會用到日誌記錄需要註入 所以日誌在AddMvc()前面添加，Autofac配置不能在 AddMvc前面，所以這裡用.NET Core的Ioc容器，後面Autofac會接管容器。

services.AddSingleton<ILogWrite, LogWrite>();

五、filter 添加三個類分別是

　　a AuthorizationFilter 許可權過濾器

　　b ExceptionFilter 異常過濾器

　　c PerformanceLogFilter 性能日誌過濾器

　　ExceptionFilter 、PerformanceLogFilter 分別定義構造函數，註入日誌依賴。

public ExceptionFilter(ILogWrite logWrite)
{
　　_logWrite = logWrite;
}

public PerformanceLogFilter(ILogWrite logWrite)
{
　　_logWrite = logWrite;
}

過濾器必須添加在 Startup類ConfigureServices的services.AddMvc()中

services.AddMvc(options =>
{
    options.Filters.Add<AuthorizationFilter>();
    options.Filters.Add<ExceptionFilter>();
    options.Filters.Add<PerformanceLogFilter>();
});

 

六、Action參數讀取，為了在異常過濾器、性能日誌過濾器中，讀取參數需要在許可權過濾器中添加下麵兩行代碼

public class AuthorizationFilter : IAuthorizationFilter
{
　　public void OnAuthorization(AuthorizationFilterContext context)
　　{
　　　　HttpRequest request = context.HttpContext.Request;
　　　　request.EnableRewind();
　　　　request.Body.Position = 0;
　　}
}

七、性能日誌過濾器 PerformanceLogFilter 繼承 IActionFilter，實現兩個介面

　　　　OnActionExecuting 在調用操作方法之前發生
　　　　OnActionExecuted 在調用操作方法之後發生
　　a 在方法 OnActionExecuting中 實例化一個 Stopwatch 用於記錄方法開支執行時間
　　  把Stopwatch 實力加入 HttpContext.Items 中，便於在 OnActionExecuted 獲取。

　　b 讀取Action請求參數, 放入 HttpContext.Items 中, 不知道為什麼OnActionExecuted 去不到參數

　　　　　/// <summary>
        /// 在調用操作方法之前發生。
        /// </summary>
        /// <param name="context"></param>
        public void OnActionExecuting(ActionExecutingContext context)
        {
　　　　　　　//
            if (SkipLogging(context)) return;

            var watch = new Stopwatch();
            context.HttpContext.Items[ConfigHelper.HttpRequestStopWatcher] = watch;
            var paramenters = context.ActionArguments.Count==0?string.Empty:context.ActionArguments.Serialize();
            context.HttpContext.Items[ConfigHelper.FilterActionArguments] = paramenters;
            watch.Start();
        }

OnActionExecuting 中增加了性能日誌開關，如果關閉直接返回，不創建Stopwatch,
在OnActionExecuted中回去到的Stopwatch是null 則直接返回（也可以用性能日誌開關做判斷），不處理後續。
如果Controll、Action添加了NoLog特性，則不記錄性能日誌

        private static bool SkipLogging(ActionExecutingContext actionContext)
        {
            if (!ConfigHelper.IsPerformanceLog) return true;
            return actionContext.ActionDescriptor.GetType().GetCustomAttributes(typeof(NoLogAttribute), false).Any() ||
                   actionContext.Controller.GetType().GetCustomAttributes(typeof(NoLogAttribute), false).Any();
        }

    　　/// <summary>
    　　/// 忽略性能日誌記錄特性
    　　/// </summary>
    　　[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class, Inherited = true)]
    　　public class NoLogAttribute : Attribute
    　　{
    　　}

八、異常過濾器

　　 /// <summary>
    /// 異常攔截器
    /// </summary>
    public class ExceptionFilter : IExceptionFilter
    {
        ILogWrite _logWrite;
        public ExceptionFilter(ILogWrite logWrite)
        {
            _logWrite = logWrite;
        }

        /// <summary>
        /// 
        /// </summary>
        /// <param name="actionExecutedContext"></param>
        /// <param name="cancellationToken"></param>
        /// <returns></returns>
        public void OnException(ExceptionContext context)
        {
            BizResult<bool> biz;

            var paramenters = context.HttpContext.Items[ConfigHelper.FilterActionArguments].ToString();
            try
            {
                biz = new BizResult<bool>(false, (int)B2CBizCode.Exception, context.Exception.Message);

                if (context.Exception.InnerException != null)
                    biz.SysMessage += ":" + context.Exception.InnerException.Message;

                if (ConfigHelper.IsPerformanceLog)
                {
                    var watch = context.HttpContext.Items[ConfigHelper.HttpRequestStopWatcher] as Stopwatch;
                    watch?.Stop();

                    var name = context.ActionDescriptor.GetType().GetProperty("ActionName").GetValue(context.ActionDescriptor).ToString();

                    _logWrite.InfoAsync(new 
                    {
                        CreateTime = DateTime.Now,
                        Method = name,
                        TimeSpan = watch.Elapsed,
                        IsSuccess = false,
                        Content = paramenters,
                        Code = ((B2CBizCode)biz.BusinessCode).ToString(),
                        Message = biz.BusinessMessage
                    }.Serialize());
                }
            }
            catch (Exception ex)
            {
                biz = new BizResult<bool>(false, (int)B2CBizCode.Exception, ex.Message);
            }
            context.Result = new ApplicationErrorResult(biz);

            _logWrite?.ErrorAsync($"鏈接訪問出錯：{context.HttpContext.Request.Path}", context.HttpContext.Request.Method, this.GetType().Name, context.Exception, paramenters);
            return;
        }
    }

    public class ApplicationErrorResult : ObjectResult
    {
        public ApplicationErrorResult(object value) : base(value)
        {
            StatusCode = (int)HttpStatusCode.InternalServerError;
        }
    }

 

 九 、添加Autofac，Autofac比.NET Core自帶的 Ioc更好用。 NuGetAPI 項目中添加Autofac.Configuration、Autofac.Extensions.DependencyInjection 兩個引用 然後 ConfigureServices方法中添加Ioc容器

 　　　　public IServiceProvider ConfigureServices(IServiceCollection services)
        {
            ConfigHelper.Init(Configuration["ConfigZookeeperAddress"], Configuration["ConfigNodePath"]);
            services.AddSingleton<ILogWrite, LogWrite>();

            services.AddMvc(options =>
            {
                options.Filters.Add<AuthorizationFilter>();
                options.Filters.Add<ExceptionFilter>();
                options.Filters.Add<PerformanceLogFilter>();
            });

            var builder = new ContainerBuilder();//實例化 AutoFac  容器            
            builder.Populate(services);

            // TODO: 這裡添加其他需要註入類的註冊

            ApplicationContainer = builder.Build();
            return new AutofacServiceProvider(ApplicationContainer);
        }

 

至此.NET Core API的 攔截器、配置管理、日誌、Ioc 設置已完成。

 

 

 public IServiceProvider ConfigureServices(IServiceCollection services)        {            ConfigHelper.Init(Configuration["ConfigZookeeperAddress"], Configuration["ConfigNodePath"]);            services.AddSingleton<ILogWrite, LogWrite>();
            services.AddMvc(options =>            {                options.Filters.Add<AuthorizationFilter>();                options.Filters.Add<ExceptionFilter>();                options.Filters.Add<PerformanceLogFilter>();            });
            var builder = new ContainerBuilder();//實例化 AutoFac  容器                        builder.Populate(services);
            // TODO: 這裡添加其他需要註入類的註冊
            ApplicationContainer = builder.Build();            return new AutofacServiceProvider(ApplicationContainer);        }


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 控制反轉
    依賴註入： 通過依賴註入來實現從不同的子公司採集數據，比如從唐山子公司、承德子公司和吉林子公司這三個地方採集，步驟如下： (1)編寫介面DataManagement介面 public interface DataManagement{ public void getData(); } (2)編寫具體 ...
  • 新晉菜鳥的錯誤
    大家好，我也是一名新的java小白，今天是我的第一篇文章，心情非常激動。初次發表請多關照。 第一篇文章完全是自己寫的，喜歡的可以關註，不喜歡的也可以多多建議。今天我遇到了一個SSM中常見的錯誤在這裡給大家分享一下。並提供自己的解決方式 因為SSM個人覺得有的方法需要配置大量的.xml文件有些繁瑣，有 ...
  • 同樣是Python程式員，為什麼別人就可以兩年躺賺200W
    小編前兩天在知乎上面看到一個帖子發佈於2014年，作者說他在2012的時候用Python寫自動化交易程式，賺了200W。 小編也抱著比較懷疑的態度去找一些資料發現，這個居然是真的，2012-2014年居然能用Python賺到200W，而且還是躺著賺錢的那種，還是六年前，想想就覺得Python還是挺可 ...
  • Java基礎——面向對象
    Hello 大家好，我又來啦，今天我們來說說Java的面向對象。 還記得之前去面試幾家公司的實習生職位，大部分面試官都問過我有關面向對象 的問題，不知道以後還會不會問，估計是不會了吧。。。(:3[▓▓] 下麵我們來說正事！(≖ ‿ ≖)✧ 面向對象特點有四個——封裝、繼承、多態、抽象 封裝： 封裝的 ...
  • 絕地求生神仙多，python科學家今天就開發個“千里眼”給你瞧瞧！
    前言 由於大量的計算都是在本地完成的，而游戲又是運行在記憶體中，那麼導致了我們有很多種方法進行利用。 絕地求生游戲體驗度極差，不是說游戲差，相反游戲做的體驗度是非常棒的，不然也不會有那麼多讓人去玩。只是不管任何段位都有很多神仙啊！我們都只是凡人，凡人不配擁有游戲體驗，神仙都是孤兒！ 學習Python中 ...
  • 堪比甄嬛傳的延禧！我媽天天看！爬取評論，和老媽找點話題聊天！
    最近宮鬥劇《延禧攻略》大火，大家稱贊的原因除了劇情，演員的演技之外，還有精良的製作，甚至有人給出了高顏值的歷史教科書的評價，初次之外，某些反派角色的飾演者的微博更是被“正義”的觀眾給攻陷了。本文將通過爬取評論區的評論，來看看小伙伴都在熱議啥。 本文分兩大部分，第一部分是爬蟲部分，爬取評論區信息；第二 ...
  • lua中table 庫函數 insert、remove、concat、sort的簡單使用【簡記】
    lua中table 庫函數table.insert()、table.remove()、table.concat()、table.sort()的簡單使用 ...
  • C#-基本語法（三）
    關鍵詞 關鍵字，是一些被C#規定了用途的重要單詞 在Visual Studio的開發環境中，關鍵字被標識為藍色 例如： using：導入命名空間 class：聲明類 static：靜態 void：無返回值 string：字元串類型 註釋 註釋，是代碼中的一些“說明性文字”，本身不參與程式的編譯和運行 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類