springmvc-210803-04---处理器方法的返回值的实现

最新推荐文章于 2023-01-08 16:40:12 发布

原创最新推荐文章于 2023-01-08 16:40:12 发布 · 208 阅读

0 ·

CC 4.0 BY-SA版权

白光一

文章标签：

#springmvc

springmvc 专栏收录该内容

19 篇文章

订阅专栏

本文介绍SpringMVC中控制器方法不同返回值类型的处理方式，包括返回String、void及Object等类型，并详解如何响应AJAX请求及JSON数据处理。

springmvc-210803-04—处理器方法的返回值的实现

MyController.java（这里是返回值，笔记也在这儿）
index.jsp（主页面）
springmvc.xml（注册驱动mvc:annotation-driven）
show.jsp
pom.xml（引入json依赖）
web.xml

MyController.java（这里是返回值，笔记也在这儿）

package com.bgy.controller;

import com.bgy.vo.Student;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.PrintWriter;
import java.util.ArrayList;
import java.util.List;

@Controller
//@RequestMapping("/test")
public class MyController {

    /**
     *测试处理器方法的返回值----返回String---返回视图----逻辑路径
     *
     * 逻辑视图需要视图解析器
     */
    @RequestMapping(value = "/returnStringView.do")
    public String doReturnStringView(HttpServletRequest request , String name , Integer age){

        // 手动添加数据到request作用域
        request.setAttribute("u_name",name);
        request.setAttribute("u_age",age);
        request.setAttribute("message","测试处理器方法的返回值----返回String---逻辑路径");

        System.out.println("doReturnStringView---->"+name+" : "+age);

        // show：逻辑视图名称，项目中配置了视图解析器
        // 框架对视图执行forward转发操作。
        return "show";
    }

    /**
     *测试处理器方法的返回值----返回String---返回视图----完整路径
     *
     * 完整路径不需要视图解析器
     *
     * 如果使用完整路径，需要取消在springmvc.xml配置的视图解析器，
     * 还需要把类上面这个注解去掉---->@RequestMapping("/test"),
     * 我的不去掉会出现404错误
     */
//    @RequestMapping(value = "/returnStringView02.do")
//    public String doReturnStringView02(HttpServletRequest request , String name , Integer age){
//
//        // 手动添加数据到request作用域
//        request.setAttribute("u_name",name);
//        request.setAttribute("u_age",age);
//        request.setAttribute("message","测试处理器方法的返回值----返回String---逻辑路径");
//
//        System.out.println(name+" : "+age);
//
//        // show：逻辑视图名称，项目中配置了视图解析器
//        // 框架对视图执行forward转发操作。
//        return "/WEB-INF/view/show.jsp";
//    }


    /**
     *测试处理器方法的返回值----返回void
     *
     * 响应ajax请求
     *
     * 需于本项目中服务端向浏览器传回的是 JSON 数据，需要使用一个工具类将字符串包装为 JSON 格式，所以需要导入 JSON 的依赖。
     * 引入jQuery
     */
    @RequestMapping(value = "/doReturnVoid.do")
    public void doReturnVoid(HttpServletResponse response , String name , Integer age) throws IOException {

        System.out.println("doReturnVoid---->"+name+" : "+age);

        // 处理ajax，使用json做数据的格式
        // service调用已经完成，可以使用Student表示处理结果
        Student student = new Student();
        student.setU_name(name);
        student.setU_age(age);

        String json = "";
        // 把结果的对象转为json格式的数据
        if (student != null) {
            ObjectMapper om = new ObjectMapper();
            json = om.writeValueAsString(student);
            System.out.println("student转换为json---->"+json);
        }

        // 输出数据，响应ajax请求
        response.setContentType("application/json;charset=utf-8");
        PrintWriter pw = response.getWriter();
        pw.print(json);
        pw.flush();
        pw.close();
    }


    /**
     *测试处理器方法的返回值----返回一个Object对象
     *
     * 处理器方法返回一个Student对象，通过框架转换为json，响应ajax请求。
     * 需要加上注解@ResponseBody：
     *      作用：把处理器方法返回对象转换为json后，通过HttpServletResponse输出给浏览器。
     *      位置，类方法上面。
     *
     * 返回对象框架处理流程：
     *      1. 调用框架中ArrayList<HttpMessageConverter>中每个类的canWrite()方法，
     *         检查哪个HttpMessageConverter的实现能处理返回的Student类型的数据，
     *         ---->MappingJackson2HttpMessageConverter（处理json）
     *
     *      2. 调用实现类的write()，MappingJackson2HttpMessageConverter.write()方法，
     *         把 ”白光一“ Student对象转为json，调用Jackson的ObjectMapper实现转为json。
     *         Content-Type application/json;charset=utf-8
     *
     *      3. 框架调用注解@ResponseBody把 2. 的结果输出到浏览，ajax请求处理完成。
     */
    @ResponseBody
    @RequestMapping(value = "/doReturnStudentJsonObject.do")
    public Student doReturnStudentJsonObject(String name , Integer age) {

        System.out.println("doReturnStudent方法---->"+name+" : "+age);

        // 调用service，获取请求结果数据，Student对象表示结果对象。
        Student student = new Student();
        student.setU_name("白光一");
        student.setU_age(22);

        // 会被框架转为json
        return student;
    }


    /**
     *测试处理器方法的返回值----返回List集合Object对象
     *
     * 处理器方法返回多个Student对象，通过框架转换为json，响应ajax请求。
     * 需要加上注解@ResponseBody：
     *      作用：把处理器方法返回对象转换为json后，通过HttpServletResponse输出给浏览器。
     *      位置，类方法上面。
     *
     * 返回List集合对象框架处理流程：
     *      1. 调用框架中ArrayList<HttpMessageConverter>中每个类的canWrite()方法，
     *         检查哪个HttpMessageConverter的实现能处理返回的List<Student>类型的数据，
     *         ---->MappingJackson2HttpMessageConverter（处理json）
     *
     *      2. 调用实现类的write()，MappingJackson2HttpMessageConverter.write()方法，
     *         把 ”白光一“ Student对象转为json，调用Jackson的ObjectMapper实现转为json array。
     *         Content-Type application/json;charset=utf-8
     *
     *      3. 框架调用注解@ResponseBody把 2. 的结果输出到浏览，ajax请求处理完成。
     */
    @ResponseBody
    @RequestMapping(value = "/doReturnStudentJsonObjectArray.do")
    public List<Student> doReturnStudentJsonObjectArray(String name , Integer age) {

        System.out.println("doReturnStudent方法---->"+name+" : "+age);

        // 调用service，获取请求结果数据，Student对象表示结果对象。
        Student student01 = new Student();
        student01.setU_name("白光一");
        student01.setU_age(22);

        Student student02 = new Student();
        student02.setU_name("汤姆猫");
        student02.setU_age(18);

        List<Student> list = new ArrayList<>();
        list.add(student01);
        list.add(student02);

        return list;
    }

    /**
     *测试处理器方法的返回值----返回String---返回数据
     *
     * 处理器方法返回String，String用来表示数据，不是视图
     * 区分String返回数据还是试图：
     *      如果有注解@ResponseBody，返回数据，
     *      反之，返回视图。
     *
     *  默认使用编码 ----> Content-Type: text/plain;charset=ISO-8859-1  导致中文乱码
     *  解决：
     *      给RequestMapping添加一个属性 ----> produces ，使用这个属性指定新的contentType。
     *
     *
     *  返回String--返回数据，框架处理流程：
     *      1. 调用框架中ArrayList<HttpMessageConverter>中每个类的canWrite()方法，
     *         检查哪个HttpMessageConverter的实现能处理返回String类型的数据，
     *         ---->StringHttpMessageConverter（处理String）
     *
     *      2. 调用实现类的write()，StringHttpMessageConverter.write()方法，
     *         把字符串按照指定的编码处理  text/plain;charset=ISO-8859-1
     *
     *      3. 框架调用注解@ResponseBody把 2. 的结果输出到浏览，ajax请求处理完成。
     *
     */
    @ResponseBody
    @RequestMapping(value = "/returnStringData.do" , produces = "text/plain;charset=utf-8")
    public String doReturnStringData(String name , Integer age){

        return "测试返回String类型，返回的是数据";
    }
}

index.jsp（主页面）

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>springmvc</title>

    <script type="text/javascript" src="js/jquery-3.4.1.js"></script>
    <script type="text/javascript">
        $(function (){
            $("button").click(function(){
                // alert("button click");
                $.ajax({
                    // url:"doReturnVoid.do",
                    // url:"doReturnStudentJsonObject.do",
                    // url:"doReturnStudentJsonObjectArray.do",

                    // 测试返回String类型的是返回的数据
                    // 需要把下面的  dataType:"json",  去掉，否则无数据
                    url:"returnStringData.do",

                    data:{
                        name:"zhangsan",
                        age:22
                    },
                    type:"post",
                    // dataType:"json",
                    success:function(resp){
                        // resp从服务器端返回的是json格式的字符串{"u_name":"zhangsan","u_age":22}
                        // jquery会把字符串转换成json对象，赋值给resp形参。
                        alert(resp);
                        // alert(resp.u_name+"："+resp.u_age);

                        // 测试返回List集合Object对象
                        // $.each(resp,function (i,n){
                        //     alert(n.u_name+" : "+n.u_age);
                        // })


                    }
                })
            })
        })
    </script>
</head>
<body>
    <form action="returnStringView.do" method="post">
        <span>测试处理器方法的返回值----返回String----逻辑路径</span>
        <br/>
        <span>姓名：</span><input type="text" name="name"/>
        <br/>
        <span>年龄：</span><input type="text" name="age"/>
        <br/>
        <input type="submit" value="提交"/>
    </form>

    <hr/>
    <hr/>
    <hr/>

<%--    <form action="returnStringView02.do" method="post">--%>
<%--        <span>测试处理器方法的返回值----返回String----完整路径</span>--%>
<%--        <br/>--%>
<%--        <span>姓名：</span><input type="text" name="name"/>--%>
<%--        <br/>--%>
<%--        <span>年龄：</span><input type="text" name="age"/>--%>
<%--        <br/>--%>
<%--        <input type="submit" value="提交"/>--%>
<%--    </form>--%>

    <hr/>
    <hr/>
    <hr/>

    <button id="btn">发起ajax请求</button>

</body>
</html>

springmvc.xml（注册驱动mvc:annotation-driven）

<?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
                           http://www.springframework.org/schema/context/spring-context.xsd
                           http://www.springframework.org/schema/mvc
                           http://www.springframework.org/schema/mvc/spring-mvc.xsd">

    <!-- 开启组件扫描 -->
    <context:component-scan base-package="com.bgy.controller"></context:component-scan>

    <!-- 声明springmvc框架中的视图解析器，帮助开发人员设置视图文件的路径 -->
    <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <!-- 前缀 -->
        <property name="prefix" value="/WEB-INF/view/"></property>
        <!-- 后缀 -->
        <property name="suffix" value=".jsp"></property>
    </bean>

    <!-- 注册驱动 -->
    <mvc:annotation-driven/>
</beans>

show.jsp

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>show</title>
</head>
<body>
    <span>message:${message}</span>
    <br/>
    <span>姓名:${u_name}</span>
    <br/>
    <span>年龄:${u_age}</span>
</body>
</html>

pom.xml（引入json依赖）

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>com.bgy</groupId>
  <artifactId>springmvc-210802-01</artifactId>
  <version>1.0-SNAPSHOT</version>
  <packaging>war</packaging>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <maven.compiler.source>1.8</maven.compiler.source>
    <maven.compiler.target>1.8</maven.compiler.target>
  </properties>

  <dependencies>

    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>4.11</version>
      <scope>test</scope>
    </dependency>

    <!-- servlet依赖 -->
    <dependency>
      <groupId>javax.servlet</groupId>
      <artifactId>javax.servlet-api</artifactId>
      <version>3.1.0</version>
      <scope>provided</scope>
    </dependency>

    <!-- springmvc依赖 -->
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-webmvc</artifactId>
      <version>5.2.5.RELEASE</version>
  </dependency>


    <!-- Jackson依赖 -->
    <dependency>
      <groupId>com.fasterxml.jackson.core</groupId>
      <artifactId>jackson-core</artifactId>
      <version>2.9.0</version>
    </dependency>
    <dependency>
      <groupId>com.fasterxml.jackson.core</groupId>
      <artifactId>jackson-databind</artifactId>
      <version>2.9.0</version>
  </dependency>

  </dependencies>

  <build>
    <plugins>
      <!-- 编码和编译和JDK版本 -->
      <plugin>
        <artifactId>maven-compiler-plugin</artifactId>
        <version>3.1</version>
        <configuration>
          <source>1.8</source>
          <target>1.8</target>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

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"
         metadata-complete="true">

  <!-- 配置过滤器，解决post请求中文乱码问题 -->
  <filter>
    <filter-name>characterEncodingFilter</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>

    <!-- 强制请求对象（HttpServletResponse）使用encoding编码的值 -->
    <init-param>
      <param-name>forceResponseEncoding</param-name>
      <param-value>true</param-value>
    </init-param>

    <!-- 强制应答对象（HttpServletRequest）使用encoding编码的值 -->
    <init-param>
      <param-name>forceRequestEncoding</param-name>
      <param-value>true</param-value>
    </init-param>
  </filter>
  <filter-mapping>
    <filter-name>characterEncodingFilter</filter-name>
    <url-pattern>/*</url-pattern>
  </filter-mapping>


  <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>*.do</url-pattern>
  </servlet-mapping>

</web-app>