• 7、SpringMVC:JSON讲解


    引用学习

    什么是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 字符串,本质是一个字符串

    SON 和 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目录下新建一个 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:"秦疆",
       age:3,
       sex:""
      };
      //将js对象转换成json字符串
      var str = JSON.stringify(user);
      console.log(str);
      ​
      //将json字符串转换为js对象
      var user2 = JSON.parse(str);
      console.log(user2.age,user2.name,user2.sex);
      ​
      </script></body>
      </html>
    3. 在IDEA中使用浏览器打开,查看控制台输出!

    Controller返回JSON数据

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

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

    我们这里使用Jackson,使用它需要导入它的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>
            <!--通过初始化参数指定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.kuang.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.kuang.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

    @Controller
    public class UserController {
    
        @RequestMapping("/json1")
        @ResponseBody
        public String json1() throws JsonProcessingException {
            //创建一个jackson的对象映射器,用来解析数据
            ObjectMapper mapper = new ObjectMapper();
            //创建一个对象
            User user = new User("秦疆1号", 3, "男");
            //将我们的对象解析成为json格式
            String str = mapper.writeValueAsString(user);
            //由于@ResponseBody注解,这里会将str转成json格式返回;十分方便
            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 ,十分便捷!

    @RestController
    public class UserController {
    
        //produces:指定响应体返回类型和编码
        @RequestMapping(value = "/json1")
        public String json1() throws JsonProcessingException {
            //创建一个jackson的对象映射器,用来解析数据
            ObjectMapper mapper = new ObjectMapper();
            //创建一个对象
            User user = new User("秦疆1号", 3, "男");
            //将我们的对象解析成为json格式
            String str = mapper.writeValueAsString(user);
            //由于@ResponseBody注解,这里会将str转成json格式返回;十分方便
            return str;
        }
    
    }

    启动tomcat测试,结果都正常输出!

    JackSon使用

    测试集合输出

    增加一个新的方法

    @RequestMapping("/json2")
    public String json2() throws JsonProcessingException {
    
        //创建一个jackson的对象映射器,用来解析数据
        ObjectMapper mapper = new ObjectMapper();
        //创建一个对象
        User user1 = new User("秦疆1号", 3, "男");
        User user2 = new User("秦疆2号", 3, "男");
        User user3 = new User("秦疆3号", 3, "男");
        User user4 = new User("秦疆4号", 3, "男");
        List<User> list = new ArrayList<User>();
        list.add(user1);
        list.add(user2);
        list.add(user3);
        list.add(user4);
    
        //将我们的对象解析成为json格式
        String str = mapper.writeValueAsString(list);
        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);
    
        Date date = new Date();
        String str = mapper.writeValueAsString(date);
    
        return str;
    }

    运行结果 : 成功的输出了时间!

    抽取为工具类

    如果要经常使用的话,这样是比较麻烦的,我们可以将这些代码封装到一个工具类中;我们去编写下

    package com.kuang.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;
    }

    大工告成!完美!

    3、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号", 3, "男");
            User user2 = new User("秦疆2号", 3, "男");
            User user3 = new User("秦疆3号", 3, "男");
            User user4 = new User("秦疆4号", 3, "男");
            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("
    ****** JSON字符串 转 Java对象*******");
            User jp_user1=JSON.parseObject(str2,User.class);
            System.out.println("JSON.parseObject(str2,User.class)==>"+jp_user1);
    
            System.out.println("
    ****** Java对象 转 JSON对象 ******");
            JSONObject jsonObject1 = (JSONObject) JSON.toJSON(user2);
            System.out.println("(JSONObject) JSON.toJSON(user2)==>"+jsonObject1.getString("name"));
    
            System.out.println("
    ****** JSON对象 转 Java对象 ******");
            User to_java_user = JSON.toJavaObject(jsonObject1, User.class);
            System.out.println("JSON.toJavaObject(jsonObject1, User.class)==>"+to_java_user);
        }
    }

    乱码解决

    <mvc:annotation-driven>
        <mvc:message-converters>
            <bean class="org.springframework.http.converter.StringHttpMessageConverter">
                <property name="supportedMediaTypes">
                    <list>
                        <value>application/json;charset=UTF-8</value>
                    </list>
                </property>
            </bean>
        </mvc:message-converters>
    </mvc:annotation-driven>

    这种工具类,我们只需要掌握使用就好了,在使用的时候在根据具体的业务去找对应的实现。和以前的commons-io那种工具包一样,拿来用就好了!

    要点

    控制器中的两种类注解的

    • @Controller //Controller和ResponseBody配合使用,只定义某个方法

    • @RestController //设置所有方法不经过视图解析器,直接返回字符串

    //@Controller   //Controller和ResponseBody配合使用,只定义某个方法
    @RestController //设置所有方法不经过视图解析器,直接返回字符串
    public class UserController {
    
    //        @RequestMapping(value = "/t1", produces = "application/json;charset=utf-8")
        @RequestMapping("j1")
    //        @ResponseBody   // 设置不经过视图解析器,会直接返回一个字符串
        public String test1() throws JsonProcessingException {
            //创建一个Jackson的对象映射器,来解析数据
            ObjectMapper mapper = new ObjectMapper();
            //创建一个对象
            User user = new User(1, "老王", 10);
            //将我们的对象解析称为json格式
            String str = mapper.writeValueAsString(user);
            //由于ResponseBosy注解,会将转换后的字符串返回,十分方便
            return str;
        }
    }

    Jackson使用总结

    1、首先导入Jackson的jar包

    2、在SpringMVC的配置文件中配置解决Json对象返回时乱码的方法

    3、在控制器中使用

    • 创建一个Jackson的对象映射器解析数据

    • 创建需要解析的对象

    • 解析对象

     

    致力于记录学习过程中的笔记,希望大家有所帮助(*^▽^*)!
  • 相关阅读:
    装饰器的应用
    绑定路由关系
    基本使用
    numpy多项式拟合
    pandas空值处理与插值
    索引
    事务
    子查询
    视图
    自关联
  • 原文地址:https://www.cnblogs.com/zxhbk/p/12992390.html
Copyright © 2020-2023  润新知