Sage.Data.Mask 1.0.0.2

Sage.Data.Mask 数据脱敏库

简介

Sage.Data.Mask 是一个高性能、易用的 .NET 数据脱敏库，用于在显示或传输敏感数据时保护用户隐私。该库提供了丰富的脱敏方法，支持多种常见数据类型的脱敏处理，如邮箱、手机号、身份证号、银行卡号等。

特性

• 丰富的脱敏类型：支持 20+ 种常见数据类型的脱敏
• 高性能实现：经过性能优化，减少不必要的字符串操作和内存分配
• 易用的 API：提供扩展方法和静态方法两种调用方式
• 链式调用：支持方法链式调用，提升代码可读性
• 批量处理：支持批量数据脱敏，提高处理效率
• 自定义规则：支持自定义脱敏规则，满足特殊业务需求
• AOT 兼容：支持 .NET Native AOT 编译

安装

dotnet add package Sage.Data.Mask

快速开始

基本用法

using Sage.Data.Mask;

// 使用扩展方法
string email = "john.doe@example.com";
string maskedEmail = email.MaskEmail(); // 返回 "jo***e@example.com"

string phone = "13812345678";
string maskedPhone = phone.MaskPhone(); // 返回 "138****5678"

string idCard = "110101199001011234";
string maskedIdCard = idCard.MaskIdCard(); // 返回 "110101********1234"

使用 MaskType 枚举

using Sage.Data.Mask;

string email = "john.doe@example.com";
string maskedEmail = Maskers.Mask(email, MaskType.Email);

string phone = "13812345678";
string maskedPhone = Maskers.Mask(phone, MaskType.Phone);

string idCard = "110101199001011234";
string maskedIdCard = Maskers.Mask(idCard, MaskType.IdCard);

自定义脱敏规则

using Sage.Data.Mask;

string text = "abcdefghijk";
string masked = Maskers.Mask(text, 2, 2); // 返回 "ab*******jk"

批量脱敏处理

using Sage.Data.Mask;
using System.Collections.Generic;

var userData = new Dictionary<string, MaskType>
{
    { "john@example.com", MaskType.Email },
    { "13812345678", MaskType.Phone },
    { "110101199001011234", MaskType.IdCard },
    { "6222081234567890123", MaskType.BankCard }
};

var maskedData = Maskers.BatchMask(userData);

foreach (var item in maskedData)
{
    Console.WriteLine($"原值: {item.Key} => 脱敏后: {item.Value}");
}

支持的脱敏类型

高级用法

链式调用

using Sage.Data.Mask;

string userInfo = $"姓名: {user.Name.MaskName()}, 手机: {user.Phone.MaskPhone()}, 邮箱: {user.Email.MaskEmail() ?? "未提供"}";

自定义脱敏规则

using Sage.Data.Mask;

// 自定义脱敏规则 - 保留前3位和后5位
string sensitive = "sensitive-data-12345";
string custom = Maskers.Mask(sensitive, 3, 5); // 返回 "sen***12345"

// 批量自定义脱敏
var customRules = new[]
{
    new { Value = "data1", Prefix = 1, Suffix = 1 },
    new { Value = "data2", Prefix = 2, Suffix = 2 },
    new { Value = "data3", Prefix = 0, Suffix = 4 }
};

foreach (var rule in customRules)
{
    var masked = Maskers.Mask(rule.Value, rule.Prefix, rule.Suffix);
    Console.WriteLine(masked);
}

在日志记录中使用

using Sage.Data.Mask;

// 记录用户登录信息，但保护敏感数据
logger.Info($"用户 {user.Name.MaskName()} 使用手机 {user.Phone.MaskPhone()} 登录系统，密码: {password.MaskPassword()}")

在API响应中使用

using Sage.Data.Mask;

// 返回用户信息，但脱敏敏感数据
public UserViewModel GetUserInfo(int userId)
{
    var user = _userRepository.GetById(userId);
    
    return new UserViewModel
    {
        Id = user.Id,
        Name = user.Name,  // 不脱敏
        Email = user.Email.MaskEmail(),  // 脱敏
        Phone = user.Phone.MaskPhone(),  // 脱敏
        IdCard = user.IdCard.MaskIdCard()  // 脱敏
    };
}

性能优化

该库在设计时考虑了性能因素，采用了以下优化措施：

• 使用 AsSpan() 减少字符串切片分配
• 避免不必要的字符串操作和内存分配
• 优化分支逻辑，提高执行效率
• 使用 StringBuilder 处理复杂字符串拼接
• 缓存正则表达式实例，避免重复编译

许可证

本项目采用 Apache 2.0 许可证。详情请参阅 LICENSE 文件。

贡献

欢迎提交问题报告和改进建议。如果您想贡献代码，请提交拉取请求。

作者

• LiuPengLai - 甲壳虫科技 欢迎提交问题和功能请求。 QQ Group: 1054304346