概念 - 命名惯例

优质

小牛编辑

126浏览

2023-12-01

英文原文：http://emberjs.com/guides/concepts/naming-conventions/

Ember.js使用命名惯例来连接各个对象，而不是通过大量的引用。对于路由，控制器以及模板，你都应该使用此命名惯例。

有些时候，或许你可以猜到某些正确的命名，但是，这篇指南在此概述了所有的命名惯例。在下面的例子中'App'是被选来作为命名空间的名字，或者说用来代表Ember应用，当然也可以选择任何你喜欢的名字。后面我们将具体介绍如何创建一个Ember应用，不过现在我们将关注惯例。

应用程序

当你的应用程序启动时，Ember会查找下面几个对象:

App.ApplicationRoute
App.ApplicationController
application模板

Ember.js会将application模板作为主模板来渲染。如果存在App.ApplicationController, Ember.js将使用App.ApplicationController的一个实例作为此模板的控制器。这意味着此模板将从这个控制器获得属性。

如果你的应用提供了App.ApplicationRoute,Ember.js将在渲染application模板前先调用此路由的钩子程序。钩子都作为方法来实现，提供了对Ember对象生命周期的访问点，可以拦截和执行代码来改变这些点的缺省行为，以符合实际需求。Ember为各种需求提供了一系列钩子（例如：model，setupController等等）。在下面的实例中，App.ApplicationRoute是一个实现了setupController钩子的Ember.Route对象。

下面这个例子中同时包含了路由，控制器和模板:

App.ApplicationRoute = Ember.Route.extend({
  setupController: function(controller) {
    // `controller` is the instance of ApplicationController
    controller.set('title', "Hello world!");
  }
});

App.ApplicationController = Ember.Controller.extend({
  appName: 'My First Example'
});

<!-- application template -->
<h1>{{appName}}</h1>

<h2>{{title}}</h2>

在Ember.js应用中，你可以总是将控制器看作是一个个的类，应用程序框架负责实例化类并且将他们提供给模板。

这将使测试控制器的工作变得轻而易举，并且确保每个控制器在整个应用中只有唯一的一个实例。

简单的路由

对于应用中的每一个路由，都会有以路由名称命名的控制器和模板。

以下面这个简单的路由为例：

1
2
3

App.Router.map(function() {
  this.route('favorites');
});

如果用户要访问/favorites，Ember.js会查找下面几个对象：

App.FavoritesRoute
App.FavoritesController
favorites模板

Ember.js会将favorites模板渲染到application模板中的{{outlet}}中去，还将会把App.FavoritesController的一个实例作为此模板的控制器。

如果你的应用程序提供了App.FavoritesRoute，应用程序框架会在渲染模板前先调用它。当然，这里会有点重复过程。

对于一个路由，例如App.FavoritesRoute,你可能需要实现model钩子去指定你的控制器要呈现给模板的模型。

下面是一个例子：

App.FavoritesRoute = Ember.Route.extend({
  model: function() {
    // the model is an Array of all of the posts
    return this.get('store').find('post');
  }
});

在这个例子中，我们并没有提供FavoritesController。因为该模型是一个数组，Ember.js会自动提供一个Ember.ArrayController，它将会把返回的数组视为模型。

你可以将ArrayController本身就看做是一个模型。这主要有两个优点：

你可以在任何时候变更控制器的模型而无需直接考虑视图的变化。
控制器可以提供额外的不属于模型层的可计算属性或特定视图的状态。这使视图，控制器和模型之间的分层结构更清晰。

模板可以迭代控制器中的元素：

<ul>
{{#each controller}}
  <li>{{title}}</li>
{{/each}}
</ul>

动态字段

如果一个路由中使用了一个动态字段，它对应的模型将基于用户提供的那个字段的值。

考虑下面这个路由的定义：

1
2
3

App.Router.map(function() {
  this.resource('post', { path: '/posts/:post_id' });
});

在这个例子中，路由的名称是post, 所以Ember.js将查找以下几个对象:

App.PostRoute
App.PostController
post模板

路由处理程序的model钩子将把动态参数:post_id转换到模型中去。而serialize钩子将会为这个路由把一个模型对象转化回URL参数(例如，在为一个模型对象生成链接的情况下)。

App.PostRoute = Ember.Route.extend({
  model: function(params) {
    return this.get('store').find('post', params.post_id);
  },

  serialize: function(post) {
    return { post_id: post.get('id') };
  }
});

由于这个模式太常见，现在它是默认的路由处理程序。

如果你的动态字段以_id结束，默认的model钩子会将第一部分转化为在应用程序命名空间中的一个模型类(post变成App.Post). 然后，钩子将在这个模型类中调用find函数，函数的参数即是动态字段的值。
默认的serialize钩子将会使用模型对象的id属性代替动态字段。

路由，控制器和默认模板

如果你没有为post路由(App.PostRoute)指定一个路由处理程序，Ember.js仍然会使用App.PostController的一个实例来渲染post模板。

如果你没有指定控制器(App.PostController)，Ember将会根据路由的model钩子的返回值自动创建一个。如果模型是一个数组，那么就会创建ArrayController。否则，将创建ObjectController。

如果你没有指定一个post模板，那么，Ember.js什么也不会渲染。

嵌套

你可以在一个resource内嵌套路由。

App.Router.map(function() {
  this.resource('posts', function() { // the `posts` route
    this.route('favorites');          // the `posts.favorites` route
    this.resource('post');            // the `post` route
  });
});

资源的名称与路由，控制器或模板的起始名称一致。即使post资源被嵌套了，它的路由的名称仍是App.PostRoute, 控制器名称是App.PostController,模板名称是post。

如果你在一个资源内嵌套了一个路由,此路由的名称将变为资源名称.路由名称。

下面定义了上面例子中各个路由的命名惯例：

路由名	控制器	路由	模板
`posts`	`PostsController`	`PostsRoute`	`posts`
`posts.favorites`	`PostsFavoritesController`	`PostsFavoritesRoute`	`posts/favorites`
`post`	`PostController`	`PostRoute`	`post`

命名的经验就是：资源名称为名词,路由名称应为形容词(favorites)或动词(edit). 这不仅确保了在嵌套的时候不会产生冗长的名称，而且可以避免常见形容词和动词之间的冲突。

索引路由

在嵌套的每一个层次(包括最上层),Ember.js自动为/路径提供了一个名称为index的路由。

例如，假如你写了如下这样一个简单的路由：

1
2
3

App.Router.map(function() {
  this.route('favorites');
});

App.Router.map(function() {
  this.route('index', { path: '/' });
  this.route('favorites');
});

如果你的用户访问/路径，Ember.js会首先查找以下几个对象：

App.IndexRoute
App.IndexController
index模板

index模板将被渲染到application模板中的{{outlet}}中去。如果用户访问/favorites, Ember.js将用favorites模板取代index模板。

例如，下面这个嵌套的路由：

App.Router.map(function() {
  this.resource('posts', function() {
    this.route('favorites');
  });
});

等价于：

App.Router.map(function() {
  this.route('index', { path: '/' });
  this.resource('posts', function() {
    this.route('index', { path: '/' });
    this.route('favorites');
  });
});

如果用户访问/posts，当前路由就是posts.index。Ember.js将查找以下几个对象：

App.PostsIndexRoute
App.PostsIndexController
posts/index模板

首先，posts模板将被渲染到application模板中的{{outlet}}中去。然后，posts/index模板将被渲染到posts模板的{{outlet}}中去。

如果用户又访问了/posts/favorites，Ember.js会使用posts/favorites模板来替换posts模板中的{{outlet}}。