Schema.NET 开源项目教程

1. 项目介绍

1.1 项目概述

Schema.NET 是一个开源项目，旨在将 Schema.org 定义的对象转换为强类型的 C# POCO（Plain Old CLR Object）类，以便在 .NET 环境中使用。这些类可以被序列化为 JSON/JSON-LD 和 XML 格式，通常用于在 HTML 页面的 head 部分表示结构化数据。

1.2 项目目标

• 提供强类型的 C# 类，便于在 .NET 项目中使用 Schema.org 定义的对象。
• 支持 JSON/JSON-LD 和 XML 格式的序列化。
• 简化在网页中嵌入结构化数据的过程，以提高搜索引擎的索引效果。

1.3 项目特点

• 强类型：所有类都是强类型的，减少了类型转换的错误。
• 多格式支持：支持 JSON/JSON-LD 和 XML 格式的序列化。
• 安全性：提供 ToHtmlEscapedString() 方法，防止跨站脚本攻击（XSS）。

2. 项目快速启动

2.1 安装

首先，通过 NuGet 安装 Schema.NET 包：

dotnet add package Schema.NET --version 6.0.0

2.2 基本使用

以下是一个简单的示例，展示如何使用 Schema.NET 创建一个 WebSite 对象并将其序列化为 JSON-LD 格式：

using Schema.NET;

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

var jsonLd = website.ToString();
Console.WriteLine(jsonLd);

输出结果：

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

2.3 防止 XSS 攻击

在将结果写入 <script> 元素时，使用 ToHtmlEscapedString() 方法以避免 XSS 攻击：

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

3. 应用案例和最佳实践

3.1 在 ASP.NET MVC 项目中使用

在 ASP.NET MVC 项目中，可以使用 Schema.NET 生成结构化数据，以提高搜索引擎的索引效果。以下是一个示例：

public class HomeController : Controller
{
    public ActionResult Index()
    {
        var website = new WebSite()
        {
            AlternateName = "An Alternative Name",
            Name = "Your Site Name",
            Url = new Uri("https://example.com")
        };

        ViewBag.Schema = website.ToString();
        return View();
    }
}

在视图中：

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

3.2 在 Windows UWP 应用中使用

在 Windows UWP 应用中，可以使用 Schema.NET 生成结构化数据，以便在应用之间共享数据。以下是一个示例：

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

var jsonLd = book.ToString();

4. 典型生态项目

4.1 OpenActive.NET

OpenActive.NET 是一个基于 Schema.NET 的项目，用于将 OpenActive 模型规范中的对象转换为强类型的 C# POCO 类。它支持 JSON/JSON-LD 序列化，适用于体育和休闲活动的在线预订系统。

4.2 Spin Web Framework

Spin Web Framework 是一个跨平台的 .NET Core 框架，使用 Schema.NET 生成结构化数据，以提高搜索引擎的索引效果。

4.3 DeploySoftware.LaunchPad

DeploySoftware.LaunchPad 是一个组织相关的代码框架，使用 Schema.NET 生成结构化数据，以便在组织内部共享和使用。

通过以上模块的介绍，您可以快速上手并深入了解 Schema.NET 的使用方法和最佳实践。