学习 | egg.js 从入门到精通

时间 2020-07-20

原文原文链接

快速初始化

使用脚手架，对项目进行快速初始化css

$ mkdir egg-example && cd egg-example
$ npm init egg --type=simple
$ npm i

启动项目

$ npm run dev
$ open http://localhost:7001

访问效果以下html

逐步搭建

初始化项目

$ mkdir egg-example
$ cd egg-example
$ npm init
$ npm i egg --save
$ npm i egg-bin --save-dev

添加相关的执行脚本

{
  "name": "egg-example",
  "scripts": {
    "dev": "egg-bin dev"
  }
}

编写Controller

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

class HomeController extends Controller {
    async index(){
        this.ctx.body = 'Hello World';
    }
}

module.exports = HomeController;

添加路由

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

添加配置文件

exports.keys = '_1595046215730_9281';

此时目录文件结构

访问效果

此时输入命令node

npm run dev

输入地址进行访问npm

http://localhost:7001json

效果以下
api

静态资源

这里使用egg.js的插件完成对egg.js文件进行处理。架构

启动项目，访问静态资源app

http://localhost:7001/public/js/lib.js

而后就能够访问了。curl

模板渲染

在本例子中，使用egg-view-nunjucks做为插件，进行模板的渲染async

安装插件

C:\Users\Administrator\Desktop\untitled2\egg-example>npm i egg-view-nunjucks --save
npm WARN acorn-jsx@5.2.0 requires a peer of acorn@^6.0.0 || ^7.0.0 but none is installed. You must install peer dependencies yo
urself.
npm WARN co-mocha@1.2.2 requires a peer of mocha@>=1.18 <6 but none is installed. You must install peer dependencies yourself.
npm WARN optional SKIPPING OPTIONAL DEPENDENCY: fsevents@1.2.13 (node_modules\fsevents):
npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for fsevents@1.2.13: wanted {"os":"darwin","arch":"any"} (cu
rrent: {"os":"win32","arch":"x64"})
npm WARN optional SKIPPING OPTIONAL DEPENDENCY: fsevents@2.1.3 (node_modules\nunjucks\node_modules\fsevents):
npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for fsevents@2.1.3: wanted {"os":"darwin","arch":"any"} (cur
rent: {"os":"win32","arch":"x64"})

+ egg-view-nunjucks@2.2.0
added 1 package from 1 contributor in 11.263s

36 packages are looking for funding
  run `npm fund` for details


C:\Users\Administrator\Desktop\untitled2\egg-example>

完成了插件的安装

开启插件

配置以下目录，开启插件

config/plugin.js

配置内容以下

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

修改总的配置文件

exports.keys = "_fduhuhrefguir83238uhfr";

exports.view = {
    defaultViewEngine: 'nunjucks',
    mapping: {
        '.tpl': 'nunjucks',
    },
}

编写模板文件

在app/view文件下增长新的模板文件。

<!-- app/view/news/list.tpl -->
<html>
  <head>
    <title>Hacker News</title>
    <link rel="stylesheet" href="/public/css/news.css" />
  </head>
  <body>
    <ul class="news-view view">
      {% for item in list %}
        <li class="item">
          <a href="{{ item.url }}">{{ item.title }}</a>
        </li>
      {% endfor %}
    </ul>
  </body>
</html>

添加控制器和路由

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

class NewsController extends Controller {
    // 同步，设置模板参数列表
    async list() {
        const dataList = {
            list: [
                { id: 1, title: 'this is news 1', url: '/news/1' },
                { id: 2, title: 'this is news 2', url: '/news/2' }
            ]
        };
        // 等待进入render
        await this.ctx.render('news/list.tpl', dataList);
    }
}

module.exports = NewsController;

添加路由

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

访问 http://localhost:7001/news 便可看到页面

编写service

在app/service 目录下，添加service相关文件。
代码以下

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

class NewsService extends Service {
    async list(page = 1) {
        // read config
        const { serverUrl, pageSize } = this.config.news;

        // use build-in http client to GET hacker-news api
        const { data: idList } = await this.ctx.curl(`${serverUrl}/topstories.json`, {
            data: {
                orderBy: '"$key"',
                startAt: `"${pageSize * (page - 1)}"`,
                endAt: `"${pageSize * page - 1}"`,
            },
            dataType: 'json',
        });

        // parallel GET detail
        const newsList = await Promise.all(
            Object.keys(idList).map(key => {
                const url = `${serverUrl}/item/${idList[key]}.json`;
                return this.ctx.curl(url, { dataType: 'json' });
            })
        );
        return newsList.map(res => res.data);
    }
}

module.exports = NewsService;

修改Controller 添加相关的service

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

class NewsController extends Controller {
  async list() {
    const ctx = this.ctx;
    const page = ctx.query.page || 1;
    const newsList = await ctx.service.news.list(page);
    await ctx.render('news/list.tpl', { list: newsList });
  }
}

module.exports = NewsController;

此时ctx.service.news.list 提供相关的数据。

增长配置文件

这时增长相关的配置文件

exports.news = {
    pageSize: 5,
    serverUrl: 'https://hacker-news.firebaseio.com/v0',
};

在模板里添加自定义函数

安装插件

npm i moment --save

// app/extend/helper.js
const moment = require('moment');
exports.relativeTime = time => moment(new Date(time * 1000)).fromNow();

<!-- app/view/news/list.tpl -->
{{ helper.relativeTime(item.time) }}

编写中间件

// app/middleware/robot.js
// options === app.config.robot
module.exports = (options, app) => {
  return async function robotMiddleware(ctx, next) {
    const source = ctx.get('user-agent') || '';
    const match = options.ua.some(ua => ua.test(source));
    if (match) {
      ctx.status = 403;
      ctx.message = 'Go away, robot.';
    } else {
      await next();
    }
  }
};

// config/config.default.js
// add middleware robot
exports.middleware = [
  'robot'
];
// robot's configurations
exports.robot = {
  ua: [
    /Baiduspider/i,
  ]
};

最后

对于egg.js 来讲，整体上也是MVC三层架构。外加中间件，设置相关的文件。之后的内容将会再次挨个深刻讲解。