前言

嗨，大家好！

想象一下，你正在開(kāi)發(fā)一款應(yīng)用程序，突然遇到了這樣一個(gè)棘手的問(wèn)題：

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

如果直接將這些密碼暴露在日志里，不僅違反了安全最佳實(shí)踐，還可能引發(fā)嚴(yán)重的隱私泄露風(fēng)險(xiǎn)。

這時(shí)候，你可能會(huì)想到幾種解決方案：

忽略序列化：將密碼字段標(biāo)記為 [JsonIgnore] 或類(lèi)似的屬性，但這可能會(huì)影響到其他業(yè)務(wù)邏輯，特別是當(dāng)實(shí)體類(lèi)位于較低層次時(shí)。
手動(dòng)打印字段：逐一打印對(duì)象的字段內(nèi)容，但這顯然非常麻煩，尤其是當(dāng)實(shí)體類(lèi)包含大量字段時(shí)，或者實(shí)體類(lèi)有變動(dòng)時(shí)。

那么，有沒(méi)有一種更優(yōu)雅、影響最小的方式來(lái)解決這個(gè)問(wèn)題呢？

答案是肯定的！

今天，我們可以利用 C# 的正則表達(dá)式，封裝編寫(xiě)一個(gè)簡(jiǎn)潔而強(qiáng)大的方法，自動(dòng)隱藏 JSON 字符串中的密碼字段。

這種方式不僅實(shí)現(xiàn)起來(lái)簡(jiǎn)單，而且對(duì)現(xiàn)有代碼的影響極小，非常適合在實(shí)際項(xiàng)目中應(yīng)用。

讓我們一起動(dòng)手試試吧！

封裝方法

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

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

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

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

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

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

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

使用示例

接下來(lái)，我們來(lái)看看如何在實(shí)際代碼中調(diào)用這個(gè)方法。

假設(shè)你有一個(gè)包含用戶(hù)名和密碼的 JSON 字符串，只需幾行代碼就可以將其密碼字段安全地隱藏起來(lái)。

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

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

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