Koa基础：Koa的基础介绍

1. Koa的安装和搭建：

1.1 项目初始化：

npm init会生成配置文件package.json，用于管理项目中用到的一些安装包。

1.2 安装Koa：

npm install koa --save

1.3 编写app.js，启动服务：

简单编写一个app.js应用程序：

const koa = require('koa');
const app = new koa();
app.use(async (ctx, next)=>{
    ctx.response.body = '<h1>Hello World</h1>';
});
app.listen(3000, ()=>{
    console.log('server is running at port 3000.');
})

node app.js启动服务，访问本地 http://localhost:3000会看到Hello World。
当然便于项目的调试和服务在线运行的稳定，建议使用pm2启动Koa服务。

2. Context对象：

context成为‘上下文’，在Koa中Nodejs的原生request和response对象都封装到了context对象中，Koa应用程序的每个请求都将创建一个context，并在中间件中作为参数被引用。
下面列举一些经常用到的context属性值：

2.1 ctx.request

• ctx是context的简写，ctx.request是Koa的request对象，看一段代码，看一下GET请求数据是怎么获取和解析的：

const koa = require('koa');
const app = new koa();
app.use(async (ctx, next)=>{
    ctx.response.body = {
        url: ctx.request.url,     //获取请求的URL
        query: ctx.request.query,    //获取get请求的解析数据
        querystring: ctx.request.querystring    //获取原始get请求的字符串
    }
})

node app.js启动应用，访问http://localhost:3000/?search=koa&keywords=context，便可以看到返回的响应：

{
    "url": "/?search=koa&keywords=context",
    "query":{"search":"koa", "keywords":"context"},
    "querystring":"search=koa&keywords=context"
}

• 有GET请求数据的获取，比然有POST数据的获取和解析，原生nodejs中获取POST请求的方式比较繁琐(可自行搜索一下，其实不复杂)，这里直接引用koa-bodyparser中间件：
  npm install koa-bodyparser --save安装该中间件，下面通过一个简单的表单提交测试koa-bodyparser如何获取post数据的：

const koa = require('koa');
const bodyParser = require('koa-bodyparser');
const app = new koa();
app.use(bodyParser());
app.use(async (ctx, next)=>{
    //解析后的post数据会存储在ctx.request.body中，如果没有数据则为空对象
    ctx.body = ctx.request.body;
})
app.listen(3000, ()=>{
    console.log('server is running at port 3000');
})

后面结合router路由，通过一个form表单来测试一下效果。

2.2 ctx.response

ctx.response是Koa的response对象，其中包含了几个常用的属性：

• ctx.response.body：返回给用户的响应主体。
• ctx.response.status：设置响应状态码(如200、404、500等)。在实际开发中，除了设置一个请求的响应主体外，往往还要设置响应状态码。
• ctx.response.type：设置响应的Content-Type，显示地设置Content-Type是因为浏览器默认地Content-Type是text/plain，如果Content-Type不对会发生解析错误。如果响应内容是HTML，则设置为ctx.response.type='html'；如果响应地是png图片，则ctx.response.type='image/png'。

2.3 ctx.state

ctx.state是推荐地命名空间，用于通过中间件传递信息和前端视图。例如koa-views这些渲染Views视图层地中间件会默认把ctx.state里面地属性作为视图模板的参数传入。

2.4 ctx.cookies

ctx.cookies用于获取和设置Cookie。

ctx.cookies.get(name, [options]);    //获取Cookie
ctx.cookies.set(name, value, [options]);    //设置Cookie

其中options配置如下：

• maxAge: /ms为单位的过期时间
• signed: Cookie签名值
• expires: Cookie过期的Date
• path: Cookie路径，默认/
• domain: Cookie域名
• secure: 安全Cookie，只能使用https协议
• httpOnly: true则Cookie无法被javascript获取到
• overwrite: 布尔值，是否覆盖以前设置的同名Cookie，默认false

2.5 ctx.throw

ctx.throw用于抛出错误，把错误信息返回给用户：

app.use(async (ctx)=>{
    ctx.throw(500);   //将响应500错误
})

3. Koa中间件：

3.1 理解中间件的概念：

先来看下面这段代码：

app.use(async (ctx, next)=>{
    console.log(ctx.method, ctx.host+ctx.url);    //打印请求方法、主机名、URL
    await next();
    ctx.body = 'Hello World';
})

上述代码可以打印日志，返回'Hello World'，其实可以将其中打印日志的部分功能抽象成一个logger函数：

const logger = async function(ctx, next){
    console.log(ctx.method, ctx.host+ctx.url);
    await next();
}
app.use(logger);    //使用app.use()加载中间件
app.use(async (ctx, next) => {
    ctx.body = 'Hello World';
})

像上面抽象出来的logger函数就是中间件，通过app.use()来加载中间件。

3.2 koa-bodyparser中间件：

对于post请求的数据获取，原生nodejs使用了req对象监听data事件并将其拼接得到，比较繁琐。而koa-bodyparser可以直接把post数据解析到ctx.request.body中，先安装npm install koa-bodyparser --save，然后通过一个表单提交来测试一下：

const koa = require('koa');
const bodyParser = require('koa-bodyparser');
const app = new koa();

app.use(bodyParser());
app.use(async (ctx, next)=>{
    if(ctx.url == '/' && ctx.request.method == 'GET'){
        ctx.request.type = 'html';
        let html = `
        <h2>登录</h2>
        <form action="/" method="POST">
            <p>用户名：</p>
            <input name="name" /></br>
            <p>密码：</p>
            <input name="password" type="password" /></br>
            <button type="submit">Submit</button>
        </form>
        `
        ctx.body = html;
    }else if(ctx.url=='/' && ctx.request.method=='POST'){
        let postData = ctx.request.body;
        ctx.body = postData;
    }
})

提交表单数据后，将会看到bodyParser解析的post数据对象。

3.3 koa-router中间件：

上面登录表单的例子通过ctx.url判断路径，通过ctx.request.method判断请求方式，然而这种手动判断路由的方法，随着后面各种各样的业务增多，会严重影响代码的可读性和可维护性，借助于koa-router中间件，能清晰简单的处理各种请求路由，先安装npm install koa-router --save，具体用法如下面代码：

const koa = require('koa');
const bodyParser = require('koa-bodyparser');
const router = require('koa-router')();
const app = new koa();

app.use(bodyParser());
router.get('/', (ctx, next)=>{
    // 登陆页，省略
});

router.post('/', (ctx, next)=>{
    let postData = ctx.request.body;
    ctx.body = postData;
});
app.use(router.routes());    //加载router中间件
app.use(router.allowedMethods());    //对异常状态码的处理

上面的代码中，直接通过router.get('uri')和router.post('uri')来处理GET和POST请求的uri，不需要再进行手动判断了。

3.3.1 koa-router获取GET请求的传值：

koa-router将原生的nodejs的request封装在ctx中:

• ctx.query：返回的是格式化好的参数对象
• ctx.querystring：返回的是请求字符串

const Koa = require('koa');
const Router = require('koa-router');
const app = new Koa();
const router = new Router();
router.get('/', function (ctx, next) {
  ctx.body="Hello koa";
})
router.get('/newscontent',(ctx,next)=>{
  let url =ctx.url;
  //从request 中获取GET 请求
  let request =ctx.request;
  let req_query = request.query;
  let req_querystring = request.querystring;
  //从上下文中直接获取
  let ctx_query = ctx.query;
  let ctx_querystring = ctx.querystring;
  ctx.body={
    url,
    req_query,
    req_querystring,
    ctx_query,
    ctx_querystring
  }
});
app.use(router.routes()); //作用：启动路由
app.use(router.allowedMethods()); //作用： 当请求出错时的处理逻辑
app.listen(3000,()=>{
  console.log('starting at port 3000');
});

3.3.2 koa-router获取URI动态传值：

//请求方式http://域名/product/123
router.get('/product/:aid',async (ctx)=>{
  console.log(ctx.params); //{ aid: '123' } //获取动态路由的数据
  ctx.body='这是商品页面';
});

3.4 koa-static中间件和koa-views中间件