Spring MVC - 如何在Rest Controller中将简单的String作为JSON返回

Question

我的问题基本上是对这个问题的后续行动.

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

在上面,Spring会在响应体中添加"Hello World".如何将String作为JSON响应返回？我知道我可以添加引号,但这更像是一个黑客.

请提供任何示例来帮助解释这个概念.

注意:我不希望这直接写入HTTP响应体,我想以JSON格式返回String(我使用我的Controller与RestyGWT,它要求响应是有效的JSON格式).

Answer 1

返回text/plain(如在Spring MVC 3 Controller中仅返回字符串消息)或包装你的String是一些对象

public class StringResponse {

    private String response;

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

    // get/set omitted...
}

将您的回复类型设置为 MediaType.APPLICATION_JSON_VALUE

@RequestMapping(value = "/getString", method = RequestMethod.GET,
                produces = MediaType.APPLICATION_JSON_VALUE)

并且你将拥有一个看起来像的JSON

{  "response" : "your string value" }

Answer 2

JSON本质上是PHP或JAVA上下文中的String.这意味着可以返回有效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所描述的包装器类.

Answer 3

自从我发布这个问题以来,我已经开始使用JSONObject(maven 依赖信息)了.特别是与团队合作,我发现当我想要的只是一个简单的String时,更容易期望返回一个String而不是一些包装器对象.

用法示例:

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

Answer 4

您可以轻松地返回JSON与String财产response如下

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

Answer 5

只需取消注册默认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而没有其他内容类型,则最好跳过默认转换器并添加单个jackson转换器.另一种方法是添加默认转换器,但顺序不同,以便jackson转换器位于字符串1之前.这应该允许控制器操作方法根据响应的媒体类型来指示他们希望如何转换String.

Answer 6

简单点：

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

Answer 7

我知道这个问题已经过时但我也愿意做出贡献:

其他响应之间的主要区别是hashmap返回.

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

Answer 8

添加produces = "application/json"在@RequestMapping像注释：

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

提示：作为返回值，我建议使用ResponseEntity<List<T>>type。因为JSON主体中产生的数据根据其规范需要是数组或对象，而不是单个简单的string。有时可能会引起问题（例如Angular2中的Observables）。

区别：

返回String的JSON："example"

返回List<String>的JSON：["example"]