如何用Eggjs从零开始开发一个项目（3）

码农天地 - 2020-12-27 01:33:32

---

上一篇中我们编写了用户注册登录、登录的代码，学习了如何进行用户的认证（JWT），如何安全地存储用的密码（hash）。这一篇我们有以下2个任务：

获取token中的数据；通过model来同步数据库。获取token中的数据

用户登录的时候我们已经用户的一些基本信息加密存储到token中，通过路由配置我们能简单的去控制哪些接口需要登录，哪些接口不需要登录，但是如果再细化到用户或者用户角色，只是从路由层面就难以控制了，我们需要拿到用户信息，并将用户信息存储在session中，方便我们随时取用。那要怎么做呢？这里我们需要编写一个中间件来实现这个功能。代码如下：

// app/middleware/eggJwt
module.exports = options => {
    return async function jwt(ctx, next) {
        const token = ctx.request.header.authorization;
        if (token) {
            // 这里有个坑，前端一般传过来是Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoieGl...
            // 但是解码时不需要Bearer，所以需要手动处理一下
            const tokenStr = token.split(' ')[1];
            try {
                // 解码token并存储到session中
                const decode = ctx.app.jwt.verify(tokenStr, options.secret);
                ctx.session.user = decode;
                await next();
            } catch (error) {
                ctx.status = 500;
                ctx.body = {
                    message: error.message
                };
                return;
            }
        } else {
            ctx.status = 401;
            ctx.body = {
                message: '用户未登录'
            };
            return;
        }
    };
};

这里说明一下eggjs的插件机制，如果你在config.default.js中配置：

config.middleware = ['eggJwt'];

那么，这个插件将作用于所有的路由，除非有特殊配置，但是这里我们不需要，所以不加这一行代码。我们按需配置：

// app/router.js
module.exports = app => {
    const { router, controller } = app;
    const jwt = app.middleware.eggJwt(app.config.jwt);
    router.get('/', controller.home.index);
    router.post('/createUser', jwt, controller.user.createUser);
    router.get('/getUsers', jwt, controller.user.getUsers);
    router.post('/register', controller.user.register);
    router.post('/login', controller.user.login);
};

我们手动引入后按需配置即可。

这个时候我们去访问配置了jwt的接口，就会执行插件，解析token，并将解析结果存储到session里。我们修改一下user controller的代码试一下：

async getUsers() {
    // 打印session
    console.log(this.ctx.session.user, '===========');
    const users = await this.ctx.model.User.findAll();
    this.ctx.body = {
        code: 200,
        data: users
    };
}

配置好token后请求localhost:7001/getUsers，数据能正常返回，同时控制台打印出了：

{ name: 'xiaoming', iat: 1609055716, exp: 1609062916 } ===========

可以看到这时我们就拿到了token里存储的数据。

通过model来同步数据库

按照我们现在的代码，如果我们需要调整model中的字段，我们需要修改model文件，然后再写脚本同步修改数据库中的字段，这样太麻烦了。幸好，Sequelize提供了一个方法让我们可以根据model去同步数据库里的字段：

User.sync() - 如果表不存在,则创建该表(如果已经存在,则不执行任何操作)User.sync({ force: true }) - 将创建表,如果表已经存在,则将其首先删除User.sync({ alter: true }) - 这将检查数据库中表的当前状态(它具有哪些列,它们的数据类型等),然后在表中进行必要的更改以使其与模型匹配.

注意我们这里只能用User.sync({ alter: true })，那么要在什么时候去执行呢？我们想在每次服务启动时去同步数据库字段，同时eggjs也提供了生命周期供我们使用：

// app.js
class AppBootHook {
    constructor(app) {
        this.app = app;
    }

    configWillLoad() {
    // 此时 config 文件已经被读取并合并，但是还并未生效
    // 这是应用层修改配置的最后时机
    // 注意：此函数只支持同步调用
    }

    async didLoad() {
    // 所有的配置已经加载完毕
    // 可以用来加载应用自定义的文件，启动自定义的服务

    }

    async willReady() {
    // 所有的插件都已启动完毕，但是应用整体还未 ready
    // 可以做一些数据初始化等操作，这些操作成功才会启动应用
        // 根据model同步数据库
        await this.app.model.sync({ alter: true });
    }

    async didReady() {
    // 应用已经启动完毕
    }

    async serverDidReady() {
    // http / https server 已启动，开始接受外部请求
    // 此时可以从 app.server 拿到 server 的实例
    }
}

module.exports = AppBootHook;

这时，我们在user model中新增一个字段：nickname: STRING(10)，然后重启一下服务，打开数据库看看user表，果然多了一个nickname的列。这个功能极大地方便了我们去同步model与数据库字段，但是操作的时候也要小心，不要误删字段。

这一篇内容不多，但是都是很实用的功能，下一篇我们将通过Sequelize来实现表的关联查询。

Tags 标签