zoukankan      html  css  js  c++  java
  • SpringMVC:JSON讲解

    SpringMVC:JSON讲解

    什么是JSON?

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

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

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

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

    {"id": "1"}
    {"name": "元思"}
    {"age": "18"}
    

    很多人搞不清楚 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 添加web的支持

    2. 在web目录下新建一个 json.html , 编写测试内容

      <!DOCTYPE html>
      <html lang="en">
      <head>
          <meta charset="UTF-8">
          <title>Title</title>
          <script type="text/javascript">
              //编写一个JavaScript对象  ES6
              var user = {                            //JavaScript对象
                  name:"张三",
                  age:18,
                  sex:"男"
              };
              //将js对象转换为json字符串
              var json = JSON.stringify(user);        //json字符串
              console.log(json);              //打印到浏览器控制台
              console.log("上面是json字符串=====================下面是JavaScript对象");
              //将JSON字符串转换为JavaScript对象
              var obj = JSON.parse(json);             //JavaScript对象
              console.log(obj);
          </script>
      </head>
      <body>
      </body>
      </html>
      
    3. 在IDEA中使用浏览器打开,查看控制台输出!

    Controller返回JSON数据(Jackson)

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

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

    • 我们这里使用Jackson,使用它需要导入它的jar包;

      <!--jackson依赖-json解析工具-->
      <dependency>
          <groupId>com.fasterxml.jackson.core</groupId>
          <artifactId>jackson-databind</artifactId>
          <version>2.10.0</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">
          <servlet>
              <!--配置DispatcherServlet:这是个springmvc的核心:请求分发器,请前端控制器-->
              <servlet-name>spring-mvc</servlet-name>
              <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
              <!--DispatcherServlet要绑定spring配置文件-->
              <init-param>
                  <param-name>contextConfigLocation</param-name>
                  <param-value>classpath:springmvc-servlet.xml</param-value>
              </init-param>
              <!--启动级别 1 数字越小,启动越早-->
              <load-on-startup>1</load-on-startup>
          </servlet>
          <servlet-mapping>
              <!-- / 匹配所有的请求:(不包括jsp)-->
              <!-- /* 匹配所有的请求:(包括jsp)  不要用这个会404-->
              <servlet-name>spring-mvc</servlet-name>
              <url-pattern>/</url-pattern>
          </servlet-mapping>
          <!--配置SpringMVC的中文乱码过滤-->
          <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>
              <!--/ 匹配所有的请求:(不包括jsp)-->
              <!--/* 匹配所有的请求:(包括jsp)-->
              <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.ys.controller"/>
    <!--解决返回字符串(JSON)中文乱码问题配置-->
        <!--<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>-->
    <!--视图解析器-->
        <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 int id;
          private String name;
          private int age;
      }
      
    • 这里我们需要两个新东西,一个是@ResponseBody,一个是ObjectMapper对象,我们看下具体的用法

    编写一个Controller;

    @Controller和@RestController的区别:

    @RestController:类下的返回值只会返回字符串,效果相当于@Controller配合@ResponseBody

    //@Controller//@Controller注解会返回字符串会被视图解析器解析
    @RestController//类下的返回值只会返回字符串,效果相当于@Controller配合@ResponseBody
    public class UserController {
    //@RequestMapping(value = "/j1",produces = "application/json;charset=utf-8")
    //    @ResponseBody//加上@ResponseBody就不会走视图解析器,会返回一个字符串
       @RequestMapping(value = "/j1")
       public String json1() throws JsonProcessingException {
            //创建一个对象
            User user = new User(3,"张三",18);
    //        Jackson-json解析工具,对象转为json格式
            ObjectMapper mapper = new ObjectMapper();
            String json = mapper.writeValueAsString(user);
            return json;//返回值简写为一行 new ObjectMapper().writeValueAsString(user);
       }
    }
    
    • 配置Tomcat , 启动测试一下!

    http://localhost:8080/j1

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

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

      @RequestMapping(value = "/j1",produces = "application/json;charset=utf-8")
      //produces属性可以解决返回字符串中文乱码,这样太不方便了,mvc提供了配置文件同统一解决。 
      
    • 再次测试, http://localhost:8080/json1 , 乱码问题OK!

    【注意:使用json记得处理乱码问题】

    代码优化

    乱码统一解决

    上一种方法比较麻烦,如果项目中有许多请求则每一个都要添加,可以通过Spring配置统一指定,这样就不用每次都去处理了!

    我们可以在springmvc的配置文件上添加一段消息StringHttpMessageConverter转换配置!

    <!--解决返回字符串(JSON)中文乱码问题配置-->
        <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 ,十分便捷!

      @RequestMapping("/j1")
       public String json1() throws JsonProcessingException {
            //创建一个对象
            User user = new User(3,"张三",18);
    //        Jackson-json解析工具,对象转为json格式
            ObjectMapper mapper = new ObjectMapper();
            String json = mapper.writeValueAsString(user);
            return json;//返回值简写为一行 new ObjectMapper().writeValueAsString(user);
       }
    

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

    测试集合输出

    增加一个新的方法

        @RequestMapping("/j2")
        public String json2() throws JsonProcessingException {
            //创建对象
            User user1 = new User(3,"张三1",18);
            User user2 = new User(3,"张三2",18);
            User user3 = new User(3,"张三3",18);
            //创建集合,并把对象放入集合
            List<User> userList = new ArrayList<User>();
            userList.add(user1);
            userList.add(user2);
            userList.add(user3);
    //Jackson-json解析工具,对象转为json格式
            ObjectMapper mapper = new ObjectMapper();
            String json = mapper.writeValueAsString(userList);
            return json;//返回值简写为一行 new ObjectMapper().writeValueAsString(userList);
        }
    //用写的工具类
    

    运行结果 : 十分完美,没有任何问题!

    输出时间对象

    ObjectMapper解析时间对象后会转换为默认格式Timestamp:时间戳(时间戳是北京时间1970年01月01日08时00分00秒起至现在的总毫秒数):先自定义定日期格式并把日期对象转换为日期字符串,日期字符串转为json字符串。

    //输出时间对象的两种方式
    //1.java方式获取时间对象格式转换为json字符串
        @RequestMapping(value = "/j3")
        public static String json3() throws JsonProcessingException {
            //Jackson-json解析工具,对象转为json格式
            //ObjectMapper解析时间对象后会转换为默认格式Timestamp:时间戳(时间戳是北京时间1970年01月01日08时00分00秒起至现在的总毫秒数)
            ObjectMapper mapper = new ObjectMapper();
            //获取当前日期
            Date date = new Date();
            //自定义日期的格式://如果不自定义日期格式用ObjectMapper解析时间后会转换为默认格式Timestamp:
            // 时间戳(时间戳是北京时间1970年01月01日08时00分00秒起至现在的总毫秒数)
            SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
            //当前日期格式字符串
            String dateFormat = sdf.format(date);
            //转换为json字符串日期格式
            String jsonDate = mapper.writeValueAsString(dateFormat);
            return jsonDate;//返回值简写为一行 new ObjectMapper().writeValueAsString(dateformat);
        }
    

    把ObjectMapper解析时间对象后会转换为默认格式Timestamp:时间戳关闭,并为ObjectMapper设置指定日期格式,把当前日期对象转换为指定日期格式json字符串。

     @RequestMapping(value = "/j4")
        public String json4() throws JsonProcessingException {
    //        Jackson-json解析工具,对象转为json格式
            ObjectMapper mapper = new ObjectMapper();
            //不使用时间戳的方式,默认使用时间戳,改为false不使用时间戳,
            mapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);
            //自定义日期格式对象
            SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
            //ObjectMapper设置指定日期格式
            mapper.setDateFormat(sdf);
            //获取当前日期
            Date date = new Date();
            String json = mapper.writeValueAsString(date);
            return json;
        }
    

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

    抽取为工具类

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

    package com.ys.utils;
    import com.fasterxml.jackson.core.JsonProcessingException;
    import com.fasterxml.jackson.databind.ObjectMapper;
    import com.fasterxml.jackson.databind.SerializationFeature;
    import org.omg.CORBA.OMGVMCID;
    import java.text.SimpleDateFormat;
    //json日期格式工具
    public class JsonUtil {
        //方法重载使用:如果只传一个参数默认返回格式为"yyyy-MM-dd HH:mm:ss",传来两个格式为自定义时间
        public static String getJson(Object object){
            return getJson(object,"yyyy-MM-dd HH:mm:ss");
        }
        public static String getJson(Object object,String dateFormat){//传日期对象和日期格式
            ObjectMapper objectMapper = new ObjectMapper();
            //不使用时间戳的方式,默认使用时间戳,改为false不使用时间戳,
            objectMapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);
            //把传来的日期格式放入
            SimpleDateFormat sdf = new SimpleDateFormat(dateFormat);
            //把传来的对象设置为指定日期格式
            objectMapper.setDateFormat(sdf);
            try {
                return objectMapper.writeValueAsString(object);
            } catch (JsonProcessingException e) {
                e.printStackTrace();
            }
            return null;
        }
    }
    
    

    我们使用工具类,代码就更加简洁了!

    //使用自己写的Json工具类
        @RequestMapping(value = "/j5")
        public String json5() throws JsonProcessingException {
            //获取当前日期
            Date date = new Date();
            //自定义格式:传两个值
    //        String json = JsonUtil.getJson(date, "yyyy-MM-dd HH:mm:ss");
            //传一个值默认格式为"yyyy-MM-dd HH:mm:ss"
            String json2 = JsonUtil.getJson(date);
            return json2;
        }
    
    

    大工告成!完美!

    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 类

    @Controller
    public class FastJsonController {
        @RequestMapping("/f/j1")
        @ResponseBody
        public String json1() throws JsonProcessingException {
            //获取当前日期
            Date date = new Date();
            String datet = JSON.toJSONString(date);
            return datet;//返回的是时间戳
        }
        @RequestMapping("/f/j2")
        @ResponseBody
        public JSONArray json2() throws JsonProcessingException {
            //创建一个集合
            User user = new User(3,"张三1",18);
            User user1 = new User(3,"张三2",18);
            User user2 = new User(3,"张三3",18);
            List<User> userList = new ArrayList<User>();
            userList.add(user);
            userList.add(user1);
            userList.add(user2);
    //        FastJson-json解析工具
    
            //java对象
            //java对象转为json字符串
            String user_to_jsonStr = toJSONString(user);
            //java对象转为json对象
            JSONObject user_to_json = (JSONObject)toJSON(user1);
    
            //javaList集合
            //javaList集合转为JSON数组
            JSONArray list_to_jsonArray= JSONArray.parseArray(JSON.toJSONString(userList));
            //javaList集合转为json字符串
            String list_to_json = JSON.toJSONString(userList);
    
            //JSON数组
            //JSON数组转为javaList集合
            List<User> jsonArray_to_list = JSONObject.parseArray(list_to_jsonArray.toJSONString(), User.class);
    
            //json字符串
            //json字符串转为javaList集合
            List<User> jsonStr_to_list = JSONObject.parseArray(list_to_json,User.class);
            //json字符串转为java对象
            User jsonStr_to_user= JSON.parseObject(user_to_jsonStr, User.class);
            
            //json对象
            //json对象转为java对象
            User json_to_user = JSON.toJavaObject(user_to_json, User.class);
            return list_to_jsonArray;
        }
    }
    
    

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

  • 相关阅读:
    Request Validation in ASP.NET
    ANSI、Unicode、Unicode big endian、UTF8编码
    在win7下安装SQL sever2005
    配置SQL Server 2005 以允许远程连接
    传统网站与Web标准——DIV+CSS布局实例
    打造自己的reset.css
    传统网站与Web标准——表格布局实例
    每天工作4小时的程序员
    良好的XHTML规则
    列表导航栏实例(02)——精美电子商务网站赏析
  • 原文地址:https://www.cnblogs.com/yu-si/p/12342229.html
Copyright © 2011-2022 走看看