Json互動處理

什麼是JSON？

JSON（JavaScript Object Notation,JS對象标記）是一種輕量級的資料交換格式，目前使用特别廣泛。
采用完全獨立于程式設計語言的文本格式來存儲和表示資料。
簡潔和清晰的層析結構使得 JSON 成為理想的資料交換語言。
易于人閱讀和編寫，同時也易于機器解析和生成，并有效地提升網絡傳輸效率。

在 JavaScript 語言中，一切都是對象。是以，任何JavaScript 支援的類型都可以通過 JSON 來表示，例如字元串、數字、對象、數組等。看看他的要求和文法格式：

對象表示為鍵值對，資料由逗号分隔
花括号儲存對象
方括号儲存數組

JSON 鍵值對是用來儲存 JavaScript 對象的一種方式，和 JavaScript 對象的寫法也大同小異，鍵/值對組合中的鍵名寫在前面并用雙引号 "" 包裹，使用冒号 : 分隔，然後緊接着值：

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

很多人搞不清楚 JSON 和 JavaScript 對象的關系，甚至連誰是誰都不清楚。其實，可以這麼了解：

JSON 是 JavaScript 對象的字元串表示法，它使用文本表示一個 JS 對象的資訊，本質是一個字元串。

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"}'

代碼測試

1、建立一個module ，springmvc-05-json ，添加web的支援

2、在web目錄下建立一個 jsontest.html ，編寫測試内容

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
    <script>
        // 編寫一個 JavaScript 對象
        var user = {
            name: "edgar",
            age: 3,
            sex: "男"
        };

        // 将 JavaScript 對象轉換為 JSON 對象
        var json = JSON.stringify(user);
        console.log(json);

        // 将 JSON 對象轉化為 JavaScript 對象
        var obj = JSON.parse(json);
        console.log(obj)
    </script>
</head>
<body>

</body>
</html>

3、在IDEA中使用浏覽器打開，檢視控制台輸出

Controller傳回JSON資料

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

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

我們這裡使用Jackson，使用它需要導入它的jar包；

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

配置SpringMVC需要的配置

web.xml

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
         version="4.0">

    <!--1.注冊servlet-->
    <servlet>
        <servlet-name>SpringMVC</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <!--通過初始化參數指定SpringMVC配置檔案的位置，進行關聯-->
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:springmvc-servlet.xml</param-value>
        </init-param>
        <!-- 啟動順序，數字越小，啟動越早 -->
        <load-on-startup>1</load-on-startup>
    </servlet>

    <!--所有請求都會被springmvc攔截 -->
    <servlet-mapping>
        <servlet-name>SpringMVC</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>

    <filter>
        <filter-name>encoding</filter-name>
        <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
        <init-param>
            <param-name>encoding</param-name>
            <param-value>utf-8</param-value>
        </init-param>
    </filter>
    <filter-mapping>
        <filter-name>encoding</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>
</web-app>

springmvc-servlet.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans.xsd
       http://www.springframework.org/schema/context
       https://www.springframework.org/schema/context/spring-context.xsd
       http://www.springframework.org/schema/mvc
       https://www.springframework.org/schema/mvc/spring-mvc.xsd">

    <!-- 自動掃描指定的包，下面所有注解類交給IOC容器管理 -->
    <context:component-scan base-package="com.edgar.controller"/>

    <!-- 視圖解析器 -->
    <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver"
          id="internalResourceViewResolver">
        <!-- 字首 -->
        <property name="prefix" value="/WEB-INF/jsp/" />
        <!-- 字尾 -->
        <property name="suffix" value=".jsp" />
    </bean>

</beans>

我們随便編寫一個User的實體類，然後我們去編寫我們的測試Controller；

package com.edgar.pojo;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

//需要導入lombok
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {

   private String name;
   private int age;
   private String sex;
   
}

這裡我們需要兩個新東西，一個是@ResponseBody，一個是ObjectMapper對象，我們看下具體的用法

編寫一個Controller；

package com.edgar.controller;

import com.edgar.pojo.User;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

@Controller
public class UserController {

    @RequestMapping("/json1")
    @ResponseBody //它就不會走視圖解析器，會直接傳回一個字元串
    public String json1() throws JsonProcessingException {
        // 建立一個jackson的對象映射器，用來解析資料
        ObjectMapper mapper = new ObjectMapper();
        // 建立一個對象
        User user = new User("超人1号", 18, "男");
        // 将我們的對象解析成為json格式的字元串
        String str = mapper.writeValueAsString(user);
        // 由于@ResponseBody注解，這裡會将str直接傳回前端；十分友善
        return str;
    }
}

配置Tomcat ，啟動測試一下！

http://localhost:8080/json1

發現出現了亂碼問題，我們需要設定一下他的編碼格式為utf-8，以及它傳回的類型；

通過@RequestMaping的produces屬性來實作，修改下代碼

//produces:指定響應體傳回類型和編碼
@RequestMapping(value = "/json1",produces = "application/json;charset=utf-8")

再次測試， http://localhost:8080/json1 ，亂碼問題OK！

【注意：使用json記得處理亂碼問題】

代碼優化

亂碼統一解決

上一種方法比較麻煩，如果項目中有許多請求則每一個都要添加，可以通過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 ，十分便捷！

package com.edgar.controller;

import com.edgar.pojo.User;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class UserController {

    @RequestMapping("/json1")
    public String json1() throws JsonProcessingException {
        // 建立一個jackson的對象映射器，用來解析資料
        ObjectMapper mapper = new ObjectMapper();
        // 建立一個對象
        User user = new User("超人1号", 18, "男");
        // 将我們的對象解析成為json格式的字元串
        String str = mapper.writeValueAsString(user);
 		// 由于@RestController注解，這裡會将str直接傳回前端；十分友善
        return str;
    }
}

啟動tomcat測試，結果都正常輸出！

測試集合輸出

增加一個新的方法

@RequestMapping("/json2")
public String json2() throws JsonProcessingException {
    ObjectMapper mapper = new ObjectMapper();
    ArrayList<User> users = new ArrayList<>();
    User user1 = new User("超人1号", 18, "男");
    User user2 = new User("超人2号", 18, "男");
    User user3 = new User("超人3号", 18, "男");
    User user4 = new User("超人4号", 18, "男");

    users.add(user1);
    users.add(user2);
    users.add(user3);
    users.add(user4);
    
    String str = mapper.writeValueAsString(users);
    return str;
}

運作結果 : 十分完美，沒有任何問題！

輸出時間對象

@RequestMapping("/json3")
public String json3() throws JsonProcessingException {
    ObjectMapper mapper = new ObjectMapper();

    // 建立時間一個對象，java.util.Date
    Date date = new Date();
    // 将我們的對象解析成為json格式
    String str = mapper.writeValueAsString(date);
    return str;
}

運作結果 :

預設日期格式會變成一個數字，是1970年1月1日到目前日期的毫秒數！
Jackson 預設是會把時間轉成timestamps形式

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

@RequestMapping("/json4")
public String json4() 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);
    // 建立時間一個對象，java.util.Date
    Date date = new Date();

    // 将我們的對象解析成為json格式
    String str = mapper.writeValueAsString(date);
    return str;
}

運作結果 : 成功的輸出了時間！

抽取為工具類

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

package com.edgar.utils;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;

import java.text.SimpleDateFormat;

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);
        try {
            return mapper.writeValueAsString(object);
        } catch (JsonProcessingException e) {
            e.printStackTrace();
        }
        return null;
    }
}

我們使用工具類，代碼就更加簡潔了！

@RequestMapping("/json3")
public String json3() throws JsonProcessingException {

    // 建立時間一個對象，java.util.Date
    Date date = new Date();

    return JsonUtils.getJson(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的轉化

JSON類源碼分析與使用
仔細觀察這些方法，主要是實作json對象，json對象數組，javabean對象，json字元串之間的互相轉化。

@RequestMapping("/json5")
public String json5() throws JsonProcessingException {
    ArrayList<User> userList = new ArrayList<>();
    User user1 = new User("超人1号", 18, "男");
    User user2 = new User("超人2号", 18, "男");
    User user3 = new User("超人3号", 18, "男");
    User user4 = new User("超人4号", 18, "男");

    userList.add(user1);
    userList.add(user2);
    userList.add(user3);
    userList.add(user4);

    System.out.println("*******Java對象 轉 JSON字元串*******");
    String str1 = JSON.toJSONString(userList);
    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);
    return JSON.toJSONString(userList);
}

這種工具類，我們隻需要掌握使用就好了，在使用的時候在根據具體的業務去找對應的實作。和以前的commons-io那種工具包一樣，拿來用就好了！

SpringMVC07：Json互動處理

Json互動處理

什麼是JSON？

Controller傳回JSON資料