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

本文出處：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框架允許我們自定義序列化方法。那麼我們就來寫一個序列化類：

package net.csdn.blog.chaijunkun.util;

import java.io.IOException;

import org.codehaus.jackson.JsonGenerationException;
import org.codehaus.jackson.JsonGenerator;
import org.codehaus.jackson.JsonProcessingException;
import org.codehaus.jackson.impl.JsonWriteContext;
import org.codehaus.jackson.map.JsonSerializer;
import org.codehaus.jackson.map.SerializerProvider;
import org.codehaus.jackson.util.CharTypes;

public class StringUnicodeSerializer extends JsonSerializer<String> {

	private final char[] HEX_CHARS = "0123456789ABCDEF".toCharArray();
	private final int[] ESCAPE_CODES = CharTypes.get7BitOutputEscapes();

	private void writeUnicodeEscape(JsonGenerator gen, char c) throws IOException {
		gen.writeRaw('\\');
		gen.writeRaw('u');
		gen.writeRaw(HEX_CHARS[(c >> 12) & 0xF]);
		gen.writeRaw(HEX_CHARS[(c >> 8) & 0xF]);
		gen.writeRaw(HEX_CHARS[(c >> 4) & 0xF]);
		gen.writeRaw(HEX_CHARS[c & 0xF]);
	}

	private void writeShortEscape(JsonGenerator gen, char c) throws IOException {
		gen.writeRaw('\\');
		gen.writeRaw(c);
	}

	@Override
	public void serialize(String str, JsonGenerator gen,
			SerializerProvider provider) throws IOException,
			JsonProcessingException {
		int status = ((JsonWriteContext) gen.getOutputContext()).writeValue();
	    switch (status) {
	      case JsonWriteContext.STATUS_OK_AFTER_COLON:
	        gen.writeRaw(':');
	        break;
	      case JsonWriteContext.STATUS_OK_AFTER_COMMA:
	        gen.writeRaw(',');
	        break;
	      case JsonWriteContext.STATUS_EXPECT_NAME:
	        throw new JsonGenerationException("Can not write string value here");
	    }
	    gen.writeRaw('"');//寫入JSON中字符串的開頭引號
	    for (char c : str.toCharArray()) {
	      if (c >= 0x80){
	    	  writeUnicodeEscape(gen, c); // 爲所有非ASCII字符生成轉義的unicode字符
	      }else {
	        // 爲ASCII字符中前128個字符使用轉義的unicode字符
	        int code = (c < ESCAPE_CODES.length ? ESCAPE_CODES[c] : 0);
	        if (code == 0){
	        	gen.writeRaw(c); // 此處不用轉義
	        }else if (code < 0){
	        	writeUnicodeEscape(gen, (char) (-code - 1)); // 通用轉義字符
	        }else {
	        	writeShortEscape(gen, (char) code); // 短轉義字符 (\n \t ...)
	        }
	      }
	    }
	    gen.writeRaw('"');//寫入JSON中字符串的結束引號
	}

}

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

if (objectMapper== null){
	objectMapper= new ObjectMapper();
	//當找不到對應的序列化器時 忽略此字段
	objectMapper.configure(SerializationConfig.Feature.FAIL_ON_EMPTY_BEANS, false);
	//使Jackson JSON支持Unicode編碼非ASCII字符
	CustomSerializerFactory serializerFactory= new CustomSerializerFactory();
	serializerFactory.addSpecificMapping(String.class, new StringUnicodeSerializer());
	objectMapper.setSerializerFactory(serializerFactory);
	//支持結束
}

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

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

if (objectMapper== null){
	objectMapper= new ObjectMapper();
	//當找不到對應的序列化器時 忽略此字段
	objectMapper.configure(SerializationFeature.FAIL_ON_EMPTY_BEANS, false);
	//使Jackson JSON支持Unicode編碼非ASCII字符
	SimpleModule module = new SimpleModule();
	module.addSerializer(String.class, new StringUnicodeSerializer());
	objectMapper.registerModule(module);
	//設置null值不參與序列化(字段不被顯示)
	objectMapper.setSerializationInclusion(Include.NON_NULL);
	//支持結束
}

2019年4月23日補充：今天查閱相關資料，發現在2012年1月20日的代碼中，com.fasterxml.jackson.core.JsonGenerator類中就增加了Unicode轉義的功能。在使用時只要按照如下方式配置即可：

this.objectMapper.configure(JsonGenerator.Feature.ESCAPE_NON_ASCII, true);

如果你使用的Jackson包在2.10及其以後的版本，則需要改爲如下寫法：

import com.fasterxml.jackson.core.json.JsonWriteFeature
...

this.objectMapper.configure(JsonWriteFeature.ESCAPE_NON_ASCII, true);

接下來我們來做一個測試用的對象，驗證我們的代碼：

package net.csdn.blog.chaijunkun.json;

import java.util.Date;

import net.csdn.blog.chaijunkun.util.DateDeserializer;
import net.csdn.blog.chaijunkun.util.DateSerializer;
import net.csdn.blog.chaijunkun.util.DateTimeDeserializer;
import net.csdn.blog.chaijunkun.util.DateTimeSerializer;

import org.codehaus.jackson.annotate.JsonPropertyOrder;
import org.codehaus.jackson.map.annotate.JsonDeserialize;
import org.codehaus.jackson.map.annotate.JsonSerialize;

@JsonPropertyOrder(alphabetic= false)
public class DemoObj {
	
	private Integer sid;
	
	private String stuName;
	
	private Boolean sex;
	
	@JsonSerialize(using= DateSerializer.class)
	@JsonDeserialize(using= DateDeserializer.class)
	private Date birthday;
	
	@JsonSerialize(using= DateTimeSerializer.class)
	@JsonDeserialize(using= DateTimeDeserializer.class)
	private Date logTime;

	//Getters and Setters
	
}

從代碼上可以看出，我們並沒有對String類型的屬性強制指定用何種序列與反序列方法。然後我們來構造測試用例：

package net.csdn.blog.chaijunkun.test;

import java.text.SimpleDateFormat;
import java.util.Calendar;
import java.util.Date;

import net.csdn.blog.chaijunkun.json.DemoObj;
import net.csdn.blog.chaijunkun.util.JSONUtil;

import org.apache.log4j.Logger;

public class JSONTest {
	
	private static Logger logger= Logger.getLogger(JSONTest.class);
	
	private static String json= "{\"sid\":2,\"stuName\":\"\u6C5F\u5357Style\",\"sex\":true,\"birthday\":\"2012-07-15\",\"logTime\":\"2012-12-04 19:22:36\"}";
	
	public static void main(String[] args) {
		DemoObj objSrc= new DemoObj();
		objSrc.setSid(1);
		objSrc.setStuName("鳥叔");
		objSrc.setSex(true);
		Calendar calendar= Calendar.getInstance();
		calendar.set(1977, Calendar.DECEMBER, 31, 0, 0, 0);
		objSrc.setBirthday(calendar.getTime());
		objSrc.setLogTime(new Date());
		logger.info(String.format("轉換爲JSON後的數據:%s", JSONUtil.toJSON(objSrc)));
		DemoObj objDes= JSONUtil.fromJSON(json, DemoObj.class);
		if(objDes==null){
			logger.info("反序列化失敗");
		}else{
			logger.info("反序列化成功");
			SimpleDateFormat sdf= new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
			logger.info(String.format("標識：%d", objDes.getSid()));
			logger.info(String.format("姓名：%s", objDes.getStuName()));
			logger.info(String.format("性別：%s", objDes.getSex()==true?"男":"女"));
			logger.info(String.format("生日：%s", sdf.format(objDes.getBirthday())));
			logger.info(String.format("登錄日期：%s", sdf.format(objDes.getLogTime())));
		}
	}

}

看一下輸出：

轉換爲JSON後的數據:{"sid":1,"stuName":"\u9E1F\u53D4","sex":true,"birthday":"1977-12-31","logTime":"2012-12-04 19:31:57"}
反序列化成功
標識：2
姓名：江南Style
性別：男
生日：2012-07-15 00:00:00
登錄日期：2012-12-04 19:22:36

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

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

package net.csdn.blog.chaijunkun.util;

import java.io.IOException;
import java.text.SimpleDateFormat;
import java.util.Date;

import org.codehaus.jackson.JsonGenerator;
import org.codehaus.jackson.JsonProcessingException;
import org.codehaus.jackson.map.JsonSerializer;
import org.codehaus.jackson.map.SerializerProvider;

public class DateTimeSerializer extends JsonSerializer<Date> {

	@Override
	public void serialize(Date date, JsonGenerator gen, SerializerProvider provider)
			throws IOException, JsonProcessingException {
		SimpleDateFormat sdf=new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
		String formattedDate= sdf.format(date);
		gen.writeString(formattedDate);
	}

}

package net.csdn.blog.chaijunkun.util;

import java.io.IOException;
import java.text.SimpleDateFormat;
import java.util.Calendar;
import java.util.Date;

import org.codehaus.jackson.JsonParser;
import org.codehaus.jackson.JsonProcessingException;
import org.codehaus.jackson.map.DeserializationContext;
import org.codehaus.jackson.map.JsonDeserializer;

public class DateTimeDeserializer extends JsonDeserializer<Date> {

	@Override
	public Date deserialize(JsonParser parser, DeserializationContext context)
	throws IOException, JsonProcessingException {
		String dateFormat= "yyyy-MM-dd HH:mm:ss";
		SimpleDateFormat sdf= new SimpleDateFormat(dateFormat);
		try{
			String fieldData= parser.getText();
			return sdf.parse(fieldData);
		}catch (Exception e) {
			Calendar ca= Calendar.getInstance();
			ca.set(1970, Calendar.JANUARY, 1, 0, 0, 0);
			return ca.getTime();
		}
	}
}

package net.csdn.blog.chaijunkun.util;

import java.io.IOException;
import java.text.SimpleDateFormat;
import java.util.Date;

import org.codehaus.jackson.JsonGenerator;
import org.codehaus.jackson.JsonProcessingException;
import org.codehaus.jackson.map.JsonSerializer;
import org.codehaus.jackson.map.SerializerProvider;

public class DateSerializer extends JsonSerializer<Date> {

	@Override
	public void serialize(Date date, JsonGenerator gen, SerializerProvider provider)
			throws IOException, JsonProcessingException {
		SimpleDateFormat sdf=new SimpleDateFormat("yyyy-MM-dd");
		String formattedDate= sdf.format(date);
		gen.writeString(formattedDate);
	}

}

package net.csdn.blog.chaijunkun.util;

import java.io.IOException;
import java.text.SimpleDateFormat;
import java.util.Calendar;
import java.util.Date;

import org.codehaus.jackson.JsonParser;
import org.codehaus.jackson.JsonProcessingException;
import org.codehaus.jackson.map.DeserializationContext;
import org.codehaus.jackson.map.JsonDeserializer;

public class DateDeserializer extends JsonDeserializer<Date> {

	@Override
	public Date deserialize(JsonParser parser, DeserializationContext context)
	throws IOException, JsonProcessingException {
		String dateFormat= "yyyy-MM-dd";
		SimpleDateFormat sdf= new SimpleDateFormat(dateFormat);
		try{
			String fieldData= parser.getText();
			return sdf.parse(fieldData);
		}catch (Exception e) {
			Calendar ca= Calendar.getInstance();
			ca.set(1970, Calendar.JANUARY, 1, 0, 0, 0);
			return ca.getTime();
		}
	}
}

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

2012年12月17日補充：

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

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

Jack_Chai 博客專家

發佈了68 篇原創文章 · 獲贊 252 · 訪問量 147萬+

他的留言板關注

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

Spring Cloud 部署時如何使用 Kubernetes 作爲註冊中心和配置中心

Spring MVC中基於自定義Editor的表單數據處理技巧

Tomcat 6、7在EL表達式解析時存在的一個Bug

一種基於memcache或redis緩存架構的驗證碼

爛筆頭筆記：關閉Idea自動生成變量時添加的final修飾符

Hibernate JPA中insert插入數據後自動執行select last_insert_id()解決方法

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結