（5）SpringMVC————JSON数据交互，Ajax，文件上传和下载以及拦截器

╰+攻爆jí腚メ 2023-02-18 01:43 27阅读 0赞

1，JSON数据交互

*  1.1，什么是JSON？
 *  1.2，Lombok的使用
 *  1.3，Gson的使用
 *  1.4， 前后端JSON交互
 *  1.5， HttpMessageConverter

2，Ajax

*  2.1，Ajax的简介
 *  2.2，jQuery.ajax
 *  2.3，使用Ajax实现注册提示效果

3，文件上传和下载

*  3.1，文件上传
 *  3.2，文件下载

4，拦截器

*  4.1，自定义拦截器
 *  4.2，多个拦截方法的执行顺序
 *  4.3，拦截用户是否登陆请求案例

> #### JSON数据交互 ####

1，什么是JSON？

*  JSON(JavaScript Object Notation, JS 对象标记) 是一种轻量级的数据交换格式
 *  采用完全独立于编程语言的文本格式来存储和表示数据。
 *  易于人阅读和编写，同时也易于机器解析和生成，并有效地提升网络传输效率。
 *  JSON 键值对是用来保存 JavaScript 对象的一种方式，和 JavaScript 对象的写法也大同小异，键/值对组合中的键名写在前面并用双引号 “” 包裹，使用冒号 : 分隔，然后紧接着值：

var obj = { a: 'Hello', b: 'World'}; //这是一个对象，注意键名也是可以使用引号包裹的
    var json = '{"a": "Hello", "b": "World"}'; //这是一个 JSON 字符串，本质是一个字符串

2，Lombok的使用

①， IDE中安装Lombok插件

File → Settings → Plugins，输入“lombok”，选中“install”进行安装即可，安装后需重启IDEA才能运行。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxNTMwMDA0_size_16_color_FFFFFF_t_70]

②， 导入相关依赖

[ lombok 1.18.8.jar][lombok 1.18.8.jar]

③，代码中使用注解

*  `@Date`：加在类上，相当于同时使用了`@ToString`、`@EqualsAndHashCode`、`@Getter`、`@Setter`和`@RequiredArgsConstrutor`这些注解；
 *  `@AllArgsConstructor`：加在类上，可以生成含实体类全参数的构造方法；
 *  `@NoArgsConstructor`：加在类上，可以生成无参构造方法；
 *  `@RequiredArgsConstructor`：加在类上，配合`@NonNull`注解使用，生成指定参数的构造方法。比如在age属性前面加`@NonNull`注解，则User生成需要age参数的构造方法；
 *  `@Getter`：加在类上，可以生成实体类所有属性的getter方法；
 *  `@Setter`：加在类上，可以生成实体类所有属性的setter方法；
 *  `@ToString`：加在类上，调用toString()方法，可以输出实体类中所有属性的值。

④，Lombok的优缺点

*  优点：
    
     *  使用`@Data`注解大大减少了代码量，使代码非常简洁
     *  增强代码可读性：专注于类的属性定义，不需要再去为排版浪费时间
     *  减少模板代码：lombok处理get，set，toString，hash，equal等方法
 *  缺点：
    
     *  代码可调试性降低，Lombok会自动生成很多代码，这些代码是要在编译阶段才会生成的，在开发的过程中，要想要知道某个类中的某个属性的getter方法都被哪些类引用的话，就没那么简单了。
     *  可能会破坏封装性
     *  影响版本升级，Lombok作为一个第三方工具，是由开源团队维护的，他的迭代速度是无法保证的，要是我们需要升级到某个新版本的JDK的时候，若其中的特性在Lombok中不支持的话就会受到影响。

⑤，Lombok的使用

@Data
    @AllArgsConstructor
    @NoArgsConstructor
    public class User { 
    
        private String name;
        private Integer age;
        private String sex;
    
    }

3，Gson的使用

*  Gson.jar谷歌开发的一款专门用于Java开发的包，可以方便的实现json对象与JavaBean对象的转换，实现JavaBean对象与json字符串的转换，实现json对象与json字符串的转换。
 *  依赖的导入
    
    [gson 2.8.5.jar][]

4，前后端JSON交互

//乱码解决方法一：
    @RequestMapping(value = "/gsonTest01",produces = "application/json;charset=utf-8")
    @ResponseBody
    public String gsonTest01() { 
        Gson gson = new Gson();
        String data = gson.toJson(new Date());
        User user1 = new User("Tommey周", 1, data);
        String str1 = gson.toJson(user1);
        return str1; 
    }

*  json乱码的解决方法二，spring-mvc.xml中添加配置，添加后加入`Jackson` jar包
    
    [Jackson Databind 2.9.8.jar 包的下载][Jackson Databind 2.9.8.jar]  
    [Jackson Annotations 2.9.8.jar 包的下载][Jackson Annotations 2.9.8.jar]  
    [Jackson-core 2.9.8.jar 包的下载][Jackson-core 2.9.8.jar]

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

*  注意：要是jar没有全部引入，否则可能会错误

5，HttpMessageConverter

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxNTMwMDA0_size_16_color_FFFFFF_t_70 1]

*  使 `HttpMessageConverter<T>` 将请 求信息转化并绑定到处理方法的入参中或将响应结果转为对应类型响应信息 Spring 提供了两种途径使 `@RequestBody` / `@ResponseBody` 对处理方法进行标注，使 `HttpEntity<T>` / `ResponseEntity<T>` 作为处理方法入参或返回值
 *  当控制器处方法使用到 `@RequestBody`/`@ResponseBody` 或 `HttpEntity<T>`/`ResponseEntity<T>`时, Spring先根据请求头或响应头的`Accept`属性选择匹配`HttpMessageConverter`, 进而根据参数类型或泛型类型过滤得到匹配的`HttpMessageConverter`, 若找不到可用的`HttpMessageConverter` 将报错
 *  `@RequestBody`和`@ResponseBody`注解的使用示例：
    
    `@RequestBody`：用于读取http请求的内容(字符串)，通过springmvc提供的`HttpMessageConverter`接口将读到的内容（json数据）转换为java对象并绑定到Controller方法的参数上
    
    `@ResponseBody`：表示该方法的返回结果直接写入HTTP response body中一般在异步获取数据时使用
    
    `@RestController`：使用改注解后，表示这个类中的所有方法返回结果直接写入HTTP response body中

@ResponseBody
    @RequestMapping(value = "/testHttpMessageConverter")
    public String testHttpMessageConverter(@RequestBody String body){ 
        System.out.println(body);
        return LocalDateTime.now().toString();
    }

*  html页面

*  ResponseEntity下载文件的使用案例：

@RequestMapping("/testResponseEntity")
    public ResponseEntity<byte[]> testResponseEntity(HttpSession session) throws IOException { 
        byte[] body = null;
        ServletContext servletContext = session.getServletContext();
        InputStream in = servletContext.getResourceAsStream("a.sql");
        body = new byte[in.available()];
        in.read();
        HttpHeaders headers = new HttpHeaders();
        headers.add("Content-Disposition","attachment;filename=a.sql");
        HttpStatus statusCode = HttpStatus.OK;
    
        ResponseEntity<byte[]> response = new ResponseEntity<>(body,headers,statusCode);
        return response;
    }

*  html页面

> #### Ajax ####

1，Ajax的简介

*  AJAX （ Asynchronous JavaScript and XML（异步的 JavaScript 和 XML））。
 *  AJAX 是一种在无需重新加载整个网页的情况下，能够更新部分网页的技术。
 *  Ajax 不是一种新的编程语言，而是一种用于创建更好更快以及交互性更强的Web应用程序的技术。
 *  传统的网页，想要更新内容或者提交一个表单，都需要重新加载整个网页。使用ajax技术的网页，通过在后台服务器进行少量的数据交换，就可以实现异步局部更新。

2，jQuery.ajax

*  jQuery 提供多个与 AJAX 有关的方法，通过 jQuery AJAX 方法，您能够使用 HTTP Get 和 HTTP Post 从远程服务器上请求文本、HTML、XML 或 JSON – 同时您能够把这些外部数据直接载入网页的被选元素中。
 *  jQuery 不是生产者，而是大自然搬运工，jQuery Ajax本质就是 XMLHttpRequest，对他进行了封装，方便调用！

jQuery.ajax(...)
          部分参数：
          url：请求地址
          type：请求方式，GET、POST（1.9.0之后用method）
          headers：请求头
          data：要发送的数据
       	  contentType：即将发送信息至服务器的内容编码类型(默认: "application/x-www-form-urlencoded; charset=UTF-8")
          async：是否异步
          timeout：设置请求超时时间（毫秒）
          beforeSend：发送请求前执行的函数(全局)
          complete：完成之后执行的回调函数(全局)
          success：成功之后执行的回调函数(全局)
          error：失败之后执行的回调函数(全局)
          accepts：通过请求头发送给服务器，告诉服务器当前客户端可接受的数据类型
          dataType：将服务器端返回的数据转换成指定类型
              "xml": 将服务器端返回的内容转换成xml格式
              "text": 将服务器端返回的内容转换成普通文本格式
              "html": 将服务器端返回的内容转换成普通文本格式，在插入DOM中时，如果包含JavaScript标签，则会尝试去执行。
            "script": 尝试将返回值当作JavaScript去执行，然后再将服务器端返回的内容转换成普通文本格式
              "json": 将服务器端返回的内容转换成相应的JavaScript对象
            "jsonp": JSONP 格式使用 JSONP 形式调用函数时，如 "myurl?callback=?" jQuery 将自动替换 ? 为正确的函数名，以执行回调函数

3，使用Ajax实现注册提示效果

*  login.jsp

<%--    <script src="${pageContext.request.contextPath}/statics/js/jquery-3.1.1.min.js"/>--%>
        
        <script src="https://code.jquery.com/jquery-3.1.1.min.js"></script>
    
        <script>
            function a1(){ 
                $.post({ 
                    url: "${pageContext.request.contextPath}/login",
                    data: { 'names':$("#names").val()},
                    success:function (data) { 
                        if (data.toString()=='OK'){ 
                            $("#username").css("color","green");
                        }else { 
                            $("#username").css("color","red");
                        }
                        $("#username").html(data);
                    }
                });
            }
        </script>
    </head>
    <body>
    <p>
        用户名:<input type="text" id="names" onblur="a1()"/>
        <span id="username"></span>
    </p>

*  DemoController.java

@RequestMapping("/login")
    public String login(String names) { 
        String msg = "";
        if (names != null && names != "") { 
            if ("admin".equals(names)) { 
                msg = "OK";
            } else { 
                msg = "用户名不已存在";
            }
        }
        return msg; //由于@RestController注解，将msg转成json格式返回
    }

> #### 文件上传和下载 ####

1，文件上传

①，jar包的导入

*  Spring MVC为文件上传提供了直接的支持，即插即用的`MultipartResolver`实现的。Spring MVC使用`Apache Commons FileUpload`技术实现了一个MultipartResolver实现类：CommonsMultipartResolver。因此，SpringMVC的文件上传还需要依赖Apache Commons FileUpload的组件。
    
    `commons-fileupload.jar`包
    
    `javax.servlet-api.jar`包

②，配置bean

<bean id="multipartResolver"  class="org.springframework.web.multipart.commons.CommonsMultipartResolver">
        
        <property name="defaultEncoding" value="utf-8"/>
        
        <property name="maxUploadSize" value="10485760"/>
        <property name="maxInMemorySize" value="40960"/>
    </bean>

③，编写前端界面

*  为了能上传文件，必须将表单的`method`设置为`POST`，并将`enctype`设置为`multipart/form-data`。只有在这样的情况下，浏览器才会把用户选择的文件以二进制数据发送给服务器；

*  `application/x-www=form-urlencoded`：默认方式，只处理表单域中的 value 属性值，采用这种编码方式的表单会将表单域中的值处理成 URL 编码方式。
 *  `multipart/form-data`：这种编码方式会以二进制流的方式来处理表单数据，这种编码方式会把文件域指定文件的内容也封装到请求参数中，不会对字符编码。
 *  `text/plain`：除了把空格转换为 “+” 号外，其他字符都不做编码处理，这种方式适用直接通过表单发送邮件。

④、Controller

*  `CommonsMultipartFile` 的 常用方法：
    
    `String getOriginalFilename()`：获取上传文件的原名
    
    `InputStream getInputStream()`：获取文件流
    
    `void transferTo(File dest)`：将上传文件保存到一个目录文件中

@RequestMapping("/testFileUpload")
    public String testFileUpload(@RequestParam("desc")String desc, @RequestParam("file")MultipartFile file,HttpServletRequest request) throws IOException { 
        //获取文件名
        String  uploadFileName = file.getOriginalFilename();
        //如果文件名为空，直接回到首页
        if ("".equals(uploadFileName)){ 
            return "redirect:/index.jsp";
        }
        System.out.println("上传文件名："+uploadFileName);
    
        //上传路径保存设置
        String path = request.getServletContext().getRealPath("/upload");
        //如果路径不存在就创建
        File realPath = new File(path);
        if(!realPath.exists()){ 
            realPath.mkdir();
        }
        System.out.println("上传文件保存地址："+realPath);
        
        //通过CommonsMultipartFile的方法直接写文件
        //file.transferTo(new File(realPath +"/"+ file.getOriginalFilename()));
    
        InputStream is = file.getInputStream();//文件输入流
        FileOutputStream os = new FileOutputStream(new File(realPath, uploadFileName));//文件输出流
    
        //读取写出
        int len = 0;
        byte[] buffer = new byte[1024];
        while ((len = is.read(buffer)) != -1){ 
            os.write(buffer,0,len);
            os.flush();
        }
        os.close();
        is.close();
    
        return "redirect:/index.jsp";
    }

2，文件下载

①、设置 response 响应头

②、读取文件 – InputStream

③、写出文件 – OutputStream

④、执行操作

⑤、关闭流 （先开后关）

*  示例代码：

@RequestMapping("/testDownload")
    public String testDownload(HttpServletRequest request,HttpServletResponse response) throws Exception { 
        //要下载的图片地址
        String path = request.getServletContext().getRealPath("/upload");
        String fileName = "B站视频资料.txt";
    
        //1，设置response响应头
        response.reset();;//设置页面不缓存，清空buffer
        response.setCharacterEncoding("UTF-8");//设置字符编码
        response.setContentType("multipart/form-data");//二进制传输数据
        //设置响应头
        response.setHeader("Content-Disposition","attachment;fileName="+ URLEncoder.encode(fileName,"UTF-8"));
    
        File file = new File(path,fileName);
        InputStream is = new FileInputStream(file);//2，读取文件（输入流）
        OutputStream os = response.getOutputStream();//3，写出文件（输出流）
    
        byte[] buffer = new byte[1024];
        int index = 0;
        //4，执行写出操作
        while ((index = is.read(buffer)) != -1){ 
            os.write(buffer,0,index);
            os.flush();
        }
        os.close();
        is.close();
        return null;
    }

> #### 拦截器 ####

*  SpringMVC的处理器拦截器类似于Servlet开发中的过滤器Filter,用于对处理器进行预处理和后处理
 *  过滤器与拦截器的区别：
    
     *  过滤器：
        
        servlet规范中的一部分，任何java web工程都可以使用
        
        在url-pattern中配置了/\*之后，可以对所有要访问的资源进行拦截
     *  拦截器：
        
        拦截器是SpringMVC框架自己的，只有使用了SpringMVC框架的工程才能使用，拦截器只会拦截访问的控制器方法， 如果访问的是jsp/html/css/image/js是不会进行拦截的
        
        拦截器是AOP思想的具体应用

1，自定义拦截器

public class FirstInterceptor implements HandlerInterceptor { 
    
        /** * 该方法在目标方法之前被调用 * 若返回值为true，则继续调用后续的拦截器和目标方法 * 若返回值为false，则不会再调用后续的拦截器和目标方法 * * 可以考虑做权限，日志，事务等 */
        public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { 
            System.out.println("=======preHandle=======");
            return true;
        }
    
        /** * 调用目标方法之后，但在渲染视图之前 * 可以对请求域中的属性或视图做出修改 */
        public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception { 
            System.out.println("=======postHandle=======");
        }
    
        //在dispatcherServlet处理后执行,做清理工作.
        public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception { 
            System.out.println("=======afterCompletion=======");
        }
    }

*  在springmvc的配置文件中配置拦截器：

<mvc:interceptors>
        <mvc:interceptor>
             <mvc:mapping path="/**"/>  <bean class="com.controller.FirstInterceptor"/> </mvc:interceptor> </mvc:interceptors>

2，多个拦截方法的执行顺序

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxNTMwMDA0_size_16_color_FFFFFF_t_70 2]

3，拦截用户是否登陆请求案例

*  如果用户已经登陆。放行， 如果用户未登陆，跳转到登陆页面
 *  index.jsp

*  login.jsp

*  success.jsp

${ user}
    <a href="${pageContext.request.contextPath}/user/logout">注销</a>

*  UserController

@RequestMapping("/user")
    @Controller
    public class UserController { 
    
        //跳转到登陆页面
        @RequestMapping("/jumplogin")
        public String jumpLogin() throws Exception { 
            return "login";
        }
    
        //跳转到成功页面
        @RequestMapping("/jumpSuccess")
        public String jumpSuccess() throws Exception { 
            return "success";
        }
    
        //登陆提交
        @RequestMapping("/login")
        public String login(HttpSession session, String username, String pwd) throws Exception { 
            // 向session记录用户身份信息
            System.out.println("接收前端==="+username);
            session.setAttribute("user", username);
            return "success";
        }
    
        //退出登陆
        @RequestMapping("logout")
        public String logout(HttpSession session) throws Exception { 
            // session 过期
            session.invalidate();
            return "login";
        }
    }

*  LoginInterceptor.java

public class LoginInterceptor implements HandlerInterceptor { 
    
        public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws ServletException, IOException { 
            // 如果是登陆页面则放行
            System.out.println("uri: " + request.getRequestURI());
            if (request.getRequestURI().contains("login")) { 
                return true;
            }
    
            HttpSession session = request.getSession();
    
            // 如果用户已登陆也放行
            if(session.getAttribute("user") != null) { 
                return true;
            }
    
            // 用户没有登陆跳转到登陆页面
            request.getRequestDispatcher("/login.jsp").forward(request, response);
            return false;
        }
    
        public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) throws Exception { 
    
        }
    
        public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception { 
    
        }

*  拦截器的配置

<mvc:interceptors>
            <mvc:interceptor>
                 <mvc:mapping path="/**"/>   <bean id="loginInterceptor" class="com.controller.LoginInterceptor"/> </mvc:interceptor> </mvc:interceptors>

--------------------

[下一章，（6）SpringMVC————异常处理以及整合Spring时实例重复创建][6_SpringMVC_Spring]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxNTMwMDA0_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/2020061508233621.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxNTMwMDA0,size_16,color_FFFFFF,t_70
[lombok 1.18.8.jar]: https://mvnrepository.com/artifact/org.projectlombok/lombok/1.18.8
[gson 2.8.5.jar]: https://mvnrepository.com/artifact/com.google.code.gson/gson/2.8.5
[Jackson Databind 2.9.8.jar]: https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-databind/2.9.8
[Jackson Annotations 2.9.8.jar]: https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-annotations/2.9.8
[Jackson-core 2.9.8.jar]: https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-core/2.9.8
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxNTMwMDA0_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20200616144130282.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxNTMwMDA0,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxNTMwMDA0_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20200616230455707.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxNTMwMDA0,size_16,color_FFFFFF,t_70
[6_SpringMVC_Spring]: https://blog.csdn.net/qq_41530004/article/details/106799553