Spring MVC控制器中的JSON参数

Question

我有

@RequestMapping(method = RequestMethod.GET)
@ResponseBody
SessionInfo register(UserProfile profileJson){
  ...
}

我这样传递profileJson：

http://server/url?profileJson={"email": "mymail@gmail.com"}

但我的 profileJson 对象具有所有空字段。我应该怎么做才能让spring解析我的json？

Answer 1

解决这个问题的方法非常简单，它实际上会让你发笑，但在我开始之前，让我先强调一下，任何有自尊的 Java 开发人员都不会，我的意思是永远使用 JSON 而不使用Jackson 高性能 JSON 库。

Jackson 不仅是 Java 开发人员的工作马和事实上的 JSON 库，而且它还提供了一整套 API 调用，使 JSON 与 Java 集成变得轻而易举（您可以通过 http://jackson.codehaus.org/ 下载 Jackson）。

现在回答。假设您有一个看起来像这样的 UserProfile pojo：

public class UserProfile {

private String email;
// etc...

public String getEmail() {
    return email;
}

public void setEmail(String email) {
    this.email = email;
}

// more getters and setters...
}

...然后您的 Spring MVC 方法将 GET 参数名称“profileJson”转换为 JSON 值为 {"email": "mymail@gmail.com"} 在您的控制器中将如下所示：

import org.codehaus.jackson.JsonParseException;
import org.codehaus.jackson.map.JsonMappingException;
import org.codehaus.jackson.map.ObjectMapper; // this is your lifesaver right here

//.. your controller class, blah blah blah

@RequestMapping(value="/register", method = RequestMethod.GET) 
public SessionInfo register(@RequestParam("profileJson") String profileJson) 
throws JsonMappingException, JsonParseException, IOException {

    // now simply convert your JSON string into your UserProfile POJO 
    // using Jackson's ObjectMapper.readValue() method, whose first 
    // parameter your JSON parameter as String, and the second 
    // parameter is the POJO class.

    UserProfile profile = 
            new ObjectMapper().readValue(profileJson, UserProfile.class);

        System.out.println(profile.getEmail());

        // rest of your code goes here.
}

砰！你完成了。我鼓励你仔细阅读 Jackson API 的大部分内容，因为正如我所说，它是一个救命稻草。例如，您是否从控制器返回 JSON？如果是这样，您需要做的就是在您的库中包含 JSON，并返回您的 POJO，Jackson 将自动将其转换为 JSON。没有比这更容易的了。干杯! :-)

Answer 2

这可以通过自定义编辑器来完成，它将 JSON 转换为 UserProfile 对象：

public class UserProfileEditor extends PropertyEditorSupport  {

    @Override
    public void setAsText(String text) throws IllegalArgumentException {
        ObjectMapper mapper = new ObjectMapper();

        UserProfile value = null;

        try {
            value = new UserProfile();
            JsonNode root = mapper.readTree(text);
            value.setEmail(root.path("email").asText());
        } catch (IOException e) {
            // handle error
        }

        setValue(value);
    }
}

这是为了在控制器类中注册编辑器：

@InitBinder
public void initBinder(WebDataBinder binder) {
    binder.registerCustomEditor(UserProfile.class, new UserProfileEditor());
}

这是如何使用编辑器来解组 JSONP 参数：

@RequestMapping(value = "/jsonp", method = RequestMethod.GET, produces = {MediaType.APPLICATION_JSON_VALUE})
@ResponseBody
SessionInfo register(@RequestParam("profileJson") UserProfile profileJson){
  ...
}

Answer 3

您可以创建自己的Converter 并让 Spring 在适当的地方自动使用它：

import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.core.convert.converter.Converter;
import org.springframework.stereotype.Component;

@Component
class JsonToUserProfileConverter implements Converter<String, UserProfile> {

    private final ObjectMapper jsonMapper = new ObjectMapper();

    public UserProfile convert(String source) {
        return jsonMapper.readValue(source, UserProfile.class);
    }
}

正如您在以下控制器方法中看到的那样，不需要什么特别的：

@GetMapping
@ResponseBody
public SessionInfo register(@RequestParam UserProfile userProfile)  {
  ...
}

如果您使用组件扫描，Spring 会自动选择转换器并使用 @Component 注释转换器类。

详细了解Spring Converter 和type conversions in Spring MVC。

Answer 4

这确实解决了我的直接问题，但我仍然很好奇您如何通过 AJAX 调用传入多个 JSON 对象。

最好的方法是拥有一个包含您要传递的两个（或多个）对象的包装器对象。然后，您将 JSON 对象构造为两个对象的数组，即

[
  {
    "name" : "object1",
    "prop1" : "foo",
    "prop2" : "bar"
  },
  {
    "name" : "object2",
    "prop1" : "hello",
    "prop2" : "world"
  }
]

然后在您的控制器方法中，您将请求正文作为单个对象接收并提取两个包含的对象。即：

@RequestMapping(value="/handlePost", method = RequestMethod.POST, consumes = {      "application/json" })
public void doPost(@RequestBody WrapperObject wrapperObj) { 
     Object obj1 = wrapperObj.getObj1;
     Object obj2 = wrapperObj.getObj2;

     //Do what you want with the objects...


}

包装对象看起来像...

public class WrapperObject {    
private Object obj1;
private Object obj2;

public Object getObj1() {
    return obj1;
}
public void setObj1(Object obj1) {
    this.obj1 = obj1;
}
public Object getObj2() {
    return obj2;
}
public void setObj2(Object obj2) {
    this.obj2 = obj2;
}   

}

Answer 5

只需在此参数前添加@RequestBody 注释