java - 如何将 Map 类型的 JSON 输入传递到 PUT JAX-RS API？

Question

我有一个 PUT 类型的 JAX-RS REST 端点，我应该将 Map 传递给此 API。

@PUT
@Path("/some/path")
@Consumes({ MediaType.TEXT_PLAIN, MediaType.APPLICATION_XML,
        MediaType.TEXT_XML, MediaType.APPLICATION_JSON })
@Produces({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON })
public Response updatePerson(HashMap<Person, Person> map) {

//some code here
}

我为 Person 类生成了 JSON，但无法将其作为 JSON 输入传递给此 API。我正在使用 Postman 客户端，当我尝试将 JSON 输入作为键值对传递时，它显示语法错误。为 Person 生成的 JSON 如下所示

  {"name":"abc","weight":100.0,"id":"123"}

我需要将其作为键值对作为 map 传递。类似的东西

 {
   {"name":"abc","weight":100.0,"id":"123"} : 
   {"name":"def","weight":200.0,"id":"123"}
 }

有什么指示我该怎么做吗？

Answer 1

一般来说，创建 Map 看起来是个坏主意。像这样。 JSON Object可以转换为Java Map哪里key是 String和value是任意 Object :可以是另一个Map , array , POJO或简单类型。所以，一般来说你的JSON应该看起来像:

{
    "key" : { .. complex nested object .. }
}

没有其他选择。如果你想有Java映射POJO -> POJO您需要指示解串器如何转换 JSON -String -key到一个物体。没有其他选择。我将尝试使用 Jackson 来解释这个过程。库，因为它在 RESTful Web Services 中使用最多。 。让我们定义Person适合您的类(class)JSON有效负载。

class Person {

    private String name;
    private double weight;
    private int id;

    public Person() {
    }

    public Person(String value) {
        String[] values = value.split(",");
        name = values[0];
        weight = Double.valueOf(values[1]);
        id = Integer.valueOf(values[2]);
    }

    public Person(String name, double weight, int id) {
        this.name = name;
        this.weight = weight;
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public double getWeight() {
        return weight;
    }

    public void setWeight(double weight) {
        this.weight = weight;
    }

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        Person person = (Person) o;
        return id == person.id;
    }

    @Override
    public int hashCode() {
        return Objects.hash(id);
    }

    @Override
    public String toString() {
        return name + "," + weight + "," + id;
    }
}

因为它用在Map中作为关键，我们需要实现 hashCode和equals方法。除了public Person(String value)构造函数和 toString方法其他一切看起来都很正常。现在，让我们看一下这个构造函数和 toString方法。它们是相关的:toString构建String来自Person实例和构造函数构建 Person来自String 。我们可以将 Map 中的 key 的第一次转换称为“序列化”，将第二次转换称为“反序列化”。序列化和反序列化。 (这两个实现得好不好是另外一回事了，我只是想展示一下背后的想法，在生产上使用之前应该改进一下)

让我们利用这些知识和 Jackson序列化和反序列化功能 Map<Person, Person> :

import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.KeyDeserializer;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
import com.fasterxml.jackson.databind.module.SimpleModule;
import com.fasterxml.jackson.databind.type.MapType;

import java.util.HashMap;
import java.util.Map;
import java.util.Objects;

public class JsonApp {

    public static void main(String[] args) throws Exception {
        // register deserializer for Person as keys.
        SimpleModule module = new SimpleModule();
        module.addKeyDeserializer(Person.class, new PersonKeyDeserializer());

        ObjectMapper mapper = new ObjectMapper();
        mapper.registerModule(module);
        mapper.enable(SerializationFeature.INDENT_OUTPUT);

        // Create example Map
        Person key = new Person("Rick", 80.5, 1);
        Person value = new Person("Morty", 40.1, 2);
        Map<Person, Person> personMap = new HashMap<>();
        personMap.put(key, value);

        // Serialise Map to JSON
        String json = mapper.writeValueAsString(personMap);
        System.out.println(json);

        // Deserialise it back to `Object`
        MapType mapType = mapper.getTypeFactory().constructMapType(HashMap.class, Person.class, Person.class);
        System.out.println(mapper.readValue(json, mapType).toString());
    }
}

class PersonKeyDeserializer extends KeyDeserializer {

    @Override
    public Object deserializeKey(String key, DeserializationContext ctxt) {
        return new Person(key);
    }
}

上面的代码首先打印 JSON :

{
  "Rick,80.5,1" : {
    "name" : "Morty",
    "weight" : 40.1,
    "id" : 2
  }
}

如您所见，Person的toString方法用于生成 JSON key 。正常序列化过程序列化Person至JSON目的。打印下面的第二个文本:

{Rick,80.5,1=Morty,40.1,2}

这是 Map 的默认表示形式它是键和值。因为两者都是Person对象是 toString方法被调用。

如您所见，有一个选项可以发送 JSON如Map<Person, Person>但 key 应该以某种方式表示。您需要查看Person类的实现。也许你会发现与我的例子有一些相似之处。如果没有，可能是通过某种方式配置的。首先尝试发送PostMan :

{
   "123" : {"name":"def","weight":200.0,"id":"123"}
}

或者:

{
   "{\"name\":\"abc\",\"weight\":100.0,\"id\":\"123\"}":{
      "name":"def",
      "weight":200.0,
      "id":"123"
   }
}

也许它会起作用。

另请参阅:

• Map Serialization and Deserialization with Jackson
• Custom ObjectMapper with Jersey 2.2 and Jackson 2.1
• JBoss resteasy - Custom Jackson provider