00-egg介绍与使用

最新推荐文章于 2024-08-16 18:20:57 发布

厚渡

最新推荐文章于 2024-08-16 18:20:57 发布

阅读量213

点赞数

分类专栏： egg 文章标签： node.js nodejs

本文链接：https://blog.csdn.net/dwp_wz/article/details/123805773

版权

egg 专栏收录该内容

13 篇文章 0 订阅

订阅专栏

官网地址: https://eggjs.org/zh-cn/intro/quickstart.html

Egg.js 是什么?

Egg.js 为企业级框架和应用而生，我们希望由 Egg.js 孕育出更多上层框架，帮助开发团队和开发人员降低开发和维护成本。

基于 Koa 开发，性能优异, 框架稳定，测试覆盖率高的框架

注：Egg.js 缩写为 Egg

设计原则

Egg 奉行『约定优于配置』

我们深知企业级应用在追求规范和共建的同时，还需要考虑如何平衡不同团队之间的差异，求同存异。所以我们没有选择社区常见框架的大集市模式（集成如数据库、模板引擎、前端框架等功能），而是专注于提供 Web 开发的核心功能和一套灵活可扩展的插件机制。我们不会做出技术选型，因为固定的技术选型会使框架的扩展性变差，无法满足各种定制需求。通过 Egg，团队的架构师和技术负责人可以非常容易地基于自身的技术架构在 Egg 基础上扩展出适合自身业务场景的框架。

Egg 的插件机制有很高的可扩展性，一个插件只做一件事（比如 Nunjucks 模板封装成了 egg-view-nunjucks、MySQL 数据库封装成了 egg-mysql）。Egg 通过框架聚合这些插件，并根据自己的业务场景定制配置，这样应用的开发成本就变得很低。

Egg 奉行『约定优于配置』，按照一套统一的约定进行应用开发，团队内部采用这种方式可以减少开发人员的学习成本，开发人员不再是『钉子』，可以流动起来。没有约定的团队，沟通成本是非常高的，比如有人会按目录分栈而其他人按目录分功能，开发者认知不一致很容易犯错。但约定不等于扩展性差，相反 Egg 有很高的扩展性，可以按照团队的约定定制框架。使用 Loader 可以让框架根据不同环境定义默认配置，还可以覆盖 Egg 的默认约定。

与其他框架比较

Express 是 Node.js 社区广泛使用的框架，简单且扩展性强，非常适合做个人项目。但框架本身缺少约定，标准的 MVC 模型会有各种千奇百怪的写法。Egg 按照约定进行开发，奉行『约定优于配置』，团队协作成本低。
Sails 是和 Egg 一样奉行『约定优于配置』的框架，扩展性也非常好。但是相比 Egg，Sails 支持 Blueprint REST API、WaterLine 这样可扩展的 ORM、前端集成、WebSocket 等，但这些功能都是由 Sails 提供的。而 Egg 不直接提供功能，只是集成各种功能插件，比如实现 egg-blueprint，egg-waterline 等这样的插件，再使用 sails-egg 框架整合这些插件就可以替代 Sails 了。 egg

egg的特性

提供基于 Egg 定制上层框架的能力
高度可扩展的插件机制
内置多进程管理
基于 Koa 开发，性能优异
框架稳定，测试覆盖率高
渐进式开发

快速入门

1. 环境准备

操作系统：支持 macOS，Linux，Windows
运行环境：建议选择 LTS 版本，最低要求 8.x。

2. 快速初始化

我们推荐直接使用脚手架，只需几条简单指令，即可快速生成项目（npm >=6.1.0）:

$ mkdir egg-example && cd egg-example  /* 创建文件夹`egg-example` 然后进入到这个文件夹 */
$ npm init egg --type=simple  /*  初始化egg的simple版本类型*/
$ npm i  /* 安装依赖 */

启动项目:

$ npm run dev /* 注意开发的时候用 这个命令跑项目 */
$ npm start /* 开发完了 */
$ open http://localhost:7001

可以访问接口: http://localhost:7001

快速入门是一句话搭建, 你也可以一步一步搭建

具体详情请看 https://eggjs.org/zh-cn/intro/quickstart.html#%E9%80%90%E6%AD%A5%E6%90%AD%E5%BB%BA

文件目录的基本介绍

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-JoTtV7Ib-1648472039577)(media/00-egg介绍与使用/image-20210525185409264.png)]

config/config.default.js 配置文件的基本介绍

/* eslint valid-jsdoc: "off" */

"use strict";

/**
 * @param {Egg.EggAppInfo} appInfo app info
 */
module.exports = (appInfo) => {
  /**
   * built-in config
   * @type {Egg.EggAppConfig}
   **/
  const config = (exports = {});

  // cookie的签名密钥
  config.keys = appInfo.name + "_1621930136791_1480";

  // 配置全局中间件
  config.middleware = [];

  // 配置属性 全局的
  const userConfig = {
    // myAppName: 'egg',
  };

  // 白名单
  exports.security = {
    domainWhiteList: [".baidu.com"], // 安全白名单，以 . 开头
  };

  // jsonp 的配置
  config.jsonp = {
    callback: "callback", // 识别 query 中的 `callback` 参数
    limit: 100, // 函数名最长为 100 个字符
    // csrf: true, //  JSONP 接口是否开启 CSRF 校验
    // whiteList: [ 'sub.test.com', 'sub2.test.com' ], // 白名单的设置
  };

  // 安全设置 csrf 安装配置
  config.security = {
    // csrf: {
    //   ignoreJSON: true, // 默认为 false，当设置为 true 时，将会放过所有 content-type 为 `application/json` 的请求
    // }
    csrf: false
  }

  
  return {
    ...config,
    ...userConfig,
  };
};

config/plugin.js 下载的插件需要在这块注册

"use strict";

/** @type Egg.EggPlugin */
module.exports = {
  // had enabled by egg
  // static: {
  //   enable: true,
  // }
// 比如我注册了 validate
  validate: {
    enable: true, // 是否启用
    package: "egg-validate", // 插件名称
  },
};