如何通过 REST 和 JAX-RS 建模父子实体

Question

我正在开发基于 REST 的 API，但在弄清楚表示父/子关系的规范方法时遇到了一些麻烦。 （我正在 CXF 中编写 beans，并使用 JAX-RS 和 JAXB。我从 CXF 提供的基本示例开始）

我的问题是，假设您有一个 Foo 和一个 Bar。 Foo和Bar之间存在1-N关系，即1个Foo有多个Bar。我的问题是，找出 Bars a Foo 有什么的规范方法是什么？访问 Foo 拥有的 Bar 资源的规范方法是什么？

我发现，例如我可以在以下位置列出 Foos：

GET http://xxx/fooservice/foos

并且对单个 foo 进行操作：

PUT/UPDATE/DELETE http://xxx/fooservice/foo/{但是

我如何列出 Foo 121 拥有的 Bars？我如何访问它们？我注意到默认的 JAXB 编组器似乎不输出 Collections 只是 bean 的属性，因此如果 Foo 是：

Foo
  - String id
  - String name
  - Collection bars

JAXB 输出类似：

123>/id>; foo 名称<-- 请注意缺少bars属性，

这是有问题的，因为客户端无法合理地期望知道Foo有Bars，除非它“只是知道”（这对我来说似乎很糟糕）。因此，虽然我可以想象使用以下方法获取酒吧列表：

GET http://xxx/fooservice/foo/ 121/bars

如果实体的输出没有说明任何内容，那么客户端如何知道 Foo 有 Bars？现在假设客户端确实获取了列表，那么实体操作似乎类似于：

GET/DELETE/UPDATE http://xxx/fooservice/foo/121/bar/435

它将访问 Foo 121 拥有的 Bar 435。

Answer 1

你想做的事情当然是可能的。设计资源的一种方法是：

/foo
          # A list of all the Foo resource names (not representations).

/foo/{fooid}
          # A detailed representation of a particular Foo, including 
          # a list of all that Foo's Bar resource names (not representations).

/foo/{fooid}/bar/{barid}
          # A detailed representation of a particular Bar.

您可能会遇到这样的情况，即 Bars 在特定 Foo 之外并不真正存在（如在采购订单的主数据及其包含的详细信息行中）。如果是这种情况，并且每个 Foo 没有获得那么多的 Bar 数据，您可以在 Foo 表示中返回完整的 Bar 详细信息：

/foo
          # A list of all the Foo resource names (not representations).

/foo/{fooid}
          # A detailed representation of a particular Foo, including 
          #   full details on each of its Bars.

您通常希望 REST 资源具有更粗的粒度。请注意，如果您选择此选项，那么要修改 Foo 的 Bars，您需要获取 Foo，修改 Foo 表示形式中的 Bars，然后 PUT Foo。

不确定序列化的 XML 表示发生了什么，您应该使用相关代码创建第二个问题。

Answer 2

感谢您详细的帖子 - 您所描述的基本上已经是我正在做的事情，而没有按照您的建议对每个 Foo 内的 Bars 进行详细表示，所以看来我的大部分都是正确的。

我将找出为什么 Foo 内的 Bars 集合没有按照您的建议在单独的 Q 中以 JAXB 中的 XML 形式解组。

Answer 3

Taylor, Jersey 的 JAX-RS 实现确实发出了转换为 XML 或 JSON 的对象的 List 属性。因此，在我刚刚完成的应用程序中，UserStore 对象有一个属性 users，这是一个列表：

List<User> users = new ArrayList<User>();

当我使用 Jersey 发出 UserStore 的 XML 或 JSON 版本时，我会得到该属性的用户数组：

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<users>
    <user>
        <firstName>John</firstName>
        <id>a29a377f-4329-4ec8-9459-b5b1c2efc38a</id>
        <lastName>Doe</lastName>
    </user>
    <user>
        <firstName>Jane</firstName>
        <id>bb4dad28-1263-440a-afc5-062a8566ef90</id>
        <lastName>Roe</lastName>
    </user>
</users>

也许

{
    "user": [{
        "firstName": "John",
        "id": "a29a377f-4329-4ec8-9459-b5b1c2efc38a",
        "lastName": "Doe",
    },
    {
        "firstName": "Jane",
        "id": "bb4dad28-1263-440a-afc5-062a8566ef90",
        "lastName": "Roe",
    }]
}

是问题你遇到的只是与你的财产是一个集合而不是一个列表有关......

Answer 4

对我来说，这个问题的答案将由数据建模驱动，对于数据建模，问题是“是否为子模型使用复合键”（如果他使用复合键），因此如果没有使用复合键，则必须将父 ID 放入 URI 中，并且孩子有自己的 id，它不是复合的，因此您可以仅使用带有孩子 id 的 URL。

所以这是数据建模问题！