一個簡單的vue + koa2前後端互動例項

雲荒杯傾發表於2018-01-23
Vue後端

寫在前面

這篇文章的主要目的是學會使用koa框架搭建web服務，從而提供一些後端介面，供前端呼叫。

在這整個過程中，涉及到以下幾點知識點。 包括：

  • koa2的知識點
  • node的知識點
  • 跨域問題
  • fetch的使用
  • axios的使用
  • promise的涉及
  • vuex -> state、mutations、actions的使用

第一部分：環境搭建

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。

// 安裝vuex
npm i vuex --save
複製程式碼

koa2環境

前端專案構建好了，就開始構建我們的後端服務。

首先在你的開發工具（不管是webstorm還是sublime）裡新建一個目錄，用來搭建基於koa的web服務。

在這裡，我們不妨給這個目錄起名為koa-demo。

然後執行：

// 進入目錄
cd koa-demo
// 生成package.json
npm init -y
// 安裝以下依賴項
npm i koa
npm i koa-router
npm 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的檔案系統API
let 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, 程式碼擼完了，獲取後端資料之前是這樣的。

一個簡單的vue + koa2前後端互動例項

獲取後端資料之後是這樣的。

一個簡單的vue + koa2前後端互動例項

說說axios

想要把本demo的fetch改為axios方式，要做的工作有以下幾處： 1、安裝axios、在vuex檔案引用axios

npm i axios
import 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，以上就是全文了。 如果這篇文章使你有所收穫，不勝榮幸。 歡迎點贊，以期能幫助更多同學！

關於作者

技術部落格 || GitHub || 掘金主頁

相關文章