差異處
這裏顯示兩個版本的差異處。
Both sides previous revision 前次修改 下次修改 | 前次修改 下次修改 Both sides next revision | ||
java:jackson:annotation:jsonserialize:module_annotation [2018/06/03 17:01] tony |
java:jackson:annotation:jsonserialize:module_annotation [2018/06/03 23:00] tony [Research] |
||
---|---|---|---|
行 2: | 行 2: | ||
====== Jackson - Convert the value fields with special char ====== | ====== Jackson - Convert the value fields with special char ====== | ||
===== Problem ===== | ===== Problem ===== | ||
- | 這陣子在擴充Rest API的功能時,聽同事說某功能輸出xml格式下,因內容使用unicode,導致無法正常在瀏覽器上顯示。xml並非不支援unicode,而是因為瀏覽器只支援xml 1.0;我們資料剛好不在1.0所規範的範圍內,因此瀏覽器才把它認為不合法。 | + | 這陣子在擴充Rest API的功能時,聽同事說某功能輸出在xml格式下,會因內容使用unicode,導致無法在瀏覽器上正常顯示。xml並非不支援unicode,而是因為瀏覽器只支援xml 1.0;我們資料剛好不在1.0所規範的範圍內,因此瀏覽器才把它認為不合法。本篇文章分享解決此問題的方法。 |
===== Research ===== | ===== Research ===== | ||
- | 為什麼Json沒這問題呢? 對於Json來說,unicode內容有兩種選擇: | + | 首先我思考的是,為什麼Json沒這問題呢? 因為對Json來說,unicode內容有兩種選擇: |
- 以代碼顯示: \u0001\u0002\u0003。 | - 以代碼顯示: \u0001\u0002\u0003。 | ||
- 以原始樣式顯示: 即欄位定義為unicode type。 | - 以原始樣式顯示: 即欄位定義為unicode type。 | ||
- | 而xml在瀏覽器接收到代碼後,會做轉換;無法轉換時,就會報錯。在花些時間研究後,得知Amazon的Simple DB針對client傳遞或是要回應給client的資料,如果有這種情況,會將內容做base64的encoding。雖然對user來說是個小effort,但也不失為一個解法。 | + | 而xml在瀏覽器接收到代碼後,會做轉換;無法轉換時,就會報錯。在花些時間研究後,得知Amazon的Simple DB針對client傳遞或是要回應給client的資料;在有這種情況時,會將內容做base64的encoding。雖然對user來說需要額外轉換,但也不失為一個解法。因此我的解法核心在於encoding,差別只在於用什麼方式。 |
===== How to? ===== | ===== How to? ===== | ||
假設我們的Event Bean物件是這樣子: | 假設我們的Event Bean物件是這樣子: | ||
行 133: | 行 134: | ||
} | } | ||
</code> | </code> | ||
- | 針對Event物件的調整,只要改為Base64Text並移除原本的@JsonSerialize與@JsonDeserialize: | + | 針對Event物件的調整,只要改為Base64Text並移除原本的@JsonSerialize與@JsonDeserialize。setMessage部分接受Base64Text與String型態以便於Client操作,這裡需要特別宣告@JsonSetter(value="message")以避免Jackson找錯set method: |
<code java> | <code java> | ||
public class Event { | public class Event { | ||
行 150: | 行 151: | ||
public Base64Text getMessage(){ | public Base64Text getMessage(){ | ||
return message; | return message; | ||
+ | } | ||
+ | |||
+ | @JsonSetter(value="message") | ||
+ | public void setMessage(Base64Text message){ | ||
+ | this.message = message; | ||
} | } | ||
行 192: | 行 198: | ||
assertEquals(msg, newEvent.getMessage().getValue()); | assertEquals(msg, newEvent.getMessage().getValue()); | ||
} | } | ||
- | </code>> | + | </code> |
這個測試輸出如下: | 這個測試輸出如下: | ||
<code> | <code> | ||
行 198: | 行 204: | ||
</code> | </code> | ||
=== Xml === | === Xml === | ||
+ | xml部分需要Serializer與Deserializer,我們先看看test code: | ||
+ | <code java> | ||
+ | @Test | ||
+ | public void testUnicodeXml() throws Exception { | ||
+ | XmlMapper mapper = new XmlMapper(); | ||
+ | |||
+ | SimpleModule m = new SimpleModule(); | ||
+ | m.addSerializer(Base64Text.class, new Base64TextSerializer()); | ||
+ | m.addDeserializer(Base64Text.class, new Base64TextDeserializer()); | ||
+ | mapper.registerModule(m); | ||
+ | Event e = new Event(); | ||
+ | String msg = "test" + (char) 1 + (char) 2 + (char) 3; | ||
+ | e.setMessage(msg); | ||
+ | |||
+ | tring ret = mapper.writeValueAsString(e); | ||
+ | System.out.println(ret); | ||
+ | Event newEvent = mapper.readValue(ret, Event.class); | ||
+ | assertEquals(msg, newEvent.getMessage().getValue()); | ||
+ | } | ||
+ | </code> | ||
+ | 流程與json部分類似,只差在多註冊Deserializer,而輸出會是: | ||
+ | <code> | ||
+ | <Event><date/><message type="base64">dGVzdAECAw==</message></Event> | ||
+ | </code> | ||
+ | Serializer如下,處理type與value的部分: | ||
+ | <code java> | ||
+ | public class Base64TextSerializer extends StdSerializer<Base64Text> { | ||
+ | private static final long serialVersionUID = 1L; | ||
+ | |||
+ | public Base64TextSerializer() { | ||
+ | super(Base64Text.class); | ||
+ | } | ||
+ | |||
+ | @Override | ||
+ | public void serialize(Base64Text value, JsonGenerator jgen, | ||
+ | SerializerProvider provider) throws IOException { | ||
+ | ToXmlGenerator xgen = (ToXmlGenerator) jgen; | ||
+ | |||
+ | xgen.writeStartObject(); | ||
+ | xgen.setNextIsAttribute(true); | ||
+ | xgen.writeFieldName("type"); | ||
+ | xgen.writeString(value.getEncoding()); | ||
+ | xgen.setNextIsAttribute(false); | ||
+ | |||
+ | xgen.setNextIsUnwrapped(true); | ||
+ | xgen.writeFieldName("value"); | ||
+ | xgen.writeObject(value.getEncodingValue()); | ||
+ | xgen.setNextIsUnwrapped(false); | ||
+ | |||
+ | xgen.writeEndObject(); | ||
+ | } | ||
+ | } | ||
+ | </code> | ||
+ | Deserializer部分會將encode的內容decode再塞回Base64Text物件中,做法如下: | ||
+ | <code java> | ||
+ | public class Base64TextDeserializer extends StdDeserializer<Base64Text> { | ||
+ | |||
+ | private static final long serialVersionUID = 1L; | ||
+ | |||
+ | public Base64TextDeserializer() { | ||
+ | super(Base64Text.class); | ||
+ | } | ||
+ | |||
+ | @Override | ||
+ | public Base64Text deserialize(JsonParser parser, DeserializationContext context) | ||
+ | throws IOException, JsonProcessingException { | ||
+ | String text = parser.getValueAsString(); | ||
+ | Base64Text encodingValue = Base64Text.decode(text); | ||
+ | return encodingValue; | ||
+ | } | ||
+ | } | ||
+ | </code> | ||
+ | 目前提供這兩種方式給大家參考。 | ||
===== Reference ===== | ===== Reference ===== | ||
* [[https://en.wikipedia.org/wiki/Valid_characters_in_XML|Valid_characters_in_XML]] | * [[https://en.wikipedia.org/wiki/Valid_characters_in_XML|Valid_characters_in_XML]] |