VueCli3.0中集成MockApi的方法示例
一:使用場景
哎喲,好煩啊,這個需求還么結(jié)束就來下一個需求,程序員不要排期的嗎?
沒辦法啊,資本主義的XX嘴臉啊
來吧,技術(shù)評審我倆把接口格式對一把,你先開發(fā),我這邊結(jié)束了我跟上,再聯(lián)調(diào)
MMP,那又增加了我的工作量啊,每次我都要自己先把數(shù)據(jù)放在一個配置文件中,引入使用,然后對接的
時候還得刪除無用代碼,好氣
你自己Mock接口啊,就向我們后端經(jīng)常用PostMan一樣模擬請求啊
Mock??我去查查看
二:Mock的概念
1:Mock的描述
Mock接口其實就是模擬真實接口提供一個在開發(fā)環(huán)境的假數(shù)據(jù),甚至是真實數(shù)據(jù),在開發(fā)時,經(jīng)常出現(xiàn)
接口內(nèi)容不能夠及時的跟進,導致開發(fā)過程中添加一些額外的工作量。接下來的例子全部圍繞著Vue為主體介紹
前后端提前確定好通信的JSON格式之后,我們在不依賴后端進度的同時,能提供一套好的開發(fā)體驗。
2:Mock能解決的問題
減少額外工作,在沒有Mock接口的時候我們模擬數(shù)據(jù)的方式很煩躁,比如list列表,需要在data中聲明list,去調(diào)試內(nèi)容,或者引入一個mock文件,這樣做導致在聯(lián)調(diào)調(diào)用接口的部分代碼沒有寫,聯(lián)調(diào)成功的時候要刪除很多無用代碼 ---> 通過Mock只需在聯(lián)調(diào)的時候把Mock接口的地址換成真實地址即可
import { mockList2 } from 'mock/list.js'; export default { data () { return { mockList: [ { "name": 'tx', "age": 12 } ], mockList2 } } }
如果采用上述的方式去模擬數(shù)據(jù),缺少真正缺口所具備的狀態(tài),比如刪除接口,有成功和失敗的區(qū)分,這個模擬就很惡心了 ----> 通過Mock,可以直接通過實在的query或者其他的操作來達到同樣的目的
3:Mock的幾種方式以及對應的優(yōu)缺點
Mock的方式 | 優(yōu)缺點 |
---|---|
本地Mock接口 | 優(yōu)點:可以更加細粒度的控制mock的內(nèi)容。缺點:需要增加本地的代碼量,以及需要配置webapck |
Mock.js實現(xiàn)ajax攔截 | 優(yōu)點:數(shù)據(jù)通過mock.js會更豐富。缺點:增加一些本地配置,攔截ajax |
后端Controller的靜態(tài)JSON | 優(yōu)點:接口聯(lián)調(diào)不需要修改任何東西。缺點:修改Mock內(nèi)容溝通成本高,跟后端扯皮 |
利用FastMock去模擬Mock | 優(yōu)點:可控內(nèi)容以及實現(xiàn)動態(tài)Restful api。缺點:如果項目包裝axios等請求庫之后需要針對接口轉(zhuǎn)發(fā)做不同處理 |
4:本地Mock接口
該篇文章針對本地Mock接口進行操作,其他的方式會簡要介紹并給出對應的鏈接,如果有需要,自行去查閱。
三:本地Mock周邊知識
本地Mock的思想就是利用Node + express完成Restful Api。結(jié)合webpack配置項devServer同時利用Vue-cli3.0的暴露的配置利用本地express完成mock接口的添加
1、Node+Express的相關(guān)知識點,用node+express寫過Restful Api的就應該知道接下來Mock怎么處理了,這里我先簡要介紹一下我們需要用到的技術(shù)吧(Express的路由以及node的fs模塊)
Express路由相關(guān),具體的見文檔,這里不區(qū)分請求方法,直接app.use
const express = require('express'); const app = express(); // 這樣一個簡單的路由就完成了,請求到/ajax-get-info的請求就能拿到對應的JSON數(shù)據(jù) app.use('/ajax-get-info', (req, res) => { res.send({ "success": true, "code": 0, "data": {} }) });
針對不同的請求生成動態(tài)的內(nèi)容,我們可以通過req.query和req.params等來生成動態(tài)內(nèi)容,在express中,我們傳入的body內(nèi)容,在req.body中并獲取不到,需要添加中間件body-parser,需要注意的是這個中間件不能在app全局路由使用,不然會影響到代碼到測服的接口,利用http-proxy-middleware轉(zhuǎn)發(fā)的接口,所以我們需要單獨的設(shè)置一個Mock路由,針對路由級別的使用中間件,代碼如下
const bodyParser = require('body-parser'); const express = require('express'); const mockRouter = express.Router(); // express middleware bodyParser for mock server // for parsing application/json mockRouter.use(bodyParser.json()); // for parsing application/x-www-form-urlencoded mockRouter.use(bodyParser.urlencoded({ extended: true })); // Api prefix named /mock app.use('/mock', mockRouter); // now you can set mock api use mockRouter mockRouter.use('/ajax-get-info', (req, res) => { // use req.body to get request body info console.log(req.body); res.send({ "success": true, "code": 0, "data": { // return dynamic JSON name: req.body.name } }) });
現(xiàn)在Mock級別的路由已經(jīng)有了,接下來我們就要準備對應的路由和響應的callback了,添加一個mock文件夾,專門放置一些mock接口的文件,利用node的fs模塊引入所有需要mock的接口即可
const path = require('path'); const mockDir = path.resolve(__dirname, '../mock'); fs.readdirSync(mockDir).forEach(file => { const mock = require(path.resolve(mockDir, file)); // mockRouter就是上面Mock路由即可 mockRouter.use(mock.api, mock.response); });
2、Vue-cli3.x的基本知識,相對比于Vue-cli2.x的版本,把webpack的配置封裝出來,拋出一些外在接口去修改webpack配置,我們需要了解的是針對開發(fā)模式express的使用(內(nèi)部使用webpack-dev-serve),Vue-cli3.0需要的是在適當?shù)臅r機處理開發(fā)模式的express實例,來達到Mock的目的
module.exports = { dev: { before: (app) => { // app就是底層的express實例,上面針對express實例的操作,全部換成app即可 } } }
3、至于mock的文件下面的js文件就是我們需要掛載到express的mock接口的信息,下面給出一個實例,其他仿照即可,一個js文件代表一個mock接口
// 注意,由于是針對子路由級別的,前端調(diào)用的url為/mock/get-info module.exports = { api: '/get-info', response: (req, res) => { // 由于添加了body-parser中間件,所以可以解析傳入的body,這里就可以用來動態(tài)的生成JSON const flag = req.body.flag; console.log(req.body); res.send( { success: flag, code: 0, data: [], message: '獲取信息成功', }, ); }, };
四:結(jié)合上面的幾點整合處理
五:其他幾種方式的Mock接口
- mock.js去,給出官網(wǎng),它會修改原生的XMLHttpRequest來攔截ajax請求,同時提供強大的根據(jù)模板生成數(shù)據(jù)
- fastmock,類似本地Mock,數(shù)據(jù)放在了外網(wǎng),團隊配合可以選擇,具體使用見鏈接
- 后端Controller生成靜態(tài)JSON,不推薦,后端不會吊我們的,搞不好會干架,哈哈
六:總結(jié)
前端工程化的出現(xiàn)能夠讓前端做的事情很多很多,技術(shù)的廣度能夠支持你做一些有意思的事情。首先這個可以做一些優(yōu)化,比如本地的Mock可以使用mock.js純處理一些數(shù)據(jù)的生成工作。注意mock接口的url和自己proxy的接口不要沖突。使用Vue-cli3.0,它不僅是封裝了webpack的配置,同時提供了自己一套插件機制,接下來寫一個簡單的cli插件自動化完成這些操作,
敬請期待。歡迎評論交流。
以上就是本文的全部內(nèi)容,希望對大家的學習有所幫助,也希望大家多多支持腳本之家。
相關(guān)文章
Vue 中使用vue2-highcharts實現(xiàn)top功能的示例
下面小編就為大家分享一篇Vue 中使用vue2-highcharts實現(xiàn)top功能的示例,具有很好的參考價值,希望對大家有所幫助。一起跟隨小編過來看看吧2018-03-03Vue中的ref作用詳解(實現(xiàn)DOM的聯(lián)動操作)
這篇文章主要介紹了Vue中的ref作用詳解(實現(xiàn)DOM的聯(lián)動操作),需要的朋友可以參考下2017-08-08