首页 > 其他分享 >Postman 实战指南

Postman 实战指南

时间：2023-10-29 11:01:18浏览次数：31  
标签：指南 实战 return String name 参数 请求 public Postman

1.1.1 介绍

Postman 实战指南_实体类

  • Postman是一款功能强大的网页调试与发送网页HTTP请求的Chrome插件。

Postman原是Chrome浏览器的插件，可以模拟浏览器向后端服务器发起任何形式(如:get、post)的HTTP请求

使用Postman还可以在发起请求时，携带一些请求参数、请求头等信息


  • 作用：常用于进行接口测试
  • 特征
  • 简单
  • 实用
  • 美观
  • 大方

1.1.2 安装

Postman 实战指南_Postman_02

双击Postman-win64-8.3.1-Setup.exe即可自动安装。

Postman 实战指南_实体类_03

安装完成之后，进入页面中会提示有新版本可以升级（无需升级）

Postman 实战指南_请求参数_04

Postman 实战指南_Postman_05

界面介绍:

Postman 实战指南_请求参数_06

1.2 简单参数

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

Postman 实战指南_请求参数_07

那么在后端程序中，如何接收传递过来的普通参数数据呢？

我们在这里讲解两种方式：

  1. 原始方式
  2. SpringBoot方式

1.2.1 原始方式

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

Tomcat接收到http请求时：把请求的相关信息封装到HttpServletRequest对象中，忘记的可以查看我之前的介绍

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

//根据指定的参数名获取请求参数的数据值
String  request.getParameter("参数名")
/**
 * 请求接收参数
 */
@RestController //@Controller+ResponseBody
public class RequestController {

    //1. 简单参数
    //原始方式
    @RequestMapping("/easyParam")
    public String simpleParam(HttpServletRequest request){
        //获取请求参数
        String name = request.getParameter("name");
        String ageStr = request.getParameter("age");
        return name+":::"+ageStr;
    }
}

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

1.2.2 SpringBoot方式

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

@RestController
public class RequestController {
    // http://localhost:8080/easyParam?name=张三&age=20
    // 第1个请求参数： name=张三   参数名:name，参数值:张三
    // 第2个请求参数： age=20     参数名:age , 参数值:20
    
    //springboot方式
    @RequestMapping("/easyParam")
    public String simpleParam(String name ,Integer age){
        //获取请求参数
        return name+":::"+age;
    }
}

postman测试( GET 请求)：

Postman 实战指南_Postman_08

postman测试( POST请求 )：回忆：POST请求的请求参数存放在哪里？

Postman 实战指南_Postman_09

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

1.2.3 参数名不一致

思考:如果方法形参名称与请求参数名称不一致，controller方法中的形参还能接收到请求参数值吗？

@RestController
public class RequestController {
    // http://localhost:8080/easyParam?name=张三&age=20
    // 请求参数名：name

    //springboot方式
    @RequestMapping("/easyParam")
    public String simpleParam(String username , Integer age ){//请求参数名和形参名不相同
        return username+"  :  "+age;
    }
}

测试结果：

Postman 实战指南_Postman_10

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

思考:那么如果我们开发中，遇到了这种请求参数名和controller方法中的形参名不相同，怎么办？

解决方案：可以使用Spring提供的@RequestParam注解完成映射

在方法形参前面加上 @RequestParam 然后通过value属性执行请求参数名，从而完成映射。代码如下：

@RestController
public class RequestController {
    // http://localhost:8080/simpleParam?name=Tom&age=20
    // 请求参数名：name

    //springboot方式
    @RequestMapping("/easyParam")
    public String simpleParam(@RequestParam("name") String username , Integer age ){//请求参数名和形参名不相同
        return username+"  :  "+age;
    }
}

注意事项：

@RequestParam中的required属性默认为true（默认值也是true），代表该请求参数必须传递，如果不传递将报错


Postman 实战指南_实体类_11



如果该参数是可选的，可以将required属性设置为false

@RequestMapping("/easyParam")
    public String simpleParam(@RequestParam(value = "name",required = false) String username , Integer age ){//请求参数名和形参名不相同
        return username+"  :  "+age;
    }

1.3 实体参数

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

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

1.3.1 简单实体对象

定义POJO实体类：

@Data
@AllArgsConstructor
@NoArgsConstructor
public class Student {

    private String name;
    private Integer age;
    private String image;
    private String gender;
    private String job;
}

Controller方法：

@RestController
public class RequestController {
    //实体参数：简单实体对象
    @RequestMapping("/easyPojo")
    public String simplePojo(Student student){

        return "name = "+student.getName()+", age = "+student.getAge()+", job = "+student.getJob();
    }
}

Postman测试：

Postman 实战指南_请求参数_12

总结：

  • 参数名和实体类属性名一致时,参数值才会传递
  • 参数名和实体类属性名不一致时,不传递值

1.3.2 复杂实体对象

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

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

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

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

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

定义POJO实体类：

  • Address实体类
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Address {
    private String province;
    private String city;
}
  • Student实体类
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Student {

    private String name;
    private Integer age;
    private String job;
    private String image;
    private String gender;
    private Address address;

}

Controller方法：

@RestController
public class RequestController {
    //实体参数：复杂实体对象
    @RequestMapping("/complexPojo")
    public String complexPojo(Student student){
        return "name = "+student.getName()+
                ", age = "+student.getAge()+
                ", job = "+student.getJob()+
        ", address.city = "+student.getAddress().getCity()+
        ", address.province = "+student.getAddress().getProvince();
    }
}

Postman测试：

Postman 实战指南_请求参数_13

1.4 数组集合参数

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

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

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

  1. 数组
  2. 集合

1.4.1 数组

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

Postman 实战指南_Postman_14

Controller方法：

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

Postman测试：

在前端请求时，有两种传递形式：

方式一： xxxxxxxxxx?course=Java&course=Redis

Postman 实战指南_请求参数_15

方式二：xxxxxxxxxxxxx?course=game,java

Postman 实战指南_请求参数_16

1.4.2 集合

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

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

Postman 实战指南_实体类_17

Controller方法：

@RestController
public class RequestController {
    //数组集合参数
    @RequestMapping("/listParam")
    public String listParam(@RequestParam List<String> course){
        return "课程: "+course;
    }
}

Postman测试：

方式一： xxxxxxxxxx?course=Java&course=Redis

Postman 实战指南_Postman_18

方式二：xxxxxxxxxxxxx?course=game,java

Postman 实战指南_请求参数_19

1.5 日期参数

上述演示的都是一些普通的参数，在一些特殊的需求中，可能会涉及到日期类型数据的封装。

因为日期的格式多种多样（如：2022-12-12 10:05:45 、2022/12/12 10:05:45），对于日期类型的参数在进行封装的时候，需要通过@DateTimeFormat注解，以及其pattern属性来设置日期的格式。

  • 日期类型数据基于系统不同格式也不尽相同 2088-08-18 2088/08/18 08/18/2088
  • 接收形参时，根据不同的日期格式设置不同的接收方式

使用@DateTimeFormat注解设置日期类型数据格式，默认格式yyyy/MM/dd

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

Controller方法：

@RestController
public class RequestController {
    //日期时间参数
    @RequestMapping("/dataParam")
    public String dataParam(Date date,
                            @DateTimeFormat(pattern="yyyy-MM-dd") Date date1,
                            @DateTimeFormat(pattern="yyyy/MM/dd HH:mm:ss") Date date2){
        System.out.println("参数传递 date ==> "+date);
        System.out.println("参数传递 date1(yyyy-MM-dd) ==> "+date1);
        System.out.println("参数传递 date2(yyyy/MM/dd HH:mm:ss) ==> "+date2);
        return "{'module':'data param'}";
    }

}

Postman测试：

Postman 实战指南_实体类_20

1.6 JSON参数

前后端分离后，前端向后台会传递JSON格式数据,进行交互时，如果是比较复杂的参数，前后端通过会使用JSON格式的数据进行传输。 （JSON是开发中最常用的前后端数据交互方式）

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

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

Postman发送JSON格式数据：

Postman 实战指南_请求参数_21

服务端Controller方法接收JSON格式数据：

  • 传递json格式的参数，在Controller中会使用实体类进行封装。
  • 封装规则：JSON数据键名与形参对象属性名相同，定义POJO类型形参即可接收参数。需要使用 @RequestBody标识。
  • @RequestBody注解：将JSON数据映射到形参的实体类对象中（JSON中的key和实体类中的属性名保持一致）

Controller方法：

//5. json参数
    @RequestMapping("/jsonParam")
    public String jsonParam(@RequestBody Student student){
        return "name = "+student.getName()+
                ", age = "+student.getAge()+
                ", job = "+student.getJob()+
                ", address.city = "+student.getAddress().getCity()+
                ", address.province = "+student.getAddress().getProvince();
    }

Postman测试：

Postman 实战指南_实体类_22

1.7 路径参数

传统的开发中请求参数是放在请求体(POST请求)传递或跟在URL后面通过?key=value的形式传递(GET请求)。

在现在的开发中，经常还会直接在请求的URL中传递参数。例如：

http://localhost:8080/path/1  
http://localhost:880/path/1/0

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

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

路径参数：

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

Postman 实战指南_请求参数_23

Controller方法：

@RestController
public class RequestController {
    //路径参数
    @RequestMapping("/path/{id}")
    public String pathParam(@PathVariable Integer id){
        return "id = "+id;
    }
}

Postman测试：

image-20221204002040184

传递多个路径参数：

Postman：

Postman 实战指南_请求参数_24

Controller方法：

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

2. 响应

前面我们学习过HTTL协议的交互方式：请求响应模式（有请求就有响应）

那么Controller程序呢，除了接收请求外，还可以进行响应。

2.1 @ResponseBody

在我们前面所编写的controller方法中，都已经设置了响应数据。

Postman 实战指南_Postman_25

思考：controller方法中的return的结果，怎么就可以响应给浏览器呢？

答案：使用@ResponseBody注解

@ResponseBody注解：

  • 类型：方法注解、类注解
  • 位置：书写在Controller方法上或类上
  • 作用：将方法返回值直接响应给浏览器
  • 如果返回值类型是实体对象/集合，将会转换为JSON格式后在响应给浏览器

但是在我们所书写的Controller中，只在类上添加了@RestController注解、方法添加了@RequestMapping注解，并没有使用@ResponseBody注解，怎么给浏览器响应呢？

@RestController
public class ResponseController {

    @RequestMapping("/study")
    public String study(){
        return "根据maguobin学习SpringBoot";
    }
}

原因：在类上添加的@RestController注解，是一个组合注解。

  • @RestController = @Controller + @ResponseBody

@RestController源码：

Postman 实战指南_请求参数_26

结论：在类上添加@RestController就相当于添加了@ResponseBody注解。

  • 类上有@RestController注解或@ResponseBody注解时：表示当前类下所有的方法返回值做为响应数据
  • 方法的返回值，如果是一个POJO对象或集合时，会先转换为JSON格式，在响应给浏览器

下面我们来测试下响应数据：

package com.zbbmeta.controller;

import com.zbbmeta.entity.Address;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.ArrayList;
import java.util.List;

@RestController
public class ResponseController {

    @RequestMapping("/study")
    public String study(){
        return "根据SpringBoot葵花宝典学习SpringBoot";
    }

    //响应实体对象
    @RequestMapping("/getAddr")
    public Address getAddr(){
        Address addr = new Address();//创建实体类对象
        addr.setProvince("广东");
        addr.setCity("深圳");
        return addr;
    }
    //响应集合数据
    @RequestMapping("/listAddr")
    public List<Address> listAddr(){
        List<Address> list = new ArrayList<>();//集合对象

        Address addr = new Address();
        addr.setProvince("广东");
        addr.setCity("深圳");

        Address addr2 = new Address();
        addr2.setProvince("陕西");
        addr2.setCity("西安");

        list.add(addr);
        list.add(addr2);
        return list;
    }
}

在服务端响应了一个对象或者集合，那私前端获取到的数据是什么样子的呢？我们使用postman发送请求来测试下。测试效果如下：

Postman 实战指南_实体类_27

Postman 实战指南_请求参数_28

2.2 统一响应结果

大家有没有发现一个问题，我们在前面所编写的这些Controller方法中，返回值各种各样，没有任何的规范。

Postman 实战指南_Postman_29

如果我们开发一个大型项目，项目中controller方法将成千上万，使用上述方式将造成整个项目难以维护。那在真实的项目开发中是什么样子的呢？

在真实的项目开发中，无论是哪种方法，我们都会定义一个统一的返回结果。方案如下：

Postman 实战指南_Postman_30

前端：只需要按照统一格式的返回结果进行解析(仅一种解析方案)，就可以拿到数据。

统一的返回结果使用类来描述，在这个结果中包含：

  • 响应状态码：当前请求是成功，还是失败
  • 状态码信息：给页面的提示信息
  • 返回的数据：给前端响应的数据（字符串、对象、集合）

定义在一个实体类Result来包含以上信息。代码如下：

public class Result {
    private Integer code;//响应码，1 代表成功; 0 代表失败
    private String msg;  //响应码 描述字符串
    private Object data; //返回的数据

    public Result() { }
    public Result(Integer code, String msg, Object data) {
        this.code = code;
        this.msg = msg;
        this.data = data;
    }

    public Integer getCode() {
        return code;
    }

    public void setCode(Integer code) {
        this.code = code;
    }

    public String getMsg() {
        return msg;
    }

    public void setMsg(String msg) {
        this.msg = msg;
    }

    public Object getData() {
        return data;
    }

    public void setData(Object data) {
        this.data = data;
    }

    //增删改 成功响应(不需要给前端返回数据)
    public static Result success(){
        return new Result(1,"success",null);
    }
    //查询 成功响应(把查询结果做为返回数据响应给前端)
    public static Result success(Object data){
        return new Result(1,"success",data);
    }
    //失败响应
    public static Result error(String msg){
        return new Result(0,msg,null);
    }
}

改造Controller：

package com.zbbmeta.controller;

import com.zbbmeta.entity.Address;
import com.zbbmeta.entity.Result;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.ArrayList;
import java.util.List;

@RestController
public class ResponseController {

    @RequestMapping("/study")
    public Result study(){
        return Result.success( "根据maguobin学习SpringBoot");
    }

    //响应实体对象
    @RequestMapping("/getAddr")
    public Result getAddr(){
        Address addr = new Address();//创建实体类对象
        addr.setProvince("广东");
        addr.setCity("深圳");
        return Result.success(addr);
    }
    //响应集合数据
    @RequestMapping("/listAddr")
    public Result listAddr(){
        List<Address> list = new ArrayList<>();//集合对象

        Address addr = new Address();
        addr.setProvince("广东");
        addr.setCity("深圳");

        Address addr2 = new Address();
        addr2.setProvince("陕西");
        addr2.setCity("西安");

        list.add(addr);
        list.add(addr2);
        return  Result.success(list);
    }
}

使用Postman测试：

Postman 实战指南_请求参数_31

标签：指南,实战,return,String,name,参数,请求,public,Postman
From： https://blog.51cto.com/maguobin/8078546

相关文章

  • 读图数据库实战笔记02_图数据建模
    1. 概念1.1. 实体1.1.1. 通常用名词来表示1.1.2. 描述一个领域中的事物或者事物类型1.1.2.1. 汽车1.1.2.2. 用户1.1.2.3. 地理位置1.1.3. 在逻辑模型和技术实现过程中，实体通常会变成“顶点”1.2. 关系1.2.1. 用动词（或动词短语）来表示1.2.2. 描述实体之间的互......
  • java——redis随笔——实战——优惠券秒杀——分布式锁
    注意：synchronized用户单机（jvm）上面的锁，对于分布式应用则无能为力。所以对于分布式系统，则需要分布式锁。 分布式锁：满足分布式系统或集群模式下多线程课件并且可以互斥的锁分布式锁的核心思想就是让大家共用同一把锁，那么我们就能锁住线程，不让线程进行，让程序串行执行，这就是分......
  • 从零开始：开发直播商城APP的技术指南
    时下，直播商城APP已经成了线上购物、电子商务的核心组成，本文将为您提供一个全面的技术指南，帮助您从零开始开发一个直播商城APP。我们将涵盖所有关键方面，包括技术堆栈、功能模块、用户体验和安全性。第一部分：技术堆栈的选择1.移动平台：您可以选择iOS和Android平台开发应用，使用Swift或O......
  • UniApp实战技巧：页面导航、数据传递和组件通信，以及资源管理和优化
    UniApp是一个基于Vue.js的开发框架，可以使用它快速构建跨平台的移动应用。本文将介绍UniApp中的一些实战技巧，包括页面导航、数据传递和组件通信。这些技巧可以帮助开发者更好地使用UniApp进行开发。1.页面导航在UniApp中，我们可以使用uni.navigateTo和uni.redirectTo等方法进行页面......
  • java——redis随笔——实战——优惠券秒杀
    黑马视频地址：https://www.bilibili.com/video/BV1cr4y1671t?p=49&spm_id_from=pageDriver&vd_source=79bbd5b76bfd74c2ef1501653cee29d6 csdn地址：https://blog.csdn.net/weixin_50523986/article/details/131815165          stringRedisTemplate.......
  • API商品数据接口调用爬虫实战
    随着互联网的发展，越来越多的商家开始将自己的商品数据通过API接口对外开放，以供其他开发者使用。这些API接口可以提供丰富的商品数据，包括商品名称、价格、库存、图片等信息。对于爬虫开发者来说，通过调用这些API接口，可以更加便捷地获取商品数据，避免了爬取网页数据的繁琐过程。本文将......
  • ArmSoM---SPI开发指南
    1.简介RK3588从入门到精通本⽂主要介绍在Rockchip平台配置spi接口并且使用的方法开发板：ArmSoM-W3Kernel：5.10.160OS：Debian112.SPI接口概述SPI（SerialPeripheralInterface），即串行外围设备接口，是一种同步的，全双工的，多设备的，多主机的通信协议，用于连接外围设备，如ADC、DAC、数......
  • ArmSoM---SPI开发指南
    1.简介RK3588从入门到精通本⽂主要介绍在Rockchip平台配置spi接口并且使用的方法开发板：ArmSoM-W3Kernel：5.10.160OS：Debian112.SPI接口概述SPI（SerialPeripheralInterface），即串行外围设备接口，是一种同步的，全双工的，多设备的，多主机的通信协议，用于连接外围设备，如A......
  • 802.11无线网络权威指南学习笔记
    以前在CSDN博客写的，后来不用CSDN，改用cnblogs，没想到在搜索资料时发现了以前被人转载的笔记，做个记录https://blog.csdn.net/machiner1/article/details/41726539......
  • arthas使用指南
    安装包解压 在当前路径下启动cmd输入命令java-jararthas-boot.jar会让你选择需要监听当前运行的那个项目 选择输入点击回撤以后，arthas启动成功，如下图： 当前窗口继续输入命令：watchcom.yonyougov.rest.service.api.runtime.process.FbpmProcessInstanceResource......

赞助商

阅读排行

网站主页关于我们联系我们网站地图

本网站内容转载自其他媒体，侵权联系[admin##ips99.com]。

Copyright © 2020-2023 IPS99 版权所有 IPS99