前言

嗨，大家好！

想象一下，你正在開發一款應用程序，突然遇到了這樣一個棘手的問題：

你需要將對象序列化為 JSON 字符串并打印到日志中進行調試，但這其中包含了敏感的密碼信息。

如果直接將這些密碼暴露在日志里，不僅違反了安全最佳實踐，還可能引發嚴重的隱私泄露風險。

這時候，你可能會想到幾種解決方案：

忽略序列化：將密碼字段標記為 [JsonIgnore] 或類似的屬性，但這可能會影響到其他業務邏輯，特別是當實體類位于較低層次時。
手動打印字段：逐一打印對象的字段內容，但這顯然非常麻煩，尤其是當實體類包含大量字段時，或者實體類有變動時。

那么，有沒有一種更優雅、影響最小的方式來解決這個問題呢？

答案是肯定的！

今天，我們可以利用 C# 的正則表達式，封裝編寫一個簡潔而強大的方法，自動隱藏 JSON 字符串中的密碼字段。

這種方式不僅實現起來簡單，而且對現有代碼的影響極小，非常適合在實際項目中應用。

讓我們一起動手試試吧！

封裝方法

下面是我封裝的方法，通過正則表達式，它能夠智能地識別并隱藏 JSON 字符串中的密碼字段，留意代碼中的注釋：

/// <summary>
/// 隱藏Json字符串中的密碼
/// </summary>
/// <param name="jsonData">需要處理的 JSON 字符串</param>
/// <returns>處理后的 JSON 字符串，其中密碼字段已被隱藏</returns>
public static string HidePassword(string jsonData)
{
    string newJsonData = null;

    // 定義替換模式，使用命名捕獲組 "str" 來匹配鍵名
    string replacement = "\"${str}\":\"********\"";

    // 匹配包含 "password" 的鍵名（不區分大小寫）
    // 替換為星號掩碼
    string pattern1 = "\"(?<str>([A-Za-z0-9_]*)password)\":\"(.*?)\""; 

    // 使用正則表達式替換所有匹配項
    newJsonData = Regex.Replace(jsonData, pattern1, replacement, RegexOptions.IgnoreCase | RegexOptions.Multiline | RegexOptions.Singleline);

    // 如果有多個不同的密碼字段（如 pwd），可以繼續增加隱藏語句
    // 或者將它單獨抽出來作為一個子方法
    // string pattern2 = "\"(?<str>([A-Za-z0-9_]*)pwd)\":\"(.*?)\"";
    // newJsonData = Regex.Replace(newJsonData, pattern2, replacement, RegexOptions.IgnoreCase | RegexOptions.Multiline | RegexOptions.Singleline);

    // 返回處理后的 JSON 字符串
    return newJsonData;
}

使用示例

接下來，我們來看看如何在實際代碼中調用這個方法。

假設你有一個包含用戶名和密碼的 JSON 字符串，只需幾行代碼就可以將其密碼字段安全地隱藏起來。

class Program
{
    static void Main()
    {
        // 假設這是從某個地方獲取的 JSON 字符串
        string jsonData = "{\"username\":\"Jacky\", \"password\":\"123456\",\"Age\":35}";

        // 調用 HidePassword 方法隱藏密碼字段
        string sanitizedJson = SecurityUtil.HidePassword(jsonData);

        // 輸出處理后的 JSON 字符串
        Console.WriteLine(sanitizedJson);
    }
}