postman
Postman是一款功能强大的网页调试与发送网页HTTP请求的Chrome插件
作用:常用于进行接口测试
简单参数
原始方式
在原始的web程序中,获取请求参数,需要通过HttpServletRequest 对象手动获
http://localhost:8080/simpleParam?name=Tom&age=10
SpringBoot方式
简单参数:参数名与形参变量名相同,定义形参即可接收参数
1.编写代码
@RequestMapping("/simpleParam")
public String simpleParam(String name,Integer age){
System.out.println(name + ":" + age);
return "ok";
}
2. 启动程序
3.打开postman工具,点击发送,显示ok
http://localhost:8080/simpleParam?name=Tom&age=18
4.返回控制台查看
如果是POST方式 无需修改Java代码
其余步骤一样
简单参数:如果方法形参名称与请求参数名称不匹配,可以使用 @RequestParam 完成映射。
//简单参数
@RequestMapping("/simpleParam")
public String simpleParam(@RequestParam(name="name") String username, Integer age){
System.out.println(username + ":" + age);
return "ok";
}
注意事项
@RequestParam中的required属性默认为true,代表该请求参数必须传递,如果不传递将报错。
如果该参数是可选的,可以将required属性设置为false。
1.原始方式获取请求参数
Controller方法形参中声明HttpServletRequest对象
调用对象的getParameter(参数名)
2.SpringBoot中接收简单参数
请求参数名与方法形参变量名相同
会自动进行类型转换
3.@RequestParam注解
方法形参名称与请求参数名称不匹配,通过该注解完成映射
该注解的required属性默认是true,代表请求参数必须传递
实体参数
简单实体对象
请求参数名与形参对象属性名相同,定义POJO接收即可
1.定义User类
public class User {
private String name;
private Integer age;
@Override
public String toString() {
return "User{" +
"name='" + name + '\'' +
", age=" + age +
'}';
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public Integer getAge() {
return age;
}
public void setAge(Integer age) {
this.age = age;
}
}
2.在controller中编写请求代码
//实体参数
@RequestMapping("/simplePojo")
public String simplePojo(User user){
System.out.println(user);
return "OK";
}
3.点开postman工具
http://localhost:8080/simplePojo?name=ITCAST&age=10
4.返回idea控制台显示
复杂实体对象
请求参数名与形参对象属性名相同,按照对象层次结构关系即可接收嵌套POIO属性
参数
1.定义Address类
package com.example.springboot01.pojo;
/**
* @author hyk~
*/
public class Address {
private String province;
private String city;
@Override
public String toString() {
return "Address{" +
"province='" + province + '\'' +
", city='" + 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;
}
}
2.在User类中添加新的属性
package com.example.springboot01.pojo;
/**
* @author hyk~
*/
public class User {
private String name;
private Integer age;
private Address address;
@Override
public String toString() {
return "User{" +
"name='" + name + '\'' +
", age=" + age +
", address=" + address +
'}';
}
public Address getAddress() {
return address;
}
public void setAddress(Address address) {
this.address = address;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public Integer getAge() {
return age;
}
public void setAge(Integer age) {
this.age = age;
}
}
3.编写请求方法
//复杂实体对象
@RequestMapping("/complexPojo")
public String complexPojo(User user){
System.out.println(user);
return "ok";
}
4.运行 并在postman中发送
http://localhost:8080/complexPojo?name=ITCAST&age=20&address.province=湖南&address.city=长沙
5.控制台输出
实体对象参数
规则: 请求参数名与形参对象属性名相同,即可直接通过POJO接收
数组集合参数
数组参数
请求参数名与形参数组名称相同且请求参数为多个,定义数组类型形参即可接收参数
//数组集合参数
@RequestMapping("/arrayParam")
public String arrayParam(String hobby[]){
System.out.println(Arrays.toString(hobby));
return "ok";
}
http://localhost:8080/arrayParam?hobby=game&hobby=java&hobby=sing
集合参数
请求参数名与形参集合名称相同且请求参数为多个,@RequestParam 绑定参数关系
//集合参数
@RequestMapping("/listParam")
public String listParam(@RequestParam List<String> hobby){
System.out.println(hobby);
return "ok";
}
http://localhost:8080/listParam?hobby=game&hobby=java&hobby=sing
小结
数组集合参数
数组: 请求参数名与形参中数组变量名相同,可以直接使用数组封装
集合:请求参数名与形参中集合变量名相同,通过@RequestParam绑定参数关系
日期参数
日期参数:使用 @DateTimeFormat 注解完成日期参数格式转换
//日期参数
@RequestMapping("/dateParam")
public String dateParam(@DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")LocalDateTime updateTime){
System.out.println(updateTime);
return "ok";
}
http://localhost:8080/dateParam?updateTime=2024-12-12 10:00:05
JSON参数
JSON参数:JSON数据键名与形参对象属性名相同,定义POJO类型形参即可接收参数,需要使用 @RequestBody 标识
1.编写请求方法
//JSON参数
@RequestMapping("/jsonParam")
public String jsonParam(@RequestBody User user){
System.out.println(user);
return "ok";
}
2.在postman中点击发送
http://localhost:8080/jsonParam
-
URL:请求的URL是
http://localhost:8080/jsonParam
,这表明请求是发送到本地服务器上的/jsonParam
路径。 -
请求方法:使用的是POST方法,这意味着请求的主要目的是向服务器发送数据。
-
Body部分:
- Body类型:选择了
raw
,表示你要发送的是原始数据。 - 数据格式:选择了
JSON
,这表示你发送的数据格式是JSON。
- Body类型:选择了
-
发送的数据:
- JSON对象包含三个键值对:
"name": "ITCAST"
:表示名称为ITCAST
。"age": 16
:表示年龄为16。"address"
:是一个嵌套的JSON对象,包含两个键值对:"province": "北京"
:表示省份为北京。"city": "北京"
:表示城市为北京。
- JSON对象包含三个键值对:
-
响应:
- 请求成功发送,并且服务器返回了
200 OK
的状态码,表示请求成功。 - 返回的内容是一个字符串
"ok"
。
- 请求成功发送,并且服务器返回了
这个操作是在通过Postman向一个本地服务器的接口发送一个JSON格式的请求数据,并成功得到了服务器的响应。
编写json代码
{
"name":"ITCAST",
"age":16,
"address":{
"province":"北京",
"city":"北京"
}
}
3.运行
路径参数
通过请求URL直接传递参数,使用{...}来标识该路径参数,需要使用 @PathVariable 获取路径参数
//路径参数
@RequestMapping("/path/{id}")
public String pathParam(@PathVariable Integer id){
System.out.println(id);
return "ok";
}
获取多个路径参数
@RequestMapping("/path/{id}/{name}")
public String pathParam(@PathVariable Integer id,@PathVariable String name){
System.out.println(id+":"+name);
return "ok";
}
http://localhost:8080/path/200/Tom
总结
1.简单参数
定义方法形参,请求参数名与形参变量名一致
如果不一致,通过@RequestParam手动映射
2.实体参数
请求参数名,与实体对象的属性名一致,会自动接收封装
3.数组集合参数
数组: 请求参数名与数组名一致,直接封装
集合: 请求参数名与集合名一致,@RequestParam绑定关系
4.日期参数
@DateTimeFormat
5.JSON参数
@RequestBody
6.路径参数
@PathVariable