如何测试包含axios的类组件?实例传参与axios-mock-adapter使用疑问
问题解答
1. ApiClient实例参数传递说明
你当前的代码默认导出的是已经实例化的ApiClient单例,项目中直接导入即可使用,不需要手动调用new创建实例。如果测试时需要自定义baseURL、accessToken参数,有两种实现方式:
- 方式一:测试前预先给localStorage写入对应值即可,你的ApiClient初始化时会自动读取localStorage的配置
- 方式二:如果需要灵活传参,可以给构造函数新增可选参数,优先级高于localStorage读取,修改参考:
constructor(customConfig = {}) { this.axiosConfig = { baseURL: customConfig.baseURL || this.getURL(), timeout: 1000 * 120, // 120seconds/2minutes headers: { contentType: 'application/json', accept: 'application/json', Authorization: customConfig.token ? `Bearer ${customConfig.token}` : `Bearer ${this.getAccessToken()}`, }, } this.axiosInstance = axios.create(this.axiosConfig) }
如果需要手动创建实例,可以把当前的单例导出改成导出类本身,测试时自己传参初始化即可。
2. 完全可以使用axios-mock-adapter进行测试
以下是可复用的测试示例(基于Jest测试框架,其他测试框架逻辑也通用):
首先先安装依赖:npm install axios-mock-adapter jest --save-dev
然后编写测试用例文件apiClient.test.js:
import axios from 'axios'; import MockAdapter from 'axios-mock-adapter'; import apiClient from './你的ApiClient文件路径'; // 初始化mock对象 const mock = new MockAdapter(apiClient.axiosInstance); // 每个测试用例执行前重置localStorage和mock数据 beforeEach(() => { localStorage.clear(); mock.reset(); // 预先设置测试用的token和baseURL localStorage.setItem('otaAccessToken', 'test-token-123'); localStorage.setItem('otaAPIURL', 'https://test-api.example.com'); // 调用updateAxios刷新实例配置 apiClient.updateAxios(); }); // 测试fetchOTARequests方法 test('fetchOTARequests 应该携带正确参数发起请求', async () => { const mockResponseData = { list: [], total: 0 }; // mock对应接口的返回 mock.onGet('/otaRequests').reply(200, mockResponseData); const result = await apiClient.fetchOTARequests(1, 10, 'createTime', 'desc', 'test'); // 验证参数是否正确 expect(mock.history.get[0].params).toEqual({ page: 1, pageSize: 10, sortBy: 'createTime', sortOrder: 'desc', searchValue: 'test' }); // 验证返回数据是否正确 expect(result.data).toEqual(mockResponseData); }); // 测试createOTARequest方法 test('createOTARequest 应该正确提交payload', async () => { const testPayload = { iccId: '123456789', content: 'test' }; const mockResponse = { success: true }; mock.onPost('/otaRequests').reply(200, mockResponse); const result = await apiClient.createOTARequest(testPayload); // 验证提交的payload是否正确 expect(JSON.parse(mock.history.post[0].data)).toEqual(testPayload); expect(result.data).toEqual(mockResponse); });
注意事项
- 你的ApiClient依赖window.localStorage,Jest默认已经模拟了浏览器的localStorage,不需要额外配置,如果是其他测试环境需要提前模拟localStorage对象
- 测试完每个用例记得调用
mock.reset()清空之前的mock记录,避免用例之间互相影响 - 如果需要测试异常场景,只需要把mock返回的状态码改成400/500即可,验证错误处理逻辑
内容的提问来源于stack exchange,提问作者Jaimini Chothwani
相关产品推荐
相关产品推荐

