Jackson - Convert the key fields with special char

Problem

在將物件轉為json或xml格式時，可能會因為key欄位名稱有特殊字元，而無法產生出正常的輸出。舉例來說:

	@JsonProperty(value="metadata")
	private Map<String, Object> mMetadata;

mMetadata為map物件，如果key的內容包含特殊字元，如$ARG$，產生出的xml則會變成不合法格式:

<Command xmlns=""><metadata><$ARG$>123</$ARG$></metadata></Command>

接下來看看如何解決這問題。

How to resolve?

我想到的幾個解法是:

1. 在塞值時去避免: 這是最直接方法，但可能因為同一物件有其它client使用而需要修改。
2. 在取值時去轉換: 假如物件是多層的，如Map<String, Object>型態，程式不太寫且是額外的工。
3. 在轉換為json或xml時，去濾掉或偵測: 由於轉換本身就會讀到key欄位，在轉換過程順便過濾或偵測效率最佳。

在這我使用了第三個解法，並針對要處理的項目:

Source Object and JsonSerialize Annotation

Command類別是此範例中，要轉為json與xml格式的目標:

import java.util.Map;
 
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
 
 
public class Command {
	@JsonProperty(value="name")
	private String mName;
 
 
	@JsonSerialize(keyUsing=KeySerializer.class)
	@JsonProperty(value="metadata")
	private Map<String, Object> mMetadata;
 
	public Command() {
 
	}
 
	public void setMetadata(Map<String, Object> aMetadata){
		mMetadata = aMetadata;
	}
 
	public String getName() {
		return mName;
	}
 
	public void setName(String aName) {
		this.mName = aName;
	}
}

對於mMetadata，我使用了@JsonSerialize(keyUsing=KeySerializer.class)，要透過KeySerializer將key濾掉$字號。

KeySerializer for String

從annotation的宣告可得知，自訂的Serializer必須繼承於JsonSerializer:

    public Class<? extends JsonSerializer> keyUsing()
        default JsonSerializer.None.class;

來看看我做的KeySerializer，針對key value將$取代為空白:

import java.io.IOException;
 
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.SerializerProvider;
 
public class KeySerializer extends JsonSerializer<String> {
 
	@Override
	public void serialize(String value, JsonGenerator gen,
			SerializerProvider serializers) throws IOException,
			JsonProcessingException {
		gen.writeFieldName(value.replaceAll("\\$", ""));
	}
}

接下來看看產生的結果。

Convert to json

	@Test
	public void testJsonGenerator() throws IOException {
		ObjectMapper mapper = new ObjectMapper();
		JsonGenerator generator = mapper.getFactory().createGenerator(System.out);
 
		Map<String, Object> metadata = new HashMap<String, Object>();
		Map<String, Object> tmp = new HashMap<String, Object>();
		tmp.put("$ARG4$", "789");
		tmp.put("$ARG5$", "111");
		metadata.put("$ARG1$", "123");
		metadata.put("$ARG2$", "456");
		metadata.put("$ARG3$", tmp);
 
		Command cmd = new Command();
		cmd.setName("ping");
		cmd.setMetadata(metadata);
 
		generator.writeObject(cmd);
	}

Output:

{"name":"ping","metadata":{"ARG3":{"ARG5":"111","ARG4":"789"},"ARG2":"456","ARG1":"123"}}

Convert to xml

	@Test
	public void testXmlGenerator() throws IOException {
		XmlMapper mapper = new XmlMapper();
		JsonGenerator generator = mapper.getFactory().createGenerator(System.out);
 
		Map<String, Object> metadata = new HashMap<String, Object>();
		Map<String, Object> tmp = new HashMap<String, Object>();
		tmp.put("$ARG4$", "789");
		tmp.put("$ARG5$", "111");
		metadata.put("$ARG1$", "123");
		metadata.put("$ARG2$", "456");
		metadata.put("$ARG3$", tmp);
 
		Command cmd = new Command();
		cmd.setName("ping");
		cmd.setMetadata(metadata);
 
		generator.writeObject(cmd);
	}

Output:

<Command xmlns=""><name>ping</name><metadata><ARG3><ARG5>111</ARG5><ARG4>789</ARG4></ARG3><ARG2>456</ARG2><ARG1>123</ARG1></metadata></Command>

Reference

• jackson-modules-for-map-serialization