JSON入门实战

JSON是行业内使用最为广泛的数据传输格式，也是所有开发人员必备的技能之一，它在很多场景都有广泛的应用，最常见的例子就是当我们开发一个手机APP时需要调用服务端的API时，大多数API是使用JSON作为返回格式，也有很多使用JSON作为数据存储的比如数据库，或者说JSON也为我们提供一种对象序列化的方式。

一、JSON基础知识

JSON是一种与开发语言无关的、轻量级的数据格式。全称JavaScript Object Notation。JSON的优点是易于人的阅读和编写，易于程序解析与生产。JSON是一种k-v的存储方式，一个简单的JSON样例：

{

“name”:”JSON入门实战”，

“author”:”davebobo”,

“content”:{“JSON基础入门”,“常用JSON处理”},

“time”:{

       “value”:30,

       “unit”:”分钟”

    }

}

标准的JSON数据表示

数据结构

Object 使用花括号来标识的对象或者称为结构体

使用花括号{}包含的键值对结构，Key必须是string类型，value为任何基本类型或数据结构。



Array 用逗号中括号来区分的数组

使用中括号[]来起始，并用逗号，来分隔元素。



基本类型

       string(字符串),number(数字类型),true,false,null(数据为空)

JSON数据演示 davebobo.json

{

       “name”:””,

       “age”,25,

“birthday”:”1990-01-01”,

“school”:”蓝翔”，

“major”:[“理发”,”挖掘机”],

“has_girlfriend”:false,

“car”:null,

“house”:null,

“comment”:”这是一个注释”

}

一、JSON在java中的使用

新建Maven项目，项目名称为json,项目结构如下



JSONObject依赖库生成JSON对象

这里我们需要首先在pom.xml中添加json的依赖

<dependency>
<groupId>org.json</groupId>
<artifactId>json</artifactId>
<version>20090211</version>
</dependency>

方式一：JSONObject put方式原生构建JSON数据

方式二：通过HashMap构建JSON数据

方式三：使用Java Bean构建对象（实际开发）

JavaBean

package bean;

public class Man {

private String name;
private String school;
private boolean has_girlfriend;
private double age;
private Object car;
private Object house;
private String[] major;
private String comment;
private String birthday;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getSchool() {
return school;
}
public void setSchool(String school) {
this.school = school;
}
public boolean isHas_girlfriend() {
return has_girlfriend;
}
public void setHas_girlfriend(boolean has_girlfriend) {
this.has_girlfriend = has_girlfriend;
}
public double getAge() {
return age;
}
public void setAge(double age) {
this.age = age;
}
public Object getCar() {
return car;
}
public void setCar(Object car) {
this.car = car;
}
public Object getHouse() {
return house;
}
public void setHouse(Object house) {
this.house = house;
}
public String[] getMajor() {
return major;
}
public void setMajor(String[] major) {
this.major = major;
}
public String getComment() {
return comment;
}
public void setComment(String comment) {
this.comment = comment;
}
public String getBirthday() {
return birthday;
}
public void setBirthday(String birthday) {
this.birthday = birthday;
}

}

JsonObjectSample类

package json;

import java.util.HashMap;
import java.util.Map;

import org.json.JSONException;
import org.json.JSONObject;

import bean.Man;

public class JsonObjectSample {

/**
* @param args
*/
public static void main(String[] args) {
// TODO Auto-generated method stub
//jSONObjectSample();
createJsonByMap();
//createJsonByBean();
}

/*
{
“name”:”davebobo”,
“age”:25.3,
“birthday”:”1990-01-01”,
“school”:”蓝翔”，
“major”:[“理发”,”挖掘机”],
“has_girlfriend”:false,
“car”:null,
“house”:null,
“comment”:”这是一个注释”
}
*/

private static void jSONObjectSample() {
// TODO Auto-generated method stub
JSONObject davebobo = new JSONObject();
Object nullObj = null;
try {
davebobo.put("name", "davebobo");
davebobo.put("age", 25.3);
davebobo.put("birthday", "1990-01-01");
davebobo.put("school", "蓝翔");
davebobo.put("major",new String[]{"理发","挖掘机"});
davebobo.put("has_girlfriend",false);
davebobo.put("car",nullObj);
davebobo.put("house", nullObj);
davebobo.put("comment", "这是一个注释");
System.out.println(davebobo.toString());
} catch (JSONException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}

private static void createJsonByMap(){
Map<String,Object> davebobo = new HashMap<String,Object>();
Object nullObj = null;
davebobo.put("name", "davebobo");
davebobo.put("age", 25.3);
davebobo.put("birthday", "1990-01-01");
davebobo.put("school", "蓝翔");
davebobo.put("major",new String[]{"理发","挖掘机"});
davebobo.put("has_girlfriend",false);
davebobo.put("car",nullObj);
davebobo.put("house", nullObj);
davebobo.put("comment", "这是一个注释");
System.out.println(new JSONObject(davebobo).toString());
}

private static void createJsonByBean(){
Man davebobo = new Man();
davebobo.setName("davebobo");
davebobo.setAge(25.3);
davebobo.setBirthday("1990-01-01");
davebobo.setSchool("蓝翔");
davebobo.setMajor(new String[]{"理发","挖掘机"});
davebobo.setHas_girlfriend(false);
davebobo.setCar(null);
davebobo.setHouse(null);
davebobo.setComment("这是一个注释");
System.out.println(new JSONObject(davebobo));
}
}

解析（文件或远程网络API）一个JSON数据

从文件中读取json，增加Apache的commons-io的依赖方便读取文件中的内容。

<dependency>
<groupId>commons-io</groupId>
<artifactId>commons-io</artifactId>
<version>2.4</version>
</dependency>

ReadJSONSample.java

package json;

import java.io.File;
import java.io.IOException;

import org.apache.commons.io.FileUtils;
import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;

public class ReadJSONSample {

/**
* @param args
* @throws IOException
* @throws JSONException
*/
public static void main(String[] args) throws IOException, JSONException {
// TODO Auto-generated method stub
File file = new File("../json Maven Webapp/src/main/java/json/davebobo.json");
String content = FileUtils.readFileToString(file);
JSONObject jsonObject = new JSONObject(content);
if(!jsonObject.isNull("name")){
System.out.println("姓名是："+jsonObject.getString("name"));
}
if(!jsonObject.isNull("nickname")){
System.out.println("姓名是："+jsonObject.getString("nickname"));
}
System.out.println("年龄是："+jsonObject.getDouble("age"));
System.out.println("有没有女朋友？"+jsonObject.getBoolean("has_girlfriend"));
JSONArray majorArray = jsonObject.getJSONArray("major");
for(int i =0;i<majorArray.length();i++){
String m = (String)majorArray.get(i);
System.out.println("专业"+(i+1)+":"+m);
}
}
}

运行结果：



缺陷：

没有日期格式

可以使用JavaBean生成JSON数据但是不能反解析回来

三、GSON的使用

比JSON功能更加强大，性能更加出色，同时在使用的方式上更加便捷和简单。

GSON生成JSON数据

首先在pom.xml中加入依赖：

<dependency>
<groupId>com.google.code.gson</groupId>
<artifactId>gson</artifactId>
<version>2.4</version>
</dependency>

GsonCreateSample.java生成JSON数据

package gson;

import java.lang.reflect.Field;

import bean.Man;

import com.google.gson.FieldNamingStrategy;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;

public class GsonCreateSample {

/**
* @param args
*/
public static void main(String[] args) {
// TODO Auto-generated method stub
Man davebobo = new Man();
davebobo.setName("davebobo");
davebobo.setAge(25.3);
davebobo.setBirthday("1990-01-01");
davebobo.setSchool("蓝翔");
davebobo.setMajor(new String[]{"理发","挖掘机"});
davebobo.setHas_girlfriend(false);
davebobo.setCar(null);
davebobo.setHouse(null);
davebobo.setComment("这是一个注释");
davebobo.setIgnore("不要看见我");

GsonBuilder gsonBuilder = new GsonBuilder();
gsonBuilder.setPrettyPrinting();
gsonBuilder.setFieldNamingStrategy(new FieldNamingStrategy(){

@Override
public String translateName(Field f) {
// TODO Auto-generated method stub
if(f.getName().equals("name")){
return "NAME";
}
return f.getName();
}
});
Gson gson = gsonBuilder.create();
System.out.println(gson.toJson(davebobo));
}
}

运行结果：



知识点：

（1）@SerializedName(“NAME”) 将JavaBean的name值设置为大写

（2）transient关键字将JavaBean的属性设置为不可见

GSON解析

GsonReadSample.java

package gson;

import java.io.File;
import java.io.IOException;

import org.apache.commons.io.FileUtils;

import bean.Man;
import bean.ManWithBirthday;

import com.google.gson.Gson;
import com.google.gson.GsonBuilder;

public class GsonReadSample {

/**
* @param args
* @throws IOException
*/
public static void main(String[] args) throws IOException {
// TODO Auto-generated method stub
File file = new File("../json Maven Webapp/src/main/java/json/davebobo.json");
String content = FileUtils.readFileToString(file);

Gson gson = new GsonBuilder().setDateFormat("yyyy-MM-dd").create();
ManWithBirthday davebobo = gson.fromJson(content,ManWithBirthday.class);
System.out.println(davebobo.getBirthday().toLocaleString());

System.out.println(davebobo.getMajor());
System.out.println(davebobo.getMajor().getClass());
}

}
运行结果：



优点：

（1）   支持正向生成和反向解析

（2）   支持带日期的转换

（3）   集合类解析

总结：

JSON:

JSON是Android SDK官方的库，在开发移动端程序时势必要使用JSONObject进行数据的转换和生成。

GSON:

GSON适用于服务端开发，GSON比JSON更强大比如集合类的处理或者自定义一些属性。

关于JSON库的总结

功能:映射Java Object与json格式数据

1.     通过Annotation注解来声明

2.     支持自定义属性名称

3.     支持包含或排除属性

4.     支持自定义接口自己完成解析/生成过程

Refrence:

http://json.org/

http://www.bejson.com/jsoneditoronline/

https://github.com/google/gson