angular中的路由 ng-router vs ui.router

时间  2020-05-19
标签 angular 路由 router ui.router 栏目 AngularJS 繁體版
原文   原文链接

路由(route)，几乎全部的MVC(VM)框架都应该具备的特性，由于它是前端构建单页面应用(SPA)必不可少的组成部分。javascript

那么，对于angular而言，它天然也有内置的路由模块：叫作ngRoute。html

不过，你们不多用它，由于它的功能太有限，每每不能知足开发需求！！前端

因而，一个基于ngRoute开发的第三方路由模块，叫作ui.router，受到了你们的“追捧”。java

ngRoute vs ui.router

首先，不管是使用哪一种路由，做为框架额外的附加功能，它们都将以模块依赖的形式被引入，简而言之就是：在引入路由源文件以后，你的代码应该这样写(以ui.router为例)：git

angular.module("myApp", ["ui.router"]); // myApp为自定义模块，依赖第三方路由模块ui.router

这样作的目的是：在程序启动(bootstrap)的时候，加载依赖模块(如：ui.router)，将全部挂载在该模块的服务(provider)，指令(directive)，过滤器(filter)等都进行注册，那么在后面的程序中即可以调用了。github

说到这里，就得看看ngRoute模块和ui.router模块各自都提供了哪些服务，哪些指令？bootstrap

  1. ngRoute
  2. $routeProvider(服务提供者) --------- 对应于下面的urlRouterProvider和stateProvider
  3. $route(服务) --------- 对应于下面的urlRouter和state
  4. $routeParams(服务) --------- 对应于下面的stateParams

  5. ng-view(指令) --------- 对应于下面的ui-viewpromise

  6. ui.router浏览器

  7. $urlRouterProvider(服务提供者) --------- 用来配置路由重定向
  8. $urlRouter(服务)
  9. $stateProvider(服务提供者) --------- 用来配置路由
  10. $state(服务) --------- 用来显示当前路由状态信息，以及一些路由方法（如：跳转）
  11. $stateParams(服务) --------- 用来存储路由匹配时的参数
  12. ui-view(指令) --------- 路由模板渲染，对应的dom相关联
  13. ui-sref(指令)
  14. ...

(注：服务提供者：用来提供服务实例和配置服务。)缓存

这样一看，其实ui.router和ngRoute大致的设计思路，对应的模块划分都是一致的(毕竟是同一个团队开发)，不一样的地方在于功能点的实现和加强。

那么问题来了：ngRoute弱在哪些方面，ui.router怎么弥补了这些方面?

这里，列举两个最重要的方面来讲(其余细节，后面再说)：

  1. 多视图
  2. 嵌套视图
多视图

多视图：页面能够显示多个动态变化的不一样区块。

这样的业务场景是有的：

好比：页面一个区块用来显示页面状态，另外一个区块用来显示页面主内容，当路由切换时，页面状态跟着变化，对应的页面主内容也跟着变化。

首先，咱们尝试着用ngRoute来作：

html

<div ng-view>区块1</div>
<div ng-view>区块2</div>

js

$routeProvider
    .when('/', {
    template: 'hello world'
});

咱们在html中利用ng-view指令定义了两个区块，因而两个div中显示了相同的内容，这很合乎情理，但却不是咱们想要的，可是又不能为力，由于，在ngRoute中：

  1. 视图没有名字进行惟一标志，因此它们被同等的处理。
  2. 路由配置只有一个模板，没法配置多个。

ok，针对上述两个问题，咱们尝试用ui.router来作：

html

<div ui-view></div>
  <div ui-view="status"></div>

js

$stateProvider
    .state('home', {
        url: '/',
        views: {
            '': {
                template: 'hello world'
            },
            'status': {
                template: 'home page'
            }
        }
    });

此次，结果是咱们想要的，两个区块，分别显示了不一样的内容，缘由在于，在ui.router中：

  1. 能够给视图命名，如：ui-view="status"。
  2. 能够在路由配置中根据视图名字(如：status)，配置不一样的模板（其实还有controller等）。

注：视图名是一个字符串，不能够包含@（缘由后面会说）。

嵌套视图

嵌套视图：页面某个动态变化区块中，嵌套着另外一个能够动态变化的区块。

这样的业务场景也是有的：

好比：页面一个主区块显示主内容，主内容中的部份内容要求根据路由变化而变化，这时就须要另外一个动态变化的区块嵌套在主区块中。

其实，嵌套视图，在html中的最终表现就像这样：

<div ng-view>
I am parent
<div ng-view>I am child</div>
</div>

转成javascript，咱们会在程序里这样写：

$routeProvider
    .when('/', {
    template: 'I am parent <div ng-view>I am child</div>'
});

假若，你真的用ngRoute这样写，你会发现浏览器崩溃了，由于在ng-view指令link的过程当中，代码会无限递归下去。

那么形成这种现象的最根本缘由：路由没有明确的父子层级关系！

看看ui.router是如何解决这一问题的？

$stateProvider
    .state('parent', {
        abstract: true,
        url: '/',
        template: 'I am parent <div ui-view></div>'
    })
    .state('parent.child', {
        url: '',
        template: 'I am child'
    });
  1. 巧妙地，经过parent与parent.child来肯定路由的父子关系，从而解决无限递归问题。
  2. 另外子路由的模板最终也将被插入到父路由模板的div[ui-view]中去，从而达到视图嵌套的效果。

ui.router工做原理

路由，大体能够理解为：一个查找匹配的过程。

对于前端MVC(VM)而言，就是将hash值(#xxx)与一系列的路由规则进行查找匹配，匹配出一个符合条件的规则，而后根据这个规则，进行数据的获取，以及页面的渲染。

因此，接下来：

  • 第一步，学会如何建立路由规则？
  • 第二步，了解路由查找匹配原理？
路由的建立

首先，看一个简单的例子：

$stateProvider
    .state('home', {
        url: '/abc',
        template: 'hello world'
    });

上面，咱们经过调用$stateProvider.state(...)方法，建立了一个简单路由规则，经过参数，能够容易理解到：

  1. 规则名：'home'
  2. 匹配的url：'/abc'
  3. 对应的模板：'hello world'

意思就是说：当咱们访问http://xxxx#/abc的时候，这个路由规则被匹配到，对应的模板会被填到某个div[ui-view]中。

看上去彷佛很简单，那是由于咱们尚未深究具体的一些路由配置参数（咱们后面再说）。

这里须要深刻的是：$stateProvider.state(...)方法，它作了些什么工做？

  1. 首先，建立并存储一个state对象，里面包含着该路由规则的全部配置信息。
  2. 而后，调用$urlRouterProvider.when(...)方法，进行路由的注册(以前是路由的建立)，代码里是这样写的：
$urlRouterProvider.when(state.url, ['$match', '$stateParams', function ($match, $stateParams) {
  // 判断是不是同一个state || 当前匹配参数是否相同
  if ($state.$current.navigable != state || !equalForKeys($match, $stateParams)) {
    $state.transitionTo(state, $match, { inherit: true, location: false });
  }
}]);

上述代码的意思是：当hash值与state.url相匹配时，就执行后面那段回调，回调函数里面进行了两个条件判断以后，决定是否须要跳转到该state？

这里就插入了一个话题：为何说 “跳转到该state，而不是该url”？

其实这个问题跟你们一直说的：“ui.router是基于state(状态)的，而不是url”是同一个问题。

个人理解是这样的：以前就说过，路由存在着明确的父子关系，每个路由能够理解为一个state，

  1. 当程序匹配到某一个子路由时，咱们就认为这个子路由state被激活，同时，它对应的父路由state也将被激活。
  2. 咱们还能够手动的激活某一个state，就像上面写的那样，$state.transitionTo(state, ...);，这样的话，它的父state会被激活（若是尚未激活的话），它的子state会被销毁（若是已经激活的话）。

ok，回到以前的路由注册，调用了$urlRouterProvider.when(...)方法，它作了什么呢？

它建立了一个rule，并存储在rules集合里面，以后的，每次hash值变化，路由从新查找匹配都是经过遍历这个rules集合进行的。

路由的查找匹配

有了以前，路由的建立和注册，接下来，天然会想到路由是如何查找匹配的？

恐怕，这得从页面加载完毕提及：

  1. angular 在刚开始的$digest时，$rootScope会触发$locationChangeSuccess事件（angular在每次浏览器hash change的时候也会触发$locationChangeSuccess事件）
  2. ui.router 监听了$locationChangeSuccess事件，因而开始经过遍历一系列rules，进行路由查找匹配
  3. 当匹配到路由后，就经过$state.transitionTo(state,...)，跳转激活对应的state
  4. 最后，完成数据请求和模板的渲染

能够从下面这段源代码看到，看到查找匹配的起始和过程：

function update(evt) {
  // ...省略
  function check(rule) {
    var handled = rule($injector, $location);
// handled能够是返回：
// 1. 新的的url，用于重定向
// 2. false，不匹配
// 3. true，匹配
    if (!handled) return false;

    if (isString(handled)) $location.replace().url(handled);
    return true;
  }

  var n = rules.length, i;

  // 渲染遍历rules，匹配到路由，就中止循环
  for (i = 0; i < n; i++) {
    if (check(rules[i])) return;
  }
  // 若是都匹配不到路由，使用otherwise路由(若是设置了的话)
  if (otherwise) check(otherwise);
}

function listen() {
  // 监听$locationChangeSuccess，开始路由的查找匹配
  listener = listener || $rootScope.$on('$locationChangeSuccess', update);
  return listener;
}

if (!interceptDeferred) listen();

那么，问题来了：难道每次路由变化(hash变化)，因为监听了’$locationChangeSuccess'事件，都要进行rules的遍历来查找匹配路由，而后跳转到对应的state吗？

答案是：确定的，通常的路由器都是这么作的，包括ngRoute。

那么ui.router对于这样的问题，会怎么进行优化呢？

回归到问题：咱们之因此要循环遍历rules，是由于要查找匹配到对应的路由(state)，而后跳转过去，假若不循环，能直接找到对应的state吗？

答案是：能够的。

还记得前面说过，在用ui.router在建立路由时：

  1. 会实例化一个对应的state对象，并存储起来(states集合里面)
  2. 每个state对象都有一个state.name进行惟一标识(如：'home')

根据以上两点，因而ui.router提供了另外一个指令叫作：ui-sref指令，来解决这个问题，好比这样：

<a ui-sref="home">经过ui-sref跳转到home state</a>

当点击这个a标签时，会直接跳转到home state，而并不须要循环遍历rules，ui.router是这样作到的(这里简单说一下)：

首先，ui-sref="home"指令会给对应的dom添加click事件，而后根据state.name，直接跳转到对应的state，代码像这样：

element.bind("click", function(e) {
// ..省略若干代码
    var transition = $timeout(function() {
      // 手动跳转到指定的state
      $state.go(ref.state, params, options);
    });
});

跳转到对应的state以后，ui.router会作一个善后处理，就是改变hash，因此理所固然，会触发’$locationChangeSuccess'事件，而后执行回调，可是在回调中能够经过一个判断代码规避循环rules，像这样：

function update(evt) {
  var ignoreUpdate = lastPushedUrl && $location.url() === lastPushedUrl;

  // 手动调用$state.go(...)时，直接return避免下面的循环
  if (ignoreUpdate) return true;

  // 省略下面的循环ruls代码
}

说了那么多，其实就是想说，咱们不建议直接使用href="#/xxx"来改变hash，而后跳转到对应state(虽然也是能够的)，由于这样作会多了一步rules循环遍历，浪费性能，就像下面这样：

<a href="#/abc">经过href跳转到home state</a>

路由详解

这里详细地介绍ui.router的参数配置和一些深层次用法。

不过，在这以前，须要一个demo，ui.router的官网demo无非就是最好的学习例子，里面涉及了大部分的知识点，因此接下来的代码讲解大部分都会是这里面的(建议下载到本地进行代码学习)。

为了更好的学习这个demo，我画了一张图来描述这个demo的contacts部分各个视图模块，以下：

视图模块

父与子

以前就说到，在ui.router中，路由就有父与子的关系(多个父与子凑起来就有了，祖先和子孙的关系)，从javascript的角度来讲，其实就是路由对应的state对象之间存在着某种引用的关系。

ok，接下来就看下是如何定义路由的父子关系的？

假设有一个父路由，以下：

$stateProvider
.state('contacts', {});

ui.router提供了几种方法来定义它的子路由：

1.点标记法(推荐)

$stateProvider
.state('contacts.list', {});

经过状态名简单明了地来肯定父子路由关系，如：状态名为'a.b.c'的路由，对应的父路由就是状态名为'a.b'路由。

2.parent属性

$stateProvider
.state({
name: 'list',// 状态名也能够直接在配置里指定
parent: 'contacts'// 父路由的状态名
});

或者：

$stateProvider
.state({
name: 'list',// 状态名也能够直接在配置里指定
parent: {// parent也能够是一个父路由配置对象(指定路由的状态名便可)
name: 'contacts'
}
});

经过parent直接指定父路由，能够是父路由的状态名(字符串)，也能够是一个包含状态名的父路由配置(对象)。

居然路由有了父与子的关系，那么它们的注册顺序有要求嘛？

答案是：没有要求，咱们能够在父路由存在以前，建立子路由(不过，不是很推荐)，由于ui.router在遇到这种状况时，在内部会帮咱们先缓存子路由的信息，等待它的父路由注册完毕后，再进行子路由的注册。

模板渲染

当路由成功跳转到指定的state时，ui.router会触发'$stateChangeSuccess'事件通知全部的ui-view进行模板从新渲染。

代码是这样的：

if (options.notify) {
  $rootScope.$broadcast('$stateChangeSuccess', to.self, toParams, from.self, fromParams);
}

而ui-view指令在进行link的时候，在其内部就已经监听了这一事件(消息)，来随时更新视图：

scope.$on('$stateChangeSuccess', function() {
  updateView(false);
});

大致的模板渲染过程就是这样的，这里遇到一个问题，就是：每个 div[ui-view]在从新渲染的时候如何获取到对应视图模板的呢?

要想知道这个答案，

首先，咱们得先看一下模板如何设置？

通常在设置单视图的时候，咱们会这样作：

$stateProvider
.state('contacts', {
abstract: true,
url: '/contacts',
templateUrl: 'app/contacts/contacts.html'
});

在配置对象里面，咱们用templateUrl指定模板路径便可。

若是咱们须要设置多视图，就须要用到views字段，像这样：

$stateProvider
.state('contacts.detail', {
url: '/{contactId:[0-9]{1,4}}',
views: {
'' : {
templateUrl: 'app/contacts/contacts.detail.html',
},
'hint@': {
template: 'This is contacts.detail populating the "hint" ui-view'
},
'menuTip': {
templateProvider: ['$stateParams', function($stateParams) {
return '<hr><small class="muted">Contact ID: ' + $stateParams.contactId + '</small>';
}]
}
}
});

这里咱们使用了另外两种方式设置模板：

  1. template：直接指定模板内容，另外也能够是函数返回模板内容
  2. templateProvider：经过依赖注入的调用函数的方式返回模板内容

上述咱们介绍了设置单视图和多视图模板的方式，其实最终它们在ui.router内部都会被统一格式化成的views的形式，且它们的key值会作特殊变化：

上述的单视图会变成这样：

views: {
// 模板内容会被安插在根路由模板(index.html)的匿名视图下
'@': {
abstract: true,
url: '/contacts',
templateUrl: 'app/contacts/contacts.html'
}
}

多视图会变成这样：

views: {
// 模板内容会被安插在父路由(contacts)模板的匿名视图下
'@contacts': {
templateUrl: 'app/contacts/contacts.detail.html',
},
// 模板内容会被安插在根路由(index.html)模板的名为hint视图下
'hint@': {
template: 'This is contacts.detail populating the "hint" ui-view'
},
// 模板内容会被安插在父路由(contacts)模板的名为menuTip视图下
'menuTip@contacts': {
templateProvider: ['$stateParams', function($stateParams) {
return '<hr><small class="muted">Contact ID: ' + $stateParams.contactId + '</small>';
}]
}
}

咱们会发现views对象里面的key变化了，最明显的是出现了一个@符号，其实这样的key值是ui.router的一个设计，它的原型是：viewName + '@' + stateName，解释下：

  1. viewName
  2. 指的是ui-view="status"中的'status'
  3. 也能够是''(空字符串)，由于会有匿名的ui-view或者ui-view=""
  4. stateName
    -默认状况下是父路由的state.name，由于子路由模板通常都安插在父路由的ui-view中
  5. 也能够是''(空字符串)，表示最顶层rootState
  6. 还能够是任意的祖先state.name

这样原型的意思是，表示该模板将会被安插在名为stateName路由对应模板的viewName视图下(能够看看上面代码中的注释理解下)。

其实这也解释了以前我说的：“为何state.name里面不能存在@符号”？由于@在这里被用于特殊含义了。

因此，到这里，咱们就知道在ui-view从新进行模板渲染时，是根据viewName + '@' + stateName来获取对应的视图模板内容(其实还有controller等)的。

其实，因为路由有了父与子的关系，某种程度上就有了override(覆盖或者重写)可能。

父路由和子路由之间就存在着视图的override，像下面这段代码：

$stateProvider
.state('contacts.detail', {
url: '/{contactId:[0-9]{1,4}}',
views: {
            'hint@': {
              template: 'This is contacts.detail populating the "hint" ui-view'
            }
}
});

$stateProvider
.state('contacts.detail.item', {
url: '/item/:itemId',
views: {
            'hint@': {
              template: ' This is contacts.detail.item overriding the "hint" ui-view'
            }
}
});

上面两个路由(state)存在着父与子的关系，且他们都对@hint定义了视图，那么当子路由被激活时(它的父路由也会被激活)，咱们应该选择哪一个视图配置呢？

答案是：子路由的配置。

具体的，ui.router是如何实现这样的视图override的呢？

简单地回答就是：经过javascript原型链实现的，你能够在每次路由切换成功后，尝试着打印出$state.current.locals这个变量一看究竟。

还有一个很重要的问题，关乎性能：当咱们子路由变化时，页面中全部的ui-view都会从新进行渲染吗？

答案是：不会，只会从子路由对应的视图开始局部从新渲染。

在每次路由变化时，ui.router会记录变化的子路由，并对子路由进行从新的预处理(包括controller，reslove等)，最后局部更新对应的ui-view，父路由部分是不会有任何变化的。

controller控制器

有了模板以后，必然不可缺乏controller向模板对应的做用域(scope)中填写数据，这样才能够渲染出动态数据。

咱们能够为每个视图添加不一样的controller，就像下面这样：

$stateProvider
.state('contacts', {
abstract: true,
url: '/contacts',
templateUrl: 'app/contacts/contacts.html',
        resolve: {
        'contacts': ['contacts',
            function( contacts){
                return contacts.all();
             }]
         },
controller: ['$scope', '$state', 'contacts', 'utils',
function ($scope,   $state,   contacts,   utils) {
// 向做用域写数据
$scope.contacts = contacts;
}]
});

注意：controller是能够进行依赖注入的，它注入的对象有两种：

  1. 已经注册的服务(service)，如：$state，utils
  2. 上面的reslove定义的解决项(这个后面来讲)，如：contacts

可是无论怎样，目的都是：向做用域里写数据。

reslove解决项

resolve在state配置参数中，是一个对象(key-value)，每个value都是一个能够依赖注入的函数，而且返回的是一个promise(固然也能够是值，resloved defer)。

咱们一般会在resolve中，进行数据获取的操做，而后返回一个promise，就像这样：

resolve: {
    'contacts': ['contacts',
        function( contacts){
            return contacts.all();
     }]
 }

上面有好多contacts，为了避免混淆，我改一下代码：

resolve: {
    'myResolve': ['contacts',
        function(contacts){
            return contacts.all();
     }]
 }

这样就看清了，咱们定义了resolve，包含了一个myResolve的key，它对应的value是一个函数，依赖注入了一个服务contacts，调用了contacts.all()方法并返回了一个promise。

因而咱们即可以在controller中引用myResolve，像这样：

controller: ['$scope', '$state', 'myResolve', 'utils',
    function ($scope,   $state,   contacts,   utils) {
    // 向做用域写数据
    $scope.contacts = contacts;
}]

这样作的目的：

  1. 简化了controller的操做，将数据的获取放在resolve中进行，这在多个视图多个controller须要相同数据时，有必定的做用。
  2. 只有当reslove中的promise所有resolved(即数据获取成功)后，才会触发'$stateChangeSuccess'切换路由，进而实例化controller，而后更新模板。

另外，子路由的resolve或者controller都是能够依赖注入父路由的resolve提供的数据服务，就像这样：

$stateProvider
    .state('parent', {
        url: '',
        resolve: {
            parent: ['$q', '$timeout', function ($q, $timeout) {
                var defer = $q.defer();
                $timeout(function () {
                    defer.resolve('parent');
                }, 1000);
                return defer.promise;
            }]
        },
        template: 'I am parent <div ui-view></div>'
    })
    .state('parent.child', {
        url: '/child',
        resolve: {
            child: ['parent', function (parent) {// 调用父路由的解决项
                return parent + ' and child';
            }]
        },
        controller: ['child', 'parent', function (child, parent) {// 调用自身的解决项，以及父路由的解决项
            console.log(child, parent);
        }],
        template: 'I am child'
    });

另外每个视图也能够单独定义本身的resolve和controller，它们也是能够依赖注入自身的state.resolve，或者view下的resolve，或者父路由的reslove，就像这样：

html

<div ui-view></div>
  <div ui-view="status"></div>

javascript:

$stateProvider
    .state('home', {
        url: '/home',
        resolve: {
            common: ['$q', '$timeout', function ($q, $timeout) {// 公共的resolve
                var defer = $q.defer();
                $timeout(function () {
                    defer.resolve('common data');
                }, 1000);
                return defer.promise;
            }],
        },
        views: {
            '': {
                resolve: {
                    special: ['common', function (common) {// 访问state.resolve
                        console.log(common);
                    }]
                }
            },
            'status': {
                resolve: {
                    common: function () {// 重写state.resolve
                        return 'override common data'
                    }
                },
                controller: ['common', function (common) {// 访问视图自身的resolve
                    console.log(common);
                }]
            }
        }
    });

总结一下：

  1. 路由的controller除了能够依赖注入正常的service，也能够依赖注入resolve
  2. 子路由的resolve能够依赖注入父路由的resolve，也能够重写父路由的resolve供controller调用
  3. 路由能够有单独的state.resolve以外，还能够在views视图中单独配置resolve，视图resolve是能够依赖注入自身state.resolve甚至是父路由的state.resolve
相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程