当前位置：Gxlcms > JavaScript > 详解vue+vuex+koa2开发环境搭建及示例开发

详解vue+vuex+koa2开发环境搭建及示例开发

时间：2021-07-01 10:21:17 帮助过：13人阅读

写在前面

这篇文章的主要目的是学会使用koa框架搭建web服务，从而提供一些后端接口，供前端调用。

搭建这个环境的目的是： 前端工程师在跟后台工程师商定了接口但还未联调之前，涉及到向后端请求数据的功能能够走前端工程师自己搭建的http路径，而不是直接在前端写几个死数据。即，模拟后端接口。

当然在这整个过程（搭建环境 + 开发示例demo）中，涉及到以下几点知识点。

包括：

  1. koa2的知识点
  2. node的知识点
  3. 跨域问题
  4. fetch的使用
  5. axios的使用
  6. promise的涉及
  7. vuex -> state、mutations、actions的使用

第一部分：环境搭建

vue + vuex环境

首先是vue + vue-router + vuex的环境。我们用vue-cli脚手架生成项目，会用vue的同学对这块应该很熟了。

  1. // 全局安装脚手架工具
  2. npm i vue-vli -g
  3. // 验证脚手架工具安装成功与否
  4. vue --version
  5. // 构建项目
  6. vue init webpack 项目名
  7. // 测试vue项目是否运行成功
  8. npm run dev

因为脚手架生成的vue项目不包含vuex，所以再安装vuex。

  1. // 安装vuex
  2. npm i vuex --save

koa2环境

前端项目构建好了，就开始构建我们的后端服务。

首先在你的开发工具（不管是webstorm还是sublime）里新建一个目录，用来搭建基于koa的web服务。

在这里，我们不妨给这个目录起名为koa-demo。

然后执行：

  1. // 进入目录
  2. cd koa-demo
  3. // 生成package.json
  4. npm init -y
  5. // 安装以下依赖项
  6. npm i koa
  7. npm i koa-router
  8. npm i koa-cors

安装好koa和两个中间件，环境就算搭建完成了。

第二部分：示例开发

搭建环境是为了使用，所以我们立马来写一个demo出来。

demo开发既是一个练习如何在开发环境中写代码的过程，反过来，也是一个验证环境搭建的对不对、好不好用的过程。

后端接口开发

本例中，后端我们只提供一个服务，就是给前端提供一个返回json数据的接口。代码中包含注释，所以直接上代码。

server.js文件

  1. // server.js文件
  2. let Koa = require('koa');
  3. let Router = require('koa-router');
  4. let cors = require('koa-cors');
  5. // 引入modejs的文件系统API
  6. let fs = require('fs');
  7. const app = new Koa();
  8. const router = new Router();
  9. // 提供一个/getJson接口
  10. router
  11.   .get('/getJson', async ctx => {
  12.     // 后端允许cors跨域请求
  13.     await cors();
  14.     // 返回给前端的数据
  15.     ctx.body = JSON.parse(fs.readFileSync( './static/material.json'));
  16.   
  17.   });
  18. // 将koa和两个中间件连起来
  19. app.use(router.routes()).use(router.allowedMethods());
  20. // 监听3000端口
  21. app.listen(3000);

这里面用到了一个json文件，在'./static/material.json'路径，该json文件的代码是：

  1. // material.json文件
  2. [{
  3.   "id": 1,
  4.   "date": "2016-05-02",
  5.   "name": "张三",
  6.   "address": "北京 清华大学",
  7. }, {
  8.   "id": 2,
  9.   "date": "2016-05-04",
  10.   "name": "李四",
  11.   "address": "上海 复旦大学",
  12. }, {
  13.   "id": 3,
  14.   "date": "2016-05-01",
  15.   "name": "王五",
  16.   "address": "广东 中山大学",
  17. }, {
  18.   "id": 4,
  19.   "date": "2016-05-03",
  20.   "name": "赵六",
  21.   "address": "广东 深圳大学",
  22. }, {
  23.   "id": 5,
  24.   "date": "2016-05-05",
  25.   "name": "韩梅梅",
  26.   "address": "四川 四川大学",
  27. }, {
  28.   "id": 6,
  29.   "date": "2016-05-11",
  30.   "name": "刘小律",
  31.   "address": "湖南 中南大学",
  32. }, {
  33.   "id": 7,
  34.   "date": "2016-04-13",
  35.   "name": "曾坦",
  36.   "address": "江苏 南京大学",
  37. }]

然后我们是用以下命令将服务启动

  1. node server.js

测试接口是否良好

打开浏览器，输入http://127.0.0.1:3000/getJson。看一看页面上是否将json文件中的json数据显示出来，如果能够显示出来，则说明这个提供json数据的服务，我们已经搭建好了。

前端调用后端接口示例

为突出重点，排除干扰，方便理解。我们的前端就写一个组件，组件有两部分：首先是一个按钮，用来调用web服务的getJson接口；然后是一个内容展示区域，拿到后端返回的数据以后，将其在组件的这块区域显示出来。

首先我们看组件文件吧

  1. <template>
  2.   <div class="test">
  3.     <button type="button" @click="getJson">从后端取json</button>
  4.     <div class="showJson">{{json}}</div>
  5.   </div>
  6. </template>
  7. <script>
  8.   import {store} from '../vuex'
  9.   export default {
  10.     computed: {
  11.      json(){
  12.        return store.state.json;
  13.      }
  14.     },
  15.     methods: {
  16.      getJson(){
  17.        store.dispatch("getJson");
  18.      }
  19.     }
  20.   }
  21. </script>
  22. <style scoped>
  23.  .showJson{
  24.   width:500px;
  25.   margin:10px auto;
  26.   min-height:500px;
  27.   background-color: palegreen;
  28.  }
  29. </style>

非常简单，就不多解释了。

然后看我们的vuex文件。

  1. import Vue from 'vue'
  2. import Vuex from 'vuex';
  3. Vue.use(Vuex)
  4. const state = {
  5.   json: [],
  6. };
  7. const mutations = {
  8.  setJson(state, db){
  9.   state.json = db;
  10.  }
  11. }
  12. const actions = {
  13.  getJson(context){
  14.   // 调用我们的后端getJson接口
  15.   fetch('http://127.0.0.1:3000/json', {
  16.    method: 'GET',
  17.    // mode:'cors',
  18.    headers: {
  19.     'Accept': 'application/json',
  20.     'Content-Type': 'application/json',
  21.    },
  22.   }).then(function (res) {
  23.    if(res.status === 200){
  24.     return res.json()
  25.    }
  26.   }).then(function (json) {
  27.    //console.log(typeof Array.from(json), Array.from(json));
  28.    context.commit('setJson', Array.from(json));
  29.   })
  30.  }
  31. };
  32. export const store = new Vuex.Store({
  33.  state: state,
  34.  mutations: mutations,
  35.  actions: actions,
  36. })

ok, 代码撸完了。

说说axios

想要把本demo的fetch改为axios方式，要做的工作有以下几处：

1、安装axios、在vuex文件引用axios

  1. npm i axios
  2. import axios from 'axios'

2、将fetch部分代码替换为：

  1. const actions = {
  2.  getJson(context){
  3.   axios.get('/json', {
  4.    method: 'GET',
  5.    // mode:'cors',
  6.    headers: {
  7.     'Accept': 'application/json',
  8.     'Content-Type': 'application/json',
  9.    },
  10.   }).then(function (res) {
  11.    if(res.status === 200){
  12.     return res.data
  13.    }
  14.   }).then(function (json) {
  15.    //console.log(typeof Array.from(json), Array.from(json));
  16.    context.commit('setJson', Array.from(json));
  17.   })
  18.  }
  19. };

3、又会遇到跨域，在webpack中修改，路径config/index.js文件中添加proxyTable项的配置：

  1. proxyTable: {
  2.    '/json': {
  3.     target: 'http://127.0.0.1:3000',
  4.     changeOrigin: true,
  5.     pathRewrite: {
  6.      '^/json': '/json'
  7.     }
  8.    }
  9.   },

后记

基于vue脚手架搭建的项目，模拟异步取数据，也可以直接在脚手架生成的static文件夹下放置数据，假装是后台拿过来的数据。

不过搭建一个基于express或者koa的web服务，确实也该是一个前端工程师应该掌握的。

OK，以上就是全文了。希望对大家的学习有所帮助，也希望大家多多支持脚本之家。

人气教程排行

本站所有资源全部来源于网络，若本站发布的内容侵害到您的隐私或者利益，请联系我们删除！