跳到主要內容

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

留言

這個網誌中的熱門文章

Show NIC selection when setting the network command with the device option

 Problem  在answer file中設定網卡名稱後,安裝時會停在以下畫面: 所使用的command參數如下: network --onboot = yes --bootproto =dhcp --ipv6 =auto --device =eth1 Diagnostic Result 這樣的參數,以前試驗過是可以安裝完成的。因此在發生這個問題後,我檢查了它的debug console: 從console得知,eth1可能是沒有連接網路線或者是網路太慢而導致的問題。後來和Ivy再三確認,有問題的是有接網路線的網卡,且問題是發生在activate階段: Solution 我想既然有retry應該就有次數或者timeout限制,因此發現在Anaconda的說明文件中( link ),有提到dhcptimeout這個boot參數。看了一些人的使用範例,應該是可以直接串在isolinux.cfg中,如下: default linux ksdevice = link ip =dhcp ks =cdrom: / ks.cfg dhcptimeout = 90 然而我在RHEL/CentOS 6.7與6.8試驗後都無效。 因此我就拿了顯示的錯誤字串,問問Google大師,想找一下Anaconda source code來看一下。最後找到別人根據Anaconda code修改的版本: link ,關鍵在於setupIfaceStruct函式中的setupIfaceStruct與readNetConfig: setupIfaceStruct: 會在dhcp時設定dhcptimeout。 readNetConfig: 在writeEnabledNetInfo將timeout寫入dhclient config中;在wait_for_iface_activation內會根據timeout做retry。 再來從log與code可以得知,它讀取的檔案是answer file而不是boot command line。因此我接下來的測試,就是在answer file的network command上加入dhcptimeout: network --onboot = yes --bootproto =dhcp --ipv6 =auto --device =eth1 --dhcptimeo

解決RobotFramework從3.1.2升級到3.2.2之後,Choose File突然會整個Hand住的問題

考慮到自動測試環境的維護,我們很久以前就使用java去執行robot framework。前陣子開始處理從3.1.2升級到3.2.2的事情,主要先把明確的runtime語法錯誤與deprecate item處理好,這部分內容可以參考: link 。 直到最近才發現,透過SeleniumLibrary執行Choose File去上傳檔案的動作,會導致測試案例timeout。本篇文章主要分享心路歷程與解決方法,我也送了一條issue給robot framework: link 。 我的環境如下: RobotFramework: 3.2.2 Selenium: 3.141.0 SeleniumLibrary: 3.3.1 Remote Selenium Version: selenium-server-standalone-3.141.59 首先並非所有Choose File的動作都會hang住,有些測試案例是可以執行的,但是上傳一個作業系統ISO檔案一定會發生問題。後來我透過wireshark去比對新舊版本的上傳動作,因為我使用 Remote Selenium ,所以Selenium會先把檔案透過REST API發送到Remote Selenium Server上。從下圖我們可以發現,在3.2.2的最後一個TCP封包,比3.1.2大概少了500個bytes。 於是就開始了我trace code之路。包含SeleniumLibrary產生要送給Remote Selenium Server的request內容,還有HTTP Content-Length的計算,我都確認過沒有問題。 最後發現問題是出在socket API的使用上,就是下圖的這支code: 最後發現可能因為開始使用nio的方式送資料,但沒處理到尚未送完的資料內容,而導致發生問題。加一個loop去做計算就可以解決了。 最後我有把解法提供給robot framework官方,在他們出新的版本之前,我是將改完的_socket.py放在我們自己的Lib底下,好讓我們測試可以正常進行。(shutil.py應該也是為了解某個bug而產生的樣子..)

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了。