基于 IoC 的 Web 全栈开发框架 Midway

MIT
TypeScript
跨平台
2019-01-11
陈仲寅

Midway 是 阿里巴巴淘宝技术部 MidwayJs 团队产出的第二款产品,也是以团队名命名的核心产品 - Midway。

Midway 是一个 Typescript 编写的 Node.js web 框架,它通过 IoC 的注入机制,让应用的业务逻辑进行解耦,让大型 Node.js 应用开发变的更加简单自然。

Midway 的一些特性。

  • 基于 IoC 体系业务代码进行解耦,依赖统一管理统一初始化

  • 常见的 web 场景装饰器简化业务开发

  • 支持 Egg.js 的所有插件体系,框架装饰器统一编码风格

  • 基于 Typescript ,面向接口编程的编码体验

 

创建新应用

使用 midway-init 工具自动创建 midway 应用的目录结构:

$ npm i midway-init -g
$ midway-init

目前只有一个 ts 的脚手架,可以直接使用。

通过生成的 npm scripts 来驱动启动命令:

$ npm install
$ npm run dev

 

快速开发引导

想要快速上手 midway,除了需要了解一些基础的东西:

  • 虽然可以直接用 js 的语法书写,但是你最好了解 Typescript,这里有个 快速介绍

  • 尽可能使用面向对象的思想来编码,它的经久不衰是有道理的,使用 class 机制能够方便的融入我们的新特性。

  • 了解 midway 的依赖注入体系,以及常用的装饰器,这里做了 依赖注入的介绍

  • 如果你在 midway 的文档中没有找到你想要的东西,记住可以去 Egg 的文档找找,或者 向我们提 Issue

 

代码风格

我们将依赖注入引入到了复杂业务中,经过各种装饰器的包装,业务的同学们可以更加专注的在业务领域,而不用关心依赖的实例化,初始化。

简单的例子。

@provide()
@controller()
export class HomeController {

  @inject()
  reportService: IReportService;
  
  @get('/')
  async index(ctx) {
    ctx.body = await this.reportService.getReport();
  }
}

@provide()
class ReportService implements IReportService {

  @inject()
  reporter: IReportManager;
  
  async getReport(id: number) {
    return await this.reporter.get(id);
  }
}

上边的代码中我们展示了两个 class,HomeController 依赖了 ReportService ,很常见的写法,可以看到其中没有任何实例化或者初始化的迹象,业务代码也如同普通调用的那样直接,这都归功于依赖注入的魔法。

经过装饰器的修饰,形成了多个类,但是又不会相互耦合的局面,让独立开发,测试都非常的方便。

除了以上的装饰器,我们还开发了 @schedule @init @plugin 等好用的装饰器。

    的码云指数为
    超过 的项目
    加载中

    评论(7)

    开源前端工程师
    开源前端工程师

    引用来自“ChengShuai”的评论

    刚才扫了一遍文档,果然跟egg有着千丝万缕得联系啊。我从前年的egg1.0开始,各个服务就全面切换为egg了,然后又在去年把egg框架下的js版逐步转为ts版,不知道midway和egg的ts版有多大优势。不管怎么说,先找机会用用看,百花齐放总是好的ᖗ乛◡乛ᖘ

    引用来自“左华栋”的评论

    egg 本身设计得有问题。 被nest.js 发布仅一年就反超了。 midway 学习了 nest.js 。
    可以仔细说说蛋蛋有啥问题嘛
    robortly
    robortly

    引用来自“鞋底两万里”的评论

    又是阿里不要的东西
    阿里不是家技术公司呀!
    鞋底两万里
    鞋底两万里
    又是阿里不要的东西
    fhaoquan
    fhaoquan
    阿里的东西都好用?
    左华栋
    左华栋

    引用来自“ChengShuai”的评论

    刚才扫了一遍文档,果然跟egg有着千丝万缕得联系啊。我从前年的egg1.0开始,各个服务就全面切换为egg了,然后又在去年把egg框架下的js版逐步转为ts版,不知道midway和egg的ts版有多大优势。不管怎么说,先找机会用用看,百花齐放总是好的ᖗ乛◡乛ᖘ
    egg 本身设计得有问题。 被nest.js 发布仅一年就反超了。 midway 学习了 nest.js 。
    螃蟹一啊
    螃蟹一啊
    跟java一样,这注解
    ChengShuai
    ChengShuai
    刚才扫了一遍文档,果然跟egg有着千丝万缕得联系啊。我从前年的egg1.0开始,各个服务就全面切换为egg了,然后又在去年把egg框架下的js版逐步转为ts版,不知道midway和egg的ts版有多大优势。不管怎么说,先找机会用用看,百花齐放总是好的ᖗ乛◡乛ᖘ

    Midway v1.0 正式发布 - 面向未来的全栈开发方案

    双旦已过,新年将至,midwayJs 向大家献上贺礼。 之前我们向社区开放了我们的治理工具,也就是 Pandora.js 工具包,用于整个 Node.js 应用的监控和治理,我们承诺这不是结束,只是开源的开始...

    01/11 10:56

    没有更多内容

    加载失败,请刷新页面

    没有更多内容

    1
    回答
    midway v1.0 社区正式发布 - 面向未来的全栈开发方案 会有未来吗?

    双旦已过,新年将至,midwayJs 向大家献上贺礼,首先奉上地址: https://github.com/midwayjs/midway/,欢迎 sta...

    01/14 17:16
    4
    回答
    【一周热点】调查显示 3% 开发者修仙 | 手脚数不过来,Linux 内核开始 5.x 系列

    回顾一周社区热门资讯与你的精彩留言~ 第【十】期:0105-0111 精彩回复 from: 8 年后重登王座,Python 再度成为 TIOBE 年度编程...

    01/12 20:38

    没有更多内容

    加载失败,请刷新页面

    没有更多内容

    测试 Services / Factories

    向作者学习。http://www.yearofmoo.com/2013/01/full-spectrum-testing-with-angularjs-and-karma.html#testing-services-factories...

    2014/06/10 10:45
    59
    0
    测试 Modules

    向作者学习。http://www.yearofmoo.com/2013/01/full-spectrum-testing-with-angularjs-and-karma.html#testing-modules...

    2014/06/10 09:24
    80
    0
    测试 Routes

    向作者学习。http://www.yearofmoo.com/2013/01/full-spectrum-testing-with-angularjs-and-karma.html#testing-routes...

    2014/06/10 09:36
    65
    0
    AngularJS中的两种测试类型(+1)

    向作者学习。http://www.yearofmoo.com/2013/01/full-spectrum-testing-with-angularjs-and-karma.html#two-types-of-tests-in-angularjs...

    2014/06/09 23:15
    87
    0
    LaTeX - tikz画摆线

    \documentclass[border=0,tikz]{standalone} \usetikzlibrary{arrows.meta} \usepackage{scalerel} %\scaleobj{1.5}{} 缩放公式大小 \begin{document} \begin{tikzpicture} \draw[arrows={-...

    2018/10/26 14:04
    35
    0
    测试 Requests / Pages

    向作者学习。http://www.yearofmoo.com/2013/01/full-spectrum-testing-with-angularjs-and-karma.html#testing-requests-pages...

    2014/06/10 09:56
    48
    0
    测试 Controllers

    向作者学习。http://www.yearofmoo.com/2013/01/full-spectrum-testing-with-angularjs-and-karma.html#testing-controllers...

    2014/06/10 10:23
    74
    0
    组织代码

    向作者学习。http://www.yearofmoo.com/2013/01/full-spectrum-testing-with-angularjs-and-karma.html#organizing-your-code...

    2014/06/10 08:20
    45
    1

    没有更多内容

    加载失败,请刷新页面

    返回顶部
    顶部