尝试使用 Spring Boot REST 从 POST 读取 JSON 字符串答案

【问题标题】：Trying to use Spring Boot REST to Read JSON String from POST尝试使用 Spring Boot REST 从 POST 读取 JSON 字符串
【发布时间】：2015-06-01 13:10:12
【问题描述】：

我正在使用最新版本的 Spring Boot 通过 Restful Web Service 读取示例 JSON...

这是我的 pom.xml：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"       
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 
         http://maven.apache.org/maven-v4_0_0.xsd"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

    <modelVersion>4.0.0</modelVersion>

    <groupId>org.springframework</groupId>
    <artifactId>myservice</artifactId>
    <version>0.1.0</version>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.2.2.RELEASE</version>
    </parent>

    <properties>
        <java.version>1.7</java.version>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.data</groupId>
            <artifactId>spring-data-rest-webmvc</artifactId>
        </dependency>
        <dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

    <repositories>
        <repository>
            <id>spring-releases</id>
            <name>Spring Releases</name>
            <url>https://repo.spring.io/libs-release</url>
        </repository>
        <repository>
            <id>org.jboss.repository.releases</id>
            <name>JBoss Maven Release Repository</name>
            <url>https://repository.jboss.org/nexus/content/repositories/releases</url>
        </repository>
    </repositories>

    <pluginRepositories>
        <pluginRepository>
            <id>spring-releases</id>
            <name>Spring Releases</name>
            <url>https://repo.spring.io/libs-release</url>
        </pluginRepository>
    </pluginRepositories>

</project>

这是我的网络服务代码：

import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/myservice")
public class BaseService {  

    @RequestMapping(value="/process", method = RequestMethod.POST)
    public void process(@RequestBody String payload) throws Exception {
        System.out.println(payload);
    }
}

当我使用以下命令调用它时：

curl -H "Accept: application/json" -H "Content-type: application/json" 
-X POST -d '{"name":"value"}' http://localhost:8080/myservice/process

我收到此错误消息：

{"timestamp":1427515733546,"status":400,
 "error":"Bad Request",

"exception":
"org.springframework.http.converter.HttpMessageNotReadableException","
 message":
 "Could not read JSON: Can not deserialize instance of java.lang.String
  out of START_OBJECT token\n at 

 [Source: java.io.PushbackInputStream@8252f; line: 1, column: 1]; 
  nested    exception is com.fasterxml.jackson.databind.JsonMappingException:
  Can not deserialize instance of java.lang.String out of START_OBJECT token\n    
  at [Source: java.io.PushbackInputStream@8252f; line: 1, column: 1]",
  "path":"/myservice/process"

我唯一想做的就是传入一些有效的 JSON（通过 curl 作为字符串）并查看 String 有效负载是否以 {"name":"value"} 的形式进入 process 方法

我可能做错了什么？

感谢您抽出宝贵时间阅读本文...

【问题讨论】：

您的pom.xml 中有一个错误：<dependency> 在<dependencies> 之前的一个无用/未封闭标签。但这不是你的问题吗……

标签： java json rest spring-mvc spring-boot

【解决方案1】：

我认为使用 JSON 最简单/方便的方法是使用类似于 JSON 的 Java 类：https://stackoverflow.com/a/6019761

但如果您不能使用 Java 类，您可以使用这两种解决方案之一。

解决方案 1：您可以从控制器接收Map<String, Object>：

@RequestMapping(
    value = "/process", 
    method = RequestMethod.POST)
public void process(@RequestBody Map<String, Object> payload) 
    throws Exception {

  System.out.println(payload);

}

使用您的请求：

curl -H "Accept: application/json" -H "Content-type: application/json" \
-X POST -d '{"name":"value"}' http://localhost:8080/myservice/process

解决方案 2： 否则您可以将 POST 有效负载作为 String：

@RequestMapping(
    value = "/process", 
    method = RequestMethod.POST,
    consumes = "text/plain")
public void process(@RequestBody String payload) throws Exception {

  System.out.println(payload);

}

然后根据需要解析字符串。请注意，必须在控制器上指定 consumes = "text/plain"。在这种情况下，您必须使用 Content-type: text/plain 更改您的请求：

curl -H "Accept: application/json" -H "Content-type: text/plain" -X POST \
-d '{"name":"value"}' http://localhost:8080/myservice/process

【讨论】：

这成功了！我刚刚尝试了您的第二个解决方案...非常感谢。问题是该服务将一直有不同的 JSON 进入并且它没有架构...... Map 以及 String 有效负载是否能够正确容纳任何类型的 JSON？
@socal_javaguy 第一个解决方案将为您解析任何 JSON 为 Map 对象。如果您使用的是第二种解决方案，则需要注意验证字符串并将其解析为 JSON，例如使用：baeldung.com/jackson-json-to-jsonnode
当 JSON 包含 Long 数据类型 stackoverflow.com/questions/64382824/… 时出现 404 错误
我有一个类似的控制器，但是遇到了另一个问题，当字符串带有 ç ou õ 等特殊字符时，我得到了未定义的字符，尝试使用 consumes = "text/plain; charset=utf 设置字符集-8"，但没有运气。有人吗？

【解决方案2】：

添加到 Andrea 的解决方案中，例如，如果您要传递 JSON 数组

[
    {"name":"value"},
    {"name":"value2"}
]

然后你需要像这样设置 Spring Boot Controller：

@RequestMapping(
    value = "/process", 
    method = RequestMethod.POST)
public void process(@RequestBody Map<String, Object>[] payload) 
    throws Exception {

    System.out.println(payload);

}

【讨论】：

【解决方案3】：

要在 Spring-Boot 中接收任意 Json，您可以简单地使用 Jackson 的 JsonNode。会自动配置相应的转换器。

    @PostMapping(value="/process")
    public void process(@RequestBody com.fasterxml.jackson.databind.JsonNode payload) {
        System.out.println(payload);
    }

【讨论】：

就像一个魅力！ tks

【解决方案4】：

要进一步使用地图数组，以下内容可能会有所帮助：

@RequestMapping(value = "/process", method = RequestMethod.POST, headers = "Accept=application/json")
public void setLead(@RequestBody Collection<? extends Map<String, Object>> payload) throws Exception {

  List<Map<String,Object>> maps = new ArrayList<Map<String,Object>>();
  maps.addAll(payload);

}

【讨论】：

【解决方案5】：

从请求正文解析 JSON 时会出现问题，这对于无效的 JSON 是典型的。如果您在 Windows 上使用 curl，请尝试转义 json，例如 -d "{"name":"value"}" 甚至 -d "{"""name""":"value"""}"

另一方面，您可以省略 content-type 标头，在这种情况下，发送的 whetewer 将转换为您的 String 参数

【讨论】：

感谢Master Slave，我之所以没有使用POJO是因为这个服务会接收不同类型的JSON（包含不同的内容）...你明白我想问什么吗?
我明白了（现在）。另一方面，您的服务器端实际上是可以的。它抱怨无法解析 json，编辑答案
我正在使用来自 OS X Mavericks 的 bash ...我想要做的是传入一个 JSON，以便我可以解析它以返回一个自定义响应，无论它是否有效。这是第一步，首先从 Post 中获取一个 JSON 字符串。我做错了吗？
嗯，好吧，如果我理解正确的话，不是真的。您发送设置为 application/json 的内容类型标头这一事实意味着将在请求到达处理程序方法之前尝试转换，对于无效的 json，这将失败并出现错误的请求 400。但是，您应该做的是不发送内容类型标头，而不是请求将到达您的方法，您可以在那里以编程方式尝试转换并返回适当的响应。不确定这对您是否可行，但我们肯定会这样做
没有它返回的内容类型：%7B%22name%22%3A%22value%22%7D=

【解决方案6】：

Jackson 库 是我们需要将 Json 字符串直接注入响应中而无需任何额外解析。

如果我们有一个已经转义的属性并且需要序列化它而不进一步转义，我们可能希望在该字段上使用 Jackson 的 @JsonRawValue 注释。

也在其文件中指出：

标记注解，表示被注解的方法或字段应该通过包含属性的文字字符串值来序列化按原样，不引用字符。这对于注入很有用已在 JSON 中序列化或传递 javascript 函数的值从服务器到 javascript 客户端的定义。警告：结果 JSON 流可能无效，具体取决于您的输入值。

这是我的 DTO 课程：

public class UserProfileResponse {

    private Long id;

    private String userName;

    @JsonRawValue
    private String profile;

    @JsonRawValue
    private String settings;
}

没有使用@JsonRawValue 我的响应将如下所示，因为我的配置文件和设置字段正在从我的数据库（例如Oracle）中获取JSON，并在需要时再次序列化它们为客户创建响应：

{
    "id": 25,
    "userName": "admin",
    "profile": "{ \"gender\": \"male\", \"nationalId\": \"0123456789\", \"contacts\": { \"phone\": \"02112341234\" } }",
    "settings": "{\"lang\":\"fa-IR\",\"cols\":[],\"watch_lists\":{\"list_2\":[\"2\",\"3\"],\"list_1\":[\"1\",\"2\",\"3\"]}}"
}

但是当我将@JsonRawValue 放在这些变量上时，响应会像这样序列化：

{
    "id": 25,
    "userName": "admin",
    "profile": {
        "gender": "male",
        "nationalId": "0123456789",
        "contacts": {
            "phone": "02112341234"
        }
    },
    "settings": {
        "lang": "fa-IR",
        "cols": [],
        "watch_lists": {
            "list_2": [
                "2",
                "3"
            ],
            "list_1": [
                "1",
                "2",
                "3"
            ]
        }
    }
}

【讨论】：