弹簧架控制器返回特定字段

rest java spring spring-mvc spring-restcontroller

2022-09-01 23:28:36

我一直在思考使用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 和性能的角度来看，调用所有内容似乎是一个坏主意。

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

现在，例如，如果您没有指定任何包含，您将获得的只是以下内容。

{
    "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 对象。这甚至有可能吗？在春季MVC中解决这个问题的最佳方法是什么？

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

答案 1

您可以不返回对象，而是将其序列化为，其中映射键表示属性名称。因此，您可以根据参数将值添加到地图中。GameMap<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"
    }
  ]
}

答案 2

意识到我的答案来得很晚：我建议看看.Projections

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

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

提供了一种非常动态的方式来按需提供不同的投影。我刚刚遇到了一篇关于如何使用的非常有用的文章：https://www.graphql-java.com/tutorials/getting-started-with-spring-boot/GraphQLGraphQLSpringBoot