it-swarm.com.ru

Spring MVC - Как вернуть простую строку как JSON в Rest Controller

Мой вопрос по сути является продолжением этого вопроса.

@RestController
public class TestController
{
    @RequestMapping("/getString")
    public String getString()
    {
        return "Hello World";
    }
}

Выше Spring добавил бы "Hello World" в тело ответа. Как я могу вернуть строку в качестве ответа JSON? Я понимаю, что могу добавить цитаты, но это больше похоже на взлом.

Пожалуйста, предоставьте любые примеры, чтобы помочь объяснить эту концепцию.

Примечание: Я не хочу, чтобы это было записано прямо в тело ответа HTTP, я хочу вернуть строку в формате JSON (я использую свой контроллер с RestyGWT , который требует, чтобы ответ был в допустимом формате JSON).

106
The Gilbert Arenas Dagger

Либо вернуть text/plain (как в вернуть только строковое сообщение из контроллера Spring MVC ) OR обернуть вашу строку каким-то объектом

public class StringResponse {

    private String response;

    public StringResponse(String s) { 
       this.response = s;
    }

    // get/set omitted...
}


Установите тип ответа application/json

@RequestMapping(value = "/getString", method = RequestMethod.GET, produces = "application/json")

и у вас будет JSON, который выглядит как

{  "response" : "your string value" }
114
Shaun

По сути, JSON является строкой в ​​контексте PHP или Java. Это означает, что строка, которая является допустимой JSON, может быть возвращена в ответ. Следующее должно работать.

  @RequestMapping(value="/user/addUser", method=RequestMethod.POST)
  @ResponseBody
  public String addUser(@ModelAttribute("user") User user) {

    if (user != null) {
      logger.info("Inside addIssuer, adding: " + user.toString());
    } else {
      logger.info("Inside addIssuer...");
    }
    users.put(user.getUsername(), user);
    return "{\"success\":1}";
  }

Это нормально для простого строкового ответа. Но для сложного ответа JSON вы должны использовать класс-оболочку, как описано Shaun.

42
pinkal vansia

С тех пор как я разместил этот вопрос, я начал использовать JSONObject (maven информация о зависимостях ). Особенно работая с командой, мне легче ожидать, что будет возвращена строка, а не какой-нибудь объект-обертка, когда все, что мне нужно, это простая строка.

Пример использования:

@RestController
public class TestController
{
    @RequestMapping("/getString")
    public String getString()
    {
        return JSONObject.quote("Hello World");
    }
}
22
The Gilbert Arenas Dagger

Вы можете легко вернуть JSON с String в свойстве response следующим образом

@RestController
public class TestController {
    @RequestMapping(value = "/getString", produces = MediaType.APPLICATION_JSON_VALUE)
    public Map getString() {
        return Collections.singletonMap("response", "Hello World");
    }
}
17
Javasick

Просто отмените регистрацию StringHttpMessageConverter по умолчанию:

@Configuration
public class WebMvcConfiguration extends WebMvcConfigurationSupport {
  /**
   * Unregister the default {@link StringHttpMessageConverter} as we want Strings
   * to be handled by the JSON converter.
   *
   * @param converters List of already configured converters
   * @see WebMvcConfigurationSupport#addDefaultHttpMessageConverters(List)
   */
  @Override
  protected void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
    converters.stream()
      .filter(c -> c instanceof StringHttpMessageConverter)
      .findFirst().ifPresent(converters::remove);
  }
}

Протестировано с использованием методов обработчика действий контроллера и обработчиков исключений контроллера:

@RequestMapping("/foo")
public String produceFoo() {
  return "foo";
}

@ExceptionHandler(FooApiException.class)
public String fooException(HttpServletRequest request, Throwable e) {
  return e.getMessage();
}

Финальные заметки:

  • extendMessageConverters доступен начиная с Spring 4.1.3, если вы работаете в предыдущей версии, вы можете реализовать ту же технику, используя configureMessageConverters, это займет немного больше работы.
  • Это был один из многих возможных подходов: если ваше приложение возвращает только JSON и никаких других типов контента, вам лучше пропустить конвертеры по умолчанию и добавить один конвертер Джексона. Другой подход заключается в добавлении преобразователей по умолчанию, но в другом порядке, чтобы преобразователь Джексона предшествовал строковому. Это должно позволить методам действия контроллера определять, как они должны преобразовывать строку в зависимости от типа носителя ответа.
8
Amr Mostafa

Я знаю, что этот вопрос старый, но я бы тоже хотел внести свой вклад:

Основное различие между другими ответами - возвращение хэш-карты.

@GetMapping("...")
@ResponseBody
public HashMap<String, Object> endPointExample(...) {

    HashMap<String, Object> rtn = new LinkedHashMap<String, Object>();
    rtn.put("pic", image);
    rtn.put("potato", "King Potato");

    return rtn;

}

Это вернет:

{"pic":"a17fefab83517fb...beb8ac5a2ae8f0449","potato":"King Potato"}
6
Brenno Leal

Добавьте produces = "application/json" в аннотацию @RequestMapping, например:

@RequestMapping(value = "api/login", method = RequestMethod.GET, produces = "application/json")

Подсказка: в качестве возвращаемого значения я рекомендую использовать тип ResponseEntity<List<T>>. Поскольку производимые данные в теле JSON должны быть массив или объект в соответствии с их спецификациями, а не одним простым строка. Это может иногда вызывать проблемы (например, наблюдаемые в Angular2).

Разница:

вернул String как json: "example"

вернул List<String> как json: ["example"]

4
Aybars Yuksel

Добавьте аннотацию @ResponseBody, которая будет записывать возвращаемые данные в выходной поток.

3
hugo

Сделай просто:

    @GetMapping("/health")
    public ResponseEntity<String> healthCheck() {
        LOG.info("REST request health check");
        return new ResponseEntity<>("{\"status\" : \"UP\"}", HttpStatus.OK);
    }
1
samarone

Весной MVC 4 типом ответа по умолчанию для объектов является JSON. Так что все, что вам нужно сделать, это обернуть вашу строку в некоторый объект.

    public class StringResponse {

   private String response;

   public StringResponse(String s) { 
       this.response = s;
   }

    // getters and setters 
}

Никаких изменений в контроллере, кроме возврата StringResponse вместо String.

1
Ranuka