深入浅析nodejs里的koa-static中间件

本篇文章给大家介绍一下node里的静态文件中间件koa-static。有一定的参考价值，有需要的朋友可以参考一下，希望对大家有所帮助。

相关推荐：《nodejs 教程》

细说koa-static使用

在app.js里，若想指定当前目录为托管目录，我们一般会这样做：

const static=require('koa-static')
const Koa=require('koa')
const app=new Koa()

app.use(static('.'))
app.listen(8081)

koa-static 就是koa（node框架）中最常用的、较为成熟的 静态web托管服务中间件 ，在koa中常用于比如外链静态资源（如CSS文件）：

//下载
npm install koa-static --save

//引入
const server=require('koa-static')

//使用
app.use(server('static'))//或：app.use(server(__dirname+'/static'))

总之，server里面一定是静态模板（相对）路径

然后我们就可以这样使用static目录下的css文件夹中的xxx.css文件了：

<link rel="stylesheet" href="css/xxx.css" />

这么简单？那它的原理是啥？

根据文件后缀名设置请求头 「Content-Type」值，使之与浏览器渲染相匹配！

就拿上面说的static说吧：

• 寻找 static/css/xxx.css 是否存在

• （若存在）设置 Content-Type: text/css;charset=utf-8;

• 通过response返回给浏览器

前面说了koa-static作用是 ☞静态文件托管☜ ，那肯定不只是对于CSS、JavaScript这类资源文件。

事实上，对于图片，koa-static同样可以用于设置 图片缓存 ！就像这样

const server=require('koa-static')
const path=require('path')   //path模块：设置路径信息

const staticPath=path.resolve(__dirname,'static')
const staticServer=server(staticPath,{
	setHeadears:(res,path,stats)=>{
		if(path.indexOf(/[jpg|png|gif|jpeg]/)>-1){
			res.setHeader('Cache-Control',['private','max-age=60'])
		}
	}
})
app.use(staticServer);

——如果对应路径中是jpg/GIF/png/jpeg格式的图片，那么就将其缓存60s。

---

我们都知道，在express（node框架）中有一个关于静态服务的“便捷方式”：

app.use('/teacher',express.static('/public'))

它可以指定静态服务的“请求前缀” —— 就是指定加载相对于哪个url的静态资源。

很明显，这是非常实用的。我们突然想到，本文上面我们所说的koa-static都是相对于“全局 ”作用的？

如何在koa中实现这个功能呢？koa为开发者提供了另一个（辅助）模块 —— koa-mount

const Koa=require('koa')
const server=require('koa-static')
const mount=require('koa-mount')

const app=new Koa()
app.use(mount('/teacher',server('/public')))

koa-mount是一个将中间件挂载到指定路径的Koa中间件。它可以挂载任意Koa中间件！
前面说过，koa-static是一个中间件，所以koa-mount可以和koa-static结合，以实现和express一样的静态服务请求前缀的功能。

---

static原理探究

学习了上面神奇的使用方式，你有没有想过它是怎么实现的？
通过 npm info koa-static ，你会发现 koa-static 依赖两个模块，分别是 debug 和 koa-send 。
找到 koa-static 源码的index文件，其核心实现如下：

const send = require('koa-send');
//...
function serve (root, opts) {
	//...
	return async function serve (ctx, next) {
		await next()
		if (ctx.method !== 'HEAD' && ctx.method !== 'GET') return
		if (ctx.body !== null && ctx.status !== 404) return // eslint-disable-line
		try {
			await send(ctx, ctx.path, opts)
		}catch (err) {
			if (err.status !== 404) {
				throw err
			}
		}
	}
}

而经过这段代码，我们发现其中实现核心是 send() 方法，而这是由模块 koa-send 提供的！

找到koa-send的源码，发现其核心实现原理也是很简单的：

if (!ctx.type) ctx.type = type(path, encodingExt)
ctx.body = fs.createReadStream(path)

其中type方法是根据文件后缀来设置 Content-Type ！很实用，但是我们这里更要关注的是另一个比较有趣的事 —— koa-send的原理：

• 设置 Content-Type ，可通过文件后缀进行设置；

• 以Stream形式为ctx.body赋值

为什么说它有趣呢？
除了它竟然也是以设置content-type为目标外，stream流的方式一直受到业界大拿们的推崇：因为它比 fs.readFileSync 更高效！

让我们拿下面这段代码和上面 koa-send 的源码作比较：

app.use(function(ctx){
	const fs=require('fs')
	const result=fs.readFileSync('xxx')
	ctx.type=type(result, encodingExt)
	ctx.body=result
})

---

Koa回顾

其实在koa中，ctx.body的工作原理其实就和本文所说 koa-static、koa-send 中间件相似：根据赋值类型来进行不同 Content-type 的处理

• 根据body类型设置对应的Content-type

• 根据Content-type调用res.write或者res.end，将数据写入浏览器

关于Content-type值：
字符串——又分为“text/html”和“text/plain”两种类型（不一样）；
Buffer / Stream类型；
若不是以上任何类型，那么应该就是JSON对象了
（源码中是通过typeof来判定其类型，这种技巧非常实用！

更多编程相关知识，请访问：编程视频！！

Atas ialah kandungan terperinci 深入浅析nodejs里的koa-static中间件. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!