文档菜单
文档首页
/
MongoDB C# 分析器
/

分析 POCOs

在本页

  • 概述
  • 预览为 JSON
  • 在 Visual Studio 中预览 POCOs

普通的 CLR 对象,或普通的类对象(POCOs),是简单的类对象,不继承任何框架特定的基类或接口。如果您的应用程序使用 POCOs,您可以使用 C# 分析器将它们预览为 JSON 对象。

有关 POCOs 的更多信息,请参阅POCOs 页面在维基百科上 以及 .NET/C# 驱动文档中的 使用 POCO 页面。

以下代码示例展示了 POCO 类定义及其相应的 JSON 转换示例。通过以 JSON 预览您的 POCO,您可以查看 BSON 序列化属性,如BsonIdBsonElement,如何改变序列化后 BSON 的形状。

class Order
{
[BsonId]
public int OrderNumber { get; set; }
[BsonElement("customer_id")]
public int CustomerId { get; set; }
public string Date { get; set; }
[BsonIgnore]
public string Email { get; set; }
}
{
"_id": 6783456,
"customer_id": 678234,
"Date": "06/03/2023"
}

提示

示例数据

C# 分析器为某些常见的属性名提供了预定义的示例值。如果您的 POCO 中使用这些属性名,分析器将使用 JSON 输出中的示例值。对于没有预定义示例值的任何属性名,分析器将使用与属性数据类型匹配的随机值。

有关带有示例值的属性名称列表,请参阅MongoDB C# Analyzer GitHub仓库中的JSON示例值文件

要在Visual Studio中预览您的POCO,请执行以下操作

  1. 按照安装MongoDB C# Analyzer指南中的说明进行安装。

  2. 定义一个POCO类。

  3. 将您的光标移至...省略号注解在您的类定义的第一词下方,以显示包含JSON翻译的信息消息。

点击以下相应的标签页,查看带有或没有信息消息显示的POCO类定义

Screenshot of POCO definition with an ellipsis annotation in Visual Studio
Screenshot of POCO definition with an information message displayed in Visual Studio

提示

规则ID

信息消息以生成弹出窗口的C# Analyzer规则ID开头。在前面示例中,规则ID是MAPoco1001,表示POCO是有效的。要了解更多关于此规则的信息,请参阅规则和消息内容指南。

返回

LINQ 表达式