Question

我一直在思考使用Spring MVC设计JSON API的最佳方法。我们都知道IO很昂贵，因此我不想让客户端进行多次API调用以获得他们需要的东西。然而，与此同时，我并不一定想要回到厨房水槽。

作为一个例子，我正在开发类似于IMDB的游戏API，而不是用于视频游戏。

如果我返回与Game相关的所有内容，它将会是这样的。

/ API /游戏/ 1

{
    "id": 1,
    "title": "Call of Duty Advanced Warfare",
    "release_date": "2014-11-24",
    "publishers": [
        {
            "id": 1,
            "name": "Activision"
        }
    ],
    "developers": [
        {
            "id": 1,
            "name": "Sledge Hammer"
        }
    ],
    "platforms": [
        {
            "id": 1,
            "name": "Xbox One",
            "manufactorer": "Microsoft",
            "release_date": "2013-11-11"
        },
        {
            "id": 2,
            "name": "Playstation 4",
            "manufactorer": "Sony",
            "release_date": "2013-11-18"
        },
        {
            "id": 3,
            "name": "Xbox 360",
            "manufactorer": "Microsoft",
            "release_date": "2005-11-12"
        }
    ],
    "esrbRating": {
        "id": 1,
        "code": "T",
        "name": "Teen",
        "description": "Content is generally suitable for ages 13 and up. May contain violence, suggestive themes, crude humor, minimal blood, simulated gambling and/or infrequent use of strong language."
    },
    "reviews": [
        {
            "id": 1,
            "user_id": 111,
            "rating": 4.5,
            "description": "This game is awesome"
        }
    ]
}

然而，他们可能不需要所有这些信息，但他们可能会再次提供这些信息。从I / O和性能来看，调用所有内容似乎是一个坏主意。

我想通过在请求中指定include参数来做到这一点。

现在举例来说，如果您没有指定任何包含，那么您将获得以下内容。

{
    "id": 1,
    "title": "Call of Duty Advanced Warfare",
    "release_date": "2014-11-24"
}

但是，您希望所有信息都是您的要求。

/api/game/1?include=publishers,developers,platforms,reviews,esrbRating

这样客户端就能够指定他们想要的信息量。但是，使用Spring MVC实现这一点时，我有点不知所措。

我认为控制器看起来像这样。

public @ResponseBody Game getGame(@PathVariable("id") long id, 
    @RequestParam(value = "include", required = false) String include)) {

        // check which include params are present

        // then someone do the filtering?
}

我不确定如何选择序列化Game对象。这甚至是可能的吗？在Spring MVC中处理此问题的最佳方法是什么？

仅供参考，我正在使用Spring Boot，其中包括Jackson进行序列化。

Answer 1

您可以将其序列化为Game，而不是返回Map<String, Object>对象，其中映射键表示属性名称。因此，您可以根据include参数将值添加到地图中。

@ResponseBody
public Map<String, Object> getGame(@PathVariable("id") long id, String include) {

    Game game = service.loadGame(id);
    // check the `include` parameter and create a map containing only the required attributes
    Map<String, Object> gameMap = service.convertGameToMap(game, include);

    return gameMap;

}

例如，如果你有Map<String, Object>这样的话：

gameMap.put("id", game.getId());
gameMap.put("title", game.getTitle());
gameMap.put("publishers", game.getPublishers());

它会像这样序列化：

{
  "id": 1,
  "title": "Call of Duty Advanced Warfare",
  "publishers": [
    {
        "id": 1,
        "name": "Activision"
    }
  ]
}

Answer 2

请注意，我的回答来得太晚了：建议您查看Projections。

您要问的是关于什么的预测。

由于您正在询问有关Spring的信息，因此可以尝试一下： https://docs.spring.io/spring-data/rest/docs/current/reference/html/#projections-excerpts

Answer 3

这可以在Spring Projections之前完成。在Kotlin上也可以正常工作。在这里看看：https://www.baeldung.com/spring-data-jpa-projections

Spring Rest Controller返回特定字段

3 个答案: