当前位置:网站首页 > iOS应用开发 > 正文

Web应用开发框架-egg(一)——Egg入门、Egg与Koa的关系 & 快速入门之编写Controller、静态资源

Web应用开发框架-egg(一)——Egg入门、Egg与Koa的关系 & 快速入门之编写Controller、静态资源

第二章 Egg入门

Egg是什么?

由阿里巴巴团队开源的一套基于koa的应用框架,已经在集团内部服务了大量的nodejs系统。

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

注:Egg.js 缩写为 Egg

设计原则

Egg 的插件机制有很高的可扩展性,一个插件只做一件事

(比如 Nunjucks 模板封装成了 egg-view-nunjucks、MySQL 数据库封装成了 egg-mysql)。Egg 通过框架聚合这些插件,并根据自己的业务场景定制配置,这样应用的开发成本就变得很低。

Egg 奉行『约定优于配置』,按照一套统一的约定进行应用开发,团队内部采用这种方式可以减少开发人员的学习成本,开发人员不再是『钉子』,可以流动起来。

没有约定的团队,沟通成本是非常高的,比如有人会按目录分栈而其他人按目录分功能,开发者认知不一致很容易犯错。但约定不等于扩展性差,相反 Egg 有很高的扩展性,可以按照团队的约定定制框架。使用 Loader 可以让框架根据不同环境定义默认配置,还可以覆盖 Egg 的默认约定。

在这里插入图片描述

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

Egg与Koa的关系

Koa 是一个非常优秀的框架,然而对于企业级应用来说,它还比较基础。

Egg 选择了 Koa 作为其基础框架,在它的模型基础上,进一步对它进行了一些增强。

扩展
// app/extend/context.js module.exports = { 
    get isIOS() { 
    const iosReg = /iphone|ipad|ipod/i; return iosReg.test(this.get('user-agent')); }, }; 

在 Controller 中,我们就可以使用到刚才定义的这个便捷属性了:

// app/controller/home.js exports.handler = ctx => { 
    ctx.body = ctx.isIOS ? 'Your operating system is iOS.' : 'Your operating system is not iOS.'; }; 
插件

Koa 中,经常会引入许许多多的中间件来提供各种各样的功能,例如引入 koa-bodyparser 来解析请求 body。而 Egg 提供了一个更加强大的插件机制,让这些独立领域的功能模块可以更加容易编写。

一个插件可以包含

  • extend:扩展基础对象的上下文,提供各种工具类、属性。
  • middleware:增加一个或多个中间件,提供请求的前置、后置处理逻辑。
  • config:配置各个环境下插件自身的默认配置项。

快速入门

我们推荐直接使用脚手架,只需几条简单指令,即可快速生成项目:

$ mkdir egg-example && cd egg-example $ npm init egg --type=simple $ npm i 
编写Controller
// app/controller/home.js const Controller = require('egg').Controller; class HomeController extends Controller { 
    async index() { 
    const { 
    ctx } = this; ctx.body = 'hi, egg'; } } module.exports = HomeController; 

配置路由映射:

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

Egg 内置了 static 插件,线上环境建议部署到 CDN,无需该插件。

static 插件默认映射 /public/* -> app/public/* 目录

此处,我们把静态资源都放到 app/public 目录即可:

app/public ├── css │ └── news.css └── js ├── lib.js └── news.js 

服务端开启项目后,浏览器访问地址——

localhost:7001/public/lib.js

到此这篇Web应用开发框架-egg(一)——Egg入门、Egg与Koa的关系 & 快速入门之编写Controller、静态资源的文章就介绍到这了,更多相关内容请继续浏览下面的相关推荐文章,希望大家都能在编程的领域有一番成就!

版权声明


相关文章:

  • Web应用开发框架-egg(二)——快速入门之模板渲染、编写helper扩展、编写Middleware、渐进式开发 & egg总结2024-11-27 22:54:06
  • Web应用开发框架-egg(三)01-基础功能——目录结构的约定之框架规定的目录、内置插件约定的目录 & 内置对象之Application、context、Request & Response等2024-11-27 22:54:06
  • Web应用开发框架-egg(三)02-基础功能——运行环境 & Config配置之多环境配置、配置写法、配置加载顺序、合并规则、配置结果2024-11-27 22:54:06
  • Web应用开发框架-egg(三)03-基础功能——中间件之编写中间件、中间件的配置、使用中间件、在框架和插件中使用中间件 & 中间件的通用配置项2024-11-27 22:54:06
  • Web应用开发框架-egg(三)04-基础功能——路由之定义Router、restful风格的URL定义、获取路由参数2024-11-27 22:54:06
  • Web应用开发框架-egg(三)06-基础功能——插件之定义插件、编写插件 & 定时任务 & 自定义启动app2024-11-27 22:54:06
  • Web应用开发框架-koa(五)——koa总结之koa特点、koa-route路由 & 中间件之洋葱模型、异步中间件、中间件的合成 & 错误处理之http状态码、koa抛出错误、错误处理中间件2024-11-27 22:54:06
  • Web应用开发框架-koa(四)——koa错误处理之状态码 & koa抛错两种方式-try和catch、ctx.app.emit() & koa-body模块处理错误 & koa-body处理文件上传2024-11-27 22:54:06
  • Web应用开发框架-koa(三)——koa中间件之概念、洋葱模型-执行顺序、异步中间件、koa-compose中间件合成-compsoe函数2024-11-27 22:54:06
  • Web应用开发框架-koa(一)——koa入门与使用、context对象 & 读取并返回html片段之response把读取的内容返回给客户端2024-11-27 22:54:06
  • 全屏图片