Spring mvc JSON數(shù)據(jù)交換格式原理解析

更新時間：2020年03月19日 11:51:02 作者：黃大姐の老公

這篇文章主要介紹了Spring mvc JSON數(shù)據(jù)交換格式原理解析,文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友可以參考下

什么是JSON

JSON(JavaScript Object Notation, JS 對象標(biāo)記) 是一種輕量級的數(shù)據(jù)交換格式，目前使用特別廣泛。

采用完全獨(dú)立于編程語言的文本格式來存儲和表示數(shù)據(jù)。

簡潔和清晰的層次結(jié)構(gòu)使得 JSON 成為理想的數(shù)據(jù)交換語言。

易于人閱讀和編寫，同時也易于機(jī)器解析和生成，并有效地提升網(wǎng)絡(luò)傳輸效率。

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

對象表示為鍵值對，數(shù)據(jù)由逗號分隔
花括號保存對象
方括號保存數(shù)組

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

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

JSON 和 JavaScript 對象的關(guān)系：

JSON 是 JavaScript 對象的字符串表示法，它使用文本表示一個 JS 對象的信息，本質(zhì)是一個字符串。

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

JSON 和 JavaScript 對象互轉(zhuǎn)：

要實(shí)現(xiàn)從JSON字符串轉(zhuǎn)換為JavaScript 對象，使用 JSON.parse() 方法：

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

要實(shí)現(xiàn)從JavaScript 對象轉(zhuǎn)換為JSON字符串，使用 JSON.stringify() 方法：

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

代碼測試

在web目錄下新建一個 json-1.html ，編寫測試內(nèi)容

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>JSON_秦疆</title>
</head>
<body>

<script type="text/javascript">
//編寫一個js的對象
var user = {
 name:"黃大姐",
 age:25,
 sex:"女"
};
//將js對象轉(zhuǎn)換成json字符串
var str = JSON.stringify(user);
console.log(str);

//將json字符串轉(zhuǎn)換為js對象
var user2 = JSON.parse(str);
console.log(user2.age,user2.name,user2.sex);

</script>

</body>
</html>

在IDEA中使用瀏覽器打開，查看控制臺輸出！

Controller返回JSON數(shù)據(jù)

Jackson應(yīng)該是目前比較好的json解析工具了

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

我們這里使用Jackson，使用它需要導(dǎo)入它的jar包；

<!-- https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-core -->
<dependency>
  <groupId>com.fasterxml.jackson.core</groupId>
  <artifactId>jackson-databind</artifactId>
  <version>2.9.8</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>
    <!--通過初始化參數(shù)指定SpringMVC配置文件的位置，進(jìn)行關(guān)聯(lián)-->
    <init-param>
      <param-name>contextConfigLocation</param-name>
      <param-value>classpath:springmvc-servlet.xml</param-value>
    </init-param>
    <!-- 啟動順序，數(shù)字越小，啟動越早 -->
    <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.xiaohua.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的實(shí)體類，然后我們?nèi)ゾ帉懳覀兊臏y試Controller；

package com.kuang.pojo;

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

//需要導(dǎo)入lombok
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {

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

}

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

編寫一個Controller；

@Controller
public class UserController {

  @RequestMapping("/json1")
  @ResponseBody
  public String json1() throws JsonProcessingException {
    //創(chuàng)建一個jackson的對象映射器，用來解析數(shù)據(jù)
    ObjectMapper mapper = new ObjectMapper();
    //創(chuàng)建一個對象
    User user = new User("黃大姐", 25, "女");
    //將我們的對象解析成為json格式
    String str = mapper.writeValueAsString(user);
    //由于@ResponseBody注解，這里會將str轉(zhuǎn)成json格式返回；十分方便
    return str;
  }

}

配置Tomcat ，啟動測試一下！

發(fā)現(xiàn)出現(xiàn)了亂碼問題，我們需要設(shè)置一下他的編碼格式為utf-8，以及它返回的類型；

通過@RequestMaping的produces屬性來實(shí)現(xiàn)，修改下代碼

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

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

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

代碼優(yōu)化
亂碼統(tǒng)一解決

上一種方法比較麻煩，如果項(xiàng)目中有許多請求則每一個都要添加，可以通過Spring配置統(tǒng)一指定，這樣就不用每次都去處理了！

我們可以在springmvc的配置文件上添加一段消息StringHttpMessageConverter轉(zhuǎn)換配置！

<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字符串統(tǒng)一解決

在類上直接使用 @RestController ，這樣子，里面所有的方法都只會返回 json 字符串了，不用再每一個都添加@ResponseBody ！我們在前后端分離開發(fā)中，一般都使用 @RestController ，十分便捷！

@RestController
public class UserController {

  //produces:指定響應(yīng)體返回類型和編碼
  @RequestMapping(value = "/json1")
  public String json1() throws JsonProcessingException {
    //創(chuàng)建一個jackson的對象映射器，用來解析數(shù)據(jù)
    ObjectMapper mapper = new ObjectMapper();
    //創(chuàng)建一個對象
    User user = new User("黃大姐", 25, "女");
    //將我們的對象解析成為json格式
    String str = mapper.writeValueAsString(user);
    //由于@ResponseBody注解，這里會將str轉(zhuǎn)成json格式返回；十分方便
    return str;
  }

}

啟動tomcat測試，結(jié)果都正常輸出！

集合輸出

增加一個新的方法

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

  //創(chuàng)建一個jackson的對象映射器，用來解析數(shù)據(jù)
  ObjectMapper mapper = new ObjectMapper();
  //創(chuàng)建一個對象
  User user1 = new User("黃大姐", 25, "女");
  User user2 = new User("黃小姐", 25, "女");
  List<User> list = new ArrayList<User>();
  list.add(user1);
  list.add(user2);

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

時間對象輸出

增加一個新的方法

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

  ObjectMapper mapper = new ObjectMapper();

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

運(yùn)行結(jié)果 :

默認(rèn)日期格式會變成一個數(shù)字，是1970年1月1日到當(dāng)前日期的毫秒數(shù)！

Jackson 默認(rèn)是會把時間轉(zhuǎn)成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);

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

  return str;
}

運(yùn)行結(jié)果 : 成功的輸出了時間！

抽取為工具類

如果要經(jīng)常使用的話，這樣是比較麻煩的，我們可以將這些代碼封裝到一個工具類中；我們?nèi)ゾ帉懴?/p>

package com.xiaohua.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("/json5")
public String json5() throws JsonProcessingException {
  Date date = new Date();
  String json = JsonUtils.getJson(date);
  return json;
}

FastJson

fastjson.jar是阿里開發(fā)的一款專門用于Java開發(fā)的包，可以方便的實(shí)現(xiàn)json對象與JavaBean對象的轉(zhuǎn)換，實(shí)現(xiàn)JavaBean對象與json字符串的轉(zhuǎn)換，實(shí)現(xiàn)json對象與json字符串的轉(zhuǎn)換。實(shí)現(xiàn)json的轉(zhuǎn)換方法很多，最后的實(shí)現(xiàn)結(jié)果都是一樣的。

fastjson 的 pom依賴！

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

fastjson 三個主要的類：

【JSONObject 代表 json 對象】
- JSONObject實(shí)現(xiàn)了Map接口, 猜想 JSONObject底層操作是由Map實(shí)現(xiàn)的。
- JSONObject對應(yīng)json對象，通過各種形式的get()方法可以獲取json對象中的數(shù)據(jù)，也可利用諸如size()，isEmpty()等方法獲取"鍵：值"對的個數(shù)和判斷是否為空。其本質(zhì)是通過實(shí)現(xiàn)Map接口并調(diào)用接口中的方法完成的。
【JSONArray 代表 json 對象數(shù)組】
- 內(nèi)部是有List接口中的方法來完成操作的。
【JSON 代表 JSONObject和JSONArray的轉(zhuǎn)化】
- JSON類源碼分析與使用
- 仔細(xì)觀察這些方法，主要是實(shí)現(xiàn)json對象，json對象數(shù)組，javabean對象，json字符串之間的相互轉(zhuǎn)化。

代碼測試，我們新建一個FastJsonDemo 類

package com.xiaohua.controller;

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import com.kuang.pojo.User;

import java.util.ArrayList;
import java.util.List;

public class FastJsonDemo {
  public static void main(String[] args) {
    //創(chuàng)建一個對象
    User user1 = new User("黃大姐", 25, "女");
    User user2 = new User("黃大姐", 25, "女");
    List<User> list = new ArrayList<User>();
    list.add(user1);
    list.add(user2);

    System.out.println("*******Java對象 轉(zhuǎn) 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字符串 轉(zhuǎn) Java對象*******");
    User jp_user1=JSON.parseObject(str2,User.class);
    System.out.println("JSON.parseObject(str2,User.class)==>"+jp_user1);

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

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

以上就是本文的全部內(nèi)容，希望對大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: