寫在前面
這篇文章的主要目的是學會使用koa框架搭建web服務,從而提供一些后端接口,供前端調用。
搭建這個環境的目的是: 前端工程師在跟后臺工程師商定了接口但還未聯調之前,涉及到向后端請求數據的功能能夠走前端工程師自己搭建的http路徑,而不是直接在前端寫幾個死數據。即,模擬后端接口。
當然在這整個過程(搭建環境 + 開發示例demo)中,涉及到以下幾點知識點。
包括:
第一部分:環境搭建
vue + vuex環境
首先是vue + vue-router + vuex的環境。我們用vue-cli腳手架生成項目,會用vue的同學對這塊應該很熟了。
// 全局安裝腳手架工具npm i vue-vli -g// 驗證腳手架工具安裝成功與否vue --version// 構建項目vue init webpack 項目名// 測試vue項目是否運行成功npm run dev
因為腳手架生成的vue項目不包含vuex,所以再安裝vuex。
// 安裝vuexnpm i vuex --save
koa2環境
前端項目構建好了,就開始構建我們的后端服務。
首先在你的開發工具(不管是webstorm還是sublime)里新建一個目錄,用來搭建基于koa的web服務。
在這里,我們不妨給這個目錄起名為koa-demo。
然后執行:
// 進入目錄cd koa-demo// 生成package.jsonnpm init -y// 安裝以下依賴項npm i koanpm i koa-routernpm i koa-cors
安裝好koa和兩個中間件,環境就算搭建完成了。
第二部分:示例開發
搭建環境是為了使用,所以我們立馬來寫一個demo出來。
demo開發既是一個練習如何在開發環境中寫代碼的過程,反過來,也是一個驗證環境搭建的對不對、好不好用的過程。
后端接口開發
本例中,后端我們只提供一個服務,就是給前端提供一個返回json數據的接口。代碼中包含注釋,所以直接上代碼。
server.js文件
// server.js文件let Koa = require('koa');let Router = require('koa-router');let cors = require('koa-cors');// 引入modejs的文件系統APIlet fs = require('fs');const app = new Koa();const router = new Router();// 提供一個/getJson接口router .get('/getJson', async ctx => { // 后端允許cors跨域請求 await cors(); // 返回給前端的數據 ctx.body = JSON.parse(fs.readFileSync( './static/material.json')); });// 將koa和兩個中間件連起來app.use(router.routes()).use(router.allowedMethods());// 監聽3000端口app.listen(3000);這里面用到了一個json文件,在'./static/material.json'路徑,該json文件的代碼是:
// material.json文件[{ "id": 1, "date": "2016-05-02", "name": "張三", "address": "北京 清華大學",}, { "id": 2, "date": "2016-05-04", "name": "李四", "address": "上海 復旦大學",}, { "id": 3, "date": "2016-05-01", "name": "王五", "address": "廣東 中山大學",}, { "id": 4, "date": "2016-05-03", "name": "趙六", "address": "廣東 深圳大學",}, { "id": 5, "date": "2016-05-05", "name": "韓梅梅", "address": "四川 四川大學",}, { "id": 6, "date": "2016-05-11", "name": "劉小律", "address": "湖南 中南大學",}, { "id": 7, "date": "2016-04-13", "name": "曾坦", "address": "江蘇 南京大學",}]然后我們是用以下命令將服務啟動
node server.js
測試接口是否良好
打開瀏覽器,輸入http://127.0.0.1:3000/getJson。看一看頁面上是否將json文件中的json數據顯示出來,如果能夠顯示出來,則說明這個提供json數據的服務,我們已經搭建好了。
前端調用后端接口示例
為突出重點,排除干擾,方便理解。我們的前端就寫一個組件,組件有兩部分:首先是一個按鈕,用來調用web服務的getJson接口;然后是一個內容展示區域,拿到后端返回的數據以后,將其在組件的這塊區域顯示出來。
首先我們看組件文件吧
<template> <div class="test"> <button type="button" @click="getJson">從后端取json</button> <div class="showJson">{{json}}</div> </div></template><script> import {store} from '../vuex' export default { computed: { json(){ return store.state.json; } }, methods: { getJson(){ store.dispatch("getJson"); } } }</script><style scoped> .showJson{ width:500px; margin:10px auto; min-height:500px; background-color: palegreen; }</style>非常簡單,就不多解釋了。
然后看我們的vuex文件。
import Vue from 'vue'import Vuex from 'vuex';Vue.use(Vuex)const state = { json: [],};const mutations = { setJson(state, db){ state.json = db; }}const actions = { getJson(context){ // 調用我們的后端getJson接口 fetch('http://127.0.0.1:3000/json', { method: 'GET', // mode:'cors', headers: { 'Accept': 'application/json', 'Content-Type': 'application/json', }, }).then(function (res) { if(res.status === 200){ return res.json() } }).then(function (json) { //console.log(typeof Array.from(json), Array.from(json)); context.commit('setJson', Array.from(json)); }) }};export const store = new Vuex.Store({ state: state, mutations: mutations, actions: actions,})ok, 代碼擼完了。
說說axios
想要把本demo的fetch改為axios方式,要做的工作有以下幾處:
1、安裝axios、在vuex文件引用axios
npm i axiosimport axios from 'axios'
2、將fetch部分代碼替換為:
const actions = { getJson(context){ axios.get('/json', { method: 'GET', // mode:'cors', headers: { 'Accept': 'application/json', 'Content-Type': 'application/json', }, }).then(function (res) { if(res.status === 200){ return res.data } }).then(function (json) { //console.log(typeof Array.from(json), Array.from(json)); context.commit('setJson', Array.from(json)); }) }};3、又會遇到跨域,在webpack中修改,路徑config/index.js文件中添加proxyTable項的配置:
proxyTable: { '/json': { target: 'http://127.0.0.1:3000', changeOrigin: true, pathRewrite: { '^/json': '/json' } } },后記
基于vue腳手架搭建的項目,模擬異步取數據,也可以直接在腳手架生成的static文件夾下放置數據,假裝是后臺拿過來的數據。
不過搭建一個基于express或者koa的web服務,確實也該是一個前端工程師應該掌握的。
OK,以上就是全文了。希望對大家的學習有所幫助,也希望大家多多支持武林網。
新聞熱點
疑難解答