egg.js-基于koa2的node.js入门

Bertha 。 2024-04-17 06:28 32阅读 0赞

一．**Egg.JS 简介**

Egg.JS是阿里开发的一套node.JS的框架，主要以下几个特点：

1.  Egg 的插件机制有很高的可扩展性，一个插件只做一件事，Egg 通过框架聚合这些插件，并根据自己的业务场景定制配置，这样应用的开发成本就变得很低。
2.  Egg 奉行『**约定优于配置**』，目录名称规范，团队内部采用这种方式可以减少开发人员的学习成本，
3.  Node.遵循MVC框架

Mode 层对应server文件夹

View 层 对应view文件

Controller 对应 Controller文件夹  
4.其他

提供基于 Egg 定制上层框架的能力,

高度可扩展的插件机制

内置多进程管理

基于 Koa 开发，性能优异

框架稳定，测试覆盖率高

渐进式开发

![format_png][]

创建项目

cnpm i  egg-init -g

egg-init spider --type=simple

cd spider

cnpm i

**二.Egg快速编辑插件Vscode+egg的安装和使用**

![format_png 1][]

![format_png 2][]

安装完成egg controller即可一键输出controller基本结构

Service，config ，plugin同理，生成controller

![复制代码][aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]

'use strict';
    
    const Controller = require('egg').Controller;
    class ListController extends Controller {
    async echo() {
    }
    }
    module.exports = ListController;

![复制代码][aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]

Egg.JS的目录结构如下

![format_png 3][]

### 三、为好的使用egg安装ejs模板 ###

模板地址：  [https://www.npmjs.com/package/egg-view][https_www.npmjs.com_package_egg-view]

cnpm install egg-view-ejs --save

ejs配置

**修改文件//config/plugin.js**

'use strict';
    exports.ejs = {
        enable: true,
        package: 'egg-view-ejs',
      };

**修改文件//config/config.default**

config.view = {
        mapping: {
          '.html': 'ejs',
        },
      };

**修改//constroller/new.js**

![复制代码][aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]

async index() {
        let name = this.ctx.query.name;  //query接收动态数据
        let id = this.ctx.params.id;   //params接收路由传值
    let list = [1,2,3]; 
    // 修改加载ejs的方式
    await this.ctx.render('news',{name,id,list})
      }
    module.exports = NewsController;

![复制代码][aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]

### 四．**动态参数的读取get，query传值和params传值** ###

4.1 Constroller里写

let name = this.ctx.query.name;  //query接收动态数据
    
        let id = this.ctx.params.id;   //params接收路由传值

4.2 Router文件动态配置id参数

router.get('/news', controller.news.index);
    
      router.get('/news/:id', controller.news.index);

4.3 模板文件解析参数的写法view/news.html

![复制代码][aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]

<!DOCTYPE html><html lang="en"><head>
    <meta charset="UTF-8">
    <meta http-equiv="X-UA-Compatible" content="ie=edge">
    <link rel="stylesheet" href="/public/css/basic.css">
    <title>Document</title></head><body>
    <p>query:<%= name %></p>
    <p>params<%= id %></p>
    <ul>
    <% for(var i=0;i<list.length;i++){ %>
    <li><%= list[i]%></li>
    <% } %>
    </ul>
    <img src="/public/img/timg.jpg"/>
    </body>
    </html>

![复制代码][aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]

![format_png 4][]

### 五．**Server文件的封装** ###

Server的封装是为了数据在多个Constroller中都可以用到，以达到一次渲染多处调用的目的

![format_png 5][]

在service下面新建 new.js 并在里面建 list服务

![复制代码][aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]

'use strict';
    
    const Service = require('egg').Service;
    class NewsService extends Service {
    async list() {
    let list = [1,2,3,4];
    return list
    }
    }
    module.exports = NewsService;

![复制代码][aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]

Server在controller中的引用

let list = await this.service.news.list(); //service的引用

### 六．**Egg插件机制的使用** ###

新建extend文件夹 Extend提供的扩展功能

application

context

helper  //工具方法

request

在extend目录下新建helper.js

Application.js 挂载app的方法

![复制代码][aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]

/* 外部可以通过 this.app.foo() */
    module.exports = {
    foo(param) {
    // this 就是 app 对象，在其中可以调用 app 上的其他方法，属性
    // console.log(this);
    return this.config.api;
    },
    };

![复制代码][aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]

Context.js

![复制代码][aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]

/* 外部可以通过 this.ctx.getHost() */
    
    module.exports={
    getHost(){
    // this 就是 ctx 对象，在其中可以调用 ctx 上的其他方法，或访问属性 
    return this.request.host;
    }
    }

![复制代码][aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]

Helper.JS 工具函数类

![复制代码][aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]

module.exports = {
    formatDate(time) {
    return time+100
    }
    }
    //在view下的html文件中的调用方式
    <%= helper.formatDate(list[i].dateline)%>

![复制代码][aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]

Request.js 请求

![复制代码][aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]

/*外部可以通过 this.ctx.request.foo()*/
    module.exports = {
    foo(param) {
    // console.log(this);
    return this.header.host;
    },
    };

![复制代码][aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]

### 七．**Egg中间件middleware** ###

中间件：匹配路由前、匹配路由完成做的一系列的操作。 Egg 是基于 Koa 实现的，所以 Egg 的中间件形式和 Koa 的中间件形式是一样的，都是基于洋葱圈模型

Egg中间件放置在 app/middleware 目录下的单独文件，它需要 exports 一个普通的 function，接受两个参数：

options: 中间件的配置项，框架会将 app.config\[$\{middlewareName\}\] 传递进来。

app: 当前应用 Application 的实例。

**1、app/middleware下面新建forbidip.js 内容如下：**

![复制代码][aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]

module.exports = (options, app) => {
            return async function forbidipMiddleware(ctx, next) { 
                 console.log(options);  //传过来的参数
               console.log(ctx.request.ip); //获取当前的ip
               var sourceIp=ctx.request.ip;
                 const match = options.ip.some(val =>{
                if(val==sourceIp){
                  return true;
                }
              });
              if (match) {
                ctx.status = 403;
                ctx.message = 'Go away, robot.';
              } else {
                await next();
              }
            }
        };

![复制代码][aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]

2、找到**config.default.js**配置当前项目需要使用的中间件以及中间件的参数

![复制代码][aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]

//中间件
      config.middleware = ['forbidip'];
      config.forbidip = {
        ip: [
          '127.0.0.1',
          '192.168.0.1'
        ],
      };

![复制代码][aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]

### 八．**Egg中间件post提交数据安全，csrf的防范机制** ###

所有post请求需要引入 csrf

async forms() {
    await this.ctx.render('forms'{csrf:this.ctx.csrf})
    }

![复制代码][aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]

<form action="/add?_csrf=<%=csrf%>" method="post">
    
    用户名： <input type="text" name="username"><br/>
    密码： <input type="text" name="password" type="password"><br/>
    <input type="submit" value="提交">
    </form>

![复制代码][aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]

1.  添加全局变量csrf，设置为中间件

** 在middleware下增加 auth.js**

![复制代码][aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]

module.exports = (option,app) => {
    return async function auth(ctx,next){
    //添加全局变量
    ctx.state.csrf = ctx.csrf;
    await next();
    }
    }

![复制代码][aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]

在 config/config.default.js下调用中间件

config.middleware = ['auth'];

### 九．**Egg中使用cookies** ###

Cookie设置

![复制代码][aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]

this.ctx.cookies.set('username','张三',{
    maxAge: 1000*3600*24,
    httpOnly: true, //是否允许在js中获取
    signed: true, // 加签防止修改
    encrypt: true //如果加密的时候获取时需解密
    });

![复制代码][aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]

Cookie读取

this.ctx.cookies.get(‘name’)

Cookie保存对象需要加转换

### 十．**Egg中使用session** ###

Session的公共配置

![复制代码][aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]

config.session ={
    
    maxAge:30*1000*60,
    
    renew:true  //每次加载重新计算时间
    
    }

![复制代码][aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]

Session设置

this.ctx.session.userinfo='hahaha';

Session读取

this.ctx.session.userinfo

[format_png]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9pbWcyMDE4LmNuYmxvZ3MuY29tL2Jsb2cvMTE2NjQ1NC8yMDE4MTIvMTE2NjQ1NC0yMDE4MTIxMjEwNTY0NDgwMy0xNzI3NTUwMTA3LnBuZw?x-oss-process=image/format,png
[format_png 1]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9pbWcyMDE4LmNuYmxvZ3MuY29tL2Jsb2cvMTE2NjQ1NC8yMDE4MTIvMTE2NjQ1NC0yMDE4MTIxMjEwNTcxNDcyNi0xMjgyOTk3ODk1LnBuZw?x-oss-process=image/format,png
[format_png 2]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9pbWcyMDE4LmNuYmxvZ3MuY29tL2Jsb2cvMTE2NjQ1NC8yMDE4MTIvMTE2NjQ1NC0yMDE4MTIxMjEwNTczMDkyNS0xMDM0MTI5NTc0LnBuZw?x-oss-process=image/format,png
[aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg
[format_png 3]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9pbWcyMDE4LmNuYmxvZ3MuY29tL2Jsb2cvMTE2NjQ1NC8yMDE4MTIvMTE2NjQ1NC0yMDE4MTIxMjEwNTkwNjA0MC0xMTUzNzUxMDA2LnBuZw?x-oss-process=image/format,png
[https_www.npmjs.com_package_egg-view]: https://www.npmjs.com/package/egg-view
[format_png 4]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9pbWcyMDE4LmNuYmxvZ3MuY29tL2Jsb2cvMTE2NjQ1NC8yMDE4MTIvMTE2NjQ1NC0yMDE4MTIxMjExMDEyMzEzOS05NzIxNDE4NjQucG5n?x-oss-process=image/format,png
[format_png 5]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9pbWcyMDE4LmNuYmxvZ3MuY29tL2Jsb2cvMTE2NjQ1NC8yMDE4MTIvMTE2NjQ1NC0yMDE4MTIxMjExMDE0NDk5Ni0xMTc0ODg5MDUxLnBuZw?x-oss-process=image/format,png