【SpringMVC 筆記】Json 交互處理

什麼是 Json?

JSON（JavaScript Object Notation）

• 是一種輕量級的數據交換格式，目前使用特別廣泛。
• 採用完全獨立於編程語言的文本格式來存儲和表示數據。
• 簡潔和清晰的層次結構使得 JSON 成爲理想的數據交換語言。
• 易於人閱讀和編寫，同時也易於機器解析和生成，並有效地提升網絡傳輸效率。

Json 語法格式：

{"name": "QinJiang"}
{"age": "3"}
{"sex": "男"}

var obj = {a: 'Hello', b: 'World'}; // 這是一個對象，注意鍵名也是可以使用引號包裹的
var json = '{"a": "Hello", "b": "World"}'; // 這是一個 JSON 字符串，本質是一個字符串

JSON 和 JavaScript 對象互轉

JSON字符串 轉換爲 JavaScript 對象，使用 JSON.parse() 方法：

var obj = JSON.parse('{"a": "Hello", "b": "World"}');
// 結果是 {a: 'Hello', b: 'World'}

JavaScript 對象 轉換爲 JSON字符串，使用 JSON.stringify() 方法：

var json = JSON.stringify({a: 'Hello', b: 'World'});
// 結果是 '{"a": "Hello", "b": "World"}'

測試代碼：

// 編寫一個 js對象
var user = {
    name : "yusael",
    age : 3,
    sex : "男"
};
// 將 js對象 轉爲 json字符串
var str = JSON.stringify(user);
console.log(str);
// 將 json字符串 轉爲js對象
var userObj = JSON.parse(str);
console.log(userObj);

Jackson

Jackson 應該是目前比較好的 json 解析工具了

當然工具不止這一個，比如還有阿里巴巴的 fastjson 等等。

使用 Jackson，使用它需要導入它的 jar 包：

<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.11.0</version>
</dependency>

使用 json 注意 解決亂碼問題：用 @RequestMaping 的 produces 指定響應體返回類型和編碼。

• @RequestMapping(value = "/json", produces = "application/json;charset=utf-8")

@Controller
public class UserController {
    // 解決亂碼問題
    @RequestMapping(value = "/json", produces = "application/json;charset=utf-8")
    @ResponseBody
    public String json() throws JsonProcessingException {
        // 創建一個 jackson 的對象映射器, 用來解析數據
        ObjectMapper mapper = new ObjectMapper();
        // 創建一個對象
        User user = new User(1, "zhenyu", "男");
        // 將對象解析成 json 格式
        String str = mapper.writeValueAsString(user);
        System.out.println(str);
        // 由於@ResponseBody註解, 這裏會將 str 轉成 json 格式返回
        return str;
    }
}

統一亂碼解決

通過 @RequestMapping(value = "/json", produces = "application/json;charset=utf-8") 解決亂碼比較麻煩，如果項目中有許多請求則每一個都要添加，可以通過 Spring 配置統一指定，這樣就不用每次都去處理了。

我們可以在 springmvc 的配置文件上添加一段消息 StringHttpMessageConverter 轉換配置：

<mvc:annotation-driven>
   <mvc:message-converters register-defaults="true">
       <bean class="org.springframework.http.converter.StringHttpMessageConverter">
           <constructor-arg value="UTF-8"/>
       </bean>
       <bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
           <property name="objectMapper">
               <bean class="org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean">
                   <property name="failOnEmptyBeans" value="false"/>
               </bean>
           </property>
       </bean>
   </mvc:message-converters>
</mvc:annotation-driven>

返回 Json 字符串統一解決

在類上直接使用 @RestController，這樣子，裏面所有的方法都只會返回 Json 字符串了，不用再每一個都添加 @ResponseBody。在前後端分離開發中，一般都使用 @RestController，十分便捷。

@RestController // 使得所有方法都返回 Json 字符串
public class UserController {
   @RequestMapping(value = "/json")
    public String json() throws JsonProcessingException {
        // 創建一個 jackson 的對象映射器, 用來解析數據
        ObjectMapper mapper = new ObjectMapper();
        // 創建一個對象
        User user = new User(1, "zhenyu", "男");
        // 將對象解析成 json 格式
        String str = mapper.writeValueAsString(user);
        System.out.println(str);
        // 由於@RestController 註解, 這裏會將 str 轉成 json 格式返回;
        return str;
    }
}

Json 返回集合

@RequestMapping("/json1")
public String json2() throws JsonProcessingException {
    ObjectMapper mapper = new ObjectMapper();
    User user1 = new User(1, "Jack", "男");
    User user2 = new User(2, "Rose", "女");
    User user3 = new User(3, "Kitty", "女");
    User user4 = new User(4, "Jerry", "男");
    User user5 = new User(5, "Yusael", "男");

    List<User> users = new ArrayList<>();
    users.add(user1);
    users.add(user2);
    users.add(user3);
    users.add(user4);
    users.add(user5);

    String str = mapper.writeValueAsString(users);
    return str;
}

Json 輸出時間對象

默認日期格式是 時間戳 —— 1970年1月1日到當前日期的毫秒數。

• Jackson 默認是會把時間轉成 timestamps 形式。

@RequestMapping("/json2")
public String json2() throws JsonProcessingException {
    ObjectMapper mapper = new ObjectMapper();
    Date date = new Date();
    String str = mapper.writeValueAsString(date);
    return str;
}

解決方案：取消 timestamps 形式，自定義時間格式。

@RequestMapping("/json3")
public String json3() throws JsonProcessingException {
    ObjectMapper mapper = new ObjectMapper();
    // 設置不使用時間戳的格式
    mapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);
    // 自定義日期格式對象
    SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
    // 指定日期格式
    mapper.setDateFormat(sdf);

    Date date = new Date();
    String str = mapper.writeValueAsString(date);
    return str;
}

抽取工具類

如果要經常使用的話，這樣是比較麻煩的，我們可以將這些代碼封裝到一個工具類中；

public class JsonUtils {

    public static String getJson(Object object) {
        return getJson(object, "yyyy-MM-dd HH:mm:ss");
    }

    public static String getJson(Object object, String dateFormat) {
        ObjectMapper mapper = new ObjectMapper();
        // 不使用時間戳的方式
        mapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);
        // 自定義日期格式對象
        SimpleDateFormat sdf = new SimpleDateFormat(dateFormat);
        // 指定日期格式
        mapper.setDateFormat(sdf);
        Date date = new Date();
        try {
            return mapper.writeValueAsString(date);
        } catch (JsonProcessingException e) {
            e.printStackTrace();
        }
        return null;
    }

}

使用工具類，代碼就變得更加簡單了。

@RequestMapping("/json4")
public String json4() throws JsonProcessingException {
    ObjectMapper mapper = new ObjectMapper();
    return JsonUtils.getJson(new Date());
}

fastjson

fastjson.jar 是阿里開發的一款專門用於 Java 開發的包，可以方便的實現 json 對象與 JavaBean 對象的轉換，實現 JavaBean 對象與 Json 字符串的轉換，實現 Json 對象 與 Json字符串 的轉換。

實現 Json 的轉換方法很多，最後的實現結果都是一樣的。

fastjson 的 pom 依賴：

<dependency>
   <groupId>com.alibaba</groupId>
   <artifactId>fastjson</artifactId>
   <version>1.2.60</version>
</dependency>

fastjson 中三個主要的類：

• JSONObject 代表 Json 對象
  JSONObject 實現了 Map 接口, 猜想 JSONObject 底層操作是由 Map 實現的。
  JSONObject 對應 Json 對象，通過各種形式的 get() 方法可以獲取 Json 對象中的數據，也可利用諸如 size()，isEmpty() 等方法獲取 “鍵 : 值對” 的個數和判斷是否爲空。其本質是通過實現 Map 接口並調用接口中的方法完成的。

• JSONArray 代表 Json 對象數組
  內部是由 List 接口中的方法來完成操作的。

• JSON 代表 JSONObject 和 JSONArray 的轉化

測試代碼：

public class FastJsonDemo {
    public static void main(String[] args) {
        User user1 = new User(1, "Jack", "男");
        User user2 = new User(2, "Rose", "女");
        User user3 = new User(3, "Kitty", "女");
        User user4 = new User(4, "Jerry", "男");
        User user5 = new User(5, "Yusael", "男");
        List<User> list = new ArrayList<User>();
        list.add(user1);
        list.add(user2);
        list.add(user3);
        list.add(user4);
        list.add(user5);

        System.out.println("*******Java對象 轉 JSON字符串*******");
        String str1 = JSON.toJSONString(list);
        System.out.println("JSON.toJSONString(list) ==> " + str1);
        String str2 = JSON.toJSONString(user1);
        System.out.println("JSON.toJSONString(user1) ==> " + str2);

        System.out.println("\n****** JSON字符串 轉 Java對象*******");
        User jp_user1=JSON.parseObject(str2, User.class);
        System.out.println("JSON.parseObject(str2,User.class) ==> " + jp_user1);

        System.out.println("\n****** Java對象 轉 JSON對象 ******");
        JSONObject jsonObject1 = (JSONObject) JSON.toJSON(user2);
        System.out.println("(JSONObject) JSON.toJSON(user2) ==> " + jsonObject1.getString("name"));

        System.out.println("\n****** JSON對象 轉 Java對象 ******");
        User to_java_user = JSON.toJavaObject(jsonObject1, User.class);
        System.out.println("JSON.toJavaObject(jsonObject1, User.class) ==> " + to_java_user);
    }
    
}