测试工具 Postman的使用

1.简单参数

简单参数：在向服务器发起请求时，向服务器传递的是一些普通的请求数据。 在后端程序中，

原始方式接收： 在原始的Web程序当中，需要通过Servlet中提供的API：HttpServletRequest（请求对象），获取请求的相关信息。比如获取请求参数：

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

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

//根据指定的参数名获取请求参数的数据值

String request.getParameter("参数名")

@RestController

public class RequestController {

//原始方式

@RequestMapping("/simpleParam")

public String simpleParam(HttpServletRequest request){

// http://localhost:8080/simpleParam?name=Tom&age=10

// 请求参数： name=Tom&age=10 （有2个请求参数）

// 第1个请求参数： name=Tom 参数名:name，参数值:Tom

// 第2个请求参数： age=10 参数名:age , 参数值:10

String name = request.getParameter("name");//name就是请求参数名

String ageStr = request.getParameter("age");//age就是请求参数名

int age = Integer.parseInt(ageStr);//需要手动进行类型转换

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

return "OK";

}

}

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

@RestController

public class RequestController {

// http://localhost:8080/simpleParam?name=Tom&age=10

// 第1个请求参数： name=Tom 参数名:name，参数值:Tom

// 第2个请求参数： age=10 参数名:age , 参数值:10

//springboot方式

@RequestMapping("/simpleParam")

public String simpleParam(String name , Integer age ){//形参名和请求参数名保持一致

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

return "OK";

}

}

postman测试( GET 请求)：

postman测试( POST请求 )：

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

2.实体参数

在使用简单参数做为数据传递方式时，前端传递了多少个请求参数，后端controller方法中的形参就要书写多少个。如果请求参数比较多，通过上述的方式一个参数一个参数的接收，会比较繁琐。

此时，我们可以考虑将请求参数封装到一个实体类对象中。 要想完成数据封装，需要遵守如下规则：请求参数名与实体类的属性名相同 简单实体对象

定义POJO实体类：

public class User {

private String name;

private Integer 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;

}

@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";

}

}

Postman测试：

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

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

2.1复杂实体对象

上面我们讲的呢是简单的实体对象，下面我们在来学习下复杂的实体对象。

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

User类中有一个Address类型的属性（Address是一个实体类）

复杂实体对象的封装，需要遵守如下规则：

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

定义POJO实体类：

Address实体类

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实体类

public class User {

private String name;

private Integer age;

private 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;

}

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";

}

}

Postman测试：

3.数组集合参数

数组集合参数的使用场景：在HTML的表单中，有一个表单项是支持多选的(复选框)，可以提交选择的多个值。

多个值是怎么提交的呢？其实多个值也是一个一个的提交。

后端程序接收上述多个值的方式有两种：

- 数组 数组参数：请求参数名与形参数组名称相同且请求参数为多个，定义数组类型形参即可接收参数 Controller方法：

@RestController

public class RequestController {

//数组集合参数

@RequestMapping("/arrayParam")

public String arrayParam(String[] hobby){

System.out.println(Arrays.toString(hobby));

return "OK";

}

}

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

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

Postman测试：

在前端请求时，有两种传递形式： 方式一： xxxxxxxxxx?hobby=game&hobby=java 方式二：xxxxxxxxxxxxx?hobby=game,java

4.日期参数

在一些特殊的需求中，可能会涉及到日期类型数据的封装。比如，如下需求：

为日期的格式多种多样（如：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";

}

}

Postman测试：

5.JSON参数

在学习前端技术时，我们有讲到过JSON，而在前后端进行交互时，如果是比较复杂的参数，前后端通过会使用JSON格式的数据进行传输。 （JSON是开发中最常用的前后端数据交互方式）

我们学习JSON格式参数，主要从以下两个方面着手：

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

Postman发送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";

}

}

Postman测试：

6.路径参数

传统的开发中请求参数是放在请求体(POST请求)传递或跟在URL后面通过?key=value的形式传递(GET请求)。 在现在的开发中，经常还会直接在请求的URL中传递参数。例如：

http://localhost:8080/user/1

http://localhost:880/user/1/0

上述的这种传递请求参数的形式呢，我们称之为：路径参数。

学习路径参数呢，主要掌握在后端的controller方法中，如何接收路径参数。 路径参数：

前端：通过请求URL直接传递参数后端：使用{…}来标识该路径参数，需要使用 @PathVariable 获取路径参数 Controller方法：

@RestController

public class RequestController {

//路径参数

@RequestMapping("/path/{id}")

public String pathParam(@PathVariable Integer id){

System.out.println(id);

return "OK";

}

}

Postman测试： 传递多个路径参数： Controller方法：

@RestController

public class RequestController {

//路径参数

@RequestMapping("/path/{id}/{name}")

public String pathParam2(@PathVariable Integer id, @PathVariable String name){

System.out.println(id+ " : " +name);

return "OK";

}

}

精彩内容

 您阅读本篇文章共花了：