在Spring Boot中返回JSON对象作为响应

我在Spring Boot中有一个示例RestController：

@RestController
@RequestMapping("/api")
class MyRestController
{
    @GetMapping(path = "/hello")
    public JSONObject sayHello()
    {
        return new JSONObject("{'aa':'bb'}");
    }
}

我正在使用JSON库 org.json

当我点击API时/hello，出现一个异常提示：

路径为[]的上下文中的Servlet [dispatcherServlet]的Servlet.service（）引发异常[请求处理失败；嵌套异常为java.lang.IllegalArgumentException：未找到类型为org.json.JSONObject]的返回值的转换器，其根本原因是

java.lang.IllegalArgumentException：未找到类型为org.json.JSONObject的返回值的转换器

有什么问题 有人可以解释到底发生了什么吗？

当您使用Spring Boot Web时，Jackson依赖关系是隐式的，我们不必显式定义。pom.xml如果使用eclipse ，则可以在依赖项层次结构选项卡中检查Jackson依赖项。

并且正如您所注释的那样，@RestController无需进行显式的json转换。只需返回一个POJO，杰克逊序列化器将负责转换为json。@ResponseBody与@Controller一起使用时，等效于使用。而不是放置@ResponseBody在每个控制器方法上，我们放置的@RestController不是香草@Controller，而是@ResponseBody默认情况下应用于该控制器中的所有资源。
请参阅此链接： https : //docs.spring.io/spring/docs/current/spring-framework-reference/html/mvc.html#mvc-ann-responsebody

您面临的问题是因为返回的对象（JSONObject）没有某些属性的吸气剂。您的意图不是序列化此JSONObject而是序列化POJO。因此，只需返回POJO。
请参阅此链接： https : //stackoverflow.com/a/35822500/5039001

如果要返回json序列化的字符串，则只需返回该字符串。在这种情况下，Spring将使用StringHttpMessageConverter而不是JSON转换器。

您当前的方法不起作用的原因是，默认情况下使用Jackson来序列化和反序列化对象。但是，它不知道如何序列化JSONObject。如果要创建动态JSON结构，则可以使用Map，例如：

@GetMapping
public Map<String, String> sayHello() {
    HashMap<String, String> map = new HashMap<>();
    map.put("key", "value");
    map.put("foo", "bar");
    map.put("aa", "bb");
    return map;
}

这将导致以下JSON响应：

{ "key": "value", "foo": "bar", "aa": "bb" }

这有点受限制，因为添加子对象可能会变得更加困难。杰克逊使用ObjectNode和拥有自己的机制ArrayNode。要使用它，您必须自动连接ObjectMapper服务/控制器。然后，您可以使用：

@GetMapping
public ObjectNode sayHello() {
    ObjectNode objectNode = mapper.createObjectNode();
    objectNode.put("key", "value");
    objectNode.put("foo", "bar");
    objectNode.put("number", 42);
    return objectNode;
}

这种方法允许您添加子对象，数组并使用所有各种类型。

您可以String按照@vagaasen的建议返回响应，也可以使用ResponseEntitySpring提供的Object，如下所示。通过这种方式，您还可以返回Http status code在Web服务调用中更为有用的内容。

@RestController
@RequestMapping("/api")
public class MyRestController
{

    @GetMapping(path = "/hello", produces=MediaType.APPLICATION_JSON_VALUE)
    public ResponseEntity<Object> sayHello()
    {
         //Get data from service layer into entityList.

        List<JSONObject> entities = new ArrayList<JSONObject>();
        for (Entity n : entityList) {
            JSONObject entity = new JSONObject();
            entity.put("aa", "bb");
            entities.add(entity);
        }
        return new ResponseEntity<Object>(entities, HttpStatus.OK);
    }
}

您也可以为此使用哈希表

@GetMapping
public HashMap<String, Object> get() {
    HashMap<String, Object> map = new HashMap<>();
    map.put("key1", "value1");
    map.put("results", somePOJO);
    return map;
}

@RequestMapping("/api/status")
public Map doSomething()
{
    return Collections.singletonMap("status", myService.doSomething());
}

PS。仅适用于1个值

使用 ResponseEntity<ResponseBean>

在这里，您可以根据需要使用ResponseBean或Any java bean返回api响应，这是最佳实践。我已使用Enum进行响应。它将返回状态代码和API的状态消息。

@GetMapping(path = "/login")
public ResponseEntity<ServiceStatus> restApiExample(HttpServletRequest request,
            HttpServletResponse response) {
        String username = request.getParameter("username");
        String password = request.getParameter("password");

        loginService.login(username, password, request);
        return new ResponseEntity<ServiceStatus>(ServiceStatus.LOGIN_SUCCESS,
                HttpStatus.ACCEPTED);
    }

用于响应ServiceStatus或（ResponseBody）

    public enum ServiceStatus {

    LOGIN_SUCCESS(0, "Login success"),

    private final int id;
    private final String message;

    //Enum constructor
    ServiceStatus(int id, String message) {
        this.id = id;
        this.message = message;
    }

    public int getId() {
        return id;
    }

    public String getMessage() {
        return message;
    }
}

Spring REST API应该具有以下响应键

1. 状态码
2. 信息

您将在下面得到最终答复

{

   "StatusCode" : "0",

   "Message":"Login success"

}

您可以根据需要使用ResponseBody（java POJO，ENUM等）。

更正确的API查询创建DTO，例如，entityDTO：

1. 默认响应OK，带有实体列表：

@GetMapping(produces=MediaType.APPLICATION_JSON_VALUE)
@ResponseStatus(HttpStatus.OK)
public List<EntityDto> getAll() {
    return entityService.getAllEntities();
}

但是，如果需要返回不同的Map参数，则可以使用下面的两个示例
2。对于返回一个参数，如map：

@GetMapping(produces=MediaType.APPLICATION_JSON_VALUE)
public ResponseEntity<Object> getOneParameterMap() {
    return ResponseEntity.status(HttpStatus.CREATED).body(
            Collections.singletonMap("key", "value"));
}

3. 并且如果您需要某些参数的返回映射（自Java 9开始）：

@GetMapping(produces = MediaType.APPLICATION_JSON_VALUE)
public ResponseEntity<Object> getSomeParameters() {
    return ResponseEntity.status(HttpStatus.OK).body(Map.of(
            "key-1", "value-1",
            "key-2", "value-2",
            "key-3", "value-3"));
}

如果您需要使用String返回JSON对象，则应执行以下操作：

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.http.ResponseEntity;
...

@RestController
@RequestMapping("/student")
public class StudentController {

    @GetMapping
    @RequestMapping("/")
    public ResponseEntity<JsonNode> get() throws JsonProcessingException {
        ObjectMapper mapper = new ObjectMapper();
        JsonNode json = mapper.readTree("{\"id\": \"132\", \"name\": \"Alice\"}");
        return ResponseEntity.ok(json);
    }
    ...
}