Spring Rest 控制器返回特定字段

Question

我一直在思考使用 Spring MVC 设计 JSON API 的最佳方法。众所周知，IO 很昂贵，因此我不想让客户端进行多次 API 调用来获得他们需要的东西。但与此同时，我不一定想归还厨房水槽。

例如，我正在开发一个类似于 IMDB 但用于视频游戏的游戏 API。

如果我返回与 Game 相关的所有内容，它会看起来像这样。

/api/game/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 和性能来看，对所有内容进行调用似乎是个坏主意。

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

现在，例如，如果您没有指定任何包含，那么您将返回以下内容。

{
    "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 中解决此问题的最佳方法是什么？

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

Answer 1

解决方案 1： 将 @JsonIgnore 添加到您不想包含在 API 响应中的变量（在模型中）

@JsonIgnore
    private Set<Student> students;

解决方案 2： 删除您不想包含的变量的 getter。

如果您在其他地方需要它们，请为 getter 使用不同的格式，以便 spring 不知道它。

Answer 2

这可以通过 Spring Projections 完成。也适用于 Kotlin。 看这里：https://www.baeldung.com/spring-data-jpa-projections

Answer 3

意识到我的回答来得太晚了：我建议您查看Projections。

您所要求的是预测的内容。

既然你问的是 Spring，我想试试这个： https://docs.spring.io/spring-data/rest/docs/current/reference/html/#projections-excerpts

Answer 4

您可以将其序列化为Map<String, Object>，而不是返回Game 对象，其中映射键表示属性名称。因此，您可以根据 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"
    }
  ]
}