使用egg.js前的准备工作_egg typings文件夹-优快云博客

本文链接：https://blog.youkuaiyun.com/qq_44482048/article/details/126638971

一、搭建开发环境
1.安装yarn

sudo npm i  yarn  -g

2.用yarn命令创建egg文件夹

// type就是哪种模板，这里选择最简单的一种egg的模板 
yarn  create egg  --type=simple

● 创建过程中，遇到第一个选项：确定项目名称，这里直接默认设置为egg
在这里插入图片描述

● 第二个对项目进行描述，根据自己项目的内容写
在这里插入图片描述

● 第三个，项目作者
在这里插入图片描述

● 第四个，cookie安全密钥，直接默认
在这里插入图片描述

3.安装项目的所有依赖

yarn install

4.使用开发模式（调试模式）启动程序
// 项目正常运行,这里使用dev打开项目

yarn dev

在这里插入图片描述

5.在终端中停掉egg项目运行
使用Mac快捷键 control + c或者command+。

6.egg.js框架和express/koa框架的特征对比

特征对比	Egg.js	express/koa
代码规范性(MVC开发模式）	符合MVC模式	灵活编码没有明确规范
创建机制/扩展机制）	有	无
多线程管理	有	无
HttpClient集成	有	无

二、Egg的项目结构

1.目录结构
在这里插入图片描述

● app - 项目开发的主目录，工作中的代码几乎都写在这里面
○ controller – 控制器目录，所有的控制器都写在这个里面
○ router.js – 项目的路由文件
● config - 项目配置目录，比如插件相关的配置
○ config.default.js – 系统默认配置文件
○ plugin.js – 插件配置文件
● logs – 项目启动后的日志文件夹
● node_modules - 项目的运行/开发依赖包，都会放到这个文件夹下面
● test - 项目测试/单元测试时使用的目录
● run - 项目启动后生成的临时文件，用于保证项目正确运行
● typings - TypeScript配置目录，说明项目可以使用TS开发
● .eslintignore - ESLint配置文件
● .eslintrc - ESLint配置文件，语法规则的详细配置文件
● .gitignore - git相关配置文件，比如哪些文件归于Git管理，哪些不需要
● jsconfig.js - js配置文件，可以对所在目录下的所有JS代码个性化支持
● package.json - 项目管理文件，包含包管理文件和命令管理文件
● README.MD - 项目描述文件

2.dev和start的区别

dev: 开发环境下使用，如果更改了页面中的代码，不需要停掉项目再重启服务器。
start: 生产环境下使用，也就是在项目开发完成正式运营的时候，如果使用yarn start，修改了代码需要重新启动, 且停掉服务器必须使用yarn stop

三、创建一个新的页面

① 在/app/controller/home.js中新添加一个方法, 在Egg.js框架下，所有的控制器文件中的方法，都是用async异步模式

class HomeController extends Controller {
 ......
 
  // 所有的控制器文件，都是用async异步的方法来编写
  // 再写一个方法,呈现一个新的页面，然后到router.js中配置路由之后才能够被访问到
  async nq() {
    // 拿到上下文，相当于拿到这个页面的所有的东西
    const { ctx } = this;
    // 在页面中输入内容
    ctx.body = '<h1>Hello nq</h1>';
  }

......
}

② 配置新建方法的路由，在/app/router.js中，添加代码

......

module.exports = app => {
  // 访问到app文件夹中的这两个文件
  const { router, controller } = app;
  router.get('/', controller.home.index);
  // 配置新写的nq方法的路由，第一个参数是地址栏中访问到地址是什么，第二个参数这个地址对应下的方法
  router.get('/nq', controller.home.nq);
};
......