技术分享 | 一步一步学测试平台开发-Vue restful请求

本文节选自霍格沃兹测试学院内部教材

一般在构建应用时需要访问后端的 API 接口获取后端数据并展示。做这件事的方法有很多种（比如 axios，vue-resource，fetch-jsonp），使用 promise 的 HTTP 客户端 axios 是其中非常流行的一种方式。axios 也支持 RESTful 请求调用规范。

promise 是一个用来传递异步操作信息的对象，主要是用来解决回调的问题。

axios介绍

axios 是一个易用、简洁且高效的 HTTP 库。axios 主要是用于向后台发起请求，或者在请求中做更多可控的功能（比如拦截请求，请求伪造等）。它是一个第三方插件，所以使用之前要先安装。

安装axios插件

github 地址：https://github.com/axios/axios

可以直接使用 npm 工具进行安装

npm install --save axios

axios 特点

从浏览器中创建 XMLHttpRequests
从 node.js 创建 http 请求
支持 Promise API
拦截请求和响应
转换请求数据和响应数据
取消请求
自动转换 JSON 数据
客户端支持防御 XSRF

axios实现RESTful请求规范

axios 其实和原生的 ajax，jquery 中的 $ajax 类似，都是用于向后端请求数据，axios 也是 Vue 官方推荐的插件。

基于 RESTful 风格的请求规范，基本请求方式有 5 种：

GET（SELECT）：从服务器取出资源（一项/多项）
POST（CREATE）：在服务器新建一个资源
PUT（UPDATE）：用来修改数据，需要把所有的字段传过去，相当于全部更新
PATCH（UPDATE）：用来修改数据，是在 PUT 的基础上改进的，适用于局部更新。比如只想修改用户名，只传用户名的字段就可以了，而不需要像 PUT 一样把所有字段传过去
DELETE（DELETE）：从服务器删除资源

代码示例-注册功能

注册功能使用的是 POST 请求。具体请求参数与返回数据可以通过查看 API 文档获取（ http://stuq.ceshiren.com:8089/swagger-ui.html#/ ）。一般开发者都会拿到这样一个接口文档说明。

从文档可以查看到，后端服务的注册接口接收请求的参数有三个 userName，password 和 email，如下：

  "email": "string",

  "password": "string",

  "userName": "string"

}

image1080×601 73.2 KB

也可以通过查看文档，获取到它的返回数据用于后续处理。

创建注册页面

对于页面设计需要提前知道页面的组成以及摆放位置，一般会有相应的页面设计文档或者参照页面。一般推荐使用 Vuetify 完成组件的开发（提前安装 Vuetify 插件）。

官方文档：

https://vuetifyjs.com/en/api/v-form/

根据官方文档，选择适合自己项目的组件样式，添加到页面中。这里需要用到标题标签<h1> ，表单相关标签<v-text-field> ，以及按钮标签<v-btn> 。

SignUp.vue

<template>

    <div class="sign-up">

        <h1>注册</h1>

        <v-text-field v-model="username" label="用户名"></v-text-field>

        <v-text-field v-model="password" label="密码" type="password"></v-text-field>

        <v-text-field v-model="email" label="邮箱" ></v-text-field>

        <v-btn color="primary" @click="register()">注册</v-btn>

    </div>

</template>

<script>

export default {

    data(){

        return {

            username: '',

            password: '',

            email: ''

        }

    },

    methods:{

        register(){

            let post_data = {

                userName: this.username,

                password: this.password,

                email: this.email,

            }

            console.log('注册')

            // this.$rouster.push({name:'SignUp'})

            this.$api.user.signUp(post_data).then(res => {

                console.log(res)

            });

        }

    }

}

</script>

<style scoped>

    .sign-up{

        width: 500px;

        margin: 0 auto;

        text-align: center;

    }

</style>

解析上面的代码：

1、首先，在 components/ 目录下创建 SignUp.vue 文件。这里添加了一个 <h1> 标题标签，然后使用v-text-field 实现用户名、密码、邮箱的输入框。使用v-btn 标签实现注册按钮。

2、这里在v-text-field 标签中使用 v-model 属性对数据进行双向绑定，它会根据控件类型自动选取正确的方法来更新元素。在标签中添加 data() 方法来获取用户输入的数据（用户名，密码和邮箱）。

3、当点击注册按钮时，会触发 register() 方法。将用户输入的数据传递给后端接口，并拿到返回数据 res ，打印输出到浏览器的 console 中。

4、在 <style></style> 中添加一个 div 样式 sign-up ，设置宽为 500px，margin 外边距设置为 0 auto （0 为外边距为 0，auto 指平分剩余空间，会展示居中的效果），text-align: center; 设置文字居中。

5、this.$api 向后端发送请求，这里会提前将$api 作为全局变量在main.js 中声明

关于 main.js 等其他代码参照贴子：

https://ceshiren.com/t/topic/12235

查看后端文档

后端文档：

http://stuq.ceshiren.com:8089/swagger-ui.html

Swagger 是一个规范并且完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。Swagger 可以使前端开发者通过可视化页面查看接口文档。后台开发也可以通过简单配置实现文档的自动生成。（官网地址：http://swagger.io/ ），查看用户管理中的注册接口详细信息。

注意：前端代码中发送请求的参数名要与接口文档中定义的参数名保持一致（参数名大小写敏感）。

后端接收到前端 SignUp 组件发来的注册请求，需要传递的参数如下图：

image1080×601 73.2 KB

创建一个axios实例

可以使用 axios.create() 方法创建一个拥有通用配置的 axios 实例。

实际工作项目中，可能需要访问多个服务地址，而这些服务请求和响应的结构也很可能是不同的，可以通过 axios.create() 创建不同的实例来处理。

在路径 src 目录下，新建目录层级如下：

src/

    api/

        http.js

http.js 主要是用来编写调用后端请求的地址以及请求的格式。下面配置后端服务的地址和头信息，代码如下：

import axios from 'axios'

var instance = axios.create({

    headers: {

        'Content-Type': 'application/json'

    },

    baseURL: 'http://stuq.ceshiren.com:8089'

})

export default instance

axios 是向后端服务发请求的插件库（提前已安装）这里使用 import 完成导入
headers 是向后端传参的头部信息
baseURL 是后端服务的地址。

axios 与服务器交互

下面先创建两个文件 api.js 和 user.js

user.js：用来管理所有用户相关的后端接口。如果有其它同一类型的接口，也可以创建一个文件管理起来（比如任务管理，用例管理等）
api.js：主要是用来管理不同类别的接口文件，方便后续维护

目录结构如下：

src/

    api/

        api.js

        user.js

user.js 代码如下：

import axios from './http'

const user = {

    signUp(params){

        return axios.post('/user/register',params)

    }

}

export default user

解析上面的代码：

先定义一个变量 user，然后注册一个 signUp(params) 方法，方法中使用 axios 调用后端的接口服务（使用 GET 还是 POST 还是其它的动作，需要根据接口文档确定）。然后通过 export default user 将 api 暴露出去，这样其它的 js 文件才能调用到它。后面就会在 api.js 中引用这个 user 变量。

api.js 代码如下：

import user from './user'

const api = {

    user

}

export default api

上面的代码，引用了当前目录下 user.js 内的 user 变量。也可以在变量 api 中引用其它的 js 文件。api 定义好了之后，需要使用export default api 将 api 这个变量暴露出去，然后就可以在其它页面中引用它了。

另外，所有页面中需要用到的代码和插件，都需要在 main.js 里面配置。

在 main.js 中添加下面代码：

import api from './api/api'

省略...

Vue.prototype.$api = api

省略...

import api from './api/api' ：将 api 这个变量导入到 main.js 中。

Vue.prototype.$api = api ：通过 Vue.prototype 定义一个 $api 变量，$api 将会在所有的 Vue 实例中可用，甚至在 Vue 实例被创建之前也可以调用到 $api ，注意一定要加上"$"符。

运行调试

将前端页面的代码开发完成，并且配置了相关的路由，就可以执行下面的运行命令：

npm run serve

然后，访问地址：

http://localhost:8080/

输入用户名，密码和邮箱，点击注册，然后在调试页面的 network 中可以查看到返回结果，如下：

image1080×318 82.6 KB

从检查页面，network 中查看 register 这个接口的返回（Response）数据，展示如下内容，说明我们请求后端服务成功的注册了一个帐号。

{

  "resultCode": 1,

  "message": "成功",

  "data": {

    "id": 198,

    "userName": "hogwarts",

    "password": "cf955f0d016f1da3fc79d468593057d5",

    "email": "hogwarts@ceshiren.com",

    "autoCreateCaseJobName": null,

    "startTestJobName": null,

    "defaultJenkinsId": null,

    "createTime": 1620716523579,

    "updateTime": 1620716523579

  }

}

这样就使用 POST 的方式向后端发送了请求，完成了用户的注册功能。其它请求方式的具体用法，请查看官方文档https://github.com/axios/axios。