全栈项目|小书架|服务器开发-Koa全局路由实现
什么是路由
路由就是具体的访问路径,指向特定的功能模块。一个
api
接口是由ip(域名)+端口号
+路径组成,例如 :https://www.npmjs.com/package/koa-router
就是一个路由,指向了koa-router
的npm
页面。
为什么需要 koa-router 路由
当然不需要koa-router
也能实现路由功能,通过ctx.request.path
去指定路径实现。例子如下:
const koa = require('koa2')
const app = new koa()
app.use(async (ctx, next) => {
if (ctx.request.path === '/') { // 首页
ctx.response.status = 200
ctx.response.body = 'index'
} else if (ctx.request.path === '/list') { // 列表页
ctx.response.status = 200
ctx.response.body = 'list'
} else {
ctx.throw(404, 'Not found') // 404
}
await next()
})
app.listen(3000)
以上代码只是实现两个接口,就写了不少代码,而写是多层的判断代码,可读性已经很差了,这时候怎么办?
是不是可以将以上代码抽取出去,通过中间件的方式去实现。
结果是可以的,koa-router
就是这样做的。使用koa-router
实现的例子如下:
- app.js 入口
- urls/home.js home 页面的路由
app.js
的代码如下
// 路由模块使用前需要先安装和实例化
const Router = require('koa-router')
const router = new Router()
// 首页
app.use(async (ctx, next) => {
if (ctx.request.path === '/') {
ctx.response.status = 200
ctx.response.body = 'index'
}
await next()
})
// 其他页面通过 router 加载
let urls = fs.readdirSync(__dirname + '/urls')
urls.forEach((element) => {
let module = require(__dirname + '/urls/' + element)
/*
urls 下面的每个文件负责一个特定的功能,分开管理
通过 fs.readdirSync 读取 urls 目录下的所有文件名,挂载到 router 上面
*/
router.use('/' + element.replace('.js', ''), module.routes(), module.allowedMethods())
})
app.use(router.routes())
urls/home.js
的代码如下
const Router = require('koa-router')
const home = new Router()
// /home
home.get('/', async (ctx, next) => {
ctx.response.status = 200
ctx.response.body = 'home'
await next()
})
// home/list
home.get('/list', async (ctx, next) => {
ctx.response.status = 200
ctx.response.body = 'home-list'
await next()
})
module.exports = home
通过以上代码基本已经实现了全局路由的功能
了,剩下得就是在urls
包下创建对应的文件即可,参考home.js
即可。
但是这里的代码还是不够完美,app.js
作为入口文件,这里的代码还是有点多了;而且首页和home
的路由是分开来实现的。再而且urls
路径是固定的,后续文件夹名称或者位置改变都会出现问题。
那么如何实现呢?
这里介绍一种思路:
- 将
app.js
中的代码抽取出来,让app.js
尽量简单 - 将首页和其他页面都在全局路由中实现
优雅的全局路由实现
通过npm
引入require-directory
require-directory npm
包的作用是:
递归地遍历指定目录,对每个文件进行require()
这里也是利用了这个包去实现的。具体实现如下:
- 在
core
目录下创建InitManager.js
const requireDirectory = require('require-directory')
const Router = require('koa-router')
/**
* 加载全局路由
*/
static initLoadRouters(app){
// 加载工作目录下的 app/api 下的路径
const apiDirectory = `${process.cwd()}/app/api`
// 参数:第一个参数固定参数module
// 第二个参数要加载的模块的文件路径
// 第三个参数:每次加载一个参数执行的函数
requireDirectory(module, apiDirectory, {
visit: whenLoadModule
})
function whenLoadModule(obj) {
if(obj instanceof Router ){
app.use(obj.routes())
}
}
}
module.exports = InitManager
从上面的实现方式可以看出这里使用了process.cwd()
获取路径,而原有的代码中是通过__dirname
去获取路径,那么二者有什么区别呢?
NodeJs
中process.cwd()
与__dirname
的区别
process.cwd()
是当前执行node
命令时候的文件夹地址 ——工作目录,保证了文件在不同的目录下执行时,路径始终不变
__dirname
是被执行的js
文件的地址 ——文件所在目录
- 在
app.js
中加载这个方法即可。
const app = new Koa()
InitManager.initLoadRouters(app)
- 在
app/api
下创建相应的接口文件即可,如home.js
咨询请加微信:轻撩即可。
全栈项目|小书架|服务器开发-Koa全局路由实现的更多相关文章
- 全栈项目|小书架|服务器开发-Koa2 全局异常处理
什么是异常 做开发的基本都知道异常,像Android开发中常见的ANR异常.空指针异常,服务器开发中经常遇到的异常404,500异常,还有一些其他常见的异常,具体可见HTTP状态码. 基本上这些异常可 ...
- 全栈项目|小书架|服务器开发-NodeJS 使用 JWT 实现登录认证
通过这篇 全栈项目|小书架|服务器开发-JWT 详解 文章我们对JWT有了深入的了解,那么接下来介绍JWT如何在项目中使用. 安装 $ npm install jsonwebtoken 生成 Toke ...
- 全栈项目|小书架|服务器开发-NodeJS 项目分包
唠嗑 参考的是慕课网七月老师的课程,七月的课质量真的挺高的,推荐一波.这次的小书架项目源码不会全部公开,因为用了七月老师课程的绝大部分代码.虽然代码不全,但是只要思路看得懂,代码实现就很简单了. 小书 ...
- 全栈项目|小书架|服务器开发-JWT 详解
JWT 官方简介:Introduction to JSON Web Tokens 文章基本是官网内容的翻译,英文不错的同学可点击上面的链接直接看英文文档. 什么是 JWT JWT全称是JSON Web ...
- 全栈项目|小书架|服务器开发-Koa2中间件机制洋葱模型了解一下
KOA2 是什么? Koa是一个新的 web 框架,由 Express 幕后的原班人马打造, 致力于成为 web 应用和 API 开发领域中的一个更小.更富有表现力.更健壮的基石. 通过利用 asyn ...
- 全栈项目|小书架|服务器开发-Koa2 连接MySQL数据库(Navicat+XAMPP)
为什么使用数据库 为什么需要数据库?-知乎 相比与文件系统,数据库具有以下优势: 高效率:查找效率高 高可用:可数据库共享 安全性强:数据不能随意修改 选择哪个数据库 数据库可以分为关系型数据库和非关 ...
- 全栈项目|小书架|服务器开发-Koa2 参数校验处理
为什么需要做参数校验 在开发中,无论是App开发还是服务器接口开发, 我们无法去预测用户传入的数据,因此参数(数据)校验是开发中不可或缺的一环. 例如像App的注册登录表单提交页面,就要做好多层的判断 ...
- 全栈项目|小书架|服务器开发-NodeJS 中使用 Sequelize 操作 MySQL数据库
安装 官网:https://sequelize.org/v5/manual/getting-started.html 安装sequelize及数据库连接驱动 npm install --save se ...
- 全栈项目|小书架|服务器端-NodeJS+Koa2实现首页图书列表接口
通过上篇文章 全栈项目|小书架|微信小程序-首页水平轮播实现 我们实现了前端(小程序)效果图的展示,这篇文章来介绍服务器端的实现. 首页书籍信息 先来回顾一下首页书籍都有哪些信息: 从下面的图片可以看 ...
随机推荐
- JVM 类加载器深入解析以及重要特性剖析
1.类加载流程图 从磁盘加载到销毁的完整过程. 2.类加载流程图2 1.加载: 就是把二进制形式的java类型读入java虚拟机中 2.连接: 验证.准备.解析. 连接就是将已经读入到内存的类的二进制 ...
- 微信小程序带cookie的request请求代码封装(小程序使用session)
微信小程序带cookie的request请求可,以使服务端知道是同一个客户端请求. session_id会不变,从而很好的使用服务端的session. 写一个工具函数,直接导入使用即可,接口同 wx. ...
- fingerprint for the ECDSA key
验证 fingerprint for the ECDSA key ssh-keygen -t ecdsa -f ssh_host_ecdsa_key 在B上ssh A ,得到A的fingerpr ...
- debian9 ps 命令不能用
# cat > /etc/apt/sources.list << EOF> deb http://mirrors.aliyun.com/debian/ stretch main ...
- 图像处理代码举例(C++、MATLAB、OpenCV)
一.C中用数组存图像信息,下标索引: pbTag[y*newWidth+x] 见:https://www.cnblogs.com/wxl845235800/p/11149853.html HRESUL ...
- Python3基础 函数 返回值 利用元组返回多个值
Python : 3.7.3 OS : Ubuntu 18.04.2 LTS IDE : pycharm-community-2019.1.3 ...
- 关于TCP粘包和拆包的终极解答
关于TCP粘包和拆包的终极解答 程序员行业有一些奇怪的错误的观点(误解),这些误解非常之流行,而且持有这些错误观点的人经常言之凿凿,打死也不相信自己有错,实在让人啼笑皆非.究其原因,还是因为这些错误观 ...
- C++11使用make_shared的优势和劣势
Why Make_shared ? C++11 中引入了智能指针, 同时还有一个模板函数 std::make_shared 可以返回一个指定类型的 std::shared_ptr, 那与 std::s ...
- 【Python】使用POST方式抓取有道翻译结果
1.安装requests库 2.打开有道翻译,按下F12,进入开发者模式,输入我爱青青,点击Network,再点击XHR 3.撰写爬虫 import requestsimport json # 使用有 ...
- 008-SpringBoot发布WAR启动报错:Error assembling WAR: webxml attribute is required
一.Spring Boot发布war包流程: 1.修改web model的pom.xml <packaging>war</packaging> SpringBoot默认发布的都 ...