元数据

本节详细介绍了基于 Spring Data REST 的应用程序提供的各种元数据形式。

应用程序级配置文件语义 (ALPS)

ALPS 是一种数据格式，用于定义应用程序级语义的简单描述，其复杂性类似于 HTML 微格式。ALPS 文档可用作配置文件，以解释具有应用程序无关媒体类型（如 HTML、HAL、Collection+JSON、Siren 等）的文档的应用程序语义。这提高了配置文件文档在各种媒体类型中的可重用性。
— M. Admundsen / L. Richardson / M. Foster
https://tools.ietf.org/html/draft-amundsen-richardson-foster-alps-00

Spring Data REST 为每个导出的资源库提供一个 ALPS 文档。它包含有关每个资源库的 RESTful 过渡和属性的信息。

在 Spring Data REST 应用程序的根目录中，有一个配置文件链接。假设您有一个应用程序，其中包含 persons 和相关的 addresses，则根文档将如下所示

{
  "_links" : {
    "persons" : {
      "href" : "https://127.0.0.1:8080/persons"
    },
    "addresses" : {
      "href" : "https://127.0.0.1:8080/addresses"
    },
    "profile" : {
      "href" : "https://127.0.0.1:8080/profile"
    }
  }
}

配置文件链接，如 RFC 6906 中所定义，是包含应用程序级详细信息的地方。 ALPS 草案规范 旨在定义特定的配置文件格式，我们将在本节后面进行探讨。

如果您导航到 localhost:8080/profile 的配置文件链接，您将看到类似于以下内容的内容

{
  "_links" : {
    "self" : {
      "href" : "https://127.0.0.1:8080/profile"
    },
    "persons" : {
      "href" : "https://127.0.0.1:8080/profile/persons"
    },
    "addresses" : {
      "href" : "https://127.0.0.1:8080/profile/addresses"
    }
  }
}
在根级别，profile 是一个单链接，无法提供多个应用程序配置文件。这就是为什么您必须导航到 /profile 才能找到每个资源元数据的链接。

如果您导航到 /profile/persons 并查看 Person 资源的配置文件数据，您会看到类似以下示例的内容

{
  "version" : "1.0",
  "descriptors" : [ {
    "id" : "person-representation", (1)
    "descriptors" : [ {
      "name" : "firstName",
      "type" : "SEMANTIC"
    }, {
      "name" : "lastName",
      "type" : "SEMANTIC"
    }, {
      "name" : "id",
      "type" : "SEMANTIC"
    }, {
      "name" : "address",
      "type" : "SAFE",
      "rt" : "https://127.0.0.1:8080/profile/addresses#address"
    } ]
  }, {
    "id" : "create-persons", (2)
    "name" : "persons", (3)
    "type" : "UNSAFE", (4)
    "rt" : "#person-representation" (5)
  }, {
    "id" : "get-persons",
    "name" : "persons",
    "type" : "SAFE",
    "rt" : "#person-representation"
  }, {
    "id" : "delete-person",
    "name" : "person",
    "type" : "IDEMPOTENT",
    "rt" : "#person-representation"
  }, {
    "id" : "patch-person",
    "name" : "person",
    "type" : "UNSAFE",
    "rt" : "#person-representation"
  }, {
    "id" : "update-person",
    "name" : "person",
    "type" : "IDEMPOTENT",
    "rt" : "#person-representation"
  }, {
    "id" : "get-person",
    "name" : "person",
    "type" : "SAFE",
    "rt" : "#person-representation"
  } ]
}
1 Person 资源属性的详细列表，标识为 #person-representation，列出了属性的名称。
2 支持的操作。这表明如何创建一个新的 Person。
3 name 是 persons，这表明（因为它是一个复数）POST 应该应用于整个集合，而不是单个 person。
4 type 是 UNSAFE，因为此操作会改变系统状态。
5 rt 是 #person-representation，这表明返回的资源类型将是 Person 资源。
此 JSON 文档的媒体类型为 application/alps+json。这与之前的 JSON 文档不同，之前的 JSON 文档的媒体类型为 application/hal+json。这些格式不同，受不同规范管理。

您还可以在检查集合资源时，在 _links 集合中找到一个 profile 链接，如下例所示

{
  "_links" : {
    "self" : {
      "href" : "https://127.0.0.1:8080/persons" (1)
    },
    ... other links ...
    "profile" : {
      "href" : "https://127.0.0.1:8080/profile/persons" (2)
    }
  },
  ...
}
1 此 HAL 文档表示 Person 集合。
2 它有一个指向相同 URI 的元数据的 profile 链接。

同样，默认情况下，profile 链接提供 ALPS。但是，如果您使用 Accept 标头，它可以提供 application/alps+json。

超媒体控制类型

ALPS 为每个超媒体控制显示类型。它们包括

表 1. ALPS 类型
类型 描述

SEMANTIC

状态元素（例如 HTML.SPAN、HTML.INPUT 等）。

SAFE

触发安全、幂等状态转换的超媒体控制（例如 GET 或 HEAD）。

IDEMPOTENT

触发不安全、幂等状态转换的超媒体控制（例如 PUT 或 DELETE）。

UNSAFE

触发不安全、非幂等状态转换的超媒体控制（例如 POST）。

在前面展示的表示部分中，来自应用程序的数据位被标记为SEMANTIC。address字段是一个链接，它涉及一个安全的GET来检索。因此，它被标记为SAFE。超媒体操作本身映射到前面的表格中所示的类型。

带有投影的 ALPS

如果您定义了任何投影，它们也会列在 ALPS 元数据中。假设我们还定义了inlineAddress和noAddresses，它们将出现在相关的操作中。（有关这两个投影的定义和讨论，请参见“投影”。）也就是说，GET将出现在整个集合的操作中，GET将出现在单个资源的操作中。以下示例显示了get-persons子部分的备用版本

...
  {
    "id" : "get-persons",
    "name" : "persons",
    "type" : "SAFE",
    "rt" : "#person-representation",
    "descriptors" : [ { (1)
      "name" : "projection",
      "doc" : {
        "value" : "The projection that shall be applied when rendering the response. Acceptable values available in nested descriptors.",
        "format" : "TEXT"
      },
      "type" : "SEMANTIC",
      "descriptors" : [ {
        "name" : "inlineAddress", (2)
        "type" : "SEMANTIC",
        "descriptors" : [ {
          "name" : "address",
          "type" : "SEMANTIC"
        }, {
          "name" : "firstName",
          "type" : "SEMANTIC"
        }, {
          "name" : "lastName",
          "type" : "SEMANTIC"
        } ]
      }, {
        "name" : "noAddresses", (3)
        "type" : "SEMANTIC",
        "descriptors" : [ {
          "name" : "firstName",
          "type" : "SEMANTIC"
        }, {
          "name" : "lastName",
          "type" : "SEMANTIC"
        } ]
      } ]
    } ]
  }
...
1 出现了一个新的属性descriptors，它包含一个带有单个条目projection的数组。
2 在projection.descriptors中，我们可以看到inLineAddress。它呈现address、firstName和lastName。在投影内呈现的关系会导致将数据字段内联包含。
3 noAddresses提供了一个包含firstName和lastName的子集。

有了所有这些信息，客户端不仅可以推断出可用的 RESTful 转换，而且在一定程度上还可以推断出与后端交互所需的数据元素。

向您的 ALPS 描述添加自定义详细信息

您可以创建出现在您的 ALPS 元数据中的自定义消息。为此，请创建rest-messages.properties，如下所示

rest.description.person=A collection of people
rest.description.person.id=primary key used internally to store a person (not for RESTful usage)
rest.description.person.firstName=Person's first name
rest.description.person.lastName=Person's last name
rest.description.person.address=Person's address

这些rest.description.*属性定义了要为Person资源显示的详细信息。它们会更改person-representation的 ALPS 格式，如下所示

...
  {
    "id" : "person-representation",
    "doc" : {
      "value" : "A collection of people", (1)
      "format" : "TEXT"
    },
    "descriptors" : [ {
      "name" : "firstName",
      "doc" : {
        "value" : "Person's first name", (2)
        "format" : "TEXT"
      },
      "type" : "SEMANTIC"
    }, {
      "name" : "lastName",
      "doc" : {
        "value" : "Person's last name", (3)
        "format" : "TEXT"
      },
      "type" : "SEMANTIC"
    }, {
      "name" : "id",
      "doc" : {
        "value" : "primary key used internally to store a person (not for RESTful usage)", (4)
        "format" : "TEXT"
      },
      "type" : "SEMANTIC"
    }, {
      "name" : "address",
      "doc" : {
        "value" : "Person's address", (5)
        "format" : "TEXT"
      },
      "type" : "SAFE",
      "rt" : "https://127.0.0.1:8080/profile/addresses#address"
    } ]
  }
...
1 rest.description.person的值映射到整个表示。
2 rest.description.person.firstName的值映射到firstName属性。
3 rest.description.person.lastName的值映射到lastName属性。
4 rest.description.person.id的值映射到id属性，这是一个通常不显示的字段。
5 rest.description.person.address的值映射到address属性。

提供这些属性设置会导致每个字段都有一个额外的doc属性。

Spring MVC（它是 Spring Data REST 应用程序的本质）支持语言环境，这意味着您可以将多个属性文件捆绑在一起，这些文件包含不同的消息。

JSON Schema

JSON Schema 是 Spring Data REST 支持的另一种元数据形式。根据他们的网站，JSON Schema 具有以下优点

  • 描述您现有的数据格式

  • 清晰、人机可读的文档

  • 完整的结构验证，有助于自动化测试和验证客户提交的数据

如上一节所示，您可以通过从根 URI 导航到profile链接来访问此数据。

{
  "_links" : {
    "self" : {
      "href" : "https://127.0.0.1:8080/profile"
    },
    "persons" : {
      "href" : "https://127.0.0.1:8080/profile/persons"
    },
    "addresses" : {
      "href" : "https://127.0.0.1:8080/profile/addresses"
    }
  }
}

这些链接与之前显示的相同。要检索 JSON Schema，您可以使用以下Accept标头调用它们：application/schema+json。

在这种情况下，如果您运行curl -H 'Accept:application/schema+json' localhost:8080/profile/persons，您将看到类似于以下内容的输出

{
  "title" : "org.springframework.data.rest.webmvc.jpa.Person", (1)
  "properties" : { (2)
    "firstName" : {
      "readOnly" : false,
      "type" : "string"
    },
    "lastName" : {
      "readOnly" : false,
      "type" : "string"
    },
    "siblings" : {
      "readOnly" : false,
      "type" : "string",
      "format" : "uri"
    },
    "created" : {
      "readOnly" : false,
      "type" : "string",
      "format" : "date-time"
    },
    "father" : {
      "readOnly" : false,
      "type" : "string",
      "format" : "uri"
    },
    "weight" : {
      "readOnly" : false,
      "type" : "integer"
    },
    "height" : {
      "readOnly" : false,
      "type" : "integer"
    }
  },
  "descriptors" : { },
  "type" : "object",
  "$schema" : "https://json-schema.fullstack.org.cn/draft-04/schema#"
}
1 导出的类型
2 属性列表

如果您的资源链接到其他资源，则会有更多详细信息。

您还可以在检查集合资源时，在 _links 集合中找到一个 profile 链接，如下例所示

{
  "_links" : {
    "self" : {
      "href" : "https://127.0.0.1:8080/persons" (1)
    },
    ... other links ...
    "profile" : {
      "href" : "https://127.0.0.1:8080/profile/persons" (2)
    }
  },
  ...
}
1 此 HAL 文档表示 Person 集合。
2 它有一个指向相同 URI 的元数据的 profile 链接。

同样，profile链接默认情况下提供ALPS。如果您为其提供Accept标头为application/schema+json，它将呈现 JSON Schema 表示。