基於.NetCore開發博客項目 StarBlog - (16) 一些新功能 (監控/統計/配置/初始化)

基於.NetCore開發博客項目 StarBlog – (16) 一些新功能 (監控/統計/配置/初始化)

2022 年 7 月 27 日
筆記
.Net / AspNetCore, ASP.NetCore, Flutter, StarBlog博客開發筆記

系列文章

前言

最近好幾天都忙着寫代碼，沒更新文章，近期給博客增加了一些功能，本文一次性介紹~

新增的功能如下：

系統監控：sentry、exceptionless、CLRStats
訪問統計
配置管理
初始化

系統監控

PS：其實前面兩篇關於日誌收集工具介紹的文章也是為了給本文做鋪墊

系統監控這塊包括日誌收集、性能監測和系統狀態監測。

日誌收集和性能監測我交給了ExceptionLess和Sentry，這倆開源的工具可以很好的完成這些工作，詳情可以看我之前寫的這倆篇文章：

然後狀態監測我是基於GitHub上的一個開源項目來魔改的：CLRStats

這個組件可以實時查看CPU、GC、線程的狀態，不過原版的實現是作為一個中間件嵌入AspNetCore項目，並且訪問的地址只能用Basic認證，不適用。

於是我把代碼clone下來之後魔改了一下，變成一個可以調用的服務，並且重新寫了API接口，終於方便起來了~

這個接口拿到的數據是這樣的，後續在管理後台裏面做成可視化圖表也比較方便。

{
  "server": {
    "machineName": "machineName",
    "systemDateTime": "7/26/2022 11:30:22 PM"
  },
  "application": {
    "cpu": {
      "usagePercent": 0
    },
    "gc": {
      "gen0CollectCount": 24,
      "gen1CollectCount": 23,
      "gen2CollectCount": 22,
      "heapMemory": 38328872,
      "heapMemoryFormat": "36 M",
      "isServerGC": true
    },
    "thread": {
      "availableCompletionPortThreads": 1000,
      "availableWorkerThreads": 32766,
      "usedCompletionPortThreads": 0,
      "usedWorkerThreads": 1,
      "usedThreadCount": 29,
      "maxCompletionPortThreads": 1000,
      "maxWorkerThreads": 32767
    }
  }
}

具體代碼就不複製粘貼了，我把它放在StarBlog.Contrib項目中，作為一個獨立的組件方便調用。

訪問統計

雖然前面這篇文章有介紹訪問統計的實現：基於.NetCore開發博客項目 StarBlog – (11) 實現訪問統計

不過只是單純講了通過中間件實現訪問記錄，這些數據存在數據庫之後並沒有被利用起來

現在就實現了一些簡單的統計，目前主要實現了總覽數據（總訪問、今日、昨日訪問）、趨勢數據、指定日期統計，這幾個功能。

邏輯代碼在StarBlog.Web/Services/VisitRecordService.cs中

總覽數據代碼在這

PS：我發現FreeSQL的ISelect對象在鏈式操作時候的行為很奇怪，我知道是懶加載，但是已經執行了.Count()似乎還沒執行，下一行調用的代碼甚至會把前面的篩選條件加上，無奈我之內在方法內又寫了一個嵌套的方法……

也就是這個GetQuerySet，這點讓我這種用習慣DjangoORM的人覺得很不適應 = =..

這個接口計算總訪問量、今日訪問量、昨日訪問量，方便做對比~~（受知乎的創作者中心啟發）~~

public object Overview() {
  ISelect<VisitRecord> GetQuerySet() => _repo.Where(a => !a.RequestPath.StartsWith("/Api"));

  return new {
    TotalVisit = GetQuerySet().Count(),
    TodayVisit = GetQuerySet().Where(a => a.Time.Date == DateTime.Today).Count(),
    YesterdayVisit = GetQuerySet().Where(a => a.Time.Date == DateTime.Today.AddDays(-2).Date).Count(),
  };
}

趨勢數據

也就是統計最近n天的訪問量

PS：C#的日期處理還是比較舒服的

public object Trend(int days = 7) {
  return _repo.Where(a => !a.RequestPath.StartsWith("/Api"))
    .Where(a => a.Time.Date > DateTime.Today.AddDays(-days).Date)
    .GroupBy(a => a.Time.Date)
    .ToList(a => new {
      time = a.Key,
      date = $"{a.Key.Month}-{a.Key.Day}",
      count = a.Count()
    });
}

按日期統計

這個簡單粗暴不用多說

public object Stats(DateTime date) {
  var data = _repo.Where(a => a.Time.Date == date.Date && !a.RequestPath.StartsWith("/Api"));
  return new { Count = data.Count() };
}

注意這裏面所有的統計我都過濾了以/Api開頭的地址，因為我只需要統計博客前台的訪問量就行了。

配置管理

博客還是有很多需要配置的東西，比如說Host

之前我是寫在appsettings.json文件里的，按理說也可以，修改這文件之後也能hot reload，不過問題是沒法實現在管理後台中修改並保存

所以我打算實現一個配置管理的功能

一開始是把目光瞄準了KV數據庫，甚至要求找一個嵌入式的、C#實現的開源項目，疊了這麼多buff，果然沒找到合適的

(不過前幾天好像看到有個大佬發了篇文章介紹用C#手寫一個KV數據庫的，大讚！)

於是還是用博客本身的數據來實現好了，也不難

老規矩，繼續寫Service：StarBlog.Web/Services/ConfigService.cs

這裡只把關鍵代碼放出來，完整代碼可以看GitHub

public class ConfigService {
    private readonly IConfiguration _conf;
    private readonly IBaseRepository<ConfigItem> _repo;

    public ConfigItem? GetByKey(string key) {
        var item = _repo.Where(a => a.Key == key).First();
        if (item == null) {
            // 嘗試讀取初始化配置
            var section = _conf.GetSection($"StarBlog:Initial:{key}");
            if (!section.Exists()) return null;
            item = new ConfigItem { Key = key, Value = section.Value, Description = "Initial" };
            item = AddOrUpdate(item);
        }

        return item;
    }

    public ConfigItem AddOrUpdate(ConfigItem item) {
        return _repo.InsertOrUpdate(item);
    }

    public int? Update(string key, string value, string? description = default) {
        var item = GetByKey(key);
        if (item == null) return null;

        item.Value = value;
        if (description != null) item.Description = description;
        return _repo.Update(item);
    }

    public string this[string key] {
        get {
            var item = GetByKey(key);
            return item == null ? "" : item.Value;
        }
        set {
            var item = GetByKey(key) ?? new ConfigItem { Key = key };
            item.Value = value;
            AddOrUpdate(item);
        }
    }
}

這個ConfigService實現了索引器，可以比較方便的實現配置的讀取和保存

比如這樣

var conf = xxx; // 注入 ConfigService
// 讀取配置
Console.WriteLine(conf["host"]);
// 修改配置
conf["host"] = "//dealiaxy.com";

同時我也寫了幾個接口，可以通過HTTP的方式管理配置，代碼就不放了~

初始化

在我的設計中，這個功能是依賴於配置管理的

所以把配置管理做完之後，我的初始化頁面也做出來了

看起來是這樣的

也就是首次運行本項目的時候，會進入這個頁面，目前的初始化配置就只有創建管理、設置Host兩個，後續應該會慢慢增加其他的

後台是通過is_init這個字段來判斷是否有初始化的

直接上Controller代碼

[HttpGet]
public IActionResult Init([FromServices] ConfigService conf) {
    if (conf["is_init"] == "true") {
        _messages.Error("已經完成初始化！");
        return RedirectToAction(nameof(Index));
    }

    return View(new InitViewModel {
        Host = conf["host"]
    });
}

[HttpPost]
public IActionResult Init([FromServices] ConfigService conf, [FromServices] IBaseRepository<User> userRepo, InitViewModel vm) {
    if (!ModelState.IsValid) return View();

    // 保存配置
    conf["host"] = vm.Host;
    conf["is_init"] = "true";

    // 創建用戶
    // todo 這裡暫時存儲明文密碼，後期要換成MD5加密存儲
    userRepo.Insert(new User {
        Id = Guid.NewGuid().ToString(),
        Name = vm.Username,
        Password = vm.Password
    });

    _messages.Success("初始化完成！");
    return RedirectToAction(nameof(Index));
}

同時還要實現一個View頁面，這個就比較簡單，代碼不放了

Tags: .Net / AspNetCore ASP.NetCore Flutter StarBlog博客開發筆記