# MasuitToolsDoc

**Repository Path**: masuit/masuit-tools-doc

## Basic Information

- **Project Name**: MasuitToolsDoc
- **Description**: Masuit.Tools在线文档
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2023-07-05
- **Last Updated**: 2025-12-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Masuit.ToolsDoc

## 项目简介
Masuit.Tools 是一个 .NET 多功能类库，适用于多种开发环境，包括 .NET Framework、.NET Standard 和 .NET Core。它提供了丰富的功能，如数据验证、硬件监控、HTML 处理、加密解密、文件操作等，适用于各种 .NET 应用程序开发。

该项目得到了 [JetBrains](https://www.jetbrains.com/shop/eform/opensource) 的支持。

## 特性
- **多平台支持**：支持 .NET Framework ≥ 4.6.1、.NET Standard ≥ 2.1、.NET Core ≥ 2.1。
- **功能丰富**：涵盖字符串验证、HTML 防 XSS、内存管理、进制转换、性能计时器、文件压缩解压、邮件发送、图像处理等。
- **扩展性强**：提供 ASP.NET Core 支持、LINQ 表达式树扩展、EF Core 扩展、JSON 反序列化行为控制等高级功能。
- **工具包模块化**：可选择基础功能包或增值包（如 MongoDB 客户端、Excel 导出、ASP.NET Core 工具等）。

## 安装方法
- **基础功能包**：适用于 .NET Framework ≥ 4.6.1 或 .NET Standard ≥ 2.1。
- **增值包**：
  - `Masuit.Tools.AspNetCore`
  - `Masuit.Tools.Excel`
  - `Masuit.Tools.NoSQL.MongoDBClient`

## 使用示例
### 1. 字符串验证
```csharp
// 验证是否为邮箱
bool isEmail = "test@example.com".IsEmail();

// 验证是否为手机号
bool isPhoneNumber = "13800001111".IsPhoneNumber();

// 验证是否为 URL
bool isUrl = "https://example.com".IsUrl();

// 验证是否为 IP 地址
bool isIpAddress = "192.168.0.1".IsIpAddress();

// 验证是否为身份证号
bool isIdCard = "110101199003072516".IsIdCard();
```

### 2. HTML 防 XSS 处理
```csharp
string safeHtml = "<script>alert('xss')</script>".HtmlSanitize();
```

### 3. 内存整理（仅支持 Windows）
```csharp
// 清理 Windows 系统内存
MemoryHelper.ReleaseMemory();
```

### 4. 任意进制转换
```csharp
// 将十进制转换为二进制
string binary = 100.ToBase(2);

// 将二进制转换为十进制
int decimalValue = "1100100".FromBase(2);
```

### 5. 性能计时器
```csharp
using (var timer = new PerformanceTimer())
{
    // 执行耗时操作
    Thread.Sleep(1000);
}
```

### 6. 分布式唯一 ID 生成
```csharp
long id = SnowflakeIdGenerator.NewId();
```

### 7. 文件压缩与解压
```csharp
// 压缩文件
ZipHelper.ZipFile("source.txt", "archive.zip");

// 解压文件
ZipHelper.UnzipFile("archive.zip", "output/");
```

### 8. 邮件发送
```csharp
var mail = new MailMessage
{
    From = new MailAddress("sender@example.com"),
    Subject = "测试邮件",
    Body = "这是一封测试邮件。"
};
mail.To.Add("receiver@example.com");

SmtpClient client = new SmtpClient("smtp.example.com");
client.Send(mail);
```

### 9. 图像处理
```csharp
// 缩放图片
ImageHelper.ResizeImage("input.jpg", "output.jpg", 200, 200);

// 添加水印
ImageHelper.AddWatermark("input.jpg", "watermarked.jpg", "水印文字");
```

### 10. 实体验证
```csharp
public class User
{
    [Required]
    public string Name { get; set; }

    [Range(18, 100)]
    public int Age { get; set; }
}

var user = new User { Name = "", Age = 15 };
bool isValid = Validator.TryValidateObject(user, out var validationResults);
```

## 开发环境
- **Node.js** ≥ v16.19.0

## 构建与运行
```bash
# 安装依赖
npm install

# 运行开发服务器
npm run docs:dev

# 构建生产环境
npm run docs:build
```

## 贡献指南
欢迎贡献代码、文档和建议。请提交 PR 或 Issues 到 [GitHub 仓库](https://gitee.com/masuit/masuit-tools-doc)。

## 许可证
本项目采用 [MIT License](https://opensource.org/licenses/MIT)，详情请参见 LICENSE 文件。