有谁知道遵循 HATEOAS 原则的 RESTful 客户端示例吗？

Question

Closed. This question is seeking recommendations for software libraries, tutorials, tools, books, or other off-site resources. It does not meet Stack Overflow guidelines. It is not currently accepting answers.

---

我们不允许提出寻求软件库、教程、工具、书籍或其他场外资源推荐的问题。您可以编辑问题，以便用事实和引文来回答。

3 年前已关闭。

Answer 1

在我们当前的项目中，我们已经完成了一半。我们返回的表示是从域对象生成的，客户端可以以 XML、JSON 或 XHTML 形式请求它们。如果它是像 Firefox 这样的 XHTML 客户端，那么人们会看到一组来自众所周知的根资源的出站链接，并且可以浏览到所有其他资源。到目前为止，它是纯粹的 HATEOAS，对于开发人员来说是一个很棒的工具。

但是，当客户端是程序而不是使用浏览器的人时，我们会担心性能。对于我们的 XML 和 JSON 表示，我们目前抑制了相关链接的生成，因为它们使表示大小增加了三倍，从而显着影响序列化/反序列化、内存使用和带宽。我们的另一个效率问题是，使用纯 HATEOAS，客户端程序在从众所周知的链接向下浏览到所需信息时，将发出数倍数量的 HTTP 请求。因此，从效率的角度来看，如果客户端了解其中编码的链接，这似乎是最好的。

但这样做意味着客户端必须进行大量字符串连接来形成 URI，
这很容易出错，并且很难重新排列资源名称空间。因此，我们使用模板系统，其中客户端代码选择模板并要求它从参数对象扩展自身。这是一种表格填写方式。

我真的很想看看其他人在这方面的经历。除了性能方面之外，HATEOAS 似乎是一个好主意。

编辑：我们的模板是我们在 Restlet 框架之上编写的 Java 客户端库的一部分。客户端库处理 HTTP 请求/响应、HTTP 标头、反序列化/序列化、GZIP 编码等的所有细节。这使得实际的客户端代码非常简洁，并有助于将其与某些服务器端更改隔离开来。

Roy Fielding 的关于 HATEOAS 的博客文章随后进行相关且有趣的讨论。

Answer 2

到目前为止，我已经构建了两个访问 REST 服务的客户端。两者都专门使用 HATEOAS。我已经取得了巨大的成功，能够在不更新客户端的情况下更新服务器功能。

我使用 xml:base 启用相对 URL，以减少 xml 文档中的干扰。除了加载图像和其他静态数据之外，我通常只跟踪用户请求的链接，因此链接的性能开销对我来说并不重要。

在客户端上，我认为需要创建的唯一常见功能是围绕我的媒体类型的包装器和管理链接的类。

---

更新：

从客户端的角度来看，似乎有两种不同的方法来处理 REST 接口。第一个是客户端知道它想要获取什么信息，并且知道它需要遍历才能获取该信息的链接。当客户端应用程序的人类用户控制要遵循哪些链接并且客户端可能事先不知道将从服务器返回什么媒体类型时，第二种方法很有用。出于娱乐目的，我将这两种类型的客户端分别称为数据挖掘器和调度程序。

例如，假设 Twitter API 实际上是RESTful

，我想编写一个客户端来检索特定 Twitter 用户的最新关注者的最新状态消息。

假设我正在使用很棒的新 Microsoft.Http.HttpClient 库，并且我编写了一些“ReadAs”扩展方法来解析来自 twitter API 的 XML，我想它会像这样：

var twitterService = HttpClient.Get("http://api.twitter.com").Content.ReadAsTwitterService();

var userLink = twitterService.GetUserLink("DarrelMiller");
var userPage = HttpClient.Get(userLink).Content.ReadAsTwitterUserPage();

var followersLink = userPage.GetFollowersLink();
var followersPage = HttpClient.Get(followersLink).Content.ReadAsFollowersPage();
var followerUserName = followersPage.FirstFollower.UserName;

var followerUserLink = twitterService.GetUserLink(followerUserName);
var followerUserPage = HttpClient.Get(followerUserLink).Content.ReadAsTwitterUserPage();

var followerStatuses = HttpClient.Get(followerUserPage.GetStatusesLink()).Content.ReadAsTwitterUserPage();

var statusMessage = followerStatuses.LastMessage; 

调度程序

为了更好地说明这一点例如，假设您正在实现一个呈现谱系信息的客户端。客户端需要能够显示树、深入了解有关特定人员的信息并查看相关图像。考虑以下代码片段：

 void ProcessResponse(HttpResponseMessage response) {
            IResponseController controller;

            switch(response.Content.ContentType) {
                case "vnd.MyCompany.FamilyTree+xml":
                    controller = new FamilyTreeController(response);
                    controller.Execute();
                    break;
                case "vnd.MyCompany.PersonProfile+xml":
                    controller = new PersonProfileController(response);
                    controller.Execute();
                    break;
                case "image/jpeg":
                    controller = new ImageController(response);
                    controller.Execute();
                    break;
            }

        }

客户端应用程序可以使用完全通用的机制来跟踪链接并将响应传递给此调度方法。从这里，switch 语句将控制传递给特定的控制器类，该控制器类知道如何根据媒体类型解释和呈现信息。

显然，客户端应用程序还有更多的部分，但这些都是与 HATEOAS 相对应的部分。请随时要求我澄清任何要点，因为我已经浏览了许多细节。

Answer 3

诺基亚的 地点 API（网络存档 snapshot) 是 RESTful 的，并在整个过程中使用超媒体。其文档中也明确指出不鼓励使用 URI 模板/硬编码：

超媒体链接的使用

您的应用程序必须使用 JSON 中公开的超媒体链接
对任务流中后续请求的响应，而不是
尝试通过 URI 模板构建后续步骤的 URI。经过
使用 URI 模板，您的请求不会包含关键内容
创建下一个响应所需的信息
请求。

Answer 4

Jim，我还对缺少 HATEOAS 后的 RESTful 客户端示例感到有点沮丧，因此我写了一篇博客文章，展示了用于创建和下订单的正确 HATEOAS 示例。令人惊讶的是，通过 API 执行此操作的示例很少，我发现它有点令人困惑，但这里是链接：
使用 Rest 的 API 示例。让我知道你的想法以及你认为我做错了什么。

Answer 5

我编写了两个 HATEOAS 客户端，一次使用 Java，一次使用 Ruby，我和您一样感到沮丧。在这两种情况下，我所做的事情都完全缺乏工具支持。例如，我使用的 REST API 会告诉我每个超文本控件使用什么 HTTP 方法，但是 HttpClient 不允许您传入该方法，因此我最终得到了以下丑陋的代码（顺便说一句，所有代码都位于自定义 Ant 任务中，因此出现了 BuildException）：

private HttpMethod getHypermediaControl(Node href, Node method,
        NodeList children) {
    if (href == null) {
        return null;
    }
    HttpMethod control;
    if (method == null || method.getNodeValue().equals("")
            || method.getNodeValue().equalsIgnoreCase("GET")) {
        control = new GetMethod(href.getNodeValue());
    } else if (method.getNodeValue().equalsIgnoreCase("POST")) {
        control = new PostMethod(href.getNodeValue());
    } else if (method.getNodeValue().equalsIgnoreCase("PUT")) {
        control = new PutMethod(href.getNodeValue());
    } else if (method.getNodeValue().equalsIgnoreCase("DELETE")) {
        control = new DeleteMethod(href.getNodeValue());
    } else {
        throw new BuildException("Unknown/Unimplemented method "
                + method.getNodeValue());
    }
    control.addRequestHeader(accept);
    return control;
}

这最终成为我使用的 REST 客户端实用程序方法的基础。

private HttpMethod getHypermediaControl(String path, Document source)
        throws TransformerException, IOException {

    Node node = XPathAPI.selectSingleNode(source, path);
    return getHypermediaControl(node);
}

private HttpMethod getHypermediaControl(Node node) {
    if (node == null) {
        return null;
    }
    NamedNodeMap attributes = node.getAttributes();
    if (attributes == null) {
        return null;
    }
    Node href = attributes.getNamedItem("href");
    Node method = attributes.getNamedItem("method");
    HttpMethod control = getHypermediaControl(href, method,
            node.getChildNodes());
    return control;
}

private Document invokeHypermediaControl(HttpClient client, Document node,
        final String path) throws TransformerException, IOException,
        HttpException, URIException, SAXException,
        ParserConfigurationException, FactoryConfigurationError {
    HttpMethod method = getHypermediaControl(path, node);
    if (method == null) {
        throw new BuildException("Unable to find hypermedia controls for "
                + path);
    }
    int status = client.executeMethod(method);

    if (status != HttpStatus.SC_OK) {
        log(method.getStatusLine().toString(), Project.MSG_ERR);
        log(method.getResponseBodyAsString(), Project.MSG_ERR);
        throw new BuildException("Unexpected status code ("
                + method.getStatusCode() + ") from " + method.getURI());
    }
    String strResp = method.getResponseBodyAsString();
    StringReader reader = new StringReader(strResp);
    Document resp = getBuilder().parse(new InputSource(reader));
    Node rval = XPathAPI.selectSingleNode(resp, "/");
    if (rval == null) {
        log(method.getStatusLine().toString(), Project.MSG_ERR);
        log(method.getResponseBodyAsString(), Project.MSG_ERR);
        throw new BuildException("Could not handle response");
    }
    method.releaseConnection();
    return resp;
}

通过这一点代码，我可以相当轻松地编写将遍历返回文档中的超媒体控件的客户端。缺少的主要部分是对表单参数的支持。对我来说幸运的是，除了一个之外，我使用的所有控件都是无参数的（我遵循 规则三是关于重构）。为了完整起见，该代码片段如下所示：

    HttpMethod licenseUpdateMethod = getHypermediaControl(
            "/license/update", licenseNode);
    if (licenseUpdateMethod == null) {
        log(getStringFromDoc(licenseNode), Project.MSG_ERR);
        throw new BuildException(
                "Unable to find hypermedia controls to get the test suites or install the license");
    } else if (license != null) {
        EntityEnclosingMethod eem = (EntityEnclosingMethod) licenseUpdateMethod;
        Part[] parts = { new StringPart("license", this.license) };
        eem.setRequestEntity(new MultipartRequestEntity(parts, eem
                .getParams()));
        int status2 = client.executeMethod(eem);
        if (status2 != HttpStatus.SC_OK) {
            log(eem.getStatusLine().toString(), Project.MSG_ERR);
            log(eem.getResponseBodyAsString(), Project.MSG_ERR);
            throw new BuildException("Unexpected status code ("
                    + eem.getStatusCode() + ") from " + eem.getURI());
        }
        eem.releaseConnection();
    }

现在，应该做的是查看 /license/update 的子级以找出需要传递哪些参数，但是 这必须等到我有另外两个需要遵循的参数化表单。

顺便说一句，经过所有的努力，在不影响客户端的情况下修改服务器非常令人满意且容易。这种感觉太好了，以至于我很惊讶它在某些州没有被禁止。

Answer 6

您选择的网络浏览器是整个 WWW 的“纯粹的 HATEOAS”客户端。

在我看来，这个问题确实没有意义。