路由ui-router

拼搏现实的明天。 2022-05-26 10:15 188阅读 0赞

# 路由ui-router #

Angular ngRoute针对于单视图，而ui-router可用于多视图（这里说的视图是指在页面内我们可控制的，可变化的区域）。比如我们点击了一个link，我们需要在视图中跳转到指定的一个页面，那么ngRoute已经满足了我们的需求，而当我们点击的时候，需要分别在不同的地方跳转两个不同的页面的时候，ngRoute就不够用了，我们就需要用到ui-router。

在ui-router中，有3个关键词：状态（state）、Url、模板（template），也就是说，它在ng-route的基础之上，增加了“状态”的概念。这三者是一对一的关系：每一个模板，存在于一个特定的Url，同时也对应于一个独一无二的状态。

所以，我们想要在代码中控制页面跳转的时候，既可以基于url，用href的方式进行跳转，也可以进行状态的转换，两者都可以达到切换template的目的。

## $urlRouterProvider ##

urlRouterProvider负责监听  u r l R o u t e r P r o v i d e r 负 责 监 听 location.当location变化的时候，  l o c a t i o n 变 化 的 时 候 ， urlRouterProvider开始在一个规则的列表中一个个的查找，直到找到匹配的值。$urlRouterProvider用于在后端指定url的状态配置。所有的url被编译成UrlMatcher对象。

**otherwise(rule);**

定义一个当请求的路径是无效路径时跳转的路径。  
rule：你想重定向的url路径或一个返回的网址路径的规则函数。函数传入两个参数：injector和  i n j e c t o r 和 location服务，而且必须返回一个string的url。  
代码：

angular.module('Demo',['ui.router'])
    .config(["$urlRouterProvider",function(){ 
    $urlRouterProvider.otherwise(rule); // rule = 重定向的url规则
    }])

## $state ##

$state服务负责代表状态及提供状态之间的转换。它还提供你当前的状态及上一个状态。

### 方法 ###

**get(stateOrName,context);**  
返回任何指定的状态或所有状态的配置对象。  
参数：  
stateOrName：如果提供此参数，返回的是指定状态的配置对象；如果不提供此参数，则返回全部状态的配置对象。  
context：当context是一个相对的参考状态，状态会在相关上下文中检索。

**go(to,params,options);**  
参数：  
to：string，即将跳转的状态。  
params:object，跳转所带的参数。  
options：object，可选配置对象。有 location(是否更新地址栏的url，或以什么字符串替换url)，inherit(是否继承当前url的参数)，relative(当变化相对路径：如”^,定义的状态是相对的)，notify(是否广播stateChangeStart和  s t a t e C h a n g e S t a r t 和 stateChangeSuccess事件)，reload(是否重新载入)。  
代码：  
`$state.go('contact.detail');`

**href(stateOeName,params,options);**  
一个URL生成方法，返回为给定的状态填充指定的参数编译后的链接。  
参数：  
stateOeName：string，你想要生成的url的状态或者状态对象。  
params：object，一个用于填充状态需要的参数的对象。  
options：可选配置对象。有lossy(当第一个参数url未被提供时是否继承导航的url进行构建href),inherit(是否继承当前url的参数),relative(当变化相对路径：如”^,定义的状态是相对的),absolute(是否生成绝对url)。  
代码：  
`$state.href("about.person", { person: "bob" })`

### 事件 ###

**$stateChangeError**  
路由状态变化发生错误时触发的事件。参数有：event，toState，toParams，fromState，fromParams，error。  
**$stateChangeStart**  
路由状态变化发生前触发的事件。参数有：event，toState，toParams，fromState，fromParams。  
**$stateChangeSuccess**  
路由状态变化正确时触发的事件。参数有：event，toState，toParams，fromState，fromParams。  
**$stateNotFound**  
路由状态没找到的时候触发的事件。参数有：event，unfoundState，fromState，fromParams。

## $stateProvider ##

处理路由状态的服务，路由的状态反映了该项在应用程序中的位置，描述了在当前状态下UI是应该怎么样的，并且该做什么。

**state(name,stateConfig);**  
注册一个状态，并给定其配置。  
参数：  
name：状态的名称。  
stateConfig：状态配置对象。配置具有以下各项属性：  
\* template： string/function，html模板字符串，或者一个返回html模板字符串的函数。  
\* templateUrl：string/function，模板路径的字符串，或者返回模板路径字符串的函数。  
\* templateProvider：function，返回html模板字符串或模板路径的服务。  
\* controller：string/function，新注册一个控制器函数或者一个已注册的控制器的名称字符串。  
\* controllerProvider：function，返回控制器或者控制器名称的服务  
\* controllerAs：string，控制器别名。  
\* parent：string/object，手动指定该状态的父级。  
\* resolve：object，将会被注入controller去执行的函数，`<string,function>`形式。  
\* url：string，当前状态的对应url。  
\* views：object，视图展示的配置。`<string,object>`形式。  
\* abstract：boolean，一个永远不会被激活的抽象的状态，但可以给其子级提供特性的继承。默认是true。  
\* onEnter：function，当进入一个状态后的回调函数。  
\* onExit：function，当退出一个状态后的回调函数。  
\* reloadOnSearch：boolean，如果为false，那么当一个search/query参数改变时不会触发相同的状态，用于当你修改`$location.search()`的时候不想重新加载页面。默认为true。  
\* data：object，任意对象数据，用于自定义配置。继承父级状态的data属性。换句话说，通过原型继承可以达到添加一个data数据从而整个树结构都能获取到。  
\* params：url里的参数值，通过它可以实现页面间的参数传递。

## ui-sref ##

一种将链接（`<a>`标签）绑定到一个状态的指令。点击该链接将触发一个可以带有可选参数的状态转换。

## 使用示例 ##

### 简单的使用代码(ui-router的单视图)： ###

### 使用代码(ui-router的多视图)： ###

angular.module('Demo', ['ui.router'])
    .config(["$stateProvider","$urlRouterProvider",routeConfig])
    .controller("testCtrl", angular.noop)
    function routeConfig($stateProvider,$urlRouterProvider){
    $urlRouterProvider.otherwise("/app/page1");
    $stateProvider
    .state("app",{
    url:"/app",
    views:{
    "":{
    templateUrl:"'layout.html'"
    },
    "nav":{
    templateUrl:"'nav1.html'"
    }
    }
    })
    .state("app.page1",{
    url:"/page1",
    templateUrl:"'page1.html'"
    })
    .state("app.page2",{
    url:"/page2",
    templateUrl:"'page2.html'"
    })
    .state("test",{
    url:"/test",
    views:{
    "":{
    templateUrl:"'layout.html'"
    },
    "nav":{
    templateUrl:"'nav2.html'"
    }
    }
    })
    .state("test.page1",{
    url:"/page1?:id",
    templateUrl:"'page3.html'",
    controller:["$stateParams",function($stateParams){
    console.log($stateParams.id);// 1 这里实现传参
    }],
    params:{
    id:null
    }
    })
    .state("test.page2",{
    url:"/page2",
    templateUrl:"'page4.html'"
    })
    }

### 一般使用 ###

假如我们现在有3个页面，模板分别为page1.html、page2.html、page3.html，同时我们分别给予一个状态：one、two、three。如果我们想要下图的跳转效果：

![这里写图片描述][70]

即1可以跳到2，2可以跳到3，3又可以跳回1。我们可以这么做：

（1）在templates文件夹下新建3个模板（为了举例，这里模板的内容很简单），其中设置一个可以跳转的按钮，按钮带有一个叫做“ui-sref”的属性，用来填入一个state：

page1.html

<ion-nav-view>
    <ion-content>
    <p>
    This is page 1.
    </p>
    
    <a class="button" ui-sref="two">go to page2</a>
    </ion-content>
    </ion-nav-view>

同理，页面2和页面3：

page2.html

<ion-nav-view>
    <ion-content>
    <p>
    This is page 2.
    </p>
    <a class="button" ui-sref="three">go to page3</a>
    </ion-content>
    </ion-nav-view>

page3.html

<ion-nav-view>
    <ion-content>
    <p>
    This is page 3.
    </p>
    <a class="button" ui-sref="one">go to page1</a>
    </ion-content>
    </ion-nav-view>

（2）在app.js中配置路由：

在config过程中配置。我们需要使用到服务stateProvider，它用来设置状态路由。另外，还有一个  s t a t e P r o v i d e r ， 它 用 来 设 置 状 态 路 由 。 另 外 ， 还 有 一 个 urlRouterProvider，它通常用来设置打开App后默认跳转的Url，即启动页面。  
上述例子的路由配置为：

...
    .config(function ($stateProvider, $urlRouterProvider) {
    // $stateProvider用来配置状态路由
    $stateProvider
    .state('one', { // "one"是页面1的状态
    url: '/one', // "/one"是页面1的Url
    templateUrl: 'templates/page1.html' // "page1.html"是页面1的模板
    })
    .state('two', {
    url: '/two',
    templateUrl: 'templates/page2.html'
    })
    .state('three', {
    url: '/three',
    templateUrl: 'templates/page3.html'
    });
    // 以上匹配都失败的情况下，进行下面的匹配
    // 通常用在配置第一个进入的界面，比如这里定义了首先进入界面2
    $urlRouterProvider.otherwise('/one');
    });

### ui-router路由在ion-tabs中的使用 ###

如果应用存在ion-tab元素，那么路由的配置会复杂那么一点点。具体来说，还是我们上面的例子，假如这时候我需要把这3个页面分别对应于3个tab（即底部选项卡），那就需要考虑更多：  
因为底部栏是3个页面中的公共部分，所以我们可以抽出来作为一个“父模板”（tabs.html），其状态为“tabs”，url为“\#/tabs”  
然后，原来的3个模板就作为它的子模板，对应的状态就得使用符号“.”连接上父状态，来设置成“tabs.one”、“tabs.two”、“tabs.three”。如此一来，对应的URL就变成了“\#/tabs/one”、“\#/tabs/two”、“\#/tabs/three”。

（1）创建带有3个tab的模板tabs.html，它作为3个page的“父模板”，并且在每一个tab上使用ui-sref属性来建立点击的跳转：  
tabs.html

<ion-tabs>
    
    <ion-tab title="1" ui-sref="tabs.one">
    
    <ion-nav-view name="for_template_page_1"></ion-nav-view>
    </ion-tab>
    <ion-tab title="2" ui-sref="tabs.two">
    <ion-nav-view name="for_template_page_2"></ion-nav-view>
    </ion-tab>
    <ion-tab title="3" ui-sref="tabs.three">
    <ion-nav-view name="for_template_page_3"></ion-nav-view>
    </ion-tab>
    </ion-tabs>

（2）修改app.js中的路由配置（解说在注释里）：

...
    $stateProvider
    .state('tabs', { //父页面的状态
    url: '/tabs', //父页面的Url
    abstract: true, //true表示该页面作为一个父页面，父页面其实可以理解成3个子页面的共同部分，即底部的3个tab。配置之后，父页面不能单独存在。
    templateUrl: 'templates/tabs.html'
    })
    .state('tabs.one', { //页面1的状态。注意这里不再是one，而是tabs.one，即子状态，这样的Url就会自动带上父页面的Url，即/tabs/one
    url: '/one', //注意写法，这里不用带上父url，不要写成/tabs/one
    views: {
    'for_template_page_1': { //这里填入tab子页面的容器的名字，对应于tabs.html中<ion-nav-view>的name属性
    templateUrl: 'templates/page1.html' //这里表示：在"for_template_page_1"这个tab中装载"templates/page1.html"这个模板
    }
    }
    })
    .state('tabs.two', { //其余的同上
    url: '/two',
    views: {
    'for_template_page_2': {
    templateUrl: 'templates/page2.html'
    }
    }
    })
    .state('tabs.three', {
    url: '/three',
    views: {
    'for_template_page_3': {
    templateUrl: 'templates/page3.html'
    }
    }
    });

改写之后，路由属性嵌套得比较多，所以要写清楚。错了一个地方，通常会导致页面显示不出来。

[70]: /images/20220526/eb82e77417bf4d0f8c9c91ae6be1b04f.png