koa2+koa-generator+mysql快速搭建nodejs服务器

用koa的脚手架koa-generator可以快速生成项目骨架,可以用于发开或者测试接口

https://github.com/hellojinjin123/node-koa2-template

1. 全局安装koa-generator(不用全局安装koa)

项目名字fast-koa

npm install koa-generator -g
koa2 fast-koa
cd fast-koa
npm install

目录结构如下

-bin // www 项目启动目录 node ./www

-public // 静态网站放置目录 也就是vue dist代码放置的地 项目入口index.html

-routes // 路由

-views // 视图 服务器渲染使用的模板

-app.js // 项目入口

-packaga.json

2. 启动项目

// package.json
"scripts": {
"start": "node bin/www",
"dev": "./node_modules/.bin/nodemon bin/www",
"prd": "pm2 start bin/www",
"test": "echo \"Error: no test specified\" && exit 1"
}

运行npm run dev开启服务器

同时可以看到generator自带了nodemon(Nodemon 是一款非常实用的工具,用来监控你 node.js 源代码的任何变化和自动重启你的服务器)

如下图:服务器启动了

avatar1

3. 项目入口app.js

// app.js
const Koa = require('koa')
const app = new Koa()
const views = require('koa-views')
const json = require('koa-json')
const onerror = require('koa-onerror')
const bodyparser = require('koa-bodyparser')
const logger = require('koa-logger') const index = require('./routes/index')
const users = require('./routes/users') // error handler
onerror(app) // middlewares
app.use(bodyparser({
enableTypes:['json', 'form', 'text']
}))
app.use(json())
app.use(logger())
app.use(require('koa-static')(path.resolve(__dirname, config.publicPath)))) app.use(views(__dirname + '/views', {
extension: 'pug'
})) // logger
app.use(async (ctx, next) => {
const start = new Date()
await next()
const ms = new Date() - start
console.log(`${ctx.method} ${ctx.url} - ${ms}ms`)
}) // routes
app.use(index.routes(), index.allowedMethods())
app.use(users.routes(), users.allowedMethods()) // error-handling
app.on('error', (err, ctx) => {
console.error('server error', err, ctx)
}); module.exports = app

可以在根目录路添加config.js 把一些公共的配置放入 比如数据库信息,端口,静态资源路径等

// config.js
const path = require('path');
const config = {
// 项目启动监听的端口
port: 3000, publicPath: 'public',
logPath: 'logs/koa-template.log', // 数据库配置
database: {
HOST: 'xxx', // 数据库地址
USERNAME: 'xxx', // 用户名
PASSWORD: 'xxx', // 用户密码
DATABASE: 'xxx', // 数据库名
PORT: 3306 // 数据库端口(默认: 3306)
}
}; module.exports = config;

4. koa-static 静态资源中间件

app.use(require('koa-static')(path.resolve(__dirname, config.publicPath))))

koa-generator已经配置了静态资源中间件,只要放入public目录,静态网站就可以运行

浏览http://localhost:3000/,服务器会优先读取public下的index.html

如果没有index.html,服务器会根据路由,判断'/'是否有内容返回,没有对应路由则返回404 not found

因为koa-generator默认设置了路由,所以服务器运行返回了Hello Koa 2!

如下:

router.get('/', async (ctx, next) => {
await ctx.render('index', {
title: 'Hello Koa 2!'
})
})

5. 添加models目录

相当于服务器数据层,存放数据库模型(相当于建表),使用Sequelize进行mysql操作

const { sequelize, Sequelize } = require('../config/db')
const { DataTypes, Model } = Sequelize class Admin extends Model { /**
* @description: 添加管理员
* @param {*} username
* @param {*} password
* @return {*} 返回添加的数据
*/
static async createAdmin({ username, password }) {
return await this.create({
username,
password
})
} /**
* @description: 根据id修改管理员密码
* @param {*} id
* @return {*} 返回修改的数据
*/
static async updatepwdById({id, password}) {
return await this.update({ password }, {
where: {
id
}
})
} /**
* @description: 根据id删除管理员
* @param {*} id
* @return {*}
*/
static async deleteById(id){
return await this.destroy({
where: {
id
}
})
} }
// 初始化表结构
Admin.init(
{
id: {
type: DataTypes.INTEGER,
allowNull: false, //非空
autoIncrement: true, //自动递增
primaryKey: true //主键
},
username: {
type: DataTypes.STRING,
field: "username",
allowNull: false,
unique: true // 唯一约束 用户名不能重复
},
password: {
type: DataTypes.STRING,
allowNull: false
},
active: {
type: DataTypes.BOOLEAN,
allowNull: false,
defaultValue: true
}
}, {
underscored: true, //额外字段以下划线来分割
timestamps: true, //取消默认生成的createdAt、updatedAt字段
createdAt: "created_at",
updatedAt: "updated_at",
freezeTableName: true, // Model 对应的表名将与model名相同
comment: "管理员表类",
// paranoid: true //虚拟删除
sequelize, // 我们需要传递连接实例
// modelName: 'Admin', // 我们需要选择模型名称
// tableName: 'Admin' // 表名
}
) // 创建表格
; (async () => {
await Admin.sync();
console.log("Admin表刚刚(重新)创建!");
// 这里是代码
})()
// 定义的模型是类本身
// console.log(User === sequelize.models.User); // true
module.exports = Admin

6. mysql数据库的使用(Sequelize stars 23.6k in github )

Sequelize 是一个基于 promise 的 Node.js ORM, 目前支持 Postgres, MySQL, MariaDB, SQLite 以及 Microsoft SQL Server. 它具有强大的事务支持, 关联关系, 预读和延迟加载,读取复制等功能。

Sequelize 遵从 语义版本控制。 支持 Node v10 及更高版本以便使用 ES6 功能。https://www.sequelize.com.cn/core-concepts/model-basics

安装mysql&sequelize

npm install --save mysql mysql2
npm install --save sequelize

安装sequelize之后,在config目录下创建db.js,进行数据库连接设置

const Sequelize = require('sequelize');
const db = require('./index').db // 初始化数据库
const sequelize = new Sequelize(db.database, db.username, db.password, {
host: db.host,
dialect: 'mysql',
pool: {
max: 5,
min: 0,
idle: 10000
}
}) //测试数据库链接
sequelize.authenticate().then(function() {
console.log("数据库连接成功");
}).catch(function(err) {
//数据库连接失败时打印输出
console.error(err);
throw err;
}); module.exports = { sequelize, Sequelize }

7. 添加controllers目录

有了模型层对操作数据库的支持,就可以进行业务操作了,也就是控制器目录(在这个层可以放心调用models层方法进行curd)

// 导入模型
const Admin = require('../models/admin') module.exports = { async getAllAdmins(ctx, next) {
try {
let data = await Admin.findAll()
ctx.body = { msg: 1001, data }
} catch (err) {
ctx.body = { code: -1, msg: 1000, }
}
await next();
}, async createAdmin(ctx, next) {
let req = ctx.request.body
if (!req.username || !req.password) {
ctx.body = { code: -1, msg: 1002 }
return await next();
}
try {
let data = await Admin.createAdmin(req)
ctx.body = { msg: 1003, data }
} catch (err) {
ctx.body = { code: -1, msg: 1000 }
}
await next();
}, async updatepwdById(ctx, next) {
let req = ctx.request.body
if (req.id && req.password) {
try {
await Admin.updatepwdById(req)
ctx.body = { msg: 1004 }
} catch (err) {
ctx.body = { code: -1, msg: 1000 }
}
} else {
ctx.body = { code: -1, msg: 1002 }
}
await next();
}, async deleteById(ctx, next) {
let query = ctx.request.query // 获取get请求参数
if (query && query.id) {
try {
await Admin.deleteById(query.id)
ctx.body = { msg: 1005 }
} catch (err) {
ctx.body = { code: -1, msg: 1000 }
}
} else {
ctx.body = { code: -1, msg: 1002 }
}
await next();
}
}

8. 路由配置

// app.js 中添加
// routes
const admin = require('./routes/admin')
app.use(admin.routes(), admin.allowedMethods())

到此为止,一个完整的请求(接口)就处理完成了

比如请求 http://localhost:3000/admin/getAllAdmins

koa经历的简单过程:

  1. 浏览器发出请求 -> 中间件 ->路由中间件 -> 中间件 -> 中间件若干回调 -> 浏览器收到响应
  2. 路由:
  • router.get/post -> controllers.func -> models.func-> mysql
  •  请求行为      ->       业务逻辑     ->   模型支持   ->  入库

9. 配置自定义的中间件处理日志和response消息

可以参考github代码

10. 附上一个很好理解的中间件原理的简析

// 根目录下test.js
// koa2 中间件原理简析
// 中间件的仓库
const arr = [
async (next) => {
console.log(1);
await next();
console.log(2);
},
async (next) => {
console.log(3);
await new Promise((resolve, reject) => {
setTimeout(() => {
resolve(
console.log(4)
);
}, 3000);
}); // 异步操作 await 会等待后面的promise resolve 后再向下执行
await next();
console.log(5);
},
async (next) => {
console.log(6);
},
async (next) => {
// 不会执行 因为上一个函数中没有执行next
console.log(7);
await next();
console.log(8);
},
async (next) => {
// 不会执行 因为前面的函数中没有执行next
console.log(9);
}
]; function fun(arr) {
function dispose(index) {
const currentFun = arr[index];
const next = dispose.bind(null, index + 1);
return currentFun(next); // 尾递归
} dispose(0);
} fun(arr); // 先打印 1 3 一秒后打印4 6 5 2

参考链接

koa2+koa-generator+mysql快速搭建nodejs服务器的更多相关文章

  1. CentOS 7快速搭建Nodejs开发环境

    Node.js是一个事件驱动I/O服务端JavaScript环境,基于Google的V8引擎,V8引擎执行Javascript的速度非常快,性能非常好.学习Nodejs首先需要会安装环境.这里我介绍如 ...

  2. django+nginx+xshell简易日志查询,接上<关于《rsyslog+mysql+loganalyzer搭建日志服务器<个人笔记>》的反思>

    纠正一下之前在<关于<rsyslog+mysql+loganalyzer搭建日志服务器<个人笔记>>的反思>中说到的PHP+MySQL太慢,这里只是说我技术不好,没 ...

  3. 关于《rsyslog+mysql+loganalyzer搭建日志服务器<个人笔记>》的反思

    关于<rsyslog+mysql+loganalyzer搭建日志服务器<个人笔记>>的反思--链接--http://www.cnblogs.com/drgcaosheng/p/ ...

  4. [Windows Azure] 使用 Windows Azure 快速搭建 Redis 服务器

    [Windows Azure] 使用 Windows Azure 快速搭建 Redis 服务器   Redis相信玩开源,大数据的朋友们并不陌生,大家最熟悉的使用者就是新浪微博,微博的整体数据缓存都是 ...

  5. pm2命令,端口查询,mongodb服务启动,nginx服务启动,n模块的使用,搭建nodejs服务器环境,搭建oracledb服务器环境 linux的环境搭建

    pm2命令 pm2 ls //查询pm2 启动的列表 pm2 start app.js //启动文件 pm2 restart app //重启项目 pm2 logs app //监控项目执行日志打印 ...

  6. CentOS 6.5下快速搭建ftp服务器[转]

    CentOS 6.5下快速搭建ftp服务器 1.用root 进入系统 2.使用命令 rpm -qa|grep vsftpd 查看系统是否安装了ftp,若安装了vsftp,使用这个命令会在屏幕上显示vs ...

  7. CentOS 6.5下快速搭建ftp服务器

    来源:Linux社区 作者:Linux CentOS 6.5下快速搭建ftp服务器 1.用root 进入系统 2.使用命令 rpm -qa|grep vsftpd 查看系统是否安装了ftp,若安装了v ...

  8. 快速搭建Web服务器软件PHP+Apache+MySQL

    搭建网站或者博客,需要一个合适的 Web 服务器.除了如下能在购买的虚拟空间上进行操作外,我们也可以在自己的电脑上搞定,因为可以用来方便快捷地测试网站或者博客主题,无论是 Wordpress.Joom ...

  9. json server的简单使用(附:使用nodejs快速搭建本地服务器)

    作为前端开发人员,经常需要模拟后台数据,我们称之为mock.通常的方式为自己搭建一个服务器,返回我们想要的数据.json server 作为工具,因为它足够简单,写少量数据,即可使用. 安装 首先需要 ...

随机推荐

  1. CentOS 8 安装mysql8.0.21

    1.使用dnf安装mysql(遇到暂停按y)dnf install @mysql 2.安装完成使用下面命令启动MySQL服务systemctl enable --now mysqld 3.查看服务是否 ...

  2. spark使用idea向yarn提交报错:Exception in thread "main" java.lang.NoClassDefFoundError: com/sun/jersey/api/client/config/ClientConfig

    解决方法: 找到1.19版本放到spark的jars目录下

  3. 【C++】《Effective C++》第二章

    第二章 构造/析构/赋值运算 条款05:了解C++默默编写并调用哪些函数 默认函数 一般情况下,编译器会为类默认合成以下函数:default构造函数.copy构造函数.non-virtual析构函数. ...

  4. Flutter 应用入门:路由管理

    路由(Route)在移动开发中通常指页面(Page),这跟web开发中单页应用的Route概念意义是相同的,Route在Android中通常指一个Activity,在iOS中指一个ViewContro ...

  5. 使用 C# 9 的records作为强类型ID - 路由和查询参数

    上一篇文章,我介绍了使用 C# 9 的record类型作为强类型id,非常简洁 public record ProductId(int Value); 但是在强类型id真正可用之前,还有一些问题需要解 ...

  6. Java开发手册之设计规约

    1.谨慎使用继承的方式来进行扩展,优先使用聚合/组合的方式来实现.说明:不得已使用继承的话,必须符合里氏代换原则,此原则说父类能够出现的地方子类一定能够出现,比如,"把钱交出来", ...

  7. 记汉化zabbix后图形界面没有任何汉字的问题

    1.安装并汉化后zabbix,所有的图形界面都没有任何字图,如下图 2.郁闷不已,去/var/www/html/zabbix/fonts目录下面查看,发现之前上传字体的文件名后缀是.ttc,猜着一般见 ...

  8. 【Docker】runtime create failed: container_linux.go:345: 解决

    ------------------------------------------------------------------------------------------------- | ...

  9. 同一份数据,Redis为什么要存两次

    前言 在 Redis 中,有一种数据类型,当在存储的时候会同时采用两种数据结构来进行分别存储,那么 Redis 为什么要这么做呢?这么做会造成同一份数据占用两倍空间吗? 五种基本类型之集合对象 Red ...

  10. CMOS 摄像头的Skipping 和 Binning 模式

    在通常的摄像头中,不同的resolution对应不同的帧率.想要提高帧率就要考虑是否需要缩小视野(FOV).若不希望视野缩小,就需要减少resolution. 常用的减少resolution的两种方式 ...