Lesson-1 错误处理简介

什么是错误处理？

• 编程语言或计算机硬件里的一种机制
• 处理软件或信息系统中出现的异常状况

异常状况有哪些？

• 运行时错误，都返回500（语法正确，但是运行时候发生错误）
• 逻辑错误，如找不到（404）、先决条件失败（412）、无法处理的实体（参数格式不对，422）等

为什么要用错误处理？

• 防止程序挂掉
• 告诉用户错误信息
• 便于开发者调试

---

Lesson-2 Koa 自带的错误处理

操作步骤

• 制造 404、412、500 三种错误
• 了解 Koa 自带的错误处理做了什么

制造 404、412、500 三种错误

• 请求地址http://localhost:3000/users123，状态返回404
• 请求地址http://localhost:3000/users/1，状态返回412，因为默认db只有一条数据

findById (ctx) {
    if (+ctx.params.id >= db.length) {
        // ctx.body = '先决条件失败：id 大于数组条件长度';
        // ctx.status = 412;
        // return;

        ctx.throw(412, '先决条件失败：id 大于数组条件长度'); // 等价于上面三句话
    }

    ctx.body = db[+ctx.params.id];
}

• 请求地址http://localhost:3000/users，状态返回500，因为语法正确，但是发生了程序错误

find (ctx) {
    a.b; // a 未定义，undefined去获取属性b
    ctx.body = db;
}

---

Lesson-3 自己编写错误处理中间件

操作步骤

• 自己编写错误处理中间件
• 制造 404、412、500 三种错误

自定义错误处理中间件

该中间件只需要写在所有中间件前面，然后捕获next中间件，利用冒泡便可以捕获到所有的异常。捕获异常跟javascript一样，使用try/catch进行捕获处理。根据RESTful风格，我们使用 json 将异常吐出来。这里面我们怎么知道err有什么属性可以获取？通过前面打断点的方式，来查看捕获到的 err 存在什么字段信息，便可以直接制造一个我们需要的异常报错信息了

// index.js
const Koa = require('koa');
const bodyparser = require('koa-bodyparser');
const app = new Koa(); // 实例化koa
const routes = require('./routes');

// 错误处理中间件
app.use(async (ctx, next) => {
    try {
        await next();
    } catch (err) {
        // 如果没捕获到状态码，证明是服务器内部错误
        ctx.status = err.status || err.statusCode || 500;
        ctx.body = {
            message: err.message
        }
    }
});

// 启动路由
app.use(bodyparser());
routes(app);

app.listen(3000, () => {
    console.log(`start server...`);
});

验证的截图这里就放了，有一点需要说的是，404是不会进入异常捕获里面的，如果真的需要对404进行捕获，只能通过获取ctx.status === 404来吐出错误信息了，比如像下面这样

// 错误处理中间件
app.use(async (ctx, next) => {
    try {
        await next();

        // 捕获不到异常，但状态码为404
        if (ctx.status === 404) {
            ctx.body = {
                message: '页面找不到'
            }
        }
    } catch (err) {
        // 如果没捕获到状态码，证明是服务器内部错误
        ctx.status = err.status || err.statusCode || 500;
        ctx.body = {
            message: err.message
        }
    }
});

---

Lesson-4 使用 koa-json-error 进行错误处理

操作步骤

• 安装 koa-json-error
• 使用 koa-json-error 的默认配置处理错误
• 修改配置使其在生产环境下禁用错误堆栈的返回

安装 koa-json-error

执行 npm i koa-json-error -S 进行安装，这个插件 npm 上的描述是显示错误处理堆栈，有兴趣的同学自己阅读一下 koa-json-error NPM

使用 koa-json-error 的默认配置处理错误

声明并加入全局当中

const error = require('koa-json-error');
app.use(error());

这个时候可以看到，不仅出现了我们定义的错误message，还把错误名称错误类型已经堆栈全部都列出来了

使用koa-json-error后的错误处理

然而在生成环境中，把错误堆栈也返回出来实际是不安全的，所以我们需要更改默认配置，使其在生产环境中不暴露堆栈信息

修改配置使其在生产环境下禁用错误堆栈的返回

由于我们需要在 package.json 中，命令行语句里设置环境变量，所以这里需要安装一个插件，来让 window 和 OS X 都认识命令行当中的 NODE_ENV=production 语句，否则 windows 需要额外处理
执行 npm i cross-env -S 安装插件
package.js中新增一条启动命令 "build": "cross-env NODE_ENV=production node app"
安装完成后，我们需要修改koa-json-error的配置

// index.js
app.use(error({
    // 后置的修改返回格式
    postFormat: (err, {stack, ...rest}) => process.env.NODE_ENV === 'production' ? rest : {stack, ...rest}
}));

防止有的同学es6不熟悉，这句看着有点懵，我写个es5的

app.use(error({
    // postFormat接受一个函数，第一个为原始错误，第二个为新的格式化错误
    postFormat: function (err, obj) {
        if (process.env.NODE_ENV === 'production') {
            delete obj.stack
            return obj;
        }
        return obj;
    }
}));

执行 npm start，启动开发环境服务器

开发环境报错信息

执行 npm run build，启动生产环境服务器

生产环境报错信息

---

Lesson-5 使用 koa-parameter 校验参数

操作步骤

• 安装 koa-parameter
• 使用 koa-parameter 校验参数
• 制造 422 错误来测试校验结果

安装 koa-parameter

执行 npm i koa-parameter -S 安装插件，并全局加入

// index.js
const parameter = require('koa-parameter');
app.use(parameter(app));

使用 koa-parameter 校验参数

其实在搜索这个插件的时候，发现这个插件github上star 25…而且还不在官方推荐里面，但只是想验证功能，能凑合用先就行，有兴趣的同学可以自己看一下 koa社区，挑选更加合适的插件

// controller/users.js
const db = [{name: '李雷'}];

class UsersCtl {
    find (ctx) {
        a.b;
        ctx.body = db;
    }

    findById (ctx) {
        if (+ctx.params.id >= db.length) {
            ctx.throw(412, '先决条件失败：id 大于数组条件长度'); // 等价于上面三句话
        }

        ctx.body = db[+ctx.params.id];
    }

    create (ctx) {
        ctx.verifyParams({
            name: {
                type: 'string',
                required: true
            },
            age: {
                type: 'number',
                required: false
            }
        });

        db.push(ctx.request.body);
        ctx.body = ctx.request.body;
    }

    update (ctx) {
        if (+ctx.params.id >= db.length) {
            ctx.throw(412, '先决条件失败：id 大于数组条件长度'); // 等价于上面三句话
        }

        ctx.verifyParams({
            name: {
                type: 'string',
                required: true
            },
            age: {
                type: 'number',
                required: false
            }
        });

        db[+ctx.params.id] = ctx.request.body;
        ctx.body = ctx.request.body;
    }

    delete (ctx) {
        if (+ctx.params.id >= db.length) {
            ctx.throw(412, '先决条件失败：id 大于数组条件长度'); // 等价于上面三句话
        }

        db.splice(+ctx.params.id, 1);
        ctx.status = 204; // 没有内容，但是成功了
    }
}

module.exports = new UsersCtl();

上面涉及ctx.request.body的都加上了相同的验证，如果验证失败，将返回422与详细的错误信息

制造 422 错误来测试校验结果

错误的请求体

上图，age为非必传，类型为数值类型，但传了字符串类型，所以出现验证失败，图中也可以看到相关的错误参数，错误信息，方便开发者进行错误处理