SpringMVC项目响应

阳光穿透心脏的1/2处 2024-04-01 15:13 89阅读 0赞

SpringMVC接收到请求和数据后，进行一些了的处理，当然这个处理可以是转发给Service，Service层再调用Dao层完成的，不管怎样，处理完以后，都需要将结果告知给用户。

比如:根据用户ID查询用户信息、查询用户列表、新增用户等。

对于响应，主要就包含两部分内容：

*  响应页面
 *  响应数据
    
     *  文本数据
     *  json数据

因为异步调用是目前常用的主流方式，所以我们需要更关注的就是如何返回JSON数据，对于其他只需要认识了解即可。

### 1. 环境准备 ###

*  创建一个Web的Maven项目
 *  pom.xml添加Spring依赖
    
        <?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.dcxuexi</groupId>
          <artifactId>springmvc_04_response</artifactId>
          <version>1.0-SNAPSHOT</version>
          <packaging>war</packaging>
        
          <name>springmvc_04_response Maven Webapp</name>
          
          <url>http://www.example.com</url>
        
          <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>org.springframework</groupId>
              <artifactId>spring-webmvc</artifactId>
              <version>5.2.15.RELEASE</version>
            </dependency>
            <dependency>
              <groupId>javax.servlet</groupId>
              <artifactId>javax.servlet-api</artifactId>
              <version>3.1.0</version>
              <scope>provided</scope>
            </dependency>
            <dependency>
              <groupId>com.fasterxml.jackson.core</groupId>
              <artifactId>jackson-databind</artifactId>
              <version>2.9.8</version>
            </dependency>
          </dependencies>
        
          <build>
            <plugins>
              <plugin>
                <groupId>org.apache.tomcat.maven</groupId>
                <artifactId>tomcat7-maven-plugin</artifactId>
                <version>2.1</version>
                <configuration>
                  <port>80</port>
                  <path>/springmvc</path>
                  <uriEncoding>UTF-8</uriEncoding>
                </configuration>
              </plugin>
            </plugins>
          </build>
        
        </project>
 *  创建对应的配置类SpringMvcConfig和ServletContainersInitConfig
    
        @Configuration
        @ComponentScan("com.dcxuexi.controller")
        // 开启json数据类型转换
        @EnableWebMvc
        public class SpringMvcConfig {
              
        }
    
        public class ServletContainersInitConfig extends AbstractAnnotationConfigDispatcherServletInitializer {
              
            @Override
            protected Class<?>[] getRootConfigClasses() {
              
                return new Class[0];
            }
        
            @Override
            protected Class<?>[] getServletConfigClasses() {
              
                return new Class[]{
              SpringMvcConfig.class};
            }
        
            @Override
            protected String[] getServletMappings() {
              
                return new String[]{
              "/"};
            }
        
            // 处理乱码
            @Override
            protected Filter[] getServletFilters(){
              
                CharacterEncodingFilter filter = new CharacterEncodingFilter();
                filter.setEncoding("utf-8");
                return new Filter[]{
              filter};
            }
            
        }
 *  编写模型类User和City
    
        public class User {
              
            private String userName;
            private Integer userAge;
            private String userSex;
            private City city;
        
            public String getUserName() {
              
                return userName;
            }
        
            public void setUserName(String userName) {
              
                this.userName = userName;
            }
        
            public Integer getUserAge() {
              
                return userAge;
            }
        
            public void setUserAge(Integer userAge) {
              
                this.userAge = userAge;
            }
        
            public String getUserSex() {
              
                return userSex;
            }
        
            public void setUserSex(String userSex) {
              
                this.userSex = userSex;
            }
        
            public City getCity() {
              
                return city;
            }
        
            public void setCity(City city) {
              
                this.city = city;
            }
        
            @Override
            public String toString() {
              
                return "{" +
                        "userName='" + userName + '\'' +
                        ", userAge=" + userAge + 
                        ", userSex='" + userSex + '\'' +
                        ", city=" + city +
                        '}';
            }
        }
    
        public class City {
              
            private String country;
            private String provice;
            private String area;
        
            public String getCountry() {
              
                return country;
            }
        
            public void setCountry(String country) {
              
                this.country = country;
            }
        
            public String getProvice() {
              
                return provice;
            }
        
            public void setProvice(String provice) {
              
                this.provice = provice;
            }
        
            public String getArea() {
              
                return area;
            }
        
            public void setArea(String area) {
              
                this.area = area;
            }
        
            @Override
            public String toString() {
              
                return "{" +
                        "country='" + country + '\'' +
                        ", provice='" + provice + '\'' +
                        ", area='" + area + '\'' +
                        '}';
            }
        }
 *  webapp下创建user.jsp
    
        <%@ page contentType="text/html;charset=UTF-8" language="java" %>
        <html>
        <head>
            <title>user</title>
        </head>
        <body>
            <h2>Hello World! </h2>
            <h2>springmvc response.</h2>
        </body>
        </html>
 *  编写UserController
    
        @Controller
        public class UserController {
              
        
        }

最终创建好的项目结构如下:

![在这里插入图片描述][75d39081b1a3419cb52d39ebd790830a.png_pic_center]

### 2. 响应页面 ###

#### 步骤1:设置返回页面 ####

@Controller
    public class UserController {
        
    
        @RequestMapping("/toJumpPage")
        //@ResponseBody  //1.此处不能添加@ResponseBody,如果加了该注入，会直接将page.jsp当字符串返回前端
        //2.方法需要返回String
        public String toJumpPage(){
        
            System.out.println("跳转首页页面");
            return "user.jsp";
        }
    
    }

#### 步骤2:启动程序测试 ####

此处涉及到页面跳转，所以不适合采用PostMan进行测试，直接打开浏览器，输入

`http://localhost/springmvc/toJumpPage`

![在这里插入图片描述][85a0c3bca38540ce9d2a16cc59940f6a.png_pic_center]

### 3. 返回文本数据 ###

#### 步骤1:设置返回文本内容 ####

@Controller
    public class UserController {
        
        
        @RequestMapping("/toText")
        @ResponseBody  //此处该注解就不能省略，如果省略了,会把toText txt当前页面名称去查找，如果没有回报404错误
        public String toText(){
        
            System.out.println("返回纯文本数据");
            return "toText txt";
        }
        
    }

#### 步骤2:启动程序测试 ####

此处不涉及到页面跳转，因为我们现在发送的是GET请求，可以使用浏览器也可以使用PostMan进行测试，输入地址`http://localhost/springmvc/toText`访问

![在这里插入图片描述][6d6078fd29b2423cb03795d57fe17295.png_pic_center]

### 4. 响应JSON数据 ###

#### 响应POJO对象 ####

@Controller
    public class UserController {
        
        
        @RequestMapping("/toJsonPOJO")
        @ResponseBody
        public User toJsonPOJO(){
        
            System.out.println("返回json对象数据");
            User user = new User();
            City city = new City();
            city.setCountry("中国");
            city.setProvice("上海");
            city.setArea("浦东新区");
            user.setUserName("小闯");
            user.setUserAge(20);
            user.setUserSex("男");
            user.setCity(city);
            return user;
        }
        
    }

返回值为实体类对象，设置返回值为实体类类型，即可实现返回对应对象的json数据，需要依赖==@ResponseBody注解和@EnableWebMvc==注解

重新启动服务器，访问`http://localhost/springmvc/toJsonPOJO`

![在这里插入图片描述][d62f827ceba94efb907c2b99f8a32ff2.png_pic_center]

#### 响应POJO集合对象 ####

@Controller
    public class UserController {
        
        
        @RequestMapping("/toJsonPOJOList")
        @ResponseBody
        public List<User> toJsonPOJOList(){
        
            System.out.println("返回json对象集合数据");
            List<User> userList  = new ArrayList<>();
            User user = new User();
            City city = new City();
            city.setCountry("中国");
            city.setProvice("上海");
            city.setArea("浦东新区");
            user.setUserName("小闯");
            user.setUserAge(20);
            user.setUserSex("男");
            user.setCity(city);
    
            User user2 = new User();
            City city2 = new City();
            city2.setCountry("中国");
            city2.setProvice("北京");
            city2.setArea("西城区");
            user2.setUserName("张三");
            user2.setUserAge(18);
            user2.setUserSex("男");
            user2.setCity(city2);
    
            userList.add(user);
            userList.add(user2);
            return userList;
        }
        
    }

重新启动服务器，访问`http://localhost/springmvc/toJsonPOJOList`

![在这里插入图片描述][6aa8ab796dfd40418041677829dc6dfa.png_pic_center]

### 知识点1：@ResponseBody ###

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>@ResponseBody</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>类型</td> 
   <td>方法\类注解</td> 
  </tr> 
  <tr> 
   <td>位置</td> 
   <td>SpringMVC控制器方法定义上方和控制类上</td> 
  </tr> 
  <tr> 
   <td>作用</td> 
   <td>设置当前控制器返回值作为响应体,<br>写在类上，该类的所有方法都有该注解功能</td> 
  </tr> 
  <tr> 
   <td>相关属性</td> 
   <td>pattern：指定日期时间格式字符串</td> 
  </tr> 
 </tbody> 
</table>

**说明:**

*  该注解可以写在类上或者方法上
 *  写在类上就是该类下的所有方法都有@ReponseBody功能
 *  当方法上有@ReponseBody注解后
    
     *  方法的返回值为字符串，会将其作为文本内容直接响应给前端
     *  方法的返回值为对象，会将对象转换成JSON响应给前端

此处又使用到了类型转换，内部还是通过Converter接口的实现类完成的，所以Converter除了前面所说的功能外，它还可以实现:

*  对象转Json数据(POJO -> json)
 *  集合转Json数据(Collection -> json)

### 项目代码 ###

*  [gitee 代码下载][gitee]
 *  [github 代码下载][github]

[75d39081b1a3419cb52d39ebd790830a.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/bf62dda9187942068acb181e2bee6a9b.png
[85a0c3bca38540ce9d2a16cc59940f6a.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/744d90b2dc85429fb7ab13d3f46b88ef.png
[6d6078fd29b2423cb03795d57fe17295.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/0527f543041247cab7504f137ad37c6e.png
[d62f827ceba94efb907c2b99f8a32ff2.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/109c3b20e0434418b33fad93b5291ccc.png
[6aa8ab796dfd40418041677829dc6dfa.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/f37d74134dde4815baac0c591dfb70b3.png
[gitee]: https://gitee.com/DchuangDB/SpringMVCProject
[github]: https://github.com/dcbut/SpringMVCProject