原文 https://blog.strongbrew.io/A-scalable-angular2-architecture/

这篇文章或许看上去仅和 Angular2 开发者相关,但我相信它也适用于其它的框架。这只是一份关于编写具有可拓展性和可维护性单页面应用的指南。需要指出的非常重要的是,这并不是达成目标的唯一方式,但是对我个人而言它们在不少的场景中都行之有效

编写可拓展性的单页面应用

许多开发者在编写大型的具有可拓展性和可维护性的单页面应用时都遇到困难。导致在开发早期就留下了技术债,修复 bug 时举步维艰,编写测试和创建复用代码时也踌躇不前

最大的一个挑战是:在一个拧巴的基础之上拓展现有逻辑和编写新的功能

对于那些能允许你用100种不同方式设计一个应用,没有结构和封装可言,一切东西都紧紧的耦合在一起的旧时框架,单页面应用是全新的概念

大部分时候在项目的开发的初始阶段都希望快速迭代。但是经过一些开发者,几轮功能迭代和重构之后,代码变得越来越难以维护。它开始看上去像意大利面了。虽然目前框架成熟了很多,但重要的是你编写的软件架构也要与时俱进

2016 年的单页面应用(甚至更早之前)

为了解释这篇文章谈到的架构,有必要回顾一下2016年的web应用长什么样子。这些概念是你的应用在今天也会用到的。无论使用的是 ReactAngular 2 又或者其它的框架。这些已知的原则能够让你的 web 应用变得易于维护

译者注:这已经算非近代了,如果你们想有兴趣了解2013年左右的单页面是怎么做的,可以去考察一下 Backbone.js 或者 Ember.js 以及 AngularJS。那个年代没有单项数据流,没有组件的概念。只有 MVC

原则1:组件

像 React 和 Angular 2 这样的 SPA 技术让我们开始使用组件。一个组件是 HTML 片段和 JavaScript 和结合。我们不想再使用独立的 view 和 controller。因为它们会出现爆炸式增长并且相互关联导致难以维护

译者注:你真的明白这最后一句话 “爆炸式增长” 和 “相互关联导致难以维护” 是什么意思吗?为什么会出现这样的情况以及这究竟是怎样一个场景?

所以最基本的原则是:万物皆是组件(everything should be a component),甚至你的页面和应用也是。一个应用可以长成这个样子:

<application>
	<navbar fullname="Brecht Billiet" logout="logMeOut()">
	</navbar>
	<users-page>
		...
		<grid data="users">
		</grid>
		...
	</users-page>
</application>

一些在设计组件时非常简单但又重要的提示是:

  • 保持它们尽可能的小
  • 保持它们尽可能的仅与绘制界面相关

译者注:”仅与绘制界面相关” 在原文中就一个词:dumb, 即 dumb component。仅负责绘制界面但不包含业务逻辑和数据存储的组件

如果你是设计组件的新手,这篇文章或许能帮助你:components demystified

注意:聪明组件(smart component)也被称为结构组件(structural components),容器组件(containers)或者含状态组件(stateful componnets)

原则2:单向数据流

在此之前我们通过一种非常没有效率的方式来更新应用的状态:

  • 我们尝试让兄弟组件相互通信
  • 父组件尝试通过 action 通知子组件
  • 我们尝试在不同的组件间发送事件
  • 我们使用单向绑定,双向绑定
  • 我们把数据模型注入的到处都是用以共享状态

你有尝试过让兄弟组件相互通信吗?有时候这么做看上去理所应当,但是请不要这么做

这是一个糟糕的设计!这样的话几乎无法看清数据的流动方向。这样的代码无论是对于修复 bug 又或者开发功能也非常难以维护。我们想要像 FluxRedux 的单向数据流

译者注:这个图是一个很好的关于无方向的数据流导致代码失控的例子,但其中有些问题和序号被遮挡了。我猜这应该是来自一个 PPT。但可惜我没能找到原图。

它基本上的工作原理是这样的:子组件只会通知它们的父组件,父组件(容器组件)向包含状态的 store 发送一个 action,action 会更新整个应用状态。当状态被更新之后,我们会重新计算组件树。结果就是数据朝相同的方向流动(向下)。

这种方式的最大好处是:

  • 使得组件之间解耦
  • 好的可维护性
  • 切换为实时应用的代价较小,因为软件是响应式的(reactive)
  • 通过监控 action 我们就知道发生了什么

如果你是单向数据流的新手请访问 introduction to redux 关于 单向数据流(unidirectional dataflow) 的部分

可拓展架构

我在设计一些架构时会参考当今(大部分上面都解释过了)乃至十年前的原则。但这对每个 SPA 都是成立的吗?不尽然……每一种软件类型都值得拥有它自己的架构,我只是展示一种对于我而言在大多数场景下都成立的理念。这个架构对于正在受益于依赖注入特性的 Angular 2 开发者而言迟早会有用,但也能适用于其它的框架中

有意义的抽象

这个原则部分是基于 Nicholas Zakas沙盒原则(Sandbox principle),它已经有一些年头了。对于 Nicholas Zakas 而言,沙盒扮演着包含一个容器组件的几个组件间的调度器(dispatcher)的角色。在这个架构中,没有单向数据流。对我而言一个沙盒是一种将应用逻辑与表现层解耦的方式,但那并不是它唯一的职责。

但是让我们从头开始……在这个具体的场景中我将假设我们使用 Redux,但其实无论你使用什么样的状态管理,了解它背后的原理非常重要。

规则一:不要让你的组件接触到所有的玩具

这和你不能让孩子玩耍所有的东西背后的原因一样:“可能会变得一团糟”。容器组件应该遵循一套严格的规则。不能因为我们能做到而把我们想要的每一个服务都注入进去。举个例子:把游戏引擎注入仅权限模块似乎就没有任何意义

下面的例子展示了一个拥有非常多依赖的构造函数。在这个场景里MyComponent可以在应用里做任何它想做的事情。任何它想要的想要做的都被注入其中。这不是好主意

export class MyComponent{
	constructor(...,private foo:Foo, private bar: Bar, 
		private store: Store<ApplicationState>, private authService: AuthService,
		private fooHttpService: FooHttpService, private barMapper: BarMapper, ...){
	}
}

上面的例子的构造函数里有大多的依赖了。它与太多应用里的其它部分产生了联系。当向复盘这是一种怎样的设计时结果看上去像这个样子:(REST 表示 restful 服务,所以它们只是 HTTP 模块)

这看上去就像意大利面代码,一切都是紧耦合的。一个抽象层能够给予一些帮助。下面的例子中我们看到表现层已经完全解耦,抽象层接管了所有事情

抽象层代码大概像这个样子:

export class MyComponent{
	constructor(private abstraction: SomeAbstractionType){
	}
	
	doSomething(): void{
	this.abstraction.doSomething();
}

译者注:添加了 abstraction layer 之后从外观上整体上看上去清晰了很多,但有没有可能这种混乱的关系被封装在abstraction layer 中而已?它应该如何在内部保持调理清晰?

规则二:组件应该对状态管理层不知情

展示组件和容器组件都不应该知道你用的是 Redux 还是其它的状态管理层。它们不应该关心状态是如何被管理的。它们只是相信状态被管理的很好。管理也不是它们的职责。表现层的职责是“展现”和“委托”

下面的代码片段是一个糟糕设计下组件和 redux 紧耦合的反面例子(在这个例子中我们使用 ngrx/store

export class MyComponent{
	// we just care about the state, not where it comes from...
	users$ = this.store.select(state => state.users);
	foo$ = this.store.select(state => state.foo);
	bar$ = this.store.select(state => state.bar);
	constructor(..., 
		private store: Store<ApplicationState>, ...){
	}
	
	addUser(user: User): void{
		// we don't care about the actiontype, payload or store
		this.store.dispatch({type: ADD_USER, payload: {user}}
	}
	removeUser(userId: string): void{
		// we don't care about the actiontype, payload or store
		this.store.dispatch({type: REMOVE_USER, payload: {userId}}
	}
}

这样或许更加清晰,也更松耦合:

export class MyComponent{
	users$ = this.facade.users$;
	foo$ = this.facade.foo$;
	bar$ = this.facade.bar$;
	
	constructor(private facade: ...){
	}
	
	addUser(user: User): void{
		this.facade.addUser(user);
	}
	removeUser(userId: string): void{
		this.facade.removeUser(userId)
	}
}

现在组件真正的聚焦在它自己的职责上了。它不知道用户是如何被添加或者移除的,它不知道谁产生的 users$ 流,foo$流和bar$流。它把这些职责都托付给抽象层。现在,表现层已经完全和剩余的应用部分解耦了。给我们带来以下的优势:

  • 我们终于有了封装
  • 便于测试,我们只需要 mock 抽象层
  • 如果抽象层保证它的接口不发生变化,它们就能并行开发
  • 它响应抽象层,因此实时开发变得容易许多
  • 表现层与应用中其它的部分不再耦合,所以重构变得更加容易

译者注:注意上面的优势没有一条是和确切的实现功能相关的,满足的都是所谓的“非功能需求”,在我们公司内部更习惯称之为“跨功能需求”。如果你所在的项目不讲究非功能需求,不在乎测试并且每两年就推倒重来的话。架构对你们来说并没有太大意义

规则三:HTTP 服务不应该知道状态管理层

第一眼看上去,似乎把处理 GET 请求放在含有 store 的服务中是顺理成章的事情。但是一个 HTTP 服务的唯一目标是发出 HTTP 请求并且返回这些请求的结果。代码顺理成章的看上去长这样:

export class UserService{
	// expose the users$-stream directly in the service
	users$ = this.store.select(state => state.users);
	
	constructor(private store: Store<ApplicationState>, private http: Http){
	}
	
	fetchUsers(): void{
		this.http.get("...")
			.map(...)
			.subscribe((users) => {
				// when successful, put the users in the store
				// is this really my responsibility?
				this.store.dispatch({type: SET_USERS, payload: {users}});
			});
	}
}

但是现在 http 服务于状态管理系统变得非常的紧耦合

http 服务的唯一职责应是如此

export class UserService{
	constructor(private http: Http){
	}
	
	// just let the consumer of this service handle the store interaction
	// this will just return a stream of users
	fetchUsers(): Observable<Array<User>>{
		return this.http.get("...").map(...)
	}
}

一个可能的解决方案

这当然不是唯一的解决方案,但是它对我来说绝大部分时候都管用。每一个展现模块能够访问它自己的沙盒(sandbox),沙盒一个有以下功能服务:

  • 状态流(在这个例子中从 redux 中选取)
  • (消费沙盒的)展现模块可能执行的方法

但是它不仅仅是一个外观模块:) 它应该有部分的逻辑:

  • 从 store 中抓取正确的状态碎片
  • 向 store 派遣拥有正确类型和正确负载的操作
  • 委托给不同模块里正确的服务
  • 处理乐观更新(optimistic updates)
  • 如果使用了类似于 firebase 的服务,暴露来自 firebase 的正确数据流

沙盒的好处有

  • 将表现层与其它部分解耦
  • 抽离状态管理
  • 能够看清一个模块究竟能访问什么
  • 组件没法为所欲为,更好的封装
  • 把乐观更新逻辑放对了地方,因为组件和服务都不关心这个功能。
  • 在不用重写服务和组件的情况下能够切换到不同的状态管理下面

译者注:注意这个 sandbox 的几个特质:

  • 它只能单向的去调用 state management layer 和 rest 服务,不能反之
  • sandbox 之间不能相互调用

sandbox 更像是一个调度员,它来协调组件想操作的一切。它还是应用的边界,它暴露的方法决定了整个应用的行为

总结

这整个架构是其中的一种方式,但并不意味着是唯一方式。

我们相信封装、松耦合以及正确的职责体系是非常重要的。前端领域更新的非常快,也意味着我们想要更加灵活的应对重构和想尝试一些新技术。我希望你喜欢这篇文章。

想要学习更多

请访问 strongbrew.ioKwinten Pisman在上面开设一个了“反应式应用工作坊(reactive applications workshop)”来更谈论这个主题更多的细节

特别感谢

我想要感谢所有评审这篇文章和给予价值输入的人。感谢 Jurgen Van de MoereCarmen PopoviciuManfred SteyerJuri Strumpflohner!!!

【译文】【前端架构鉴赏 03】:Angular 与 MVP 模式

原文:[https://indepth.dev/model-view-presenter-with-angular/](https://indepth.dev/model-view-presenter-with-angular/)随着应用程序的日趋庞大,它变得越来越难以维护...… Continue reading