gson入门示例
项目介绍:GSON
Gson是Google的一个开源项目，可以将Java对象转换成JSON，也可能将JSON转换成Java对象。
Gson支持任意复杂Java对象包括没有源代码的对象.
Gson有2个最基本的方法
1) toJson() – 转换java 对象到JSON
2) fromJson() – 转换JSON到java对象
1 gson下载包: http://code.google.com/p/google-gson
2 参考资料:
http://wangcheng.iteye.com/blog/550831
http://blog.csdn.net/vba_2001/archive/2010/06/25/5695118.aspx
http://www.oschina.net/code/snippet_1611_611
http://www.cnblogs.com/yueue/archive/2010/04/21/1717317.html
3 环境:XP+Myeclipse6.6+JDK1.5+google-gson-1.5
4 代码示例
A 带注解的JavaBean
B 没有注解的JavaBean
C JSONUtils源于: http://www.oschina.net/code/snippet_1611_611
D 测试类代码
E 工程见附件中:Gson-demo.rar
google-gson-1.5-release.zip 为GSON的发布包
Gson是Google的一个开源项目，可以将Java对象转换成JSON，也可能将JSON转换成Java对象。
Gson支持任意复杂Java对象包括没有源代码的对象.
Gson有2个最基本的方法
1) toJson() – 转换java 对象到JSON
2) fromJson() – 转换JSON到java对象
1 gson下载包: http://code.google.com/p/google-gson
2 参考资料:
http://wangcheng.iteye.com/blog/550831
http://blog.csdn.net/vba_2001/archive/2010/06/25/5695118.aspx
http://www.oschina.net/code/snippet_1611_611
http://www.cnblogs.com/yueue/archive/2010/04/21/1717317.html
3 环境:XP+Myeclipse6.6+JDK1.5+google-gson-1.5
4 代码示例
A 带注解的JavaBean
public class User {
@SerializedName("pwd")
private String password;
@Expose
@SerializedName("uname")
private String username;
@Expose
@Since(1.1)
private String gender;
@Expose
@Since(1.0)
private String sex;
//省略get,set方法
}
B 没有注解的JavaBean
public class User2 {
private String name = null;
private int age = 0;
private boolean sex = false;
//省略get,set方法
}
C JSONUtils源于: http://www.oschina.net/code/snippet_1611_611
import java.lang.reflect.Type;
import java.util.Collection;
import java.util.Enumeration;
import java.util.Iterator;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.google.gson.reflect.TypeToken;
import org.apache.commons.lang.StringUtils;
/**
* 包含操作 {@code JSON} 数据的常用方法的工具类。
* <p />
* 该工具类使用的 {@code JSON} 转换引擎是 <a href="http://code.google.com/p/google-gson/"
* mce_href="http://code.google.com/p/google-gson/" target="_blank">
* {@code Google Gson}</a>。 下面是工具类的使用案例：
* @author Fuchun
* @since ay-commons-lang 1.0
* @version 1.1.0
*/
public class JSONUtils {
private static final Logger LOGGER = LoggerFactory.getLogger(JSONUtils.class);
/** 空的 {@code JSON} 数据 - <code>"{}"</code>。 */
public static final String EMPTY_JSON = "{}";
/** 空的 {@code JSON} 数组(集合)数据 - {@code "[]"}。 */
public static final String EMPTY_JSON_ARRAY = "[]";
/** 默认的 {@code JSON} 日期/时间字段的格式化模式。 */
public static final String DEFAULT_DATE_PATTERN = "yyyy-MM-dd HH:mm:ss SSS";
/**
* {@code Google Gson} 的 <code>@Since</code> 注解常用的版本号常量 - {@code 1.0}。
*/
public static final double SINCE_VERSION_10 = 1.0d;
/**
* {@code Google Gson} 的 <code>@Since</code> 注解常用的版本号常量 - {@code 1.1}。
*/
public static final double SINCE_VERSION_11 = 1.1d;
/**
* {@code Google Gson} 的 <code>@Since</code> 注解常用的版本号常量 - {@code 1.2}。
*/
public static final double SINCE_VERSION_12 = 1.2d;
/**
* {@code Google Gson} 的 <code>@Until</code> 注解常用的版本号常量 - {@code 1.0}。
*/
public static final double UNTIL_VERSION_10 = SINCE_VERSION_10;
/**
* {@code Google Gson} 的 <code>@Until</code> 注解常用的版本号常量 - {@code 1.1}。
*/
public static final double UNTIL_VERSION_11 = SINCE_VERSION_11;
/**
* {@code Google Gson} 的 <code>@Until</code> 注解常用的版本号常量 - {@code 1.2}。
*/
public static final double UNTIL_VERSION_12 = SINCE_VERSION_12;
/**
* <p>
* <code>JSONUtils</code> instances should NOT be constructed in standard
* programming. Instead, the class should be used as
* <code>JSONUtils.fromJson("foo");</code>.
* </p>
* <p>
* This constructor is public to permit tools that require a JavaBean
* instance to operate.
* </p>
*/
public JSONUtils() {
super();
}
/**
* 将给定的目标对象根据指定的条件参数转换成 {@code JSON} 格式的字符串。
* <p />
* <strong>该方法转换发生错误时，不会抛出任何异常。若发生错误时，曾通对象返回 <code>"{}"</code>； 集合或数组对象返回
* <code>"[]"</code> </strong>
*
* @param target
* 目标对象。
* @param targetType
* 目标对象的类型。
* @param isSerializeNulls
* 是否序列化 {@code null} 值字段。
* @param version
* 字段的版本号注解。
* @param datePattern
* 日期字段的格式化模式。
* @param excludesFieldsWithoutExpose
* 是否排除未标注 {@literal @Expose} 注解的字段。
* @return 目标对象的 {@code JSON} 格式的字符串。
* @since 1.0
*/
public static String toJson(Object target, Type targetType,boolean isSerializeNulls, Double version, String datePattern,
boolean excludesFieldsWithoutExpose) {
if (target == null)
return EMPTY_JSON;
GsonBuilder builder = new GsonBuilder();
if (isSerializeNulls)
builder.serializeNulls();
if (version != null)
builder.setVersion(version.doubleValue());
if (StringUtils.isBlank(datePattern))
datePattern = DEFAULT_DATE_PATTERN;
builder.setDateFormat(datePattern);
if (excludesFieldsWithoutExpose)
builder.excludeFieldsWithoutExposeAnnotation();
return toJson(target, targetType, builder);
}
/**
* 将给定的目标对象转换成 {@code JSON} 格式的字符串。<strong>此方法只用来转换普通的 {@code JavaBean} 对象。</strong>
* <ul>
* <li>该方法只会转换标有 {@literal @Expose} 注解的字段；</li>
* <li>该方法不会转换 {@code null} 值字段；</li>
* <li>该方法会转换所有未标注或已标注 {@literal @Since} 的字段；</li>
* <li>该方法转换时使用默认的 日期/时间 格式化模式 - {@code yyyy-MM-dd HH:mm:ss SSS}；</li>
* </ul>
*
* @param target
* 要转换成 {@code JSON} 的目标对象。
* @return 目标对象的 {@code JSON} 格式的字符串。
* @since 1.0
*/
public static String toJson(Object target) {
return toJson(target, null, false, null, null, true);
}
/**
* 将给定的目标对象转换成 {@code JSON} 格式的字符串。<strong>此方法只用来转换普通的 {@code JavaBean} 对象。</strong>
* <ul>
* <li>该方法只会转换标有 {@literal @Expose} 注解的字段；</li>
* <li>该方法不会转换 {@code null} 值字段；</li>
* <li>该方法会转换所有未标注或已标注 {@literal @Since} 的字段；</li>
* </ul>
*
* @param target
* 要转换成 {@code JSON} 的目标对象。
* @param datePattern
* 日期字段的格式化模式。
* @return 目标对象的 {@code JSON} 格式的字符串。
* @since 1.0
*/
public static String toJson(Object target, String datePattern) {
return toJson(target, null, false, null, datePattern, true);
}
/**
* 将给定的目标对象转换成 {@code JSON} 格式的字符串。<strong>此方法只用来转换普通的 {@code JavaBean} 对象。</strong>
* <ul>
* <li>该方法只会转换标有 {@literal @Expose} 注解的字段；</li>
* <li>该方法不会转换 {@code null} 值字段；</li>
* <li>该方法转换时使用默认的 日期/时间 格式化模式 - {@code yyyy-MM-dd HH:mm:ss SSS}；</li>
* </ul>
*
* @param target
* 要转换成 {@code JSON} 的目标对象。
* @param version
* 字段的版本号注解({@literal @Since})。
* @return 目标对象的 {@code JSON} 格式的字符串。
* @since 1.0
*/
public static String toJson(Object target, Double version) {
return toJson(target, null, false, version, null, true);
}
/**
* 将给定的目标对象转换成 {@code JSON} 格式的字符串。<strong>此方法只用来转换普通的 {@code JavaBean} 对象。</strong>
* <ul>
* <li>该方法不会转换 {@code null} 值字段；</li>
* <li>该方法会转换所有未标注或已标注 {@literal @Since} 的字段；</li>
* <li>该方法转换时使用默认的 日期/时间 格式化模式 - {@code yyyy-MM-dd HH:mm:ss SSS}；</li>
* </ul>
*
* @param target
* 要转换成 {@code JSON} 的目标对象。
* @param excludesFieldsWithoutExpose
* 是否排除未标注 {@literal @Expose} 注解的字段。
* @return 目标对象的 {@code JSON} 格式的字符串。
* @since 1.0
*/
public static String toJson(Object target,
boolean excludesFieldsWithoutExpose) {
return toJson(target, null, false, null, null,
excludesFieldsWithoutExpose);
}
/**
* 将给定的目标对象转换成 {@code JSON} 格式的字符串。<strong>此方法只用来转换普通的 {@code JavaBean} 对象。</strong>
* <ul>
* <li>该方法不会转换 {@code null} 值字段；</li>
* <li>该方法转换时使用默认的 日期/时间 格式化模式 - {@code yyyy-MM-dd HH:mm:ss SSS}；</li>
* </ul>
*
* @param target
* 要转换成 {@code JSON} 的目标对象。
* @param version
* 字段的版本号注解({@literal @Since})。
* @param excludesFieldsWithoutExpose
* 是否排除未标注 {@literal @Expose} 注解的字段。
* @return 目标对象的 {@code JSON} 格式的字符串。
* @since 1.0
*/
public static String toJson(Object target, Double version,
boolean excludesFieldsWithoutExpose) {
return toJson(target, null, false, version, null,
excludesFieldsWithoutExpose);
}
/**
* 将给定的目标对象转换成 {@code JSON} 格式的字符串。<strong>此方法通常用来转换使用泛型的对象。</strong>
* <ul>
* <li>该方法只会转换标有 {@literal @Expose} 注解的字段；</li>
* <li>该方法不会转换 {@code null} 值字段；</li>
* <li>该方法会转换所有未标注或已标注 {@literal @Since} 的字段；</li>
* <li>该方法转换时使用默认的 日期/时间 格式化模式 - {@code yyyy-MM-dd HH:mm:ss SSSS}；</li>
* </ul>
*
* @param target
* 要转换成 {@code JSON} 的目标对象。
* @param targetType
* 目标对象的类型。
* @return 目标对象的 {@code JSON} 格式的字符串。
* @since 1.0
*/
public static String toJson(Object target, Type targetType) {
return toJson(target, targetType, false, null, null, true);
}
/**
* 将给定的目标对象转换成 {@code JSON} 格式的字符串。<strong>此方法通常用来转换使用泛型的对象。</strong>
* <ul>
* <li>该方法只会转换标有 {@literal @Expose} 注解的字段；</li>
* <li>该方法不会转换 {@code null} 值字段；</li>
* <li>该方法转换时使用默认的 日期/时间 格式化模式 - {@code yyyy-MM-dd HH:mm:ss SSSS}；</li>
* </ul>
*
* @param target
* 要转换成 {@code JSON} 的目标对象。
* @param targetType
* 目标对象的类型。
* @param version
* 字段的版本号注解({@literal @Since})。
* @return 目标对象的 {@code JSON} 格式的字符串。
* @since 1.0
*/
public static String toJson(Object target, Type targetType, Double version) {
return toJson(target, targetType, false, version, null, true);
}
/**
* 将给定的目标对象转换成 {@code JSON} 格式的字符串。<strong>此方法通常用来转换使用泛型的对象。</strong>
* <ul>
* <li>该方法不会转换 {@code null} 值字段；</li>
* <li>该方法会转换所有未标注或已标注 {@literal @Since} 的字段；</li>
* <li>该方法转换时使用默认的 日期/时间 格式化模式 - {@code yyyy-MM-dd HH:mm:ss SSS}；</li>
* </ul>
*
* @param target
* 要转换成 {@code JSON} 的目标对象。
* @param targetType
* 目标对象的类型。
* @param excludesFieldsWithoutExpose
* 是否排除未标注 {@literal @Expose} 注解的字段。
* @return 目标对象的 {@code JSON} 格式的字符串。
* @since 1.0
*/
public static String toJson(Object target, Type targetType,
boolean excludesFieldsWithoutExpose) {
return toJson(target, targetType, false, null, null,
excludesFieldsWithoutExpose);
}
/**
* 将给定的目标对象转换成 {@code JSON} 格式的字符串。<strong>此方法通常用来转换使用泛型的对象。</strong>
* <ul>
* <li>该方法不会转换 {@code null} 值字段；</li>
* <li>该方法转换时使用默认的 日期/时间 格式化模式 - {@code yyyy-MM-dd HH:mm:ss SSS}；</li>
* </ul>
*
* @param target
* 要转换成 {@code JSON} 的目标对象。
* @param targetType
* 目标对象的类型。
* @param version
* 字段的版本号注解({@literal @Since})。
* @param excludesFieldsWithoutExpose
* 是否排除未标注 {@literal @Expose} 注解的字段。
* @return 目标对象的 {@code JSON} 格式的字符串。
* @since 1.0
*/
public static String toJson(Object target, Type targetType, Double version,
boolean excludesFieldsWithoutExpose) {
return toJson(target, targetType, false, version, null,
excludesFieldsWithoutExpose);
}
/**
* 将给定的 {@code JSON} 字符串转换成指定的类型对象。
*
* @param <T>
* 要转换的目标类型。
* @param json
* 给定的 {@code JSON} 字符串。
* @param token
* {@code com.google.gson.reflect.TypeToken} 的类型指示类对象。
* @param datePattern
* 日期格式模式。
* @return 给定的 {@code JSON} 字符串表示的指定的类型对象。
* @since 1.0
*/
public static <T> T fromJson(String json, TypeToken<T> token,
String datePattern) {
if (StringUtils.isBlank(json)) {
return null;
}
GsonBuilder builder = new GsonBuilder();
if (StringUtils.isBlank(datePattern)) {
datePattern = DEFAULT_DATE_PATTERN;
}
Gson gson = builder.create();
try {
return gson.fromJson(json, token.getType());
} catch (Exception ex) {
LOGGER.error(json + " 无法转换为 " + token.getRawType().getName()
+ " 对象!", ex);
return null;
}
}
/**
* 将给定的 {@code JSON} 字符串转换成指定的类型对象。
*
* @param <T>
* 要转换的目标类型。
* @param json
* 给定的 {@code JSON} 字符串。
* @param token
* {@code com.google.gson.reflect.TypeToken} 的类型指示类对象。
* @return 给定的 {@code JSON} 字符串表示的指定的类型对象。
* @since 1.0
*/
public static <T> T fromJson(String json, TypeToken<T> token) {
return fromJson(json, token, null);
}
/**
* 将给定的 {@code JSON} 字符串转换成指定的类型对象。<strong>此方法通常用来转换普通的 {@code JavaBean}
* 对象。</strong>
*
* @param <T>
* 要转换的目标类型。
* @param json
* 给定的 {@code JSON} 字符串。
* @param clazz
* 要转换的目标类。
* @param datePattern
* 日期格式模式。
* @return 给定的 {@code JSON} 字符串表示的指定的类型对象。
* @since 1.0
*/
public static <T> T fromJson(String json, Class<T> clazz, String datePattern) {
if (StringUtils.isBlank(json)) {
return null;
}
GsonBuilder builder = new GsonBuilder();
if (StringUtils.isBlank(datePattern)) {
datePattern = DEFAULT_DATE_PATTERN;
}
Gson gson = builder.create();
try {
return gson.fromJson(json, clazz);
} catch (Exception ex) {
LOGGER.error(json + " 无法转换为 " + clazz.getName() + " 对象!", ex);
return null;
}
}
/**
* 将给定的 {@code JSON} 字符串转换成指定的类型对象。<strong>此方法通常用来转换普通的 {@code JavaBean}
* 对象。</strong>
*
* @param <T>
* 要转换的目标类型。
* @param json
* 给定的 {@code JSON} 字符串。
* @param clazz
* 要转换的目标类。
* @return 给定的 {@code JSON} 字符串表示的指定的类型对象。
* @since 1.0
*/
public static <T> T fromJson(String json, Class<T> clazz) {
return fromJson(json, clazz, null);
}
/**
* 将给定的目标对象根据{@code GsonBuilder} 所指定的条件参数转换成 {@code JSON} 格式的字符串。
* <p />
* 该方法转换发生错误时，不会抛出任何异常。若发生错误时，{@code JavaBean} 对象返回 <code>"{}"</code>；
* 集合或数组对象返回 <code>"[]"</code>。 其本基本类型，返回相应的基本值。
*
* @param target
* 目标对象。
* @param targetType
* 目标对象的类型。
* @param builder
* 可定制的{@code Gson} 构建器。
* @return 目标对象的 {@code JSON} 格式的字符串。
* @since 1.1
*/
public static String toJson(Object target, Type targetType,
GsonBuilder builder) {
if (target == null)
return EMPTY_JSON;
Gson gson = null;
if (builder == null) {
gson = new Gson();
} else {
gson = builder.create();
}
String result = EMPTY_JSON;
try {
if (targetType == null) {
result = gson.toJson(target);
} else {
result = gson.toJson(target, targetType);
}
} catch (Exception ex) {
LOGGER.warn("目标对象 " + target.getClass().getName()
+ " 转换 JSON 字符串时，发生异常！", ex);
if (target instanceof Collection<?>
|| target instanceof Iterator<?>
|| target instanceof Enumeration<?>
|| target.getClass().isArray()) {
result = EMPTY_JSON_ARRAY;
}
}
return result;
}
}
D 测试类代码
import java.lang.reflect.Type;
import java.util.LinkedList;
import java.util.List;
import com.google.gson.Gson;
import com.google.gson.reflect.TypeToken;
public class JSONTest {
public static void main(String[] args) {
//jsonToObject();
//objectToJson2();
objectToJson();
}
static void objectToJson() {
//不使用注解的方式
List<User2> userList = new LinkedList<User2>();
userList.add(new User2("david", 34, true));
userList.add(new User2("jack", 31, false));
Type targetType = new TypeToken<List<User2>>(){}.getType();
//sUserList1: [{},{}]
String sUserList1 = JSONUtils.toJson(userList, targetType);
System.out.println("sUserList1: " + sUserList1);
//sUserList2: [{"id":23,"name":"david","age":34,"sex":true},{"id":21,"name":"jack","age":31,"sex":false}]
String sUserList2 = JSONUtils.toJson(userList, targetType, false);
System.out.println("sUserList2: " + sUserList2);
//sUserList3: [{},{}]
String sUserList3 = JSONUtils.toJson(userList, targetType, 1.0d, true);
System.out.println("sUserList3: " + sUserList3);
//原生GSON方式
Gson gson = new Gson();
sUserList1 = gson.toJson(userList, targetType);
System.out.println("sUserList-gson: " + sUserList1);
}
static void objectToJson2() {
//使用注解的方式提取
List<User> userList = new LinkedList<User>();
User jack = new User("Jack", "123456", "Male","Female");
User marry = new User("Marry", "888888", "Female","Male");
userList.add(jack);
userList.add(marry);
Type targetType = new TypeToken<List<User>>() {}.getType();
String sUserList1 = JSONUtils.toJson(userList, targetType);
System.out.println("sUserList1: " + sUserList1);
// sUserList1 ----> [{"uname":"jack","gender":"Male","sex":"Male"},{"uname":"marry","gender":"Female","sex":"Female"}]
String sUserList2 = JSONUtils.toJson(userList, targetType, false);
System.out.println("sUserList2: " + sUserList2);
// sUserList2 ----> [{"uname":"jack","pwd":"123456","gender":"Male","sex":"Male"},{"uname":"marry","pwd":"888888","gender":"Female","sex":"Female"}]
String sUserList3 = JSONUtils.toJson(userList, targetType, 1.0d, true);
System.out.println("sUserList3: " + sUserList3);
// sUserList3 ----> [{"uname":"jack","sex":"Male"},{"uname":"marry","sex":"Female"}]
//原生GSON方式
Gson gson = new Gson();
sUserList1 = gson.toJson(userList, targetType);
System.out.println("sUserList-gson: " + sUserList1);
}
@SuppressWarnings("unchecked")
static void jsonToObject() {
/**
* sUserList1: [{"uname":"123456","gender":"Male","sex":"Female"},{"uname":"888888","gender":"Female","sex":"Male"}]
sUserList2: [{"pwd":"Jack","uname":"123456","gender":"Male","sex":"Female"},{"pwd":"Marry","uname":"888888","gender":"Female","sex":"Male"}]
sUserList3: [{"uname":"123456","sex":"Female"},{"uname":"888888","sex":"Male"}]
* */
List<User> userList = new LinkedList<User>();
User jack = new User("123456","Jack", "Male","Female");
User marry = new User("888888","Marry", "Female","Male");
userList.add(jack);
userList.add(marry);
Type targetType = new TypeToken<List<User>>() {}.getType();
String sUserList2 = JSONUtils.toJson(userList, targetType, false);
//使用了注解的方式提取:List,它会优化提取注解名称
String json = sUserList2;// "[{pwd:'223232323',uname:'jack',gender:'Male',sex:'Male'},{pwd:'5757567',uname:'marry',gender:'Female',sex:'Female'}]";
List<User> users = JSONUtils.fromJson(json, new TypeToken<List<User>>(){});
for(User user : users){
System.out.println("user: "+user);
}
System.out.println("============================");
//直接提取:List
json = "[{name:'jack',age:18,sex:true},{name:'david',age:24,sex:false}]";
List<User2> users2 = JSONUtils.fromJson(json, new TypeToken<List<User2>>(){});
for(User2 user : users2){
System.out.println("user: "+user);
}
//使用了注解的方式提取:User
System.out.println("============================");
json = "{pwd:'6666666',uname:'david',gender:'Male',sex:'Male'}";
User user = JSONUtils.fromJson(json, User.class);
System.out.println("user: "+user);
//直接提取:User
System.out.println("============================");
json = "{name:'jack',age:18,sex:true}";
User2 user2 = JSONUtils.fromJson(json, User2.class);
System.out.println("user: "+user2);
//原生GSON方式
Gson gson = new Gson();
sUserList2 = "[{pwd:'Jack',uname:'123456',gender:'Male',sex:'Female'},{pwd:'Marry',uname:'888888',gender:'Female',sex:'Male'}]";
List<User> users3 = gson.fromJson(sUserList2,targetType);
for(User user3_1 : users3){
System.out.println("原生方式: "+user3_1);
}
List<User2> userList4 = new LinkedList<User2>();
userList4.add(new User2("david", 34, true));
userList4.add(new User2("jack", 31, false));
Type targetType4 = new TypeToken<List<User2>>(){}.getType();
sUserList2 = gson.toJson(userList4, targetType4);
List<User2> users4 = gson.fromJson(sUserList2,targetType4);
for(User2 user4_1 : users4){
System.out.println("原生方式2: "+user4_1);
}
}
}
E 工程见附件中:Gson-demo.rar
google-gson-1.5-release.zip 为GSON的发布包