Egg.js实战

关于Egg.js介绍 可以参考egg - 为企业级框架和应用而生

概览

  • 开始 -> 登录 -> 鉴权 -> Redis -> 记住

  • 哈希 -> 数据库 -> ORM -> 迁移 -> 关联

  • 小结 -> 特点 -> 已解决 -> 待验证 -> 发布

开始

curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.11/install.sh | bash

nvm install --lts

npm i -g cnpm --registry=https://registry.npm.taobao.org

更多参考nvm官网

cnpm i -g egg-init

egg-init --type=simple saas-admin-server

cd saas-admin-server && cnpm i

cnpm run dev # localhost:7001
  • 测试
curl localhost:7001 # hi, egg

更多参考eggjs快速入门

登录

vim app/router.js

'use strict';

module.exports = app => {
  const { router, controller } = app;
  router.get('/', controller.home.index);
  router.post('/login', controller.auth.login);
};

vim app/controller/auth.js

'use strict';

const Controller = require('egg').Controller;

class AuthController extends Controller {
  async login() {
    const ctx = this.ctx;
    ctx.session.user = 6;
    ctx.body = { message: '登录成功' };
    ctx.status = 200;
  }
}

module.exports = AuthController;

vim config/config.default.js

// 省略了未修改的代码
  config.session = {
    key: 'EGG_SESS',
    maxAge: 24 * 3600 * 1000, // 1 天
    httpOnly: true,
    encrypt: true,
  };

  config.security = {
    csrf: {
      enable: false,
    },
  };
// 省略了未修改的代码
  • 测试
curl -c cookies -X POST localhost:7001/login # {"message":"登录成功"}

鉴权

vim app/router.js

'use strict';

module.exports = app => {
  const { router, controller } = app;
  router.get('/', controller.home.index);
  router.post('/login', controller.auth.login);
  router.get('/user', controller.user.index);
};

vim app/controller/user.js

'use strict';

const Controller = require('egg').Controller;

class UserController extends Controller {
  async index() {
    this.ctx.body = 'hi, user';
  }
}

module.exports = UserController;
  • 测试
curl localhost:7001/user # hi, user

mkdir app/middleware

vim app/middleware/auth.js

'use strict';

module.exports = () => {
  return async function(ctx, next) {
    if (!ctx.session.user) {
      ctx.status = 403;
      ctx.body = 'forbidden!';
      return;
    }
    await next();
  };
};

vim app/router.js

'use strict';

module.exports = app => {
  const { router, controller, middleware } = app;
  const auth = middleware.auth();

  router.get('/', controller.home.index);
  router.post('/login', controller.auth.login);
  router.get('/user', auth, controller.user.index);
};
  • 测试
curl localhost:7001/user # forbidden!

curl -b cookies localhost:7001/user # hi, user

Redis

docker run --name redis-egg -p 6379:6379 -d redis

cnpm i --save egg-session-redis egg-redis

vim config/config.default.js

// 省略了未修改的代码
  config.redis = {
    client: {
      host: process.env.EGG_REDIS_HOST || '127.0.0.1',
      port: process.env.EGG_REDIS_PORT || 6379,
      password: process.env.EGG_REDIS_PASSWORD || '',
      db: process.env.EGG_REDIS_DB || '0',
    },
  };
// 省略了未修改的代码

vim config/plugin.js

'use strict';

// had enabled by egg
// exports.static = true;

exports.redis = {
  enable: true,
  package: 'egg-redis',
};

exports.sessionRedis = {
  enable: true,
  package: 'egg-session-redis',
};

更多参考egg-session-redis

  • 测试
curl -b cookies localhost:7001/user # forbidden!

curl -c cookies -X POST localhost:7001/login # {"message":"登录成功"}

curl -b cookies localhost:7001/user # hi, user

记住

vim app/controller/auth.js

'use strict';

const ms = require('ms');
const Controller = require('egg').Controller;

class AuthController extends Controller {
  async login() {
    const ctx = this.ctx;
    ctx.session.user = 6;
    ctx.session.maxAge = ms('30d');
    ctx.body = { message: '登录成功' };
    ctx.status = 200;
  }
}

module.exports = AuthController;

基于Remember me Token与Session实现的"记住我"的区别 详细参考Why remember me token?

哈希

cnpm i --save node-php-password

vim app/controller/auth.js

'use strict';

const ms = require('ms');
const crypto = require('crypto');
const Password = require('node-php-password');
const Controller = require('egg').Controller;

class AuthController extends Controller {
  async login() {
    const password = '18020125636';
    const plain = password + 'Well,you-feel_invincible';
    const hash = crypto.createHash('sha256').update(plain).digest('hex');
    const result = Password.verify(hash, '$2y$10$aKQnebsmTLrsz2rJzjbiyOp3ddCr8N2rcwW56dQlwIXCfqeWxw9pm');
    if (result) {
      this.ctx.session.user = 6;
      this.ctx.session.maxAge = ms('30d');
      this.ctx.body = { message: '登录成功' };
      this.ctx.status = 200;
    } else {
      this.ctx.session.user = null;
      this.ctx.body = { message: '登录失败' };
      this.ctx.status = 401;
    }
  }
}

module.exports = AuthController;
  • 测试
curl -c cookies -X POST localhost:7001/login # {"message":"登录成功"}

数据库

docker run --name mysql-egg -p 3306:3306 -e MYSQL_ROOT_PASSWORD=123456 -d mysql:5.7.17

docker exec -i mysql-egg mysql -uroot -p123456  <<< "CREATE DATABASE IF NOT EXISTS zhg DEFAULT CHARSET utf8 COLLATE utf8_general_ci;"

docker exec -i mysql-egg mysql -uroot -p123456 zhg < ./test/users.sql

ORM

cnpm i --save egg-sequelize mysql2

vim config/config.default.js

// 省略了未修改的代码
  config.sequelize = {
    dialect: 'mysql',
    database: 'zhg',
    host: '127.0.0.1',
    port: '3306',
    username: 'root',
    password: '123456',
  };
// 省略了未修改的代码

vim config/plugin.js

// 省略了未修改的代码
exports.sequelize = {
  enable: true,
  package: 'egg-sequelize',
};

更多参考egg-sequelize

mkdir app/model

vim app/model/user.js

'use strict';

module.exports = app => {
  const { BIGINT, TINYINT, DATE, STRING } = app.Sequelize;

  const User = app.model.define('users', {
    id: {
      type: BIGINT.UNSIGNED,
      primaryKey: true,
      autoIncrement: true,
    },
    created_at: DATE,
    updated_at: DATE,
    nick_name: STRING(50),
    unique_name: STRING(16),
    password: STRING(128),
    is_active: TINYINT,
  }, {
    tableName: 'users',
    createdAt: 'created_at',
    updatedAt: 'updated_at',
    indexes: [
      {
        unique: true,
        fields: [ 'unique_name' ],
      },
    ],
  });

  return User;
};

更多参考Model definition 或 Model definition - 模型定义

vim app/controller/user.js

'use strict';

const Controller = require('egg').Controller;

class UserController extends Controller {
  async index() {
    const id = this.ctx.session.user;
    const user = await this.ctx.model.User.findById(id);
    this.ctx.body = 'hi, ' + user.nick_name;
  }
}

module.exports = UserController;
  • 测试
curl -b cookies localhost:7001/user # hi, 王世新

迁移

vim package.json

// 省略了未修改的代码
    "autod": "autod",
    "migrate:new": "egg-sequelize migration:create",
    "migrate:up": "egg-sequelize db:migrate",
    "migrate:down": "egg-sequelize db:migrate:undo"
// 省略了未修改的代码

cnpm run migrate:new -- --name create-posts-table

vim migrations/*create-posts-table.js

'use strict';

module.exports = {
  up: (queryInterface, Sequelize) => {
    const { INTEGER, DATE, STRING, BIGINT } = Sequelize;

    return queryInterface.createTable('posts', {
      id: {
        type: INTEGER,
        primaryKey: true,
        autoIncrement: true,
      },
      created_at: {
        type: DATE,
      },
      updated_at: {
        type: DATE,
      },
      title: STRING(50),
      user_id: {
        type: BIGINT.UNSIGNED,
        references: {
          model: 'users',
          key: 'id',
        },
      },
    });
  },

  down: queryInterface => {
    return queryInterface.dropTable('posts');
  },
};

cnpm run migrate:up

vim app/model/post.js

'use strict';

module.exports = app => {
  const { INTEGER, DATE, STRING, BIGINT } = app.Sequelize;

  const Post = app.model.define('posts', {
    id: {
      type: INTEGER,
      primaryKey: true,
      autoIncrement: true,
    },
    created_at: DATE,
    updated_at: DATE,
    title: STRING(50),
    user_id: BIGINT.UNSIGNED,
  }, {
    tableName: 'posts',
    createdAt: 'created_at',
    updatedAt: 'updated_at',
  });

  return Post;
};

vim app/router.js

'use strict';

module.exports = app => {
  const { router, controller, middleware } = app;
  const auth = middleware.auth();

  router.get('/', controller.home.index);
  router.post('/login', controller.auth.login);
  router.get('/user', auth, controller.user.index);
  router.post('/post', auth, controller.post.store);
  router.get('/post', auth, controller.post.index);
};

vim app/controller/post.js

'use strict';

const Controller = require('egg').Controller;

class PostController extends Controller {
  async store() {
    const post = await this.ctx.model.Post.create({
      title: '你好',
      user_id: this.ctx.session.user,
    });
    this.ctx.body = 'hi, ' + post.title;
  }

  async index() {
    const post = await this.ctx.model.Post.findById(1);
    this.ctx.body = 'hi, ' + post.title;
  }
}

module.exports = PostController;
  • 测试
curl -b cookies -X POST localhost:7001/post # hi, 你好

curl -b cookies localhost:7001/post # hi, 你好

关联

vim app/model/user.js

// 省略了未修改的代码
  User.associate = function() {
    app.model.User.hasMany(app.model.Post, { foreignKey: 'user_id' });
  };
// 省略了未修改的代码

vim app/model/post.js

// 省略了未修改的代码
  Post.associate = function() {
    app.model.Post.belongsTo(app.model.User, { foreignKey: 'user_id' });
  };
// 省略了未修改的代码

vim app/controller/user.js

'use strict';

const Controller = require('egg').Controller;

class UserController extends Controller {
  async index() {
    const id = this.ctx.session.user;
    const include = {
      include: [{
        model: this.ctx.model.Post,
        as: 'posts',
      }],
    };
    const user = await this.ctx.model.User.findById(id, include);
    this.ctx.body = 'hi, ' + user.nick_name + ' ' + user.posts[0].title;
  }
}

module.exports = UserController;

vim app/controller/post.js

// 省略了未修改的代码
  async index() {
    const include = {
      include: [{
        model: this.ctx.model.User,
        as: 'user',
      }],
    };
    const post = await this.ctx.model.Post.findById(1, include);
    this.ctx.body = 'hi, ' + post.title + ' ' + post.user.nick_name;
  }
// 省略了未修改的代码
  • 测试
curl -b cookies localhost:7001/user # hi, 王世新 你好

curl -b cookies localhost:7001/post # hi, 你好 王世新

更多参考Associations 或 Associations - 关联

小结

特点

已解决

待验证

发布

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 211,817评论 6赞 492
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 90,329评论 3赞 385
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 157,354评论 0赞 348
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 56,498评论 1赞 284
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 65,600评论 6赞 386
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 49,829评论 1赞 290
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 38,979评论 3赞 408
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 37,722评论 0赞 266
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 44,189评论 1赞 303
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,519评论 2赞 327
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,654评论 1赞 340
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 34,329评论 4赞 330
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 39,940评论 3赞 313
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,762评论 0赞 21
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,993评论 1赞 266
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 46,382评论 2赞 360
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 43,543评论 2赞 349

推荐阅读更多精彩内容

  • 面试那些事（一）2018-07-05
    一、上海某雷科技公司 刚到公司，办公室只有一个人，那就是人事。这里的环境也不是很好，貌似窗台还在漏水。前天晚上通知...
    会忆阅读 377评论 0赞 0
  • CocoaPods ☞ 创建并管理私有仓库
    CocoaPods[https://cocoapods.org/] 是一个比较常用的 iOS 依赖管理工具，今天抽...
    RiverSea阅读 1,651评论 0赞 7
  • Laravel学习日记2018-07-05
    知识点 在两个模型之间使用一对多关联； 通过模型关联来获取数据； 对微博发布时间进行友好化处理，并添加中文版本的支...
    Purson阅读 156评论 0赞 0
  • 2018-07-05
    无法重来的一生 人有悲欢离合，月有阴晴圆缺，此事古难全。但愿人长久，千里共婵娟。 最初我们来到这个世界，是因为不得...
    崔金娥阅读 278评论 0赞 0
  • 22天，这只是一个普通人成功的开始
    七月，在猫叔的公众号看到行动营的学员自述自我蜕变的文章深深的吸引住眼球。但是，由于资金原因而放弃了。月底，由于处于...
    A0蓉儿阅读 307评论 10赞 12