SpringMVC-05 Json交互处理

Json

1.什么是JSON？

JSON(JavaScript Object Notation, JS 对象标记) 是一种轻量级的数据交换格式，目前使用特别广泛。
采用完全独立于编程语言的文本格式来存储和表示数据。
简洁和清晰的层次结构使得 JSON 成为理想的数据交换语言。
易于人阅读和编写，同时也易于机器解析和生成，并有效地提升网络传输效率。

在 JavaScript 语言中，一切都是对象。因此，任何JavaScript 支持的类型都可以通过 JSON 来表示，例如字符串、数字、对象、数组等。看看他的要求和语法格式：

对象表示为键值对，数据由逗号分隔
花括号保存对象
方括号保存数组

JSON 键值对是用来保存 JavaScript 对象的一种方式，和 JavaScript 对象的写法也大同小异，键/值对组合中的键名写在前面并用双引号 "" 包裹，使用冒号 : 分隔，然后紧接着值：

{"name": "QinJiang"}

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

2.案例测试

2.1 新建一个module ，springmvc-04-json ，添加web的支持

2.2 在web目录下新建一个 json-1.html ，编写测试内容

<!DOCTYPE html>

<html lang="en">

<head>

    <meta charset="UTF-8">

    <title>JSON</title>

</head>

<body>

<script type="text/javascript">

    //编写一个js的对象

    var user = {

        name:"zc",

        age:20,

        sex:"男"

    };

    //将js对象转换成json字符串

    var str = JSON.stringify(user);

    console.log(str);

    //将json字符串转换为js对象

    var user2 = JSON.parse(str);

    console.log(user2.name,user2.age,user2.sex);

</script>

</body>

</html>

Controller返回JSON数据

Jackson应该是目前比较好的json解析工具了

当然工具不止这一个，比如还有阿里巴巴的 fastjson 等等。

我们这里使用Jackson，使用它需要导入依赖：

<dependencies>

   <!-- 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>

</dependencies>

配置文件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">

    <servlet>

        <servlet-name>springmvc</servlet-name>

        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>

        <init-param>

            <param-name>contextConfigLocation</param-name>

            <param-value>classpath:springmvc.xml</param-value>

        </init-param>

        <load-on-startup>1</load-on-startup>

    </servlet>

    <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>

        <init-param>

            <param-name>forceEncoding</param-name>

            <param-value>true</param-value>

        </init-param>

    </filter>

    <filter-mapping>

        <filter-name>encoding</filter-name>

        <url-pattern>/*</url-pattern>

    </filter-mapping>

</web-app>

springmvc.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:content="http://www.springframework.org/schema/context"

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

    <content:component-scan base-package="Controller"/>

    <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">

        <property name="prefix" value="/jsp/"/>

        <property name="suffix" value=".jsp"/>

    </bean>

</beans>

User实体类:

public class User {

    private String name;

    private int age;

    private String sex;

    // Get/Set方法

    // toString方法

    // 无参有参方法

}

这里我们需要两个新东西，一个是@ResponseBody，一个是ObjectMapper对象，具体的用法如下：

控制类Controller：

@Controller

public class UserController {

    @RequestMapping(value = "/json1")

    @ResponseBody

    public String json1() throws JsonProcessingException {

        //创建一个jackson的对象映射器，用来解析数据

        ObjectMapper mapper = new ObjectMapper();

        //创建一个对象

        User user = new User("zc", 20, "男");

        //将我们的对象解析成为json格式

        String str = mapper.writeValueAsString(user);

        //由于@ResponseBody注解，这里会将str转成json格式返回

        return str;

    }

}

可以看到，中文换成了 ? ，出现了中文乱码

发现出现了乱码问题，我们需要设置一下他的编码格式为utf-8，以及它返回的类型；

通过@RequestMaping的produces属性来实现，修改下代码

//produces:指定响应体返回类型和编码

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

再次测试，乱码问题OK！

代码优化

1. 乱码统一解决

上一种方法比较麻烦，如果项目中有许多请求则每一个都要添加，可以通过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>

2.返回json字符串统一解决

在类上直接使用 @RestController ，这样子，里面所有的方法都只会返回 json 字符串了，不用再每一个都添加@ResponseBody ，我们在前后端分离开发中，一般都使用 @RestController ，十分便捷。

@RestController

public class UserController {

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

   public String json1() throws JsonProcessingException {

       //创建一个jackson的对象映射器，用来解析数据

       ObjectMapper mapper = new ObjectMapper();

       //创建一个对象

       User user = new User("zc",20, "男");

       //将我们的对象解析成为json格式

       String str = mapper.writeValueAsString(user);

       //由于@ResponseBody注解，这里会将str转成json格式返回；十分方便

       return str;

  }

}

启动tomcat测试，结果都正常输出。

3.输出时间对象

输出时间对象，输出结果为一串数字

@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形式，自定义时间格式

    @ResponseBody

    @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;

    }

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字符串之间的相互转化。

代码测试，我们新建一个FastJsonDemo 类

package com.kuang.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) {

       //创建一个对象

       User user1 = new User("1号", 1, "男");

       User user2 = new User("2号", 2, "女");

       User user3 = new User("3号", 3, "男");

       User user4 = new User("4号", 4, "男");

       List<User> list = new ArrayList<User>();

       list.add(user1);

       list.add(user2);

       list.add(user3);

       list.add(user4);

       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);

  }

}

这种工具类，我们只需要掌握使用就好了，在使用的时候在根据具体的业务去找对应的实现。

个人博客为：

MoYu's Github Blog

MoYu's Gitee Blog