讓Jackson JSON生成的數據包含的中文以unicode方式編碼

時間  2019-11-08
標籤 jackson json 生成 數據 包含 中文 unicode 方式 編碼 欄目 JavaScript 简体版
原文   原文鏈接
 
本文出處：http://blog.csdn.net/chaijunkun/article/details/8257209，轉載請註明。因爲本人不按期會整理相關博文，會對相應內容做出完善。所以強烈建議在原始出處查看此文。

在年初的時候，我曾經寫過一篇文章介紹非關係型數據庫MongoDB和Jackson JSON框架相結合實現接口敏捷開發的文章（http://blog.csdn.net/chaijunkun/article/details/7263804），被可愛的CSDN小編推到了首頁。在此本人對小編表示感謝。事隔10個月，隨着手頭一些項目的進行，對Jackson JSON框架用得愈來愈多。以爲有必要再寫點什麼補充出來。做爲和廣大同仁的一個經驗的分享。


咱們都知道，Jackson JSON以高速、方便和靈活著稱。以前的文章中介紹過使用註解的形式來規定如何將一個對象序列化成JSON的方法，以及如何將一個JSON數據反序列化到一個對象上。可是美中不足的一點就是對於中文的處理。固然我說的美中不足是在默認狀況下，Jackson JSON不會將中文等非ASCII字符轉換爲\uFFFF這樣的形式來顯示。也就是說默認狀況下會顯示爲{"name":"張三"}而不是{"name":"\u5F20\u4E09"}。那麼爲何有這樣的需求呢？在HTTP協議中，咱們能夠指定數據頭部分的內容編碼。如：「GBK」、「UTF-8」等等。若是你設置正確了，那麼OK，前者所表示的數據您能夠正確處理。然而若是設置錯誤，對於中文字符將會產生亂碼。兩套應用系統對接，有可能兩邊使用的默認編碼不一樣，若是一方修改默認編碼將會對應用形成不可預知的後果。所以若能以長遠的眼光開發，那麼不管您設置成什麼編碼方式，都不會使數據產生亂碼。由於，這裏用到了萬國編碼——Unicode。


好的，問題出來了，咱們如何解決呢？使其經過實驗，Jackson JSON其實在默認設置下已經具有了對Unicode編碼的JSON數據進行解析。所欠缺的就是在序列化對象時缺乏相應的步驟。好在Jackson JSON框架容許咱們自定義序列化方法。那麼咱們就來寫一個序列化類：java

 

[java]  view plain  copy
 
 在CODE上查看代碼片派生到個人代碼片
  1. package net.csdn.blog.chaijunkun.util;  
  2.   
  3. import java.io.IOException;  
  4.   
  5. import org.codehaus.jackson.JsonGenerationException;  
  6. import org.codehaus.jackson.JsonGenerator;  
  7. import org.codehaus.jackson.JsonProcessingException;  
  8. import org.codehaus.jackson.impl.JsonWriteContext;  
  9. import org.codehaus.jackson.map.JsonSerializer;  
  10. import org.codehaus.jackson.map.SerializerProvider;  
  11. import org.codehaus.jackson.util.CharTypes;  
  12.   
  13. public class StringUnicodeSerializer extends JsonSerializer<String> {  
  14.   
  15.     private final char[] HEX_CHARS = "0123456789ABCDEF".toCharArray();  
  16.     private final int[] ESCAPE_CODES = CharTypes.get7BitOutputEscapes();  
  17.   
  18.     private void writeUnicodeEscape(JsonGenerator gen, char c) throws IOException {  
  19.         gen.writeRaw('\\');  
  20.         gen.writeRaw('u');  
  21.         gen.writeRaw(HEX_CHARS[(c >> 12) & 0xF]);  
  22.         gen.writeRaw(HEX_CHARS[(c >> 8) & 0xF]);  
  23.         gen.writeRaw(HEX_CHARS[(c >> 4) & 0xF]);  
  24.         gen.writeRaw(HEX_CHARS[c & 0xF]);  
  25.     }  
  26.   
  27.     private void writeShortEscape(JsonGenerator gen, char c) throws IOException {  
  28.         gen.writeRaw('\\');  
  29.         gen.writeRaw(c);  
  30.     }  
  31.   
  32.     @Override  
  33.     public void serialize(String str, JsonGenerator gen,  
  34.             SerializerProvider provider) throws IOException,  
  35.             JsonProcessingException {  
  36.         int status = ((JsonWriteContext) gen.getOutputContext()).writeValue();  
  37.         switch (status) {  
  38.           case JsonWriteContext.STATUS_OK_AFTER_COLON:  
  39.             gen.writeRaw(':');  
  40.             break;  
  41.           case JsonWriteContext.STATUS_OK_AFTER_COMMA:  
  42.             gen.writeRaw(',');  
  43.             break;  
  44.           case JsonWriteContext.STATUS_EXPECT_NAME:  
  45.             throw new JsonGenerationException("Can not write string value here");  
  46.         }  
  47.         gen.writeRaw('"');//寫入JSON中字符串的開頭引號  
  48.         for (char c : str.toCharArray()) {  
  49.           if (c >= 0x80){  
  50.               writeUnicodeEscape(gen, c); // 爲全部非ASCII字符生成轉義的unicode字符  
  51.           }else {  
  52.             // 爲ASCII字符中前128個字符使用轉義的unicode字符  
  53.             int code = (c < ESCAPE_CODES.length ? ESCAPE_CODES[c] : 0);  
  54.             if (code == 0){  
  55.                 gen.writeRaw(c); // 此處不用轉義  
  56.             }else if (code < 0){  
  57.                 writeUnicodeEscape(gen, (char) (-code - 1)); // 通用轉義字符  
  58.             }else {  
  59.                 writeShortEscape(gen, (char) code); // 短轉義字符 (\n \t ...)  
  60.             }  
  61.           }  
  62.         }  
  63.         gen.writeRaw('"');//寫入JSON中字符串的結束引號  
  64.     }  
  65.   
  66. }  

這個序列化類將要對應用中全部使用Jackson JSON的地方全都用一種方法來處理字符串類型。光有了方法還不行，還要對它進行註冊。讓Jackson JSON在序列化對象的時候使用剛剛定義好的方法：

 

 

[java]  view plain  copy
 
 在CODE上查看代碼片派生到個人代碼片
  1. if (objectMapper== null){  
  2.     objectMapper= new ObjectMapper();  
  3.     //當找不到對應的序列化器時 忽略此字段  
  4.     objectMapper.configure(SerializationConfig.Feature.FAIL_ON_EMPTY_BEANS, false);  
  5.     //使Jackson JSON支持Unicode編碼非ASCII字符  
  6.     CustomSerializerFactory serializerFactory= new CustomSerializerFactory();  
  7.     serializerFactory.addSpecificMapping(String.class, new StringUnicodeSerializer());  
  8.     objectMapper.setSerializerFactory(serializerFactory);  
  9.     //支持結束  
  10. }  

 

2014年5月13日補充：最近被問到不少次關於單例模式的實現。上面的寫法真的很不安全，沒有加鎖，也沒有對objectMapper進行volatile修飾（即所謂的「雙檢索」貨「雙重檢查」），所以最簡單的可靠的方法應該使用「枚舉單例法」。數據庫

 

2014年11月21日補充：因爲Jackson 2的版本變化，CustomSerializerFactory已經被去掉了，通過實驗，可使用這種方式代替：apache

 

[java]  view plain  copy
 
 在CODE上查看代碼片派生到個人代碼片
  1. if (objectMapper== null){  
  2.     objectMapper= new ObjectMapper();  
  3.     //當找不到對應的序列化器時 忽略此字段  
  4.     objectMapper.configure(SerializationFeature.FAIL_ON_EMPTY_BEANS, false);  
  5.     //使Jackson JSON支持Unicode編碼非ASCII字符  
  6.     SimpleModule module = new SimpleModule();  
  7.     module.addSerializer(String.class, new StringUnicodeSerializer());  
  8.     objectMapper.registerModule(module);  
  9.     //設置null值不參與序列化(字段不被顯示)  
  10.     objectMapper.setSerializationInclusion(Include.NON_NULL);  
  11.     //支持結束  
  12. }  


 

 

接下來咱們來作一個測試用的對象，驗證咱們的代碼：json

 

[java]  view plain  copy
 
 在CODE上查看代碼片派生到個人代碼片
  1. package net.csdn.blog.chaijunkun.json;  
  2.   
  3. import java.util.Date;  
  4.   
  5. import net.csdn.blog.chaijunkun.util.DateDeserializer;  
  6. import net.csdn.blog.chaijunkun.util.DateSerializer;  
  7. import net.csdn.blog.chaijunkun.util.DateTimeDeserializer;  
  8. import net.csdn.blog.chaijunkun.util.DateTimeSerializer;  
  9.   
  10. import org.codehaus.jackson.annotate.JsonPropertyOrder;  
  11. import org.codehaus.jackson.map.annotate.JsonDeserialize;  
  12. import org.codehaus.jackson.map.annotate.JsonSerialize;  
  13.   
  14. @JsonPropertyOrder(alphabetic= false)  
  15. public class DemoObj {  
  16.       
  17.     private Integer sid;  
  18.       
  19.     private String stuName;  
  20.       
  21.     private Boolean sex;  
  22.       
  23.     @JsonSerialize(using= DateSerializer.class)  
  24.     @JsonDeserialize(using= DateDeserializer.class)  
  25.     private Date birthday;  
  26.       
  27.     @JsonSerialize(using= DateTimeSerializer.class)  
  28.     @JsonDeserialize(using= DateTimeDeserializer.class)  
  29.     private Date logTime;  
  30.   
  31.     //Getters and Setters  
  32.       
  33. }  

從代碼上能夠看出，咱們並無對String類型的屬性強制指定用何種序列與反序列方法。而後咱們來構造測試用例：

 

 

[java]  view plain  copy
 
 在CODE上查看代碼片派生到個人代碼片
  1. package net.csdn.blog.chaijunkun.test;  
  2.   
  3. import java.text.SimpleDateFormat;  
  4. import java.util.Calendar;  
  5. import java.util.Date;  
  6.   
  7. import net.csdn.blog.chaijunkun.json.DemoObj;  
  8. import net.csdn.blog.chaijunkun.util.JSONUtil;  
  9.   
  10. import org.apache.log4j.Logger;  
  11.   
  12. public class JSONTest {  
  13.       
  14.     private static Logger logger= Logger.getLogger(JSONTest.class);  
  15.       
  16.     private static String json= "{\"sid\":2,\"stuName\":\"\u6C5F\u5357Style\",\"sex\":true,\"birthday\":\"2012-07-15\",\"logTime\":\"2012-12-04 19:22:36\"}";  
  17.       
  18.     public static void main(String[] args) {  
  19.         DemoObj objSrc= new DemoObj();  
  20.         objSrc.setSid(1);  
  21.         objSrc.setStuName("鳥叔");  
  22.         objSrc.setSex(true);  
  23.         Calendar calendar= Calendar.getInstance();  
  24.         calendar.set(1977, Calendar.DECEMBER, 31, 0, 0, 0);  
  25.         objSrc.setBirthday(calendar.getTime());  
  26.         objSrc.setLogTime(new Date());  
  27.         logger.info(String.format("轉換爲JSON後的數據:%s", JSONUtil.toJSON(objSrc)));  
  28.         DemoObj objDes= JSONUtil.fromJSON(json, DemoObj.class);  
  29.         if(objDes==null){  
  30.             logger.info("反序列化失敗");  
  31.         }else{  
  32.             logger.info("反序列化成功");  
  33.             SimpleDateFormat sdf= new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");  
  34.             logger.info(String.format("標識：%d", objDes.getSid()));  
  35.             logger.info(String.format("姓名：%s", objDes.getStuName()));  
  36.             logger.info(String.format("性別：%s", objDes.getSex()==true?"男":"女"));  
  37.             logger.info(String.format("生日：%s", sdf.format(objDes.getBirthday())));  
  38.             logger.info(String.format("登陸日期：%s", sdf.format(objDes.getLogTime())));  
  39.         }  
  40.     }  
  41.   
  42. }  

 

看一下輸出：安全

 

[plain]  view plain  copy
 
 在CODE上查看代碼片派生到個人代碼片
  1. 轉換爲JSON後的數據:{"sid":1,"stuName":"\u9E1F\u53D4","sex":true,"birthday":"1977-12-31","logTime":"2012-12-04 19:31:57"}  
  2. 反序列化成功  
  3. 標識：2  
  4. 姓名：江南Style  
  5. 性別：男  
  6. 生日：2012-07-15 00:00:00  
  7. 登陸日期：2012-12-04 19:22:36  

咱們看到，已經成功將中文字符顯示成爲了Unicode編碼的數據。一樣，咱們以前構造的Unicode編碼的數據，在不通過任何修改的狀況下成功顯示出來了。

 

 

細心的朋友也許觀察到了，在測試用的對象定義代碼中，針對一樣Date類型的屬性「birthday」和「logTime」，咱們指定了不一樣的序列化與反序列化方法。讓咱們來看爛這兩個有什麼不一樣：app

 

[java]  view plain  copy
 
 在CODE上查看代碼片派生到個人代碼片
  1. package net.csdn.blog.chaijunkun.util;  
  2.   
  3. import java.io.IOException;  
  4. import java.text.SimpleDateFormat;  
  5. import java.util.Date;  
  6.   
  7. import org.codehaus.jackson.JsonGenerator;  
  8. import org.codehaus.jackson.JsonProcessingException;  
  9. import org.codehaus.jackson.map.JsonSerializer;  
  10. import org.codehaus.jackson.map.SerializerProvider;  
  11.   
  12. public class DateTimeSerializer extends JsonSerializer<Date> {  
  13.   
  14.     @Override  
  15.     public void serialize(Date date, JsonGenerator gen, SerializerProvider provider)  
  16.             throws IOException, JsonProcessingException {  
  17.         SimpleDateFormat sdf=new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");  
  18.         String formattedDate= sdf.format(date);  
  19.         gen.writeString(formattedDate);  
  20.     }  
  21.   
  22. }  

[java]  view plain  copy
 
 在CODE上查看代碼片派生到個人代碼片
  1. package net.csdn.blog.chaijunkun.util;  
  2.   
  3. import java.io.IOException;  
  4. import java.text.SimpleDateFormat;  
  5. import java.util.Calendar;  
  6. import java.util.Date;  
  7.   
  8. import org.codehaus.jackson.JsonParser;  
  9. import org.codehaus.jackson.JsonProcessingException;  
  10. import org.codehaus.jackson.map.DeserializationContext;  
  11. import org.codehaus.jackson.map.JsonDeserializer;  
  12.   
  13. public class DateTimeDeserializer extends JsonDeserializer<Date> {  
  14.   
  15.     @Override  
  16.     public Date deserialize(JsonParser parser, DeserializationContext context)  
  17.     throws IOException, JsonProcessingException {  
  18.         String dateFormat= "yyyy-MM-dd HH:mm:ss";  
  19.         SimpleDateFormat sdf= new SimpleDateFormat(dateFormat);  
  20.         try{  
  21.             String fieldData= parser.getText();  
  22.             return sdf.parse(fieldData);  
  23.         }catch (Exception e) {  
  24.             Calendar ca= Calendar.getInstance();  
  25.             ca.set(1970, Calendar.JANUARY, 1, 0, 0, 0);  
  26.             return ca.getTime();  
  27.         }  
  28.     }  
  29. }  

[java]  view plain  copy
 
 在CODE上查看代碼片派生到個人代碼片
  1. package net.csdn.blog.chaijunkun.util;  
  2.   
  3. import java.io.IOException;  
  4. import java.text.SimpleDateFormat;  
  5. import java.util.Date;  
  6.   
  7. import org.codehaus.jackson.JsonGenerator;  
  8. import org.codehaus.jackson.JsonProcessingException;  
  9. import org.codehaus.jackson.map.JsonSerializer;  
  10. import org.codehaus.jackson.map.SerializerProvider;  
  11.   
  12. public class DateSerializer extends JsonSerializer<Date> {  
  13.   
  14.     @Override  
  15.     public void serialize(Date date, JsonGenerator gen, SerializerProvider provider)  
  16.             throws IOException, JsonProcessingException {  
  17.         SimpleDateFormat sdf=new SimpleDateFormat("yyyy-MM-dd");  
  18.         String formattedDate= sdf.format(date);  
  19.         gen.writeString(formattedDate);  
  20.     }  
  21.   
  22. }  

[java]  view plain  copy
 
 在CODE上查看代碼片派生到個人代碼片
  1. package net.csdn.blog.chaijunkun.util;  
  2.   
  3. import java.io.IOException;  
  4. import java.text.SimpleDateFormat;  
  5. import java.util.Calendar;  
  6. import java.util.Date;  
  7.   
  8. import org.codehaus.jackson.JsonParser;  
  9. import org.codehaus.jackson.JsonProcessingException;  
  10. import org.codehaus.jackson.map.DeserializationContext;  
  11. import org.codehaus.jackson.map.JsonDeserializer;  
  12.   
  13. public class DateDeserializer extends JsonDeserializer<Date> {  
  14.   
  15.     @Override  
  16.     public Date deserialize(JsonParser parser, DeserializationContext context)  
  17.     throws IOException, JsonProcessingException {  
  18.         String dateFormat= "yyyy-MM-dd";  
  19.         SimpleDateFormat sdf= new SimpleDateFormat(dateFormat);  
  20.         try{  
  21.             String fieldData= parser.getText();  
  22.             return sdf.parse(fieldData);  
  23.         }catch (Exception e) {  
  24.             Calendar ca= Calendar.getInstance();  
  25.             ca.set(1970, Calendar.JANUARY, 1, 0, 0, 0);  
  26.             return ca.getTime();  
  27.         }  
  28.     }  
  29. }  

從代碼咱們能夠看出，DateTimeSerializer和DateTimeDeserializer比DateSerializer和DateDeserializer細粒度更加高，加入了具體時間的屬性。這在應用開發中是很常見的，生日信息咱們每每知道年月日就能夠了，而登錄時間每每須要得比較詳細。從實例中咱們能夠知道，即使是同一類型，經過制定不一樣的序列與反序列方法，能夠靈活地獲得咱們想要的數據形態。以上測試用例已經打包，上傳到了個人資源。歡迎你們下載，共同窗習。下載地址：http://download.csdn.net/detail/chaijunkun/4846394

 

 

2012年12月17日補充：框架

最近有一個需求，須要在序列化與反序列化對象的時候對數據進行修改，當發現數據源值爲空時須要讓生成的JSON顯示改字段爲「遊客」。但是我不管如何指定序列化器與反序列化器都無效。程序根本走不到指定的代碼中去。後來我得出結論，Jackson JSON在反序列化對象的時候，若JSON數據中對應屬性爲null，則不會走自定義的反序列化器；一樣地，當你設置對象的某個屬性值爲null時，在將其序列化成JSON時，也不會走自定義的序列化器。所以如有相似的需求，請在序列化與反序列化以前經過硬代碼形式判斷和修改，千萬不要什麼事都期望着序列化器與反序列化器。ide


參考資料：來源於國外網站的一篇介紹如何轉碼的文章，原文有點錯誤。我將其改正了，並加入了一些中文註釋：http://wiki.fasterxml.com/JacksonSampleQuoteChars學習

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程