文章目录
一、前言
熟悉前端的同学怎么样快速搭建一个属于自己的后端接口项目呢?这就不得不提到Node.js了,Node.js是一个基于Chrome V8引擎的JavaScript运行环境,广泛用于构建高性能、可扩展的网络应用程序。
二、为什么要用Egg?
目前网上有很多Node框架,大家比较熟知的如express、koa框架等,以express框架为例,它简单易用好上手并且扩展性强,写比较小的项目比较方便,但是因为缺少相关的规范约定,导致每个人搭建起来的项目多多少少带有点自己的编程习惯,这在多人协作编程的时候会出现项目杂乱难维护的情况。
针对这种情况Egg.js应运而生,通过约定大于配置的原则,规范了项目的目录结构、文件命名等,使得开发者可以快速上手并且降低团队协作成本。
三、项目搭建步骤
1.使用脚手架快速初始化:
代码如下(示例):
mkdir egg-demo&& cd egg-demo
npm init egg --type=simple
npm i
2.启动项目:
代码如下(示例):
npm run dev
open http://localhost:7001
启动启动实例图片:
项目文件简介
3.测试访问
浏览器打开:http://127.0.0.1:7001
4.接口初体验
1.在controller上创建一个test.js文件:
const { Controller } = require('egg');
class TestController extends Controller {
async index() {
const { ctx } = this;
ctx.body = {
code: 0,
data: {
name: 'hanghang',
age: 18
}
};
}
}
module.exports = TestController;
2.在router.js文件新增路由
/**
* @param {Egg.Application} app - egg application
*/
module.exports = app => {
const { router, controller } = app;
router.get('/', controller.home.index);
router.get('/test', controller.test.index);
};
3.测试访问接口
总结
以上就是今天要讲的内容,本文仅仅简单介绍了egg框架的使用,后续有兴趣可以去访问官方网站:https://www.eggjs.org/zh-CN/intro/quickstart