Schema.NET 13.0.0

将 Schema.org 对象转换为强类型 C# POCO 类，以便在 .NET 中使用。所有类都可以序列化为 JSON/JSON-LD 和 XML，通常用于在 html 页面的 head 部分表示结构化数据。

简单示例

var website = new WebSite()
{
    AlternateName = "An Alternative Name",
    Name = "Your Site Name",
    Url = new Uri("https://example.com")
};
var jsonLd = website.ToString();

上面的代码输出以下 JSON-LD

{
    "@context":"https://schema.org",
    "@type":"WebSite",
    "alternateName":"An Alternative Name",
    "name":"Your Site Name",
    "url":"https://example.com"
}

如果要将结果写入 <script> 元素，请务必使用 .ToHtmlEscapedString() 方法，以避免使您的网站面临跨站脚本攻击的风险。请参阅以下示例。

什么是 Schema.org？

schema.org 定义了真实世界中对象和服务的标准类及其属性集。这是一种机器可读的格式，是互联网上用于描述事物的一种通用标准。

Schema.org 用在哪里？

网站

网站可以在其 html 的 head 部分定义结构化数据，以便搜索引擎能够在其搜索结果中显示更丰富的信息。以下是一个示例，说明 Google 如何在其搜索结果中显示有关您网站的扩展元数据。

在 html 中使用结构化数据需要使用 script 标签，其 MIME 类型为 application/ld+json，如下所示

<script type="application/ld+json">
{
  "@context": "https://schema.org",
  "@type": "Organization",
  "url": "https://www.example.com",
  "name": "Unlimited Ball Bearings Corp.",
  "contactPoint": {
    "@type": "ContactPoint",
    "telephone": "+1-401-555-1212",
    "contactType": "Customer service"
  }
}
</script>

重要安全提示

在将网站的 <script> 标签的结果序列化时，应该使用替代的 .ToHtmlEscapedString()，以避免如果您的模式中的某些属性是从不受信任的来源设置的，那么您会暴露于跨站脚本（XSS）漏洞。在 ASP.NET MVC 项目中的使用可能如下所示

<script type="application/ld+json">
    @Html.Raw(Model.Schema.ToHtmlEscapedString())
</script>

Windows UWP 共享

Windows UWP 应用允许您使用 schema.org 类来共享数据。以下是如何共享关于一本书的元数据的示例。

类与属性

schema.org 定义了类和属性，其中每个属性可以有一个值或多个值的数组。此外，属性可以有多种类型，例如，Address 属性可以是 string 类型或 PostalAddress 类型，后者有自己的属性，如 StreetAddress 或 PostalCode，这些可以将地址拆分为其组成部分。

为了实现这一点，Schema.NET 使用了一些巧妙的 C# 泛型和隐式类型转换，使得设置单个或多个值都是可能的，并且设置 string 或 PostalAddress 也是可能的

// Single string address
var organization = new Organization()
{
    Address = "123 Old Kent Road E10 6RL"
};

// Multiple string addresses
var organization = new Organization()
{
    Address = new List<string>()
    { 
        "123 Old Kent Road E10 6RL",
        "456 Finsbury Park Road SW1 2JS"
    }
};

// Single PostalAddress address
var organization = new Organization()
{
    Address = new PostalAddress()
    {
        StreetAddress = "123 Old Kent Road",
        PostalCode = "E10 6RL"
    }
};

// Multiple PostalAddress addresses
var organization = new Organization()
{
    Address = new List<PostalAddress>()
    {
        new PostalAddress()
        {
            StreetAddress = "123 Old Kent Road",
            PostalCode = "E10 6RL"
        },
        new PostalAddress()
        {
            StreetAddress = "456 Finsbury Park Road",
            PostalCode = "SW1 2JS"
        }
    }
};

// Mixed Author types
var book = new Book()
{
    Author = new List<object>()
    {
        new Organization() { Name = "Penguin" },
        new Person() { Name = "J.D. Salinger" }
    }
};

// Deconstruct a property containing mixed types
if (book.Author.HasValue)
{
    var (organisations, people) = book.Author.Value;
}

这种魔法全部是通过在 OneOrMany、Values、Values 和 Values 类型中使用 隐式转换运算符 来实现的。这些类型都是 structs，以确保最佳性能。

更多示例

有关更多示例和实际运行代码的示例，请查看项目源代码中的单元测试。

Schema.NET.Pending

在 schema.org 上还有许多挂起的类型，它们尚未完全形成且准备好用于生产。如果您需要使用这些类型，您可以安装 Schema.NET.Pending NuGet 包而不是 Schema.NET。此包包含所有已发布的模式类型以及所有挂起的类型。

持续集成

名称	操作系统	状态	历史记录
Azure Pipelines	Ubuntu
Azure Pipelines	Mac
Azure Pipelines	Windows
Azure Pipelines	总体
GitHub Actions	Ubuntu、Mac 和 Windows
AppVeyor	Ubuntu、Mac 和 Windows

贡献与感谢

请查看贡献指南了解更多信息。

• kirkone - CI 从新的全局.json 文件中读取 .NET Core 版本。
• Turnerj - 添加了对 System.Text.Json 的支持，所有类型都实现了 IEquatable 和 GetHashCode，并添加了额外的单元测试和错误修复。
• shervinw - 为结构体添加了更好的空值处理。
• kirk-marple - 重构JSON序列化以实现更高的效率。
• nickevansuk - 增加更好的空值处理，并使用HTTPS而非HTTP。
• MEmanuelsson - 增加了支持没有时间的schema.org日期类型。
• halovanic - 为Schema.NET类型添加接口以增强灵活性。
• AndreSteenbergen - 使工具能够在Linux上运行。
• benmccallum - 添加XSS漏洞保护。
• psampaio - 添加了解析支持以及单元测试。
• icunningham88 - 优化了一个测试。