Spring MVC - 如何在 Rest Controller 中以 JSON 形式返回简单字符串

Question

我的问题本质上是this 问题的后续问题。

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

在上面，Spring 会将“Hello World”添加到响应正文中。如何将字符串作为 JSON 响应返回？我知道我可以添加引号，但感觉更像是一种 hack。

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

注意：我不希望将其直接写入 HTTP 响应正文，我想以 JSON 格式返回字符串（我正在使用我的控制器 RestyGWT 要求响应为有效 JSON 格式）。

Answer 1

要么返回text/plain（如Return only string message from Spring MVC 3 Controller）要么包装你的字符串是一些对象

public class StringResponse {

    private String response;

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

    // get/set omitted...
}

将您的响应类型设置为 MediaType.APPLICATION_JSON_VALUE (= "application/json")

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

你会得到一个看起来像这样的 JSON

{  "response" : "your string value" }

Answer 2

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 描述的包装类。

Answer 3

在一个项目中，我们使用 JSONObject (maven dependency info) 解决了这个问题。我们选择这个是因为我们更喜欢返回一个简单的 String 而不是一个包装对象。如果您不想添加新的依赖项，可以轻松地使用内部帮助程序类。

示例用法：

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

Answer 4

您可以在属性response 中使用String 轻松返回JSON，如下所示

@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.removeIf(c -> c instanceof StringHttpMessageConverter);
  }
}

使用控制器操作处理程序方法和控制器异常处理程序进行测试：

@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 而没有其他内容类型，您最好跳过默认转换器并添加单个杰克逊转换器。另一种方法是添加默认转换器，但顺序不同，以便杰克逊转换器在字符串之前。这应该允许控制器操作方法根据响应的媒体类型来决定他们希望如何转换 String。

Answer 6

我知道这个问题很老，但我也想贡献：

其他响应之间的主要区别是哈希图返回。

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

    Map<String, Object> rtn = new LinkedHashMap<>();

    rtn.put("pic", image);
    rtn.put("potato", "King Potato");

    return rtn;

}

这将返回：

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

Answer 7

简单：

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

Answer 8

在@RequestMapping注解中添加produces = "application/json"，如：

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

提示：作为返回值，我推荐使用ResponseEntity<List<T>> 类型。因为 JSON body 中生成的数据需要根据其规范是一个 array 或一个 object，而不是单个简单的 string。有时可能会导致问题（例如 Angular2 中的 Observables）。

区别：

以 json 格式返回 String："example"

以 json 格式返回 List<String>：["example"]

Answer 9

添加@ResponseBody注解，将返回数据写入输出流。

Answer 10

这个问题把我逼疯了：Spring 是一个非常强大的工具，然而，如果没有丑陋的 hack，将输出字符串编写为 JSON 这样简单的事情似乎是不可能的。

我发现侵入性最小且最透明的解决方案（在 Kotlin 中）是使用控制器建议并检查请求是否到达了一组特定的端点（通常是 REST API，因为我们通常希望从这里是 JSON，而不是根据返回的数据是纯字符串（“不要做 JSON 反序列化！”）还是其他东西（“做 JSON 反序列化！”）在前端进行专门化。这样做的积极方面是控制器保持不变并且没有黑客攻击。

supports 方法确保所有由StringHttpMessageConverter 处理的请求（例如，处理所有返回纯字符串的控制器的输出的转换器）都得到处理，并且在beforeBodyWrite 方法中，我们控制在哪些情况下我们想要中断并将输出转换为 JSON（并相应地修改标头）。

@ControllerAdvice
class StringToJsonAdvice(val ob: ObjectMapper) : ResponseBodyAdvice<Any?> {
    
    override fun supports(returnType: MethodParameter, converterType: Class<out HttpMessageConverter<*>>): Boolean =
        converterType === StringHttpMessageConverter::class.java

    override fun beforeBodyWrite(
        body: Any?,
        returnType: MethodParameter,
        selectedContentType: MediaType,
        selectedConverterType: Class<out HttpMessageConverter<*>>,
        request: ServerHttpRequest,
        response: ServerHttpResponse
    ): Any? {
        return if (request.uri.path.contains("api")) {
            response.getHeaders().contentType = MediaType.APPLICATION_JSON
            ob.writeValueAsString(body)
        } else body
    }
}

我希望将来我们会得到一个简单的注释，我们可以在其中覆盖应该将哪个HttpMessageConverter 用于输出。