SpringBootWeb请求

1、请求

如何接收页面传递过来的请求数据

1.1 Apifox

在这里插入图片描述
在这种模式下,前端技术人员基于"接口文档",开发前端程序;后端技术人员也基于"接口文档",开发
后端程序。
由于前后端分离,对我们后端技术人员来讲,在开发过程中,是没有前端页面的,那我们怎么测试自己
所开发的程序呢?

  • 方式1:像之前SpringBoot入门案例中一样,直接使用浏览器。在浏览器中输入地址,测试后端程序。

弊端:在浏览器地址栏中输入地址这种方式都是GET请求,如何我们要用到POST请求怎么办呢?
要解决POST请求,需要程序员自己编写前端代码(比较麻烦)

  • 方式2:使用专业的接口测试工具(使用Postman / Apifox等工具)

1.1.1 介绍

  • Apifox = Postman + Swagger + Mock + JMeter
  • 作用:常用于进行接口测试。
    只要定义好 API 文档,API 调试、API Mock、API 自动化测试即可直接使用,无需再次定义。
    API 文档和 API 开发调试使用同一个工具,API 调试完成后即可保证和 API 文档定义完全一致。高效、及时、准确!
  • 支持
    API 文档
    API 调试
    API Mock
    API 自动化测试

1.1.2 安装(省略)

1.2 简单参数

简单参数:在向服务器发起请求时,向服务器传递的是一些普通的请求数据。
在这里插入图片描述
那么在后端程序中,如何接收传递过来的普通参数数据呢?
我们在这里讲解两种方式:

  1. 原始方式
  2. SpringBoot方式

1.2.1 原始方式

在原始的Web程序当中,需要通过Servlet中提供的API:HttpServletRequest(请求对象),获取
请求的相关信息。比如获取请求参数:

Tomcat接收到http请求时:把请求的相关信息封装到HttpServletRequest对象中

在Controller中,我们要想获取Request对象,可以直接在方法的形参中声明
HttpServletRequest 对象。然后就可以通过该对象来获取请求信息:

//根据指定的参数名获取请求参数的数据值
String request.getParameter("参数名")

com.xxx -> controller -> RequestController.java

package com.itheima.controller;

import jakarta.servlet.http.HttpServletRequest;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class RequestController {
    @RequestMapping("/simple")
    public String simpleParam(HttpServletRequest request) {
		// http://localhost:8080/simpleParam?name=张三&age=23
		// 请求参数: name=张三&age=23 (有2个请求参数)
		// 第1个请求参数: name=张三 参数名:name,参数值:张三
		// 第2个请求参数: age=23 参数名:age , 参数值:23
		
        String name = request.getParameter("name"); //name就是请求参数
        String ageStr = request.getParameter("age"); //age就是请求参数
        int age = Integer.parseInt(ageStr); //需要手动进行类型转换
        System.out.println(name + ":" + age);
        return "OK";
    }
}

以上这种方式,我们仅做了解。(在以后的开发中不会使用到)

1.2.2 SpringBoot方式

在Springboot的环境中,对原始的API进行了封装,接收参数的形式更加简单。 如果是简单参数,参
数名与形参变量名相同,定义同名的形参即可接收参数。

	@RestController
	public class RequestController {
		// http://localhost:8080/simpleParam?name=Tom&age=10
		// 第1个请求参数: name=张三 参数名:name,参数值:张三
		// 第2个请求参数: age=23 参数名:age , 参数值:23
		//springboot方式
		@RequestMapping("/simpleParam")
		public String simpleParam(String name , Integer age ){//形参名和请求参数名保持一致
			System.out.println(name+" : "+age);
			return "OK";
    	}
	}

Apifox测试( GET 请求):
在这里插入图片描述
Apifox测试( POST请求 ):
在这里插入图片描述

结论:不论是GET请求还是POST请求,对于简单参数来讲,只要保证 请求参数名和Controller
方法中的形参名保持一致 ,就可以获取到请求参数中的数据值。

1.2.3 参数名不一致

如果方法形参名称与请求参数名称不一致,controller方法中的形参还能接收到请求参数值吗?

@RestController
public class RequestController {
	// http://localhost:8080/simpleParam?name=Tom&age=20
	// 请求参数名:name
	//springboot方式
	@RequestMapping("/simpleParam")
	public String simpleParam(String username , Integer age ){ //请求参数名和形参名不相同
		System.out.println(username +" : "+age);
		return "OK";
	}
}

答案:运行没有报错。 controller方法中的username值为:null,age值为20

  • 结论:对于简单参数来讲,请求参数名和controller方法中的形参名不一致时,无法接收到请求
    数据

那么如果我们开发中,遇到了这种请求参数名和controller方法中的形参名不相同,怎么办?
解决方案:可以使用Spring提供的@RequestParam注解完成映射
在方法形参前面加上 @RequestParam 然后通过value属性执行请求参数名,从而完成映射。代码如下:

@RestController
public class RequestController {
	// http://localhost:8080/simpleParam?name=Tom&age=20
	// 请求参数名:name
	//springboot方式
	@RequestMapping("/simpleParam")
	public String simpleParam(@RequestParam("name") String username, Integer age ){
		System.out.println(username+" : "+age);
		return "OK";
	}
}

注意事项:
@RequestParam中的required属性默认为true(默认值也是true),代表该请求参数必须传
递,如果不传递将报错
在这里插入图片描述

@RequestMapping("/simple")
// springboot方式
public String simpleParam(@RequestParam(name = "name", required = false) String username, Integer age) {
     System.out.println(username + ": " + age);
     return "OK";
}

1.2.4 小结

在这里插入图片描述

1.3 实体参数

在使用简单参数做为数据传递方式时,前端传递了多少个请求参数,后端controller方法中的形参就
要书写多少个。如果请求参数比较多,通过上述的方式一个参数一个参数的接收,会比较繁琐。
此时,我们可以考虑将请求参数封装到一个实体类对象中。 要想完成数据封装,需要遵守如下规则:
请求参数名与实体类的属性名相同
在这里插入图片描述

1.3.1 简单实体对象

定义POJO实体类:
com.xxx -> pojo -> User.java

package com.itheima.pojo;

public class User {
    private String name;
    private int age;
    
    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    @Override
    public String toString() {
        return "User{" +
                "name='" + name + '\'' +
                ", age=" + age +
                '}';
    }
}

Controller方法:

@RestController
public class RequestController {
	//实体参数:简单实体对象
    @RequestMapping("/simplePojo")
    public String simplePojo(User user) {
        System.out.println(user);
        return "OK";
    }
}

Apifox测试:

  • 参数名和实体类属性名一致时

在这里插入图片描述
在这里插入图片描述

  • 参数名和实体类属性名不一致时
    在这里插入图片描述
    在这里插入图片描述

1.3.2 复杂实体对象

复杂实体对象指的是,在实体类中有一个或多个属性,也是实体对象类型的。如下:

  • User类中有一个Address类型的属性(Address是一个实体类)

在这里插入图片描述
复杂实体对象的封装,需要遵守如下规则:

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

定义POJO实体类:

  • Address实体类
    com.xxx -> pojo -> Address.java
package com.itheima.pojo;

public class Address {
    private String province;
    private String city;

    public String getProvince() {
        return province;
    }

    public void setProvince(String province) {
        this.province = province;
    }

    public String getCity() {
        return city;
    }

    public void setCity(String city) {
        this.city = city;
    }

    @Override
    public String toString() {
        return "Address{" +
                "province='" + province + '\'' +
                ", city='" + city + '\'' +
                '}';
    }
}

  • User实体类
    com.xxx -> pojo -> User.java
package com.itheima.pojo;

public class User {
    private String name;
    private int age;

    private Address address;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    public Address getAddress() {
        return address;
    }

    public void setAddress(Address address) {
        this.address = address;
    }

    @Override
    public String toString() {
        return "User{" +
                "name='" + name + '\'' +
                ", age=" + age +
                ", address=" + address +
                '}';
    }
}

Controller方法:

@RestController
public class RequestController {
// 实体参数:复杂实体对象
@RequestMapping("/complexPojo")
    public String complexPojo(User user) {
        System.out.println(user);
        return "OK";
    }
}

Apifox测试:
在这里插入图片描述
在这里插入图片描述

1.3.3 小结

在这里插入图片描述

1.4 数组集合参数

数组集合参数的使用场景:在HTML的表单中,有一个表单项是支持多选的(复选框),可以提交选择的多个值。
在这里插入图片描述
多个值是怎么提交的呢?其实多个值也是一个一个的提交。
后端程序接收上述多个值的方式有两种:

  1. 数组
  2. 集合

1.4.1 数组

数组参数:请求参数名与形参数组名称相同且请求参数为多个,定义数组类型形参即可接收参数

在这里插入图片描述
Controller方法:

@RestController
public class RequestController {
	// 数组集合参数
	@RequestMapping("/arrayParam")
    public String arrayParam(String[] hobby) {
        System.out.println(Arrays.toString(hobby));
        return "OK";
    }
}

Postman测试:
在前端请求时,有两种传递形式:

  • 方式一: xxxxxxxxxx?hobby=game&hobby=java

在这里插入图片描述

  • 方式二:xxxxxxxxxxxxx?hobby=game,java

在这里插入图片描述

1.4.2 集合

集合参数:请求参数名与形参集合对象名相同且请求参数为多个,@RequestParam 绑定参数关系

默认情况下,请求中参数名相同的多个值,是封装到数组。如果要封装到集合,要使用
@RequestParam绑定参数关系

在这里插入图片描述
Controller方法:

@RestController
public class RequestController {
	// 数组集合参数
	@RequestMapping("/listParam")
    public String listParam(@RequestParam List<String> hobby) {
        System.out.println(hobby);
        return "OK";
    }
}

Postman测试:

  • 方式一: xxxxxxxxxx?hobby=game&hobby=java
    在这里插入图片描述
  • 方式二:xxxxxxxxxxxxx?hobby=game,java
    在这里插入图片描述

1.5 日期参数

上述演示的都是一些普通的参数,在一些特殊的需求中,可能会涉及到日期类型数据的封装。比如,如下需求:
在这里插入图片描述因为日期的格式多种多样(如:2022-12-12 10:05:45 、2022/12/12 10:05:45),那么对于日
期类型的参数在进行封装的时候,需要通过@DateTimeFormat注解,以及其pattern属性来设置日期
的格式。
在这里插入图片描述

  • @DateTimeFormat 注解的 pattern 属性中指定了哪种日期格式,前端的日期参数就必须按照指定 的格式传递。
  • 后端controller方法中,需要使用 Date 类型或 LocalDateTime 类型,来封装传递的参数。

Controller方法:

@RestController
public class RequestController {
	// 日期时间参数
	@RequestMapping("/dateParam")
    public String dateParam(@DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss") LocalDateTime updateTime) {
        System.out.println(updateTime);
        return "OK";
    }
}

Apifox测试:
在这里插入图片描述

1.6 JSON参数

在学习前端技术时,我们有讲到过JSON,而在前后端进行交互时,如果是比较复杂的参数,前后端通过
会使用JSON格式的数据进行传输。 (JSON是开发中最常用的前后端数据交互方式)
我们学习JSON格式参数,主要从以下两个方面着手:

  1. Postman在发送请求时,如何传递json格式的请求参数
  2. 在服务端的controller方法中,如何接收json格式的请求参数

Apifox发送JSON格式数据:
在这里插入图片描述
服务端Controller方法接收JSON格式数据:

  • 传递json格式的参数,在Controller中会使用实体类进行封装。

  • 封装规则:JSON数据键名与形参对象属性名相同,定义POJO类型形参即可接收参数。
    需要使用@RequestBody标识。
    在这里插入图片描述

  • @RequestBody注解:将JSON数据映射到形参的实体类对象中(JSON中的key和实体类中的属性 名保持一致)
    实体类:Address

public class Address {
	private String province;
	private String city;
 	//省略GET , SET 方法
}

实体类:User

public class User {
	private String name;
	private Integer age;
	private Address address;
	//省略GET , SET 方法
} 

Controller方法:

@RestController
public class RequestController {
	// JSON参数
	@RequestMapping("/jsonParam")
    public String jsonParam(@RequestBody User user) {
        System.out.println(user);
        return "OK";
    }
}

Apifox测试:
在这里插入图片描述
在这里插入图片描述

1.7 路径参数

传统的开发中请求参数是放在请求体(POST请求)传递或跟在URL后面通过?key=value的形式传递
(GET请求)。
在这里插入图片描述
在现在的开发中,经常还会直接在请求的URL中传递参数。例如:

http://localhost:8080/user/1
http://localhost:8080/user/1/0

上述的这种传递请求参数的形式呢,我们称之为:路径参数。
学习路径参数呢,主要掌握在后端的controller方法中,如何接收路径参数。
路径参数:

  • 前端:通过请求URL直接传递参数
  • 后端:使用{…}来标识该路径参数,需要使用@PathVariable获取路径参数

在这里插入图片描述

1.7.1 传递一个路径参数

Controller方法:

@RestController
public class RequestController {
	// 路径参数
	@RequestMapping("path/{id}")
    public String pathParam(@PathVariable Integer id) {
        System.out.println(id);
        return "OK";
    }
}

Apifox测试:
在这里插入图片描述

1.7.2 传递多个路径参数

Apifeox:
在这里插入图片描述
Controller方法:

@RestController
public class RequestController {
	// 路径参数
	@RequestMapping("path/{id}/{name}")
    public String pathParam(@PathVariable Integer id, @PathVariable String name) {
        System.out.println(id);
        System.out.println(name);
        return "OK";
    }
}

总结

在这里插入图片描述

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值