526互联

第14章 JSON数据交互和RESTful支持

发布时间 2023-04-25 02:07:37作者: 冬日限定
学习目标
● 了解JSON的数据结构
● 掌握Spring MVC中JSON数据交互的使用
● 熟悉RESTful风格的请求样式
● 掌握Spring MVC中RESTful风格请求的使用
14.1 JSON数据交互
它与XML非常相似，都是用于存储数据的；但JSON相对于XML来说，解析速度更快，占用空间更小
14.1.1 JSON概述
JSON（JavaScript Object Notation, JS对象标记）是一种轻量级的数据交换格式。它是基于JavaScript的一个子集，使用了C、C++、C#、Java、JavaScript、Perl、Python等其他语言的约定，采用完全独立于编程语言的文本格式来存储和表示数据。这些特性使JSON成为理想的数据交互语言，它易于阅读和编写，同时也易于机器解析和生成。
与XML一样，JSON也是基于纯文本的数据格式。初学者可以使用JSON传输一个简单的String、Number、Boolean，也可以传输一个数组或者一个复杂的Object对象。
1．对象结构
对象结构以“{”开始，以“}”结束。中间部分由0个或多个以英文“, ”分隔的name/value对构成（注意name和value之间以英文“:”分隔），
{ 
    key1:value1, 
    key2:value2, 
    ... 
}
（key）必须为String类型，值（value）可以是String、Number、Object、Array等数据类型
例子
{"city":"Beijing", "street":"Xisanqi", "postcode":100096}
2．数组结构
数组结构以“[”开始，以“]”结束。中间部分由0个或多个以英文“, ”分隔的值的列表组成
[ 
    value1, 
    value2, 
    ... 
]
例子
["abc",12345, false, null]
（对象、数组）数据结构也可以分别组合构成更为复杂的数据结构
{ 
    "name": "zhangsan" 
    "hobby":["篮球", "羽毛球", "游泳"] 
    "address":{ 
        "city":"Beijing" 
        "street":"Xisanqi" 
        "postcode":100096 
    } 
}
如果使用JSON存储单个数据（如“abc”），一定要使用数组的形式，不要使用Object形式，因为Object形式必须是“名称：值”的形式
14.1.2 JSON数据转换
HttpMessageConverter<T>接口实现浏览器与控制器类（Controller）之间的数据交互，该接口主要用于将请求信息中的数据转换为一个类型为T的对象，并将类型为T的对象绑定到请求方法的参数中，或者将对象转换为响应信息传递给浏览器显示。
实现类：默认MappingJackson2HttpMessageConverter
利用Jackson开源包读写JSON数据，将Java对象转换为JSON对象和XML文档，同时也可以将JSON对象和XML文档转换为Java对象。
Jackson的开源包：
· jackson-annoations-2.8.8.jar:JSON转换注解包。
· jackson-core-2.8.8.jar:JSON转换核心包。
· jackson-databind-2.8.8.jar:JSON转换的数据绑定包。
两个重要的JSON格式转换注解，分别为@RequestBody和@ResponseBody
1.导包
2.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">
    <display-name>chapeter14</display-name>
    <welcome-file-list>
        <welcome-file>index.jsp</welcome-file>
    </welcome-file-list>
    <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-config.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>
</web-app>
3.springmvc-config.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-4.3.xsd
http://www.springframework.org/schema/mvc
http://www.springframework.org/schema/mvc/spring-mvc-4.3.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context-4.3.xsd
http://www.springframework.org/schema/cache
http://www.springframework.org/schema/cache/spring-cache.xsd">
<!--    指定需要扫描的包-->
 
 
    <context:component-scan base-package="com.itheima.controller"/>
<!--    配置注解驱动-->
    <mvc:annotation-driven />
<!--    配置静态资源的访问映射，此配置中的文件，将不被前端拦截器拦截-->
    <mvc:resources mapping="/js/**" location="/js/"/>
    <!-- 定义视图解析器 -->
    <bean id="viewResolver" class= "org.springframework.web.servlet.view.InternalResourceViewResolver">
        <!-- 设置前缀 -->
        <property name="prefix" value="/WEB-INF/jsp/" />
        <!-- 设置后缀 -->
        <property name="suffix" value=".jsp" />
    </bean>
</beans>
组件扫描器、视图解析器、Spring MVC的注解驱动<mvc:annotation-drivern />、静态资源访问映射<mvc:resources …/>
<mvc:annotation-drivern/>配置会自动注册RequestMappingHandlerMapping和RequestMappingHandlerAdapter两个Bean，并提供对读写XML和读写JSON等功能的支持
增加了静态资源的访问映射配置后，程序会自动地去配置路径下找静态的内容。
<mvc:resources>标签属性及说明
4.pojo类
User类属性username和password，get，set，toString方法
5.index.jsp
<head>
    <title>测试JSON交互</title>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
</head>
<script type="text/javascript" src="${pageContext.request.contextPath }/js/jquery.min.js"></script>
<script type="text/javascript">
    function testJson(){
        var username= $("#username").val();
        var password= $("#password").val();
        $.ajax({
            url :"${pageContext.request.contextPath }/testJson",
            type :"post",
            data :JSON.stringify({username:username,password:password}),
            // 定义发送请求的数据格式为JSON字符串
            contentType :"application/json; charset=UTF-8",
            // 定义回调响应的数据格式为JSON字符串，该属性可省略
            dataType :"json",
            // 成功响应的结果
            success :function (data){
                if(data != null){
                    alert("您输入的用户名："+data.username+"密码为："+data.password);
                }
            }
        });
    }
</script>
<body>
    <form>
        用户名：<input type="text" name="username" id="username" /><br/>
        密&nbsp;&nbsp;&nbsp;码：<input type="password" name="password" id="password"/><br/>
        <input type="button" value="测试JSON交互" onclick="testJson()" />
    </form>
</body>
在函数中使用了jQuery的AJAX方式将JSON格式的用户名和密码传递到以“/testJson”结尾的请求中。
· data：即请求时携带的数据，当使用JSON格式时，要注意编写规范。· contentType：当请求数据为JSON格式时，值必须为application/json。
· data：即请求时携带的数据，当使用JSON格式时，要注意编写规范。· contentType：当请求数据为JSON格式时，值必须为application/json。
· dataType：当响应数据为JSON时，可以定义dataType属性，并且值必须为json。其中dataType : "json"也可以省略不写，页面会自动识别响应的数据格式。
6.UserController
    @RequestMapping("/testJson")
    @ResponseBody
    public User testJson(@RequestBody User user){
//        打印接收的JSON格式数据
        System.out.println(user);
        return user;
    }
使用注解方式定义了一个控制器类，并编写了接收和响应JSON格式数据的testJson()方法，在方法中接收并打印了接收到的JSON格式的用户数据，然后返回了JSON格式的用户对象。
7.启动服务器
问题：Failed to load resource: the server responded with a status of 404 (Not Found)   :8080/favicon.ico:1 
解决方法：检查springmvc-config.xml文件静态资源访问映射配置
<mvc:resources mapping="/js/**" location="/js/"/>
问题：Failed to load resource: the server responded with a status of 404 (Not Found) jquery.min.js:1
解决方法：把js文件挪出WEB-INF（非rest风格代码下js资源通常为静态资源，放在web-inf下会加载不上）
问题：Failed to load resource: the server responded with a status of 404 (Not Found):8080/pro07/textJson:1     
解决方法：url里拼错了test……     
问题：Failed to load resource: the server responded with a status of 415 (Unsupported Media Type) :8080/pro07/testJson:1          
解决方法：在项目结构中手动加入jakson依赖
问题：Failed to load resource: the server responded with a status of 400 (Bad Request)
问题描述POST  The request sent by the client was syntactically incorrect.
原因：请求数据和controller处理方法中的参数不匹配，pojo类User类的password写成了Integer类型，
解决方法：User类的password改为String类型
1.JSON转换器的配置
(1).<mvc:annotation-drivern />
(2).<bean>标签
<! -- <bean>标签配置注解方式的处理器映射器和处理器适配器必须配对使用--> 
<! -- 使用<bean>标签配置注解方式的处理器映射器 --> 
<bean class="org.springframework.web.servlet.mvc.method .annotation.RequestMappingHandlerMapping" /> <! -- 使用<bean>标签配置注解方式的处理器适配器 --> 
<bean class="org.springframework.web.servlet.mvc.method .annotation.RequestMappingHandlerAdapter">        <property name="messageConverters"> 
        <list> 
            <! -- 在注解适配器中配置JSON转换器 --> 
            <bean class="org.springframework.http.converter.json .MappingJackson2HttpMessageConverter"/> 
        </list> 
    </property> 
</bean>
使用<bean>标签配置方式配置JSON转换器时，需要同时配置处理器映射器和处理器适配器，并且JSON转换器是配置在适配器中
2.配置静态资源访问的方式
(1)<mvc:resources>
(2)<mvc:default-servlet-handler>
<mvc:default-servlet-handler>
会在Spring MVC上下文中定义一个org.springframework.web.servlet.resource.DefaultServletHttpRequestHandler（即默认的Servlet请求处理器）。它会像一个检查员，对进入DispatcherServlet的URL进行筛查。如果发现是静态资源的请求，就将该请求转由Web服务器默认的Servlet处理，默认的Servlet就会对这些静态资源放行；如果不是静态资源的请求，才由DispatcherServlet继续处理。
一般Web服务器默认的Servlet名称是"default"，因此DefaultServletHttpRequestHandler可以找到它。如果使用的Web应用服务器默认的Servlet名称不是"default"，则需要通过default-servlet-name属性显示指定，具体方式如下。
<mvc:default-servlet-handler default-servlet-name="Servlet名称" />
而Web服务器的Servlet名称是由使用的服务器确定的，常用服务器及其Servlet名称如下。
· Tomcat、Jetty、JBoss和and GlassFish默认Servlet的名称——"default"。
· Google App Engine默认Servlet的名称——"_ah_default"。
· Resin默认Servlet的名称——"resin-file"。
· WebLogic默认Servlet的名称——"FileServlet"。
· WebSphere默认Servlet的名称——"SimpleFileServlet"。
(3)激活Tomcat默认的Servlet来处理静态文件访问
web.xml中
<! --激活tomcat的静态资源拦截，需要哪些静态文件，再往下追加--> 
<servlet-mapping> 
    <servlet-name>default</servlet-name> 
    <url-pattern>*.js</url-pattern> 
</servlet-mapping> 
<servlet-mapping> 
    <servlet-name>default</servlet-name> 
    <url-pattern>*.css</url-pattern> 
</servlet-mapping> 
...
配置了<servlet-mapping>元素来激活Tomcat默认的Servlet来处理静态文件，我们还可以根据需要继续追加<servlet-mapping>。此种配置方式和上一种方式本质上是一样的，都是使用Web服务器默认的Servlet来处理静态资源文件的访问。其中Servelt名称（即<servlet-name>元素的值）也是由使用的服务器来确定的，不同的服务器需要使用不同的名称。
优缺点：
· 第一和第三种配置方式可以选择性的释放静态资源。
· 第二种配置方式配置相对简单，只需要一行代码，就可以释放所有静态资源。
· 第二和第三种配置方式会导致项目移植性较差，需要根据具体的Web服务器来更改Servlet名称。
· 第三种配置方式运行效率更高，因为服务器启动时已经加载了web.xml中的静态资源。
 
14.2 RESTful支持
14.2.1 什么是RESTful
RESTful也称之为REST（Representational State Transfer），可以将它理解为一种软件架构风格或设计风格，而不是一个标准。简单来说，RESTful风格就是把请求参数变成请求路径的一种风格。
传统：
http://.../queryItems? id=1
RESTful风格：
http://.../items/1
RESTful风格中的URL不存在动词形式。
在HTTP请求中，使用put、delete、post和get方式分别对应添加、删除、修改和查询的操作。
14.2.2 应用案例——用户信息查询
1.UserController
@RequestMapping(value = "/user/{id}",method = RequestMethod.GET)
    @ResponseBody
    public User selectUser(@PathVariable("id") String id){
//        查看数据接收
        System.out.println("id = " + id);
        User user = new User();
//        模拟根据id查出到用户对象数据
        if(id.equals("123456")){
            user.setUsername("shu");
        }
//        返回JSON格式的数据
        return user;
    
    }
方法中的@PathVariable("id")注解则用于接收并绑定请求参数，它可以将请求URL中的变量映射到方法的形参上，如果请求路径为“/user/{id}”，即请求参数中的id和方法形参名称id一样，则@PathVariable后面的“("id")”可以省略。
2.restful.jsp
<head>
    <title>RESTFUL测试</title>
    <script type="text/javascript" src="${pageContext.request.contextPath }/js/jquery.min.js"></script>
    <script type="text/javascript">
        function search(){
            // 获取输入的查询编号
            var id = $("#number").val();
            $.ajax({
                url : "${pageContext.request.contextPath }/user/"+id,
                type : "GET",
                // 定义回调响应的数据格式为JSON字符串，该属性可以省略
                dataType : "json",
                success : function (data){
                    if(data.username != null){
                        alert("您查询的用户是：" + data.username);
                        
                    }else{
                        alert("没有找到id为："+id+"的用户");
                    }
                }
            
            
            });
        }
    </script>
</head>
 
 
<body>
    <formr>
        编号:<input type="text" name="number" id="number">
        <input type="button" value="搜索" onclick="search()"/>
    </formr>
 
 
 
 
</body>
【思考题】
1．请简述JSON数据交互两个注解的作用。
@responsebody放在方法上，用以返回
@requestparam放在参数上
2．请简述静态资源访问的几种配置方式。
<mvc:  location=" "  class=" ">
bean标签形式
servlet自带的