把简单的 Postman，玩出花样？

落日映苍穹つ 2022-09-04 11:42 157阅读 0赞

**目录**

环境变量

Pre-request Script

Tests

--------------------

Postman 是一款我们在工作中使用频率非常高的 API 调试工具，估计很多童鞋在使用它时也比较粗暴，填好接口地址、参数，直接 send 就完事了。估计大家要说了，这么简单的东西还能玩出什么花来。今天就和大家安利几个非常实用、但是可能一直被忽视的功能，用完之后，简直不要太香！

### 环境变量 ###

我们通过一个例子来看一下环境变量的用法，在一个项目的生命周期中，可能会有开发环境、测试环境、预上线环境、线上环境等众多的不同环境，这时候就可以通过环境变量来管理接口的地址以及端口。

点击左侧的`Environments`，系统中默认已经存在了一个`Globals`的全局环境，在这里可以存放一些通用的公共变量的值。先在这里写入`host`和`port`信息：

![图片][b4add3fe4c656dbdaa5fc9f669c62a19.png]

在需要使用变量时，可以在访问接口时使用双大括号包裹变量，以`{ {variable}}`的方式进行引用：

![图片][177fc0fd09ec54c39081c856eb5aef58.png]

除了默认的全局环境外，也可以自己创建新的环境来存放变量。在下面的例子中，创建了`local`和`test`两个环境，这样我们可以直接在两个环境间进行切换激活，简化了开发中测试接口的过程，不再需要频繁地改动接口的地址。

![图片][f51a473a531fa63ca998e1fb07e9ee1e.png]

如果激活的环境和全局环境中有名称重复的变量，那么当前激活的环境中的变量具有更高的优先级，它会直接覆盖`globals`环境中变量的值：

![图片][df75e8c84084b1b1e0296c9a23d9b465.png]

在上面，我们将环境变量分为了两类，普通环境变量和全局变量。总的来说，全局变量具有更高的使用范围，即使切换到自己创建的环境，全局变量仍然可用。但是我们自己创建的环境之间是相互隔离的，如果切换到一个环境，那么其他环境中的变量将不再可用。

像上面这样手动写入变量的值，在某些时候可能不太方便满足一些需求，因此 postman 提供了一种方法，允许使用脚本来改变环境变量的值。我们来看一下发送请求中的`Pre-request Script`和`Tests`模块，它们是在请求发送前或完成后执行的脚本，具体的使用在后面具体介绍，现在我们只需要知道能在这里执行 js 代码就可以了。

![图片][22406506286548230bc211b8f22bc47f.png]

下面，在`Pre-request Script`中加入两行 js 代码：

pm.globals.set("key1","value1");
    pm.environment.set("key2","value2");

执行完成请求后再次查看环境变量，全局环境和当前环境中都写入了新的值：

![图片][dae869dbc7407f7e32239e700eb24a28.png]

同样，也可以使用脚本删除变量：

pm.globals.unset("key1");
    pm.environment.unset("key2");

除了上面的两类变量外，postman 中的`Collection`也可以存储变量。`Collection`可以理解为一个集合，通常在使用中我们会将一个应用系统中的接口放在一个集合中，集合中的变量拥有更小的使用范围，仅在当前集合内可用：

![图片][8d83113ffa6bbb22f273d3dd8aa3cec2.png]

同样，也可以在脚本中对它进行操作：

pm.collectionVariables.set("key3","value3");
    pm.collectionVariables.unset("key3");

在有了环境变量的基础后，再回头看一下上面提到的`Pre-request Script`和`Tests`，它们是两个比较类似的功能，用处也非常广泛。

### Pre-request Script ###

运行 js 脚本

`Pre-request Script`可以翻译为预请求脚本，是在请求发送前被执行的代码逻辑，可以在这里执行一些`js`代码。通过下面的简单例子进行一下演示，先准备一个后台接口，将前端传递过来的时间戳转换为时间并打印：

@GetMapping("test1")
     public void time(@RequestParam("time") String time){
         Date date = new Date(Long.parseLong(time));
         System.out.println(date);
     }

在`Pre-request Script`中利用 js 代码获取当前时间，并放到集合变量中，在请求中传给后端：

![图片][38b5bbbacda6ba1985032c24a46bedf1.png]

发送请求，控制台打印了前端接口的调用时间：

Tue Aug 01 14:14:29 CST 2021

发送 get 请求

`Pre-request Script`的另一大用途就是，在请求当前接口前，通过执行脚本来先请求一下其他接口。在 postman 中，已经内置了`sendRequest`方法来发送`get`方法请求。我们在这里调用一个本地接口，并将信息打印到`console`控制台（可以通过 `Show Postman Console`开启）。

![图片][a392ac11655c537c17c7898868a49dfe.png]

通过控制台的打印顺序，也可以看到，是先执行了`Pre-request`中的请求后，才去执行真正目标接口的请求。直接像上面这样调用`sendRequest`时，默认发送的`get`请求，如果需要使用`post`请求、配置请求`header`或使用`json`传参的话，可以使用下面单独封装请求的方式。

发送 post 请求

在这里，我们通过一个例子来演示`Pre-request Script`在具体的工作中能够怎样应用。有一个很普遍的场景，通常在调试需要权限认证的接口时，需要提前通过一个接口获取 token，然后再访问目标接口时携带这个 token。

这时就可以在`Pre-request Script`中先调用获取 token 的接口，再将 token 设置到集合的环境变量中，在之后的接口调用中引用它。在这里先准备了一个应用了`Shiro+JWT`的项目，其中通过登录接口获取 token，之后的其他接口都需要带上这个 token 用于认证 。

我们在`sendRequest`发送`get`请求的基础上，进行一些修改。首先定义一个变量，在其中使用`url`指定请求地址，`method`指定请求方法，`body`携带参数，最后使用`sendRequest`进行请求的发送。

![图片][1b7e31c59a81c37cc89d99b599d0e26f.png]

在获取完成 token 后，通过下面的代码将获取的 token 放入了`Collection`的变量中：

pm.collectionVariables.set("TOKEN",response.json().data.token);

查看`Collection`中的变量，已经保存了刚才获取的 token：

![图片][22091d402665de967a5f238c3ef06e8b.png]

在需要认证的接口`header`中，引用这个 token，就可以正常地调用接口了：

![图片][bb549c037345cca71260bd8960a0e4a4.png]

在上面的例子中，我们使用的是`urlencoded`的表单传参方式，如果接口定义是使用 json 方式传参，可以写成下面的格式：

body: {
      mode: 'raw',
      raw: JSON.stringify({ key: 'value' })
    }

如果需要传递`header`请求头信息，也可以在自定义的请求中添加：

const loginRequest = {
      url: '...',
      header: [
          'Key1 : Value1',
          'Key2 : Value2'
      ],
      ...
    };

具体的使用中需要添加什么字段非常的灵活，可以由我们自行进行配置。

### Tests ###

和`Pre-request Script`相对，`Tests`是在请求完成后执行的操作。这里我们回顾一下上面`Pre-request Script`中发送`post`请求的例子，其实可以通过`Tests`来进行改进。

因为在上面的例子中，获取到的 token 是`JWT`生成的，具有一定有效时间，在一段时间内是都可以复用的。因此我们可以先手动调用一次`login`接口获取 token，完成后在`Tests`中使用脚本将获取的 token 放入`Collection`的变量中，就不需要在每次调用接口前都调用`login`接口重复获取 token 了。

调用`login`接口并存入缓存的过程：

![图片][f8b8015ba203cf94b3dc11a98b425d8d.png]

之后在调用其他需要携带这个 token 的接口时，使用`{ {TOKEN}}`的方式，就会自动填充刚才保存的`TOKEN`值。这样在获取到新的 token 后，每个接口中的 token 都会自动更新，就不需要再手动复制到每个接口了，极大地减少了工作量。

在 postman 中，在`Collection`中可以创建`Folder`文件夹，并且集合和文件夹上也可以添加`Pre-request Script`和`Tests`脚本。我们来看一下位于`Folder`中的请求，在执行`Pre-request Script`和`Tests`时顺序是怎样的，在每个环节中加入对应的打印语句，最后输出的结果是这样的：

![图片][aa5c4b2b67f3c67222cb865b0a52f742.png]

也就是说，在发送请求前，postman 会先执行所有`Pre-request Script`，并且顺序是集合最先、文件夹次之、最后是请求中的，在执行完成真正的请求后执行所有的`Tests`，顺序同上。这也就要求我们在使用`Pre-request Script`及`Tests`功能前，首先要求我们对接口的调用顺序、数据的流向有一个明确的了解，这样才能保证不会出现取不到值或更新错误的情况。

> 来源 | 码农参上
> 
> 作者 | Dr Hydra

[b4add3fe4c656dbdaa5fc9f669c62a19.png]: /images/20220829/e17206f0692642e2a9b1435b4ec8c09e.png
[177fc0fd09ec54c39081c856eb5aef58.png]: /images/20220829/6337dc2f2c4f40b0910de30533e3bb53.png
[f51a473a531fa63ca998e1fb07e9ee1e.png]: /images/20220829/e90fe1c0c051415991680c4d4a7a04e8.png
[df75e8c84084b1b1e0296c9a23d9b465.png]: /images/20220829/d30852f5cef94512879b05acb4876c1d.png
[22406506286548230bc211b8f22bc47f.png]: /images/20220829/cedf0d53eac54e04aa56153cb73d361b.png
[dae869dbc7407f7e32239e700eb24a28.png]: /images/20220829/3be789ee6dad4b6a958c22f8dae22a71.png
[8d83113ffa6bbb22f273d3dd8aa3cec2.png]: /images/20220829/0a2b1abbfde647f9b83e10d5932102bf.png
[38b5bbbacda6ba1985032c24a46bedf1.png]: /images/20220829/a1d8e0898f6a44d1924a8d3f50eff63d.png
[a392ac11655c537c17c7898868a49dfe.png]: /images/20220829/8cf5703ed3624217b9f20a579d263d6f.png
[1b7e31c59a81c37cc89d99b599d0e26f.png]: /images/20220829/ae0efa3a400e4c84aea4f51ccbd83abf.png
[22091d402665de967a5f238c3ef06e8b.png]: /images/20220829/1903b1eb334b4e4f861524db8036c923.png
[bb549c037345cca71260bd8960a0e4a4.png]: /images/20220829/eefc72d3ff7e437aba74c2a34c467288.png
[f8b8015ba203cf94b3dc11a98b425d8d.png]: /images/20220829/d23bd9f887684782a39d8f7d53b292f5.png
[aa5c4b2b67f3c67222cb865b0a52f742.png]: /images/20220829/d603f489da44457f814859d77ee82ab8.png