SpringMVC （Servlet简化版） + Rest风格：设定请求动作和获取请求参数，响应结果

最新推荐文章于 2023-03-20 23:17:49 发布
最新推荐文章于 2023-03-20 23:17:49 发布
阅读量487 收藏 2
点赞数
分类专栏： java框架 文章标签： servlet java restful
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/habe33/article/details/125881826
版权

对于SpringMVC的学习，最终要达成的目标:

  1. 掌握基于SpringMVC获取请求参数和响应json数据操作
  2. 熟练应用基于REST风格的请求路径设置与参数传递
  3. 能够根据实际业务建立前后端开发通信协议并进行实现
  4. 基于SSM整合技术开发任意业务模块功能

1，SpringMVC简介

  • SpringMVC隶属于Spring，是Spring技术中的一部分。
  • SpringMVC框架是用来简化Servlet开发的
  • SpringMVC与Servlet技术功能等同，均属于web层或者说表现层开发技术。

1.1 SpringMVC和Servlet开发的对比：

Servlet开发： UserUpdateServlet:使用Servlet开发的用户修改模块

1. 设置web当前的访问路径:用于外部访问
2. 重写doGet/doPost方法，
3. 获取请求参数
4. 写入响应数据

@WebServlet("/user/update")
public class UserUpdateServlet extends HttpServlet{
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        //1.接收请求参数
        String name = req.getParameter("name");
        System.out.println("servlet update name ==> " + name);
        //2.生产响应
        resp.setContentType("text/json;charset=utf-8");
        PrintWriter pw = resp.getWriter();
        pw.write("{'module':'servlet update'}");
    }

    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        this.doGet(req,resp);
    }
}

SpringMVC开发：

@Controller
public class UserController {
    @RequestMapping("/update")
    @ResponseBody
    public String update(String name){
        System.out.println("springmvc update name ==> " + name);
        return "{'module':'springmvc update'}";
    } 
}

SpringMVC这种开发方式更简单、更高效。
SpringMVC是用来替换Servlet的，所以Servlet能实现的，SpringMVC就能实现。

1.2 SpringMVC主要内容

  • SpringMVC简介
    • SpringMVC简介：主要是来认识下到底什么是SpringMVC。
  • 请求与响应
    • 请求与相应：SpringMVC是替换Servlet处于Web的框架，所以其主要的作用就是用来接收前端发过来的请求和数据然后经过处理并将处理的结果响应给前端，所以如何处理请求和响应是SpringMVC中非常重要的一块内容。
  • REST风格
    • REST风格：是一种软件架构风格，可以降低开发的复杂性，提高系统的可伸缩性，在以后开发中非常重要和常用。
  • SSM整合(注解版)
    • SSM整合：是把咱们所学习的SpringMVC+Spring+Mybatis整合在一起来完成业务开发，是对我们所学习这三个框架的一个综合应用。
  • 拦截器

1.3 SpringMVC概述

我们要学习的SpringMVC究竟是一门什么技术呢?

  • SpringMVC是一种基于Java实现MVC模型的轻量级Web框架，用于表现层开发

  • 优点

    • 使用简单、开发便捷(相比于Servlet)
    • 灵活性强

当前WEB程序的工作流程: 三层架

  • web程序通过浏览器访问前端页面，发送异步请求到后端服务器

  • 后台服务器采用三层架构进行功能开发

    • 表现层负责接收请求和数据然后将数据转交给业务层
    • 业务层负责调用数据层完成数据库表的增删改查，并将结果返给表现层
    • 表现层将数据转换成json格式返回给前端

  • 前端页面将数据进行解析最终展示给用户。

表现层与数据层的技术选型:

  • 数据层采用Mybatis框架
  • 表现层采用SpringMVC框架，SpringMVC主要负责的内容有:
    • controller如何接收请求和数据
    • 如何将请求和数据转发给业务层
    • 如何将响应数据转换成json发回到前端

2，SpringMVC入门案例

因为SpringMVC是一个Web框架，将来是要替换之前我们所使用的Servlet

Servlet开发的流程

  1. 浏览器发送请求到Tomcat服务器
  2. Tomcat服务器接收到请求后，会根据请求路径来匹配对应的Servlet,并将请求交给对应的Servlet来处理

所以对于Servlet来说，我们主要完成的是Servlet类的开发以及对应路径的配置。

SpringMVC程序的流程

  1. 浏览器发送请求到Tomcat服务器
  2. Tomcat服务器接收到请求后，会将请求交给SpringMVC中的==DispatcherServlet[前端控制器]==来处理请求
  3. DispatcherServlet不真正处理请求，只是按照对应的规则将请求分发到对应的Bean对象
  4. Bean对象是由我们自己编写来处理不同的请求，每个Bean中可以处理一个或多个不同的请求url
  5. DispatcherServlet和Bean对象都需要交给Spring容器来进行管理

综上所述，需要我们编写的内容包含:

  • Bean对象的编写
  • 请求url和Bean对象对应关系的配置
  • 构建Spring容器，将DispatcherServlet和Bean对象交给容器管理
  • 配置Tomcat服务器，使其能够识别Spring容器，并将请求交给容器中的DispatcherServlet来分发请求

具体的实现步骤如下:

1.创建web工程(Maven结构)并在工程的pom.xml添加SpringMVC和Servlet坐标

2.创建SpringMVC控制器类(等同于Servlet功能)

3.初始化SpringMVC环境(同Spring环境)，设定SpringMVC加载对应的bean

4.初始化Servlet容器，加载SpringMVC环境，并设置SpringMVC技术处理的请求

2.1 需求分析

2.2 案例制作

步骤1:创建Maven项目，并导入对应的jar包

将pom.xml中添加SpringMVC需要的依赖

<?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.itheima</groupId>
  <artifactId>springmvc_01_quickstart</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>
   <!--1. 导入SpringMVC与servlet的坐标--> 
  <dependencies>
    <dependency>
      <groupId>javax.servlet</groupId>
      <artifactId>javax.servlet-api</artifactId>
      <version>3.1.0</version>
      <scope>provided</scope>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-webmvc</artifactId>
      <version>5.2.10.RELEASE</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>/</path>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

说明:servlet的坐标为什么需要添加<scope>provided</scope>?

  • scope是maven中jar包依赖作用范围的描述，

  • 如果不设置默认是compile在在编译、运行、测试时均有效

  • 如果运行有效的话就会和tomcat中的servlet-api包发生冲突，导致启动报错

  • provided代表的是该包只在编译和测试的时候用，运行的时候无效直接使用tomcat中的，就避免冲突

步骤2:创建SpringMVC控制器类=Servlet
//2.定义controller制作控制器类，等同于Servlet
//2.1使用@controller定义bean
@Controller
public class UserController {
    //2.2设置当前方法的访问路径
    @RequestMapping("/save")
    //2.3设置当前方法的返回值为相应内容
    @ResponseBody
    public String save(){
        System.out.println("user save ...");
        return "{'module':'springmvc'}";
    }
}
步骤3:创建配置类，初始化SpringMVC环境，设置加载的bean
//3.定义配置类加载Controller对应的bean
@Configuration
@ComponentScan("com.itheima.controller")
public class SpringMvcConfig {
}
步骤4:创建Tomcat的Servlet容器配置类,初始化Servlet容器，加载SpringMVC环境，并设置技术处理的请求
//4.定义servlet容器的配置类
public class ServletContainersInitConfig extends AbstractDispatcherServletInitializer {
    //加载springMVC配置
    protected WebApplicationContext createServletApplicationContext() {
        //初始化WebApplicationContext对象
        AnnotationConfigWebApplicationContext ctx = new AnnotationConfigWebApplicationContext();
        //加载指定配置类
        ctx.register(SpringMvcConfig.class);
        return ctx;
    }

    //设置Tomcat接收的请求哪些归SpringMVC处理
    protected String[] getServletMappings() {
        return new String[]{"/"};
    }

    //设置spring相关配置
    protected WebApplicationContext createRootApplicationContext() {
        AnnotationConfigWebApplicationContext ctx = new AnnotationConfigWebApplicationContext();
        ctx.register(SpringConfig.class);
        return ctx;
    }
}

简化开发：
对于上述的配置方式，Spring还提供了一种更简单的配置方式，可以不用再去创建AnnotationConfigWebApplicationContext对象，不用手动register对应的配置类，如何实现?

ServletContainersInitConfig容器配置类实现AbstractAnnotationConfigDispatcherServletInitializer接口

public class ServletContainersInitConfig extends AbstractAnnotationConfigDispatcherServletInitializer {

    protected Class<?>[] getRootConfigClasses() {
        return new Class[]{SpringConfig.class};
    }

    protected Class<?>[] getServletConfigClasses() {
        return new Class[]{SpringMvcConfig.class};
    }

    protected String[] getServletMappings() {
        return new String[]{"/"};
    }
}

知识点1：@Controller

名称@Controller
类型类注解
位置SpringMVC控制器类定义上方
作用设定SpringMVC的核心控制器bean

知识点2：@RequestMapping

名称@RequestMapping
类型类注解或方法注解
位置SpringMVC控制器类或方法定义上方
作用设置当前控制器方法请求访问路径
相关属性value(默认)，请求访问路径

知识点3：@ResponseBody

名称@ResponseBody
类型类注解或方法注解
位置SpringMVC控制器类或方法定义上方
作用设置当前控制器方法响应内容为当前返回值，无需解析

2.3 入门案例总结

SpringMVC入门程序开发总结(1+N)

  • 一次性工作
    • 创建工程，设置服务器，加载工程
    • 导入坐标
    • 创建web容器启动类，加载SpringMVC配置，并设置SpringMVC请求拦截路径
    • SpringMVC核心配置类（设置配置类，扫描controller包，加载Controller控制器bean）
  • 多次工作
    • 定义处理请求的控制器类
    • 定义处理请求的控制器方法，并配置映射路径（@RequestMapping）与返回json数据（@ResponseBody）
  • AbstractDispatcherServletInitializer类是SpringMVC提供的快速初始化Web3.0容器的抽象类
  • AbstractDispatcherServletInitializer提供三个接口方法供用户实现
    • createRootApplicationContext()方法，用来加载Spring环境,如果创建Servlet容器时需要加载非SpringMVC对应的bean，使用当前方法进行，使用方式同createServletApplicationContext()
    • createServletApplicationContext()方法，用来加载SpringMVC环境，创建Servlet容器时，加载SpringMVC对应的bean并放入WebApplicationContext对象范围中，而WebApplicationContext的作用范围为ServletContext范围，即整个web容器范围
    • getServletMappings()方法，设定SpringMVC对应的请求映射路径，设置为/表示拦截所有请求，任意请求都将转入到SpringMVC进行处理

为了更好的使用SpringMVC,我们将SpringMVC的使用过程总共分两个阶段：启动服务器初始化过程和单次请求过程
在这里插入图片描述

2.4 bean加载控制

SpringMvcConfig和SpringConfig，这两个配置类都需要加载资源，那么它们分别都需要加载哪些内容?

我们先来看下目前我们的项目目录结构:

  • config目录存入的是配置类,写过的配置类有:
    • ServletContainersInitConfig
    • SpringConfig
    • SpringMvcConfig
    • JdbcConfig
    • MybatisConfig
  • controller目录存放的是SpringMVC的controller类
  • service目录存放的是service接口和实现类
  • dao目录存放的是dao/Mapper接口

controller、service和dao这些类都需要被容器管理成bean对象，那么到底是该让SpringMVC加载还是让Spring加载呢?

  • SpringMVC加载其相关bean(表现层bean),也就是controller包下的类
  • Spring控制的bean
    • 业务bean(Service)
    • 功能bean(DataSource,SqlSessionFactoryBean,MapperScannerConfigurer等)

因为功能不同，如何避免Spring错误加载到SpringMVC的bean?
解决思路：

  • 加载Spring控制的bean的时候排除掉SpringMVC控制的备案

方式： 设置bean加载控制

  • 方式一:Spring加载的bean设定扫描范围为精准范围，例如service包、dao包等（常用）
@Configuration
@ComponentScan({"com.itheima.service","comitheima.dao"})
public class SpringConfig {
}
  • 方式二:Spring加载的bean设定扫描范围为com.itheima,排除掉controller包中的bean
@Configuration
@ComponentScan(value="com.itheima",
    excludeFilters=@ComponentScan.Filter(
    	type = FilterType.ANNOTATION,
        classes = Controller.class
    )
)
public class SpringConfig {
}

注解：

  • excludeFilters属性：设置扫描加载bean时，排除的过滤规则

  • type属性：设置排除规则，当前使用按照bean定义时的注解类型进行排除

    • ANNOTATION：按照注解排除（常用）
    • ASSIGNABLE_TYPE:按照指定的类型过滤
    • ASPECTJ:按照Aspectj表达式排除，基本上不会用
    • REGEX:按照正则表达式排除
    • CUSTOM:按照自定义规则排除

  • classes属性：设置排除的具体注解类，当前设置排除@Controller定义的bean

知识点1：@ComponentScan

名称@ComponentScan
类型类注解
位置类定义上方
作用设置spring配置类扫描路径，用于加载使用注解格式定义的bean
相关属性excludeFilters:排除扫描路径中加载的bean,需要指定类别(type)和具体项(classes)
includeFilters:加载指定的bean，需要指定类别(type)和具体项(classes)

4，请求与响应

SpringMVC是web层的框架，主要的作用是接收请求、接收数据、响应结果，是学习SpringMVC的重点内容，四部分内容:

  • 请求映射路径
  • 请求参数
  • 日期类型参数传递
  • 响应json数据

4.1 设置请求映射路径

避免请求路径重复
在这里插入图片描述

@Controller
@RequestMapping("/user")
public class UserController {

    @RequestMapping("/save")
    @ResponseBody
    public String save(){
        System.out.println("user save ...");
        return "{'module':'user save'}";
    }
    
    @RequestMapping("/delete")
    @ResponseBody
    public String save(){
        System.out.println("user delete ...");
        return "{'module':'user delete'}";
    }
}

@Controller
@RequestMapping("/book")
public class BookController {

    @RequestMapping("/save")
    @ResponseBody
    public String save(){
        System.out.println("book save ...");
        return "{'module':'book save'}";
    }
}

注意:

  • 当类上和方法上都添加了@RequestMapping注解，前端发送请求的时候，要和两个注解的value值相加匹配才能访问到。
  • @RequestMapping注解value属性前面加不加/都可以

4.2 请求参数:参数传递

关于请求参数的传递与接收是和请求方式有关系的，目前比较常见的两种请求方式为：

  • GET
  • POST

针对于不同的请求前端如何发送，后端如何接收?

4.2.1 POST、GET发送多个参数（相同获取方式）

发送请求与参数:

http://localhost/commonParam?name=itcast&age=15

接收参数：

@Controller
public class UserController {

    @RequestMapping("/commonParam")
    @ResponseBody
    public String commonParam(String name,int age){
        System.out.println("普通参数传递 name ==> "+name);
        System.out.println("普通参数传递 age ==> "+age);
        return "{'module':'commonParam'}";
    }
}
4.2.2 中文乱码处理
GET请求中文乱码

如果我们传递的参数中有中文，你会发现接收到的参数会出现中文乱码问题。

发送请求:http://localhost/commonParam?name=张三&age=18

出现乱码的原因相信大家都清楚，Tomcat8.5以后的版本已经处理了中文乱码的问题，但是IDEA中的Tomcat插件目前只到Tomcat7，所以需要修改pom.xml来解决GET请求中文乱码问题，设置访问路径编解码字符集

<build>
    <plugins>
      <plugin>
        <groupId>org.apache.tomcat.maven</groupId>
        <artifactId>tomcat7-maven-plugin</artifactId>
        <version>2.1</version>
        <configuration>
          <port>80</port><!--tomcat端口号-->
          <path>/</path> <!--虚拟目录-->
          <uriEncoding>UTF-8</uriEncoding><!--访问路径编解码字符集-->
        </configuration>
      </plugin>
    </plugins>
  </build>
POST请求中文乱码

解决方案:配置过滤器

public class ServletContainersInitConfig extends AbstractAnnotationConfigDispatcherServletInitializer {
    protected Class<?>[] getRootConfigClasses() {
        return new Class[0];
    }

    protected Class<?>[] getServletConfigClasses() {
        return new Class[]{SpringMvcConfig.class};
    }

    protected String[] getServletMappings() {
        return new String[]{"/"};
    }

    //乱码处理
    @Override
    protected Filter[] getServletFilters() {
        CharacterEncodingFilter filter = new CharacterEncodingFilter();
        filter.setEncoding("UTF-8");
        return new Filter[]{filter};
    }
}

CharacterEncodingFilter是在spring-web包中，所以用之前需要导入对应的jar包。

4.3 五种类型参数传递

  • 普通参数：
    • 地址参数名与形参变量名相同自动赋值，否则使用@RequestParam注解进行绑定
@RequestMapping("/commonParamDifferentName")
   @ResponseBody
   public String commonParamDifferentName(@RequestPaam("name") String userName , int age){
       System.out.println("普通参数传递 userName ==> "+userName);
       System.out.println("普通参数传递 age ==> "+age);
       return "{'module':'common param different name'}";
   }

  • POJO类型参数（即类对象）

    • 请求参数与形参对象中的属性对应即可完成参数传递
    • public String pojoParam(User user){}
    • 请求参数key的名称要和POJO中属性的名称一致，否则无法封装。

  • 嵌套POJO类型参数

    • 请求参数名与形参对象属性名相同，按照对象层次结构关系即可接收嵌套POJO属性参数

  • 数组类型参数

    • 同名请求参数可以直接映射到对应名称的形参数组对象中
    • public String arrayParam(String[] likes){}

  • 集合类型参数

    • 同名请求参数可以使用@RequestParam注解映射到对应名称的集合对象中作为数据
    • public String listParam(@RequestParam List<String> likes){}
    • 集合保存普通参数：请求参数名与形参集合对象名相同且请求参数为多个，@RequestParam绑定参数关系
    • 对于简单数据类型使用数组会比集合更简单些。

补充：

  • json类型参数:参数前添加@RequestBody注解

知识点1：@RequestParam

普通参数:url地址传参，地址参数名与形参变量名相同，定义形参即可接收参数。如果形参与地址参数名不一致该如何解决?
在这里插入图片描述

4.4 JSON数据传输参数

前面我们说过，现在比较流行的开发方式为异步调用。前后台以异步方式进行交换，传输的数据使用的是JSON,所以前端如果发送的是JSON数据，后端该如何接收?

对于JSON数据类型，我们常见的有三种:

  • json普通数组（[“value1”,“value2”,“value3”,…]）
  • json对象（{key1:value1,key2:value2,…}）
  • json对象数组（[{key1:value1,…},{key2:value2,…}]）

SpringMVC接收JSON数据的实现步骤为:

(1)导入jackson包

(2)使用PostMan发送JSON数据

(3)开启SpringMVC注解驱动，在配置类上添加@EnableWebMvc注解

(4)Controller方法的参数前添加@RequestBody注解

步骤1:pom.xml添加依赖

SpringMVC默认使用的是jackson来处理json的转换，所以需要在pom.xml添加jackson依赖

<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.9.0</version>
</dependency>
步骤2:PostMan发送JSON数据

在这里插入图片描述

步骤3:开启SpringMVC注解支持

在SpringMVC的配置类中开启SpringMVC的注解支持，这里面就包含了将JSON转换成对象的功能。

在这里插入图片描述

步骤4:参数前添加@RequestBody

使用@RequestBody注解将外部传递的json数组数据映射到形参的集合对象中作为数据
在这里插入图片描述

知识点1：@EnableWebMvc
名称@EnableWebMvc
类型配置类注解
位置SpringMVC配置类定义上方
作用开启SpringMVC多项辅助功能
知识点2：@RequestBody
名称@RequestBody
类型形参注解
位置SpringMVC控制器方法形参定义前面
作用将请求中请求体所包含的数据传递给请求参数，此注解一个处理器方法只能使用一次
@RequestBody与@RequestParam区别

  • 区别

    • @RequestParam用于接收url地址传参，表单传参【application/x-www-form-urlencoded】
    • @RequestBody用于接收json数据【application/json】

  • 应用

    • 后期开发中，发送json格式数据为主，@RequestBody应用较广
    • 如果发送非json格式数据，选用@RequestParam接收请求参数

4.5 日期类型参数传递:@DateTimeFormat(pattern=“”)

在这里插入图片描述

知识点1：@DateTimeFormat
名称@DateTimeFormat
类型形参注解
位置SpringMVC控制器方法形参前面
作用设定日期时间型数据格式
相关属性pattern：指定日期时间格式字符串
内部实现原理:类型转换 Converter接口

SpringMVC中的Converter接口：实现类型转换

在框架中，有一个类型转换接口，它有许多实现类

  • Converter接口
/**
*	S: the source type
*	T: the target type
*/
public interface Converter<S, T> {
    @Nullable
    //该方法就是将从页面上接收的数据(S)转换成我们想要的数据类型(T)返回
    T convert(S source);
}

注意:Converter所属的包为org.springframework.core.convert.converter

  • 请求参数年龄数据（String→Integer）
  • json数据转对象（json → POJO）
  • 日期格式转换（String → Date）

注意:SpringMVC的配置类把@EnableWebMvc当做标配配置上去，不要省略

4.6 响应:页面、数据（文本，json）

SpringMVC接收到请求和数据后，进行一些了的处理，当然这个处理可以是转发给Service，Service层再调用Dao层完成的，将结果告知给用户。
比如:根据用户ID查询用户信息、查询用户列表、新增用户等。

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

  • 响应页面：方法返回值类型设置为String，直接return “跳转页面地址”
  • 响应数据
    • 文本数据： @ResponseBody注解+方法返回值类型设置为String+return “返回文本”
    • json数据：@EnableWebMvc+@ResponseBody注解+方法返回值类型设置为实体类+return 实体类的对象

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

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

说明:

  • 该注解可以写在类上或者方法上
  • 写在类上就是该类下的所有方法都有@ReponseBody功能
  • 当方法上有@ReponseBody注解后
    • 方法的返回值为字符串，会将其作为文本内容直接响应给前端
    • 方法的返回值为对象，会将对象转换成JSON响应给前端，（类型转换器：HttpMessageConverter）
      • 对象转Json数据(POJO -> json)
      • 集合转Json数据(Collection -> json)
示例
4.6.2 响应页面[了解]
@Controller
public class UserController {
    
    @RequestMapping("/toJumpPage")
    //注意
    //1.此处不能添加@ResponseBody,如果加了该注入，会直接将page.jsp当字符串返回前端
    //2.方法需要返回String
    public String toJumpPage(){
        System.out.println("跳转页面");
        return "page.jsp";
    }
    
}
4.6.3 返回文本数据[了解]
@Controller
public class UserController {
    
   	@RequestMapping("/toText")
	//注意此处该注解就不能省略，如果省略了,会把response text当前页面名称去查找，如果没有回报404错误
    @ResponseBody
    public String toText(){
        System.out.println("返回纯文本数据");
        return "response text";
    }
    
}
4.6.4 响应JSON数据
响应POJO对象
@Controller
public class UserController {
    
    @RequestMapping("/toJsonPOJO")
    @ResponseBody
    public User toJsonPOJO(){
        System.out.println("返回json对象数据");
        User user = new User();
        user.setName("itcast");
        user.setAge(15);
        return user;
    }
    
}

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

响应POJO集合对象
@Controller
public class UserController {
    
    @RequestMapping("/toJsonList")
    @ResponseBody
    public List<User> toJsonList(){
        System.out.println("返回json集合数据");
        User user1 = new User();
        user1.setName("传智播客");
        user1.setAge(15);

        User user2 = new User();
        user2.setName("黑马程序员");
        user2.setAge(12);

        List<User> userList = new ArrayList<User>();
        userList.add(user1);
        userList.add(user2);

        return userList;
    }
    
}

5，Rest风格

对于Rest风格，我们需要学习的内容包括:

  • REST简介
  • REST入门案例
  • REST快速开发
  • 案例:基于RESTful页面数据交互

5.1 REST简介

  • REST（Representational State Transfer），表现形式状态转换,它是一种软件架构风格
    在这里插入图片描述
    问题： 一个相同的url地址即可以是新增也可以是修改或者查询，那么到底我们该如何区分该请求到底是什么操作呢?

  • 按照REST风格访问资源时使用行为动作区分对资源进行了何种操作
    * http://localhost/users 查询全部用户信息 GET（查询）
    * http://localhost/users/1 查询指定用户信息 GET（查询）
    * http://localhost/users 添加用户信息 POST（新增/保存）
    * http://localhost/users 修改用户信息 PUT（修改/更新）
    * http://localhost/users/1 删除用户信息 DELETE（删除）

  • 请求的方式比较多，但是比较常用的就4种，分别是GET,POST,PUT,DELETE。按照不同的请求方式代表不同的操作类型。

  • 描述模块的名称通常使用复数，也就是加s的格式描述，表示此类资源，而非单个资源，例如:users、books、accounts…

  • 根据REST风格对资源进行访问称为RESTful。

后期我们在进行开发的过程中，大多是都是遵从REST风格来访问我们的后台服务，所以可以说咱们以后都是基于RESTful来进行开发的。

5.2 RESTful风格 示例：设定请求动作和获取请求参数

(1)设定Http请求动作(动词)

@RequestMapping(value=“”,method = RequestMethod.POST|GET|PUT|DELETE)

(2)设定请求参数(路径变量)

@RequestMapping(value=“/users/{id}”,method = RequestMethod.DELETE)

@ReponseBody

public String delete(@PathVariable Integer id){

}
在这里插入图片描述

在这里插入图片描述

新增
@Controller
public class UserController {
	//设置当前请求方法为POST，表示REST风格中的添加操作
    @RequestMapping(value = "/users",method = RequestMethod.POST)
    @ResponseBody
    public String save() {
        System.out.println("user save...");
        return "{'module':'user save'}";
    }
}

  • 将请求路径更改为/users

    • 访问该方法使用 POST: http://localhost/users

  • 使用method属性限定该方法的访问方式为POST

    • 如果发送的不是POST请求，比如发送GET请求，则会报错
删除 + 传递路径参数

前端发送请求的时候使用:http://localhost/users/1,路径中的1就是我们想要传递的参数。

后端获取参数，需要做如下修改:

  • 修改@RequestMapping的value属性，将其中修改为/users/{id}，目的是和路径匹配
  • 在方法的形参前添加@PathVariable注解
@Controller
public class UserController {
    //设置当前请求方法为DELETE，表示REST风格中的删除操作
	@RequestMapping(value = "/users/{id}",method = RequestMethod.DELETE)
    @ResponseBody
    public String delete(@PathVariable Integer id) {
        System.out.println("user delete..." + id);
        return "{'module':'user delete'}";
    }
}

思考如下两个问题:

(1)如果方法形参的名称和路径{}中的值不一致，该怎么办?

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-ZecoLDzw-1658238518379)(assets/1630506231379.png)]

(2)如果有多个参数需要传递该如何编写?

前端发送请求的时候使用:http://localhost/users/1/tom,路径中的1和tom就是我们想要传递的两个参数。

后端获取参数，需要做如下修改:

@Controller
public class UserController {
    //设置当前请求方法为DELETE，表示REST风格中的删除操作
	@RequestMapping(value = "/users/{id}/{name}",method = RequestMethod.DELETE)
    @ResponseBody
    public String delete(@PathVariable Integer id,@PathVariable String name) {
        System.out.println("user delete..." + id+","+name);
        return "{'module':'user delete'}";
    }
}
知识点1：接收参数的方法对比（注解）

关于接收参数，我们学过三个注解@RequestBody、@RequestParam、@PathVariable,这三个注解之间的区别和应用分别是什么?

  • 区别
    • @RequestParam用于接收url地址传参或表单传参，即get访问
    • @RequestBody用于接收json数据
    • @PathVariable用于接收路径参数，使用{参数名称}描述路径参数
  • 应用
    • 后期开发中，发送请求参数超过1个时，以json格式为主，@RequestBody应用较广
    • 如果发送非json格式数据，选用@RequestParam接收请求参数
    • 采用RESTful进行开发，当参数数量较少时，例如1个，可以采用@PathVariable接收请求路径变量，通常用于传递id值

5.3 RESTful快速开发：简化5.2

问题1：每个方法的@RequestMapping注解中都定义了访问路径/books，重复性太高。

将@RequestMapping提到类上面，用来定义所有方法共同的访问路径。

问题2：每个方法的@RequestMapping注解中都要使用method属性定义请求方式，重复性太高。

使用@GetMapping  @PostMapping  @PutMapping  @DeleteMapping代替

问题3：每个方法响应json都需要加上@ResponseBody注解，重复性太高。

1.将ResponseBody提到类上面，让所有的方法都有@ResponseBody的功能
2.使用@RestController注解替换@Controller与@ResponseBody注解，简化书写

示例：

@RestController //@Controller + ReponseBody
@RequestMapping("/books")
public class BookController {
    
	//@RequestMapping(method = RequestMethod.POST)
    @PostMapping
    public String save(@RequestBody Book book){
        System.out.println("book save..." + book);
        return "{'module':'book save'}";
    }

    //@RequestMapping(value = "/{id}",method = RequestMethod.DELETE)
    @DeleteMapping("/{id}")
    public String delete(@PathVariable Integer id){
        System.out.println("book delete..." + id);
        return "{'module':'book delete'}";
    }

    //@RequestMapping(method = RequestMethod.PUT)
    @PutMapping
    public String update(@RequestBody Book book){
        System.out.println("book update..." + book);
        return "{'module':'book update'}";
    }

    //@RequestMapping(value = "/{id}",method = RequestMethod.GET)
    @GetMapping("/{id}")
    public String getById(@PathVariable Integer id){
        System.out.println("book getById..." + id);
        return "{'module':'book getById'}";
    }

    //@RequestMapping(method = RequestMethod.GET)
    @GetMapping
    public String getAll(){
        System.out.println("book getAll...");
        return "{'module':'book getAll'}";
    }
    
}
知识点1：@RestController
名称@RestController
类型类注解
位置基于SpringMVC的RESTful开发控制器类定义上方
作用设置当前控制器类为RESTful风格，
等同于@Controller与@ResponseBody两个注解组合功能
知识点2：@GetMapping @PostMapping @PutMapping @DeleteMapping
名称@GetMapping @PostMapping @PutMapping @DeleteMapping
类型方法注解
位置基于SpringMVC的RESTful开发控制器方法定义上方
作用设置当前控制器方法请求访问路径与请求动作，每种对应一个请求动作，
例如@GetMapping对应GET请求
相关属性value（默认）：请求访问路径

5.4 RESTful案例

小孙努力学
关注
  • 0
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
servlet(获取请求参数)
m0_52896752的博客
08-04 3246
servlet获取请求参数
裸奔编程之使用Servlet实现REST风格 单纯使用Servlet进行完成REST解析
nieyong的专栏
02-17 4838
其实单纯使用Servlet已经可以完成对REST风格URL的解析任务。我们今天就尝试着写一个简单的DEMO程序，使用一个Servlet 完成 get，put，post，delete  四种请求。在编写前，先叙述一下编程环境：JDK 1.5 + TOMCAT 5.5 + Eclipse 3.2我们今天模拟在客户端使用AJAX或直接FORM提交，对同一个URL地址 ： http://你的域名/game
servlet实现restful风格调用
shawemou的博客
06-25 4093
新建立一个web项目,并导入jar包 jar包下载 或者新建一个maven项目,导入以下依赖 2.建立web入口 &amp;amp;lt;?xml version=&amp;quot;1.0&amp;quot; encoding=&amp;quot;UTF-8&amp;quot;?&amp;amp;gt; &amp;amp;lt;web-app xmlns:xsi=&amp;quot;http://www.w3.org/2001
Servlet（接口编程）
希望有点用
06-25 2126
Servlet（接口编程）
使用最基本的javaEE技术（servlet）来实现rest风格
你好小C的博客
02-11 3925
今天试了一下使用最基本的servlet来实现rest风格web项目，下面是我写的一个demo，非常成功。
Spring MVC请求参数与响应结果全局加密和解密详解
08-27
主要给大家介绍了关于Spring MVC请求参数与响应结果全局加密和解密的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
学习SpringMVC——如何获取请求参数详解
09-01
本篇文章主要介绍了SpringMVC——如何获取请求参数详解，详细的介绍了每种参数注解的用法。具有一定的参考价值，感兴趣的小伙伴们可以参考一下。
SSM后台整合（Spring+SpringMvc+Mybtis+事务+Rest风格+统一结果封装+统一异常处理+拦截器）
02-08
SSM后台整合（Spring+SpringMvc+Mybtis+事务+Rest风格+统一结果封装+统一异常处理+拦截器） 适合新手练习，熟悉ssm框架 也适合需要进行ssm框架开发的同学，直接无需搭建框架，拿来即用哦
SpringMVC的REST风格的四种请求方式总结
08-29
下面小编就为大家带来一篇SpringMVC的REST风格的四种请求方式总结。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧
SpringMvc+Servlet3.0+tomcat 整合源码。
04-09
SpringMvc+Servlet3.0+tomcat 整合源码
java通过servlet实现restful接口示例
热门推荐
a249130的博客
07-31 1万+
项目结构： JsonServlet.java代码： package com.demo; import java.io.IOException; import java.io.PrintWriter; import java.util.ArrayList; import java.util.List; import javax.servlet.ServletException; imp...
用Servlet简单实现RESTful
weixin_30247307的博客
04-25 1728
由于是本人在自己开发的公司项目中节选出来备忘，有关公司信息用***代替掉。 Demo package ***.servlet.admin; import java.util.List; import javax.servlet.annotation.WebServlet; import javax.servlet.http.HttpServletRequest; im...
servlet接受请求常用方法
玩转Java
08-31 414
servlet接受请求常用方法： /*设置编码*/ request.setCharacterEncoding("utf-8"); response.setContentType("text/html;charset=utf-8"); /*获取表单属性值*/ String name=request.getParameter("uname"); String pwd = request.getParameter("pwd");
django-restful中的response返回数据格式
chenGL
12-23 2312
在django-restful中自定义方法的时候，需要给定返回的response 通常会使用from rest_framework.response import Response 引入使用 但是有时候我们需要自定义为业务所需的规范格式，就需要对response进行自定义格式 首先需要对自定义一个类来继承response类， from django.utils import six from ...
Java Servlet RESTFul 客户端
allway2的博客
03-28 955
在 Java Servlet RESTFul 客户端教程中，我们使用 JAX-RS 在 Java Servlet 中创建了一个 RESTFul 客户端。 Java API for RESTful Web Services (JAX-RS)是一种 Java API 规范，它支持根据具象状态传输 (REST) 架构模式创建 Web 服务。 RESTEasy是一个 Java RESTful Web 服务框架和来自 JBoss 的 JAX-RS 实现。 Servlet是一个 Java 类，它响应特定类型的网络
springMvc概述 请求与响应 REST风格 各类注解的作用以及应用方法
young_young_Boy的博客
06-15 464
SpringMVC概述 请求与响应 REST风格 各类注解的作用以及应用方法
Java Restful API接口获取请求头、请求体、以及设置响应状态码、应答(响应)体等
hkl_Forever的博客
03-20 4287
【1】一般我们会为 @PostMapping、@PutMapping、@PatchMapping 请求方式设置请求体，@GetMapping、@DeleteMapping 通过路径传参，不设置请求体(也可以设置请求体)1、从 request 对象中，使用缓冲流读取器、stream流等方式获取请求体。3、通过 response 对象可以通过输出流对象，以字节的方式写入响应体。1、使用缓冲读取器读取 request 的输入流对象，可以获得请求体。2、把响应体写入输出流之后，需要冲刷、关闭输出流对象。
springboot 讲解RestController中获取请求的各种参数
qq_095的博客
08-18 7863
import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; import org.springframework.data.rest.webmvc.ResourceNotFoundException; import org.springframework.web.bind.annotati...
Restful风格请求 后端接口参数接收详解
java全栈工程师
08-03 1万+
基于restful api接口规范，在SpringBoot项目中，前端HTTP请求中的参数如何映射到Controller层的接口方法中的参数？这里针对各种方式做一个测试与总结。
SpringMVC 中的 HandlerMehtod 如何获取请求报文数据和响应报文数据？
最新发布
06-01
在 SpringMVC 中，HandlerMethod 可以通过添加注解的方式来获取请求报文数据和响应报文数据。 要获取请求报文数据，可以在 HandlerMethod 的方法参数中添加 @RequestBody 注解，这样就可以将请求报文数据自动映射到方法参数中。 要获取响应报文数据，可以在 HandlerMethod 的方法上添加 @ResponseBody 注解，返回类型可以是任意类型，SpringMVC 会自动将其序列化为 JSON/XML 格式的响应报文数据。 此外，还可以通过 HttpServletRequest 和 HttpServletResponse 对象来获取请求报文数据和响应报文数据。可以通过 HttpServletRequest#getInputStream() 方法获取请求报文输入流，通过 HttpServletResponse#getOutputStream() 方法获取响应报文输出流。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值