Возвращаемые переменные возврата Spring Spring

Question

Я продумал лучший способ разработки JSON API с использованием Spring MVC. Поскольку мы все знаем, что IO дорого, и поэтому я не хочу, чтобы клиент сделал несколько вызовов API, чтобы получить то, что им нужно. Однако в то же время я не обязательно хочу вернуть кухонную раковину.

В качестве примера я работал над игровым API, похожим на IMDB, но для видеоигр.

Если бы я вернул все, что связано с игрой, это выглядело бы примерно так.

/апи/игра/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" 
     } 
    ] 
} 

Однако они не могут нуждаться во всей этой информации, но потом они снова могли бы. Выполнение вызовов во всем кажется плохой идеей ввода-вывода и производительности.

Я думал об этом, указав параметр 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?

FYI, я использую 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" 
    } 
    ] 
}