跳到主要內容

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

留言

這個網誌中的熱門文章

PostgreSQL - Unattended installation on windows

Introduction 要將別人軟體包裝到自己軟體中,不可或缺的東西就是Unattended installation。以Unattended installation來說,我們可以選擇透過Installer的silent mode安裝,也可以透過把目標軟體做成portable的版本。本篇文章分享這兩種方法,教導大家如何將PostgreSQL透過Unattended installation方式安裝到目標系統成為service。 Note. 本篇以PostgreSQL 10.7為例。 Install with installer Tips 安裝程式或反安裝程式的參數,除了可以直接上官網搜尋Installation User Guide以外,也可以直接使用help參數查詢: postgresql- 10.7 - 2 -windows-x64.exe --help Windows安裝程式主要有EnterpriseDB與BigSQL兩種。BigSQL版本安裝元件是透過網路下載且支援參數不如EnterpriseDB版本多,以我們需求來說,我們傾向於使用EnterpriseDB版本。接下來分享給大家安裝與反安裝方法。 Installation @ echo off set INSTALL_DIR =C:\postgres10 set INSTALLER =postgresql- 10.7 - 2 -windows-x64.exe   rem options for installation set SSMDB_SERVICE =postgresql- 10 set MODE =--unattendedmodeui none --mode unattended   set DB_PASSWD =--superpassword postgres set DB_PORT =--serverport 5432   set SERVICE_NAME =--servicename % SSMDB_SERVICE %   set PREFIX =--prefix "%INSTALL_DIR%" set DATA_DIR =--datadir "%INSTALL_DIR%\data"   set OPTIONS =

How to install RIDE on Windows?

Introduction 多年沒在Windows上開發RobotFramework,趁著這次整理一下RIDE安裝方法。 目前RIDE最新版本與Python對應版本如下: (3.6 < python <= 3.11) Install current released version (2.0.8.1) with: pip install -U robotframework-ride 安裝Python 直接到Python官網找尋最新的3.11版本,我使用3.11.9: link 。安裝就是一直下一步而已。 安裝wxPython 每次安裝RIDE最困難的都是wxPython。看了一下 官網 描述,我就姑且相信一下: 接著進入下 載頁面 就有安裝教學。基本上就是到Python目錄下的Scripts直接執行以下command: pip install -U wxPython 安裝RIDE 接著就如RIDE官網所說,執行以下command: pip install -U robotframework-ride 啟動RIDE 直接在相同目錄下執行ride就可以啟動了,你也可以直接在桌面建ride連結,加快下次啟動時間。 沒想到這次這麼順利就安裝完成了。因為我是使用java去啟動robot framework,就不特別講要怎麼使用pip安裝robot framework了。

Hello World!

即將要搬家,因此舊網頁內容將慢慢轉移至Blogger。 如果要存取舊網頁,可以使用以下連結: https://wiki.tonylin.idv.tw/dokuwiki/doku.php