在C#开发中，BSON是一种常用的二进制数据格式，它保留了JSON的灵活结构，同时具备更高的解析效率和更小的存储空间，非常适合用来存储结构化的文档数据。将业务文档序列化为BSON并写入文件，是很多数据存储场景下的常见需求。
准备工作：选择BSON操作类库
目前C#生态中操作BSON最常用的是MongoDB.Bson类库，它是MongoDB官方提供的BSON处理组件，功能完善且性能稳定，支持大部分C#常用数据类型的序列化。我们可以通过NuGet包管理器安装这个类库，安装命令如下：
Install-Package MongoDB.Bson
定义待序列化的文档类
首先需要定义要序列化的业务文档类，这个类可以是普通的C#实体类，MongoDB.Bson类库会自动处理大部分基础类型的序列化逻辑。以下是一个简单的用户信息文档类示例：
using MongoDB.Bson;
using MongoDB.Bson.Serialization.Attributes;
public class UserInfo
{
// BsonId特性标记该字段为BSON文档的唯一标识，类似JSON中的_id
[BsonId]
public ObjectId Id { get; set; }
public string UserName { get; set; }
public int Age { get; set; }
public string Email { get; set; }
public DateTime RegisterTime { get; set; }
}
将文档序列化为BSON字节数组
使用MongoDB.Bson提供的BsonSerializer类可以完成对象的序列化操作，将对象转换为BSON格式的字节数组。具体实现代码如下：
using MongoDB.Bson;
using MongoDB.Bson.Serialization;
using System;
public class BsonDemo
{
public static byte[] SerializeToBson(UserInfo user)
{
// 调用BsonSerializer的Serialize方法，将对象序列化为BSON字节数组
byte[] bsonBytes = user.ToBson();
return bsonBytes;
}
}
如果需要自定义序列化逻辑，比如指定某些字段不参与序列化，或者修改字段在BSON中的名称，可以使用对应的特性标记，例如[BsonIgnore]可以忽略指定字段，[BsonElement("user_name")]可以修改字段在BSON中的键名。
将BSON数据写入文件
得到BSON字节数组之后，使用C#的文件操作API就可以将数据写入到本地文件。完整的序列化并存入文件的代码如下：
using MongoDB.Bson;
using System;
using System.IO;
public class BsonFileHandler
{
public static void SaveUserToBsonFile(UserInfo user, string filePath)
{
// 将用户对象序列化为BSON字节数组
byte[] bsonData = user.ToBson();
// 将字节数组写入指定路径的文件，如果文件已存在会覆盖原有内容
File.WriteAllBytes(filePath, bsonData);
Console.WriteLine($"文档已成功序列化为BSON并存入文件：{filePath}");
}
// 测试示例
public static void Test()
{
UserInfo user = new UserInfo
{
Id = ObjectId.GenerateNewId(),
UserName = "张三",
Age = 25,
Email = "test@ipipp.com",
RegisterTime = DateTime.Now
};
string savePath = @"D:user_data.bson";
SaveUserToBsonFile(user, savePath);
}
}
从BSON文件反序列化文档
除了序列化存入文件，我们通常还需要从BSON文件中读取数据并反序列化为对象，对应的实现代码如下：
using MongoDB.Bson;
using System;
using System.IO;
public class BsonFileHandler
{
public static UserInfo ReadUserFromBsonFile(string filePath)
{
// 从文件读取所有BSON字节数据
byte[] bsonData = File.ReadAllBytes(filePath);
// 将BSON字节数组反序列化为UserInfo对象
UserInfo user = BsonSerializer.Deserialize<UserInfo>(bsonData);
return user;
}
}
注意事项
- 序列化时如果文档类包含循环引用，需要配置
BsonSerializer的序列化选项，避免序列化过程进入死循环。 - 写入文件时注意文件路径的权限，确保程序对目标目录有写入权限，避免出现IO异常。
- 如果需要存储多个文档到同一个BSON文件，可以采用数组或者列表的形式序列化，或者每个文档单独存为一个BSON文件，根据实际业务场景选择。
- ObjectId类型的字段在反序列化时会自动还原，不需要额外处理，它是BSON格式中常用的唯一标识类型。