koa2从搭建项目到实现API

时间 2019-11-09

标签 koa2 koa 搭建项目实现 api 繁體版

原文原文链接

koa2，之前没有接触过，只知道是express的原班人马开发的，在一些方面优于express，又经历了一次从koa到koa2的升级，应该说是比较成熟的了。
根据如今的技术实现方案，如今大部分的web服务基本都是先后端分离模式的，因此koa2的让web应用开发和api的使用更加简便优点，更值得咱们去学习。javascript

本文只简单介绍将环境搭建起来，可让初次学习koa或者web应用的同窗可以更快的看到学习成果，增长学习的自信心，其中涉及到的不少的知识和技术点，咱们后续补充，不在本文作过多的阐述
本文的目的就是作知识的普及，文中可能会有些代码是从网络中复制的，可是都是亲手调试可运行，保证代码的正常运行的

搭建环境

安装node

这个不用想也不用考虑，koa项目是基于node的，上来什么都别说，先安装node。但这里有个细节须要注意，node须要最低版本为7.6.0，主要是为了一些es6的语法支持。前端

brew install node

我这里是在mac环境上安装的node，因为本人习惯使用homebrew安装，若是不是mac环境的同窗，也能够直接到官网下载安装包安装。这个步骤比较简单，通常状况下看下官网的文档介绍，能够直接搞定。
node安装完成后，要查看下node的版本，有两个目的，一是查看node是否安装成功，再就是检查是否知足koa的版本需求。

node -v
npm -v

npm集成到node中了，只要成功的安装了node，npm也会被成功安装。

安装koa

咱们学习和应用的是koa项目，就先安装上koa吧。
npm install koa --savejava

安装koa2项目生成器并建立项目

npm install koa-generator -g
koa2 bbs

这里的koa-generator，并非官方的项目生成器，而是狼叔-桑世龙为咱们贡献的财富，在这里，咱们感谢狼叔。
koa2 bbs，这行代码建立了基于koa2的项目，并生成基本的项目架构。基本的项目架构以下：
node

安装依赖

项目也建立完了，可是只是完成了一个基本的骨架，尚未血肉，接下来就须要安装项目的依赖了mysql

cd bbs
npm install

这个步骤可能消耗的时间有点长，这个和网络环境有关，因为网络的缘由，还有可能某些依赖会安装失败，这个时候，咱们能够经过修改npm镜像来减小因为网络环境致使安装依赖失败的问题。
具体可参考淘宝NPM镜像。git

启动服务

npm start

npm能够启动服务，但不支持热更新，咱们这里只是测试项目可否正常启动，执行，热更新的内容，咱们后续再讲。
服务正常启动以后，浏览器输入：localhost:3000,若是页面中展现了如"Hello Koa 2"的内容，说明项目搭建成功。es6

搭建项目

这里的搭建项目，不是前面的使用koa2初始化一个项目，而是把前面经过koa2初始化的项目补充养分，让它丰满起来。github

安装sequelize

暂且不要关心sequelize是什么，之后会有专题细讲，只须要了解一点就能够了：Sequelize是一个基于promise的nodejs ORM，目前支持Postgres、mysql、SQLite和Microsoft SQL Server。它具备强大的事务支持，关联关系，读取和复制等功能。web

npm install sequelize --save

安装mysql、mysql2

项目须要mysql的数据库支持sql

npm install mysql mysql2 --save

配置Sequelize的数据库连接

在项目的根目录下建立一个config目录，config目录中建立db.js，该文件主要用来建立mysql的数据库连接的。

const Sequelize = require('sequelize');
const sequelize = new Sequelize('dbname','dbusername','password',{
    host:'localhost',
    dialect:'mysql',
    operatorsAliases:false,
    dialectOptions:{
        //字符集
        charset:'utf8mb4',
        collate:'utf8mb4_unicode_ci',
        supportBigNumbers: true,
        bigNumberStrings: true
    },
    pool:{
        max: 5,
        min: 0,
        acquire: 30000,
        idle: 10000
    },
    timezone: '+08:00'  //东八时区
});

module.exports = {
    sequelize
};

这些代码能够直接使用，只须要将代码中实例化Sequelie对象语句中的dbname更改成你的数据库名，dbusername更改成你的数据库用户名，passoword更改成你的数据库密码，其中数据库名和数据库用户名不能为空，密码能够为空，为空时则为空的字符串就能够了。

const sequelize = new Sequelize('bbs','root','',{
……

建立schema、modules、controllers

schema:数据表模型实例
modules：实体模型
controllers：控制器
3个目录下分别建立article.js。

schema数据表模型

在schema目录下新建一个article.js文件，该文件的主要做用就是创建与数据表的对应关系，也能够理解为代码的建表。
首先来分析表结构：

字段	说明	是否必填
id	文章自增ID，主键	否，自动填的
title	文章标题	是
author	做者	是
content	文章内容	是
category	文章分类	是

分析表结构，主要是为了用来建表的，表结构，是咱们根据实体的关系抽象出来的实体关系，根据这些关系创建表，将实体的关系存储到表中。建表有两种方式：一是使用mysql数据库的命令行工具或者UI工具建表，再就是使用咱们前面介绍的Sequelize，让程序去建立表。
使用mysql工具建表方式：

DROP TABLE IF EXISTS `article`;
CREATE TABLE `article` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `title` varchar(255) NOT NULL,
  `author` varchar(255) NOT NULL,
  `content` varchar(255) NOT NULL,
  `category` varchar(255) NOT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=7 DEFAULT CHARSET=utf8;
SET FOREIGN_KEY_CHECKS = 1;

这是使用sql语句建立表的方式，咱们看另外一种借助Sequelize建表方式(Sequelize不光是能建表，还能作数据库的管理)；
咱们刚才在schema目录下的article.js用来建立数据表模型的，也能够理解为建立一张数据表，代码以下：

const moment = require("moment");
module.exports = function(sequelize,DataTypes){
    return sequelize.define('article',{
        id:{
            type: DataTypes.INTEGER,
            primaryKey: true,
            allowNull: true,
            autoIncrement: true
        },
        //文章标题
        title:{
            type: DataTypes.STRING,
            allowNull: false,
            field: 'title'
        },
        //做者
        author:{
            type: DataTypes.STRING,
            allowNull: false,
            field: 'author'
        },
        //内容
        content:{
            type: DataTypes.STRING,
            allowNull: false,
            field:'content'
        },
        //文章分类
        category:{
            type: DataTypes.STRING,
            allowNull: false,
            field: 'category'
        },
        // 建立时间
        createdAt:{
            type: DataTypes.DATE
        },
        // 更新时间
        updatedAt:{
            type: DataTypes.DATE
            }
        }
    },{
        /**
         * 若是为true，则表示名称和model相同，即user
         * 若是为fasle，mysql建立的表名称会是复数，即users
         * 若是指定的表名称自己就是复数，则形式不变
         */
        freezeTableName: true
    });
}

模型应用、使用

在项目中modules目录下建立article.js文件，为文章表，该文件为文章的实例。

// 引入mysql的配置文件
const db = require('../config/db');

// 引入sequelize对象
const Sequelize = db.sequelize;

// 引入数据表模型
const Article = Sequelize.import('../schema/article');
Article.sync({force: false}); //自动建立表

class ArticleModel {
    /**
     * 建立文章模型
     * @param data
     * @returns {Promise<*>}
     */
    static async createArticle(data){
        return await Article.create({
            title: data.title, //标题
            author: data.author,  //做者
            content: data.content,  //文章内容
            category: data.category //文章分类
        });
    }

    /**
     * 查询文章的详情
     * @param id 文章ID
     * @returns {Promise<Model>}
     */
    static async getArticleDetail(id){
        return await Article.findOne({
            where:{
                id
            }
        });
    }
}

module.exports = ArticleModel;

controller 控制器

控制器的主要做用为功能的处理，项目中controller目录下建立article.js，代码以下：

const ArticleModel = require("../modules/article");

class articleController {
    /**
     * 建立文章
     * @param ctx
     * @returns {Promise.<void>}
     */
    static async create(ctx){
        //接收客服端
        let req = ctx.request.body;
        if(req.title && req.author && req.content && req.category){
            try{
                //建立文章模型
                const ret = await ArticleModel.createArticle(req);
                //使用刚刚建立的文章ID查询文章详情，且返回文章详情信息
                const data = await ArticleModel.getArticleDetail(ret.id);

                ctx.response.status = 200;
                ctx.body = {
                    code: 200,
                    msg: '建立文章成功',
                    data
                }
            }catch(err){
                ctx.response.status = 412;
                ctx.body = {
                    code: 412,
                    msg: '建立文章失败',
                    data: err
                }
            }
        }else {
            ctx.response.status = 416;
            ctx.body = {
                code: 200,
                msg: '参数不齐全'
            }
        }
    }

    /**
     * 获取文章详情
     * @param ctx
     * @returns {Promise.<void>}
     */
    static async detail(ctx){
        let id = ctx.params.id;
        if(id){
            try{
                // 查询文章详情模型
                let data = await ArticleModel.getArticleDetail(id);
                ctx.response.status = 200;
                ctx.body = {
                    code: 200,
                    msg: '查询成功',
                    data
                }
            }catch(err){
                ctx.response.status = 412;
                ctx.body = {
                    code: 412,
                    msg: '查询失败',
                    data
                }
            }
        }else {
            ctx.response.status = 416;
            ctx.body = {
                code: 416,
                msg: '文章ID必须传'
            }
        }
    }
}

module.exports = articleController;

路由

路由，也能够简单理解为路径，主要是做为请求的url，请求的路径来处理一些请求，返回数据。通常状况下，基于node的项目，路由都是在一个叫作routes的目录下面。

const Router = require('koa-router');
const ArtileController = require('../controllers/article');

const router = new Router({
  prefix: '/api/v1'
});

/**
 * 文章接口
 */
//建立文章
router.post('/article/create',ArtileController.create);

//获取文章详情
router.get('/article/:id',ArtileController.detail)

module.exports = router

启动服务

这里主要测试服务可否正常启动，可否正常运行。

npm start

若是启动过程当中出现下面的结果，说明服务启动成功

➜  bbs npm start

> bbs@0.1.0 start /usr/local/var/www/koa/bbs
> node bin/www

koa deprecated Support for generators will be removed in v3. See the documentation for examples of how to convert old middleware https://github.com/koajs/koa/blob/master/docs/migration.md app.js:20:5
Ignoring invalid configuration option passed to Connection: collate. This is currently a warning, but in future versions of MySQL2, an error will be thrown if you pass an invalid configuration options to a Connection
Ignoring invalid configuration option passed to Connection: collate. This is currently a warning, but in future versions of MySQL2, an error will be thrown if you pass an invalid configuration options to a Connection
Executing (default): CREATE TABLE IF NOT EXISTS `article` (`id` INTEGER auto_increment , `title` VARCHAR(255) NOT NULL, `author` VARCHAR(255) NOT NULL, `content` VARCHAR(255) NOT NULL, `category` VARCHAR(255) NOT NULL, `createdAt` DATETIME, `updatedAt` DATETIME, PRIMARY KEY (`id`)) ENGINE=InnoDB;
Executing (default): SHOW INDEX FROM `article`

接下来，就能够测试接口了。
我使用的测试接口工具为postman，之前postman好像是做为浏览器的一个插件存在的，如今不做为浏览器的插件了，直接作成了应用了，能够直接从postmna官网下载。官网地址https://www.getpostman.com/,而后咱们根据咱们的系统平台来选择合适的版本下载就能够了。

解决跨域

跨域是web开发中不可避免的一个必需要解决的问题了。跨域问题，主要是要解决服务器端的通讯问题。在node的开发中，只须要实现一个CORS标准就能够了。

npm install koa-cors --save

而后在根目录下的app.js加入koa-cors的引用：

const cors = require('koa-cors')
app.use(cors()) //使用cors

而后从新启动服务。到这里为止，还不能支持热更新，如今主要测试功能，暂且先这么手动重启吧，后面会有专题描述热更新服务。

测试接口

前面我下载而且安装好了postman，工具备了，代码层面也准备就绪，解决了跨域问题，下面就能够测试接口是否可用了。
测试接口，咱们先看下咱们的路由管理文件routes目录下的index.js文件。

//建立文章
router.post('/article/create',ArtileController.create);

//获取文章详情
router.get('/article/:id',ArtileController.detail)

这里有2个文章相关的接口，一个是建立新文章，一个是获取文章详情。咱们先来测试建立新的文章。
看路由，建立新文章须要的请求方式为post，url为/article/create，那咱们就根据这些信息使用postman进行测试吧。

这是我建立新文章的接口测试，而后看测试结果：

运行结果告诉咱们建立新文章的接口已经测试成功了，说明这个接口能够走通了。若是咱们如今是先后端分离的开发模式，咱们须要提供api的话，那么这个api就能够提供给前端同窗使用了。
咱们也能够从数据库中验证一下执行结果的正确性：

数据也成功插入到数据库中了，咱们也更加验证了咱们接口的正确性和可执行性了，这个接口到此结束。
而后看下一个获取文章详情的接口。须要使用get的请求方式，请求的URL为/article/:id。

总结

到如今为止，咱们基本已经完成了从0开始搭建一个koa项目，并完成一些简单的api接口的实现，固然了，只是最基本的实现，里面还有不少可优化的空间，对于一个做为入门案例来讲，已经够了。对于有深刻了解或学习的朋友，但愿咱们功能学习，共同提升。