Spring座控制器返回特定字段

Question

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

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

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

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

我考虑通过在请求中指定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

这可以由SpringProjments完成。也适用于静态编程语言。看这里：https://www.baeldung.com/spring-data-jpa-projections

Answer 2

意识到我的答案来得很晚：我建议看一下预测。

你要求的是预测是关于什么的。

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

GraphQL提供了一种根据需求提供不同预测的非常动态的方法。我刚刚看到一篇非常有用的文章，介绍了如何将GraphQL与SpringBoot结合使用：https://www.graphql-java.com/tutorials/getting-started-with-spring-boot/

Answer 3

您可以将其序列化为Map，而不是返回Game对象

@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;

}

例如，如果您有一个映射

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"
    }
  ]
}