HttpReports

簡單介紹

HttpReports 是 .Net Core下的一個Web組件，適用於 WebAPI 項目和 API 網關項目，通過中間件的形式集成到您的項目中, 通過HttpReports，可以讓開發人員快速的搭建出一個 API 性能分析的基礎報表網站。

主要包含 HttpReports 中間件 和 HttpReports.Web 報表項目：

HttpReports： https://github.com/SpringLeee/HttpReports

HttpReports.Web： https://github.com/SpringLeee/HttpReportsWeb

如何使用

1.運行 HttpReports.Web

在github下載 HttpReports.Web 項目，項目地址：https://github.com/SpringLeee/HttpReportsWeb, Web項目是.Net Core MVC 項目，使用三層實現。

下載完成後，在VS中打開，然後還原NuGet程式包，完成後首先 appsettings.json

appsettings.json

{
  "ConnectionStrings": {
    "HttpReports": "Max Pool Size = 512;server=.;uid=sa;pwd=123456;database=HttpReports;"
  }, 
  "HttpReportsConfig": {
    "DBType": "SqlServer",
    "UserName": "admin",
    "Password": "123456"
  }
}

主要參數：

• HttpReports：配置一個可用的連接字元串；
• DBType：資料庫類型，支持SqlServer和MySql;
• UserName: Web項目的登錄名；
• Password: Web項目的登錄密碼；

假設我們使用的是SqlServer 資料庫，需要先配置ConnectionStrings，然後手動創建資料庫 HttpReports（Web項目會根據資料庫自動創建表，並且在第一次運行的時候Mock一些數據 ），我們直接F5運行項目， 沒有問題的話，會直接跳到登錄頁面，輸入用戶名密碼 admin 123456，登錄後，應該可以看到下麵的頁面

現在可以看到項目有 auth,payment，sms 三個服務節點，服務節點的定義如下：

如果你的項目是單個WebAPI項目，那麼服務節點只有一個 default，如果你的項目是 GateWay 網關項目，那麼Web項目就可以讀取到多個服務節點，比如 auth 認證，payment支付等。

2.在API項目中使用

首先要刪除 Web 項目的Mock數據，打開資料庫 HttpReports，打開表 RequestInfo,清空數據，執行Sql

  Delete * From [HttpReports].[dbo].[RequestInfo]

配置資料庫連接字元串

HttpReports 適用單個API項目和網關項目，這裡使用 Ocelot網關項目為例.

我們打開appsetting.json, 配置資料庫連接字元串，需要和Web項目一致

Nuget引用HttpReports

安裝nuget包 HttpReports ，打開StartUp

在ConfigureServices 方法下添加：

services.AddHttpReportsMiddlewire();

如果是MySql資料庫，則添加：
csharp services.AddHttpReportsMiddlewire(options =>{ options.DBType = DBType.MySql; });

加入到 Configure 方法 ，需要放在 app.UseMVC() 或者 app.UseOcelot().Wait() 的前面，要不然不生效

app.UseHttpReportsMiddlewire();

ConnectionStrings 配置的連接字元串和資料庫類型要一致，全部完成了以後，我們就可以使用 Web 項目了。

項目環境基本要求

WebAPI或者網關項目支持的.Net Core 版本 2.2, 3.0, 3.1;

HttpReports.Web 的core版本為 2.2

性能事項

HttpReports 中間件是非同步操作，所以對api介面請求的時間可以忽略，但是由於實質使用的是資料庫存儲，所以要註意直接請求到資料庫的壓力。

下麵是用PostMan做的一個簡單測試：

WebAPI內的方法：

        public string Sql1()
        {
            SqlConnection con = new SqlConnection(
                "Max Pool Size = 512;server=.;uid=sa;pwd=123456;database=HyBasicData;");

            var list1 =  con.Query(" select * from [HyBasicData].[dbo].[Customers] ");

            var list2 = con.Query(" select * from [HyBasicData].[dbo].[Customers] ");

            var list3 = con.Query(" select * from [HyBasicData].[dbo].[Customers] "); 

            return list1.Count().ToString();
        } 

PostMan分別對添加中間件和不添加中間件的 API請求 1000次，每300ms請求一次

總結

HttpReports 的實現原理並不複雜，如果你想給你的 WebAPI項目，快速的添加一套分析系統 ，那麼使用HttpReports 是一個不錯的選擇

聯繫作者

如果您在使用過程中遇到了什麼問題或者有好的建議的話，可以添加我的微信，希望可以幫助到您