核心组件
这里罗列了Mantra中的核心组件。
服务端与客户端
Mantra非常关注客户端,因为那是你写大部分代码的地方。我们允许客户端缓存和连接器与服务端和远端数据层交互。
此外,我们有一系列服务端的文件和目录结构标准。
在Mantra中,客户端与服务端的分离必须是显式的。我们不建议任何隐式的代码共用。如果你想在客户端实现延时补偿,那么你应当写对应的客户端方法来调用服务端的方法,同时留下存根。参考client/configs/method_stubs/posts.js和server/methods/posts.js。注意到客户端的存根是如何给到一个特定字段saving
,并且这个字段只反映在用户界面上,并不给到服务器去持久化。
可以看一下这么做的根本原因:Say no to universal apps
注意:以下的Mantra组件位于你app的客户端部分。
ES2015 语法和 ES2015 模块
我们依赖于ES2015的多个特性和它的模块系统。为了使用Mantra,你首先需要使用Meteor 1.3,它包含了一个ES2015模块系统的实现。
React 作为 UI
我们使用React作为Mantra的UI(表现层)。你应当使用props来传递所有的数据,事件处理和库函数。
你可以在React组件中处理状态,但是那不会和你app的其余部分交互。所以,Mantra强烈建议你不使用states。
当你编写UI组件时,你可以包含任何其他的React组件。以下是你可以导入组件的地方。
- 其他你app中定义的UI组件
- 来自于NPM的UI组件(如material-ui)
- 你app中的容器(我们一会儿会讲到它)
任何给到组件的其他东西都应当通过props传递。
点击这里查看Mantra中的UI组件
Actions
Actions是你写业务逻辑的地方,其中包含:
- 验证
- 状态管理
- 与远端数据源交互
一个action应是一个简单的函数,它的第一个参数是整个应用的上下文。其他参数一般来自UI的调用或是容器。
注意:在action中,你做的任何事都应该基于应用上下文以及其他传入action的参数。你不能在action中或是模块action停留处载入其他模块或者使用全局变量。
点击此处查看 Mantra action 示例
状态管理
在app中,我们需要处理不同种类的状态。我们可以将其分为两类:
- 本地状态 — 客户端的状态永远不会被同步到一个远端服务器上(错误,认证消息,当前页面)
- 远端状态 — 这个状态通常来自于远端服务器并且同步。
我们有不同的方法来管理app的状态,其中包括:
- Meteor/MiniMongo (Remote State)
- Tracker/ReactiveDict (Local State)
- FlowRouter (Local State)
- Redux (Local State)
- GraphQL/Lokka (Remote State)
- GraphQL/Relay (Remote State)
- Falcor (Remote State)
此处就是JavaScript社区持续产生创新的地方。所以Mantra的状态管理相当灵活。你可以使用你要的一切。
比如,你可以在app起步时使用这些:
- Meteor/MiniMongo (Remote State)
- Tracker/ReactiveDict (Local State)
- FlowRouter (Local State)
随后你可以更换其他解决方案:
注意:尽管如此,Mantra仍然着重强调一些规则来管理状态。
- 任何对于states的修改必须在action内完成
- 你可以从actions或者containers中读取states
- 你不应该直接从UI组件中读取states。UI组件不应该知道app的任何states
查看下面链接获取更多states的示例:
- Reading from local state - inside a container
- Writing into local state - inside an action
- Reading from a remote state - inside a container
容器
容器是Mantra的集成层。它做了下面这些事情:
- 将states传递给UI组件
- 将actions传递给UI组件
- 在应用上下文中传入任何配置项和库函数
容器是React组件,但是你不能直接创建它。你不应该在容器组件中使用JSX。
容器通常用类似于 react-komposer 这样的库构建。它支持不同的数据源,包括 Meteor/Tracker, Promises, Rx.js Observable 等等。
通常的,在容器中你需要写如下函数:
- 构建函数用来从states中获取数据
- 映射函数用来从依赖注入层获取数据并映射它到props中
我们也制定了一些规则:
- 所有这些函数应当在容器模块被导出
- 构建函数只能使用props传来的变量
- 映射函数只能使用参数作为变量。它能访问你整个应用和所有actions
Note: If you need to pass the application context to a component, do it via props using a mapper.
注意:如果你需要传递应用上下文到组件中,使用mapper并通过props传递。
点击这里查看Mantra中的容器
应用上下文
应用上下文能被所有actions和容器获取,所以这里是app中提供共享变量的地方。它们包括:
- Meteor namespace
- Meteor Collections
- LocalState
- FlowRouter
- Any other Meteor package
- Redux Stores
- Lokka Client
- Rest Client
点击此处查看Mantra中的示例应用上下文
依赖注入
Mantra使用依赖注入来分离app的不同部分,包括了UI组件和actions。
我们使用了一个名为 react-simple-di
的项目,它在背后使用了React的上下文。它同时接受应用上下文和actions作为依赖。
一旦配置好,应用上下文就会被注入到每个action中,也就是action的第一个参数。所以,你不需要手动地传递应用上下文。
配置依赖注入
依赖会在你的顶级组件中注入。在这里是Layout组件。
点击这里查看示例配置
路由和组件加载
注意:此处,当谈及组件时,我们包括了容器和UI组件。
我们通常使用路由来在UI中加载组件。
这里有多种选择(例如,FlowRouter和React Router)
路由在Mantra中的作用仅仅是在UI中加载组件。它只是一个工具。
点击 此处 查看如何使用FlowRouter 和 React Layout 来加载组件.
单一入口
在Mantra中,我们想要app变得可预测的。所以,你的app只有一个入口。通常这个文件会加载路由。
点击此处查看入口文件
提示:在服务器端,你可以有另外的入口。
库
任何app都有功能函数来完成不同的任务。你可以通过NPM获取它们。在Mantra中,库需要在应用上下文中导入。为此,我们提供了一个libs
字段来包含它们。
测试
测试是Mantra的核心。Mantra帮助你测试应用的每个部分。我们强调的规则会帮助你编写测试。你可以使用熟悉的工具,如Mocha, Chai和Sinon来进行测试。
使用Mantra,你可以单元测试app的三个核心部分:
- UI components - Example
- Actions - Example
- Container composers and deps mappers - Example
UI 测试
UI测试部分我们使用enzyme。点击链接查看更多测试案例。
参考
- https://kadirahq.github.io/mantra/#sec-Core-Components