koa文档笔记

请求

get

ctx.request.query       // 查询对象
ctx.request.querystring // 查询字符串
ctx.query               // 查询对象
ctx.querystring         // 查询字符串

post

• 查询对象无法直接通过ctx获得，需要对ctx.req进行解析，监听data和end事件进行查询字符串的拼装

koa-bodyparser

ctx.request.body        // 查询对象
app.use(bodyParser())   // 使用bodyParser

路由

原生路由

• 通过解析url，获取静态文件路径

• 通过fs.readFile(文件路径，"binary"，callback)获得解析的页面结构

• 赋值ctx.body

koa-router

var router = new Router({prefix:"顶层路径"})    // 声明路由
router.get(路径, callback)                      // 监听访问
router.use(父级路径，router.routes()，router.allowedMethods())    // 装载子路由
app.use(router.routes())                        // 注册应用路由
app.use(router.allowedMethods());               // 限制请求类型

cookie

设置

ctx.cookies.set(键","值"{
    domain:'127.0.0.1',             // 所在域名
    path:'/index',                  // 所在路径
    maxAge:1000*60*60*24,           // 有效时长
    expires:new Date('2018-12-31'), // 过期时间
    httpOnly:false,                 // 是否只用于http请求中获取
    overwrite:false                 // 是否允许重写
})

获取

ctx.cookies.get("键")

视图模版

koa-views

const views = require('koa-views')
const path = require('path')
app.use(views(path.join(__dirname, './view'), { extension: 'ejs'}))

静态资源

koa-static

const static = require('koa-static')
app.use(static(path.join(__dirname, 资源路径)));

Application

设置

app.listen()        // 监听端口号
app.callback()      // 返回适用于http.createServer()回调函数来处理请求
app.use()           // 载入中间件
app.keys=           // 设置签名的Cookie密钥
app.context         // ctx的原型

错误处理

• 执行自定义错误处理逻辑，可以添加一个error事件侦听器

app.on('error',(err, ctx)=> {
    log.error('server error', err)
})

Context

属性/方法	描述
ctx.req	Node的request对象
ctx.res	Node的response对象
ctx.request	koa的request对象
ctx.response	koa的response对象
ctx.state	推荐的命名空间
ctx.app	应用程序实例引用
ctx.cookies.get()	获取cookie
ctx.cookies.set()	设置cookie
ctx.throw()	抛出错误
ctx.assert()	断言测试函数
ctx.respond	是否让koa处理response对象

Request

属性/方法	描述
request.header	请求标头对象
request.headers	请求标头对象（header别名）
request.method	请求方法类型
request.length	请求的Content-Length
request.url	请求的url
request.originalUrl	请求的源url
request.origin	获取URL的来源（包括protocol和host）
request.href	获取完整的请求URL（包括protocol，host和url）
request.path	获取请求路径名
request.querystring	根据?获取原始查询字符串
request.search	使用?获取原始查询字符串
request.host	获取当前主机
request.hostname	存在时获取主机名
request.URL	获取WHATWG解析的URL对象
request.type	获取请求Content-Type不含参数"charset"
request.charse	在存在时获取请求字符集
request.query	获取解析的查询字符串对象
request.fresh	检查请求缓存是否“新鲜”，也就是内容没有改变
request.stale	与request.fresh相反
request.protocol	返回请求协议
request.secure	通过ctx.protocol=="https"来检查请求是否通过TLS发出
request.ip	请求远程地址
request.ips	当X-Forwarded-For存在并且app.proxy被启用时，这些ips的数组被返回
request.subdomains	将子域返回为数组
request.is(types...)	检查传入请求是否包含Content-Type头字段
request.accepts(types...)	检查给定的types是否可以接受
request.acceptsEncodings(encodings)	检查encodings是否可以接受
request.acceptsCharsets(charsets)	检查charsets是否可以接受
request.acceptsLanguages(langs)	检查langs是否可以接受
request.idempotent	检查请求是否是幂等的
request.socket	返回请求套接字
request.get(field)	返回请求标头

Response

属性/方法	描述
response.header	响应标头对象
response.headers	响应标头对象（header别名）
response.socket	请求套接字
response.status	获取响应状态
response.message	获取响应的状态消息
response.length	响应的Content-Length
response.body	响应主体
response.get(field)	不区分大小写获取响应标头字段值field
response.set(field, value)	设置响应标头field到value
response.append(field, value)	用值val附加额外的标头field
response.set(fields)	用一个对象设置多个响应标头fields
response.remove(field)	删除标头field
response.type	获取响应Content-Type不含参数"charset"
response.is(types...)	非常类似ctx.request.is()检查响应类型是否是所提供的类型之一
response.redirect(url, [alt])	执行重定向
response.attachment([filename])	将Content-Disposition设置为附件以指示客户端提示下载
response.headerSent	检查是否已经发送了一个响应头
response.lastModified	将Last-Modified标头返回为Date, 如果存在
response.etag	设置包含包裹的ETag响应
response.vary(field)	在field上变化
response.flushHeaders()	刷新任何设置的标头，并开始主体