Prism教程四： Region

Region可以帮助我们开发模块化程序，将程序分割成一个个独立的Module，分别进行开发。然后在程序运行的时候，将各个Module组合到一起，为程序提供各种各样的功能。通常来说，Module是一些视图和功能的集合，那么就需要一种办法来将这些视图以某种形式，在特定的时间展示出来。Prism通过Shell+Region来组织视图的布局，完成视图间的转换等。

如上图所示，Shell相当于ASP.NET中的母版页，它定义了页面的布局、主题等。其中的导航区和内容区是预留出来的需要进行填充内容的部分，也就是Region，起到占位符的作用，程序会在运行时动态地向Region中填充内容。

那么如何将一个区域定义为Region呢？

1. 首先要引入Prism命名空间

xmlns:prism="http://www.codeplex.com/prism" 如果IDE无法找到这个命名空间的话，需要先注册Prism。

2. 然后再需要定义为Region的控件上加上Attached Property。

并不是所哟的控件都可以作为Region的，需要为需要定义为Region的控件添加RegionAdapter。RegionAdapter的作用是为特定的控件创建相应的Region，并将控件与Region进行绑定，然后为Region添加一些行为。一个RegionAdapter需要实现IRegionAdapte接口，如果你需要自定义一个RegionAdapter，可以通过继承RegionAdapterBase类来省去一些工作。Prism为Silverlight提供了几个RegionAdapter：

ContentControlRegionAdapter：创建一个SingleActiveRegion并将其与ContentControl绑定。

ItemsControlRegionAdapter： 创建一个AllActiveRegion并将其与ItemsControl绑定。

SelectorRegionAdapter： 创建一个Region并将其与Selector绑定。

TabControlRegionAdapter： 创建一个Region并将其与TabControl绑定。

从图中可以看到，导航区对应的NavigationRegion中四个视图都是亮着的，而内容区对应的ContentRegion中四个视图只有一个是亮着的（橙色代表显示在页面中）。ItemsControl本来就是由许多个Items组成的，因此ItemsControlRegionAdapter会创建AllActiveRegion，这种类型的Region中所有Active的视图都会显示在ItemsControl中；而ContentControl只能容纳一个Content，所以ContentControlRegionAdapter创建了一个SingleActiveRegion，其中的视图只有一个处于Active状态的，会显示在ContentControl中，其他的都是不可见的，需要将他们激活（Active），才能使其显示。

通常我们并不直接和Region打交道，而是通过RegionManager，它实现了IRegionManager接口。IRegionManager接口包含一个只读属性Regions，是Region的集合，还有一个CreatRegionManager方法。Prism通过RegionManagerExtensions类使用扩展方法为IRegionManager添加更多的功能。

AddToRegion：将一个视图添加到一个Region中。

RegisterViewWithRegion：将一个视图和一个Region进行关联。当Region显示的时候，关联的视图才会显示，也就是说，在这个Region显示之前，关联的视图是不会被创建的。

RequestNavigate：进行页面切换，将指定的Region中显示的视图切换为指定的视图。

本文开头说过，需要在运行时将分散的各个Module的视图显示在页面特定的位置上。那么首先就需要定义页面显示的地方，即Region。然后就是要定义创建视图的时机和方式。在Prism中有两种方式来定义视图与Region之间的映射关系——View Discovery和View Injection。

View Discovery是以声明式的方式来建立Region和视图之间的关系。如上图中的导航区，需要在导航区显示的时候就将各个导航视图填充到其中。而内容区也需要一个默认显示的内容视图。因此也可以这样理解View Discovery，就是指定一个Region的默认视图。我们可以使用IRegionManager.RegisterViewWithRegion方法来声明某个Region默认应该显示哪个视图。注意这里的是Register，是注册，也就是说不会马上创建该视图。当Region显示在页面中的时候，它回去寻找与自己关联的视图，并对其进行初始化。

这样做的好处是我们不必关心在什么时候创建视图，一切都会自动完成。缺点就是默认视图是确定的，当需要进行视图转换的时候，这种方式就行不通了。这时候就需要View Injection。

View Injection可以让我们对于Region中显示的视图有更精确的控制。通常可以通过调试IRegionManager.AddToRegion方法或者死IRegionManager.Regions["RegionName"].Add方法来向一个Region中添加一个视图的实例。对于SingleActiveRegion（ContentControlRegionAdapter会创建这种类型的Region），可以通过IRegion.Activate方法将一个已经添加到Region中的视图显示出来。当然也可以通过IRegion.Deactivate方法来将视图状态置为非激活或者干脆调用IRegion.Remove方法将视图移除。可以看到，因为要添加的是视图的实例，所以需要仔细地设计在什么时候使用View Injection，以免造成不必要的开销。

在Prism 4.0 中新添加了一些导航API，这套API大大地简化了View Injection的流程，它使用URI来进行Region中视图的导航，然后会根据URI来创建视图，并将其添加到Region中，然后激活该视图。导航API的出现不只是为了简化View Injection的过程，它还提供了前进、后退的功能，并且对MVVM模式下的导航有良好的支持，还能够在进行导航的时候传递参数等等。所以推荐的方式是使用新的导航API，也就是使用IRegionManager.RequestNavigate方法。

如果一个页面相对来说不大变化，如导航区，在程序初始化的过程完成后就不会轻易变动，这时候就较适合私用RegisterViewRegion方法，通常可以在Module的Initialize方法中完成这个过程。

下面通过一个Demo来学习Region：

1. 新建一个Silverlight Application——“PrismRegionDemo”，然后再创建3个Silverlight类库工程：

2. 首先在Infrastructure——基础结构项目中来实现一些需要使用的Prism的接口。首先在该项目中引用Microsoft.Practices.Prism程序集，然后新建一个类CallbackLogger.cs该类实现了Prism内置的ILoggerFacade接口，在Prism提供的QuickStart项目里的Modularity中，有一个CallBackLogger，这里我们直接拿过来使用。该类是为了在UI上显示LOG信息使用。然后再PrismRegionShell中放一个TextBox，将log的内容显示在这个TextBox中。

using System;
using System.Net;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Documents;
using System.Windows.Ink;
using System.Windows.Input;
using System.Windows.Media;
using System.Windows.Media.Animation;
using System.Windows.Shapes;
using Microsoft.Practices.Prism.Logging;
using System.Collections.Generic;

namespace Infrastrcture
{
    //A logger that holds on to log entries until a callback delegate is set, then plays back log entries and sends new log entries.

    public class CallBackLogger:ILoggerFacade
    {
        private Queue> saveLogs = new Queue>();
        private Action callback;


        //Gets or Sets the callback to receive logs.
        public Action CallBack
        {
            get
            {
                return this.callback;
            }
            set
            {
                this.callback = value;
            }
        }

        /// 

        /// Write a new log entry with the specified category and priority.
        /// 
        /// Message body to log.
        /// Category of the entry.
        /// The priority of the entry.
        public void Log(string message, Category category, Priority priority)
        {
            if (this.CallBack != null)
            {
                this.CallBack(message, category, priority);
            }
            else
            {
                saveLogs.Enqueue(new Tuple(message, category, priority));
            }
        }

        //Replay the saved logs if the Callback has been set.
        public void ReplaySaveLogs()
        {
            if (this.CallBack != null)
            {
                while (this.saveLogs.Count > 0)
                {
                    var log = this.saveLogs.Dequeue();
                    this.CallBack(log.Item1, log.Item2, log.Item3);
                }
            }
        }
    }
}

3. 在Infrastructure里创建一个类RegionNames，用来存储RegionName的常量字符串。

    public class RegionNames
    {
        public const string NavRegion = "NavRegion";
        public const string MainRegion = "MainRegion";
        public const string NavDemoShowRegion = "NavDemoShowRegion";
        public const string NavDemoActionRegion = "NavDemoActionRegion";
        public const string TabShowRegion = "TabShowRegion";
    }

4. 在Infrastructure里新建一个类ViewNames，用来存储ViewNames常量字符串。

    public class ViewNames
    {
        public const string NavigationContainer = "NavigationContainer";
        public const string EmptyPage = "EmptyPage";
        public const string ViewA = "ViewA";
        public const string ViewB = "ViewB";
        public const string ViewC = "ViewC";
    }

5. 删除PrismRegionDemo项目中自动生成的MainPage.xaml，创建一个新的UserControl，叫做PrismRegionShell。添加对Prism程序集的引用（Microsoft.Practices.Prim;Microsoft.Pratices.Prism.UnityExtensions;Microsoft.Practices.Unity.Silverlight）,并且还要添加对页面导航的引用（System.Windows.Controls.Navigatio），以及Infrastructure项目的引用，页面代码如下：

PrismRegionShell中放一个TextBox，将log的内容显示在这个TextBox中。值得一提的是，为了让输出新log的直接显示出来，需要将TextBox的滚动条滚动到最下面。PrismRegionShell.xaml.cs如下：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Documents;
using System.Windows.Input;
using System.Windows.Media;
using System.Windows.Media.Animation;
using System.Windows.Shapes;
using Infrastrcture;
using Microsoft.Practices.Prism.Logging;
using System.Globalization;

namespace PrismRegionDemo
{
    public partial class PrismRegionShell : UserControl
    {
        public PrismRegionShell(CallBackLogger logger)
        {
            InitializeComponent();
            //显示当前Log信息
            logger.CallBack = Log;
        }

        public void Log(string message, Category category, Priority priority)
        {
            //[Debug][Low] Setting the RegionManager.
            this.LogContainer.Text += string.Format(CultureInfo.CurrentUICulture, "[{0}][{1}] {2}\r\n", category, priority, message);
            //这段代码的作用是让文本框的滚动条滚动到最底部
            LogContainer.Select(LogContainer.Text.Length, LogContainer.Text.Length);
        }
    }
}

6. 在EmptyDemoModule中新建一个UserControl——EmptyNavigationItem.xaml，这里只有一个导航按钮"空示例"

这里也要对该项目添加3个Prim的类库引用（Microsoft.Practices.Prism; Microsoft.Practices.Prism.UnityExtensions;Microsoft.Practces.Unity.Silverlight）以及Infrastructure项目，CodeBehind代码如下：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Documents;
using System.Windows.Input;
using System.Windows.Media;
using System.Windows.Media.Animation;
using System.Windows.Shapes;
using Microsoft.Practices.Prism.Regions;
using Microsoft.Practices.Prism.Logging;
using Infrastrcture;

namespace EmptyDemoModule
{
    //ViewSortHintAttribute是为了指定哪个View先在Region中显示出来，设置为02的意思是当前排序优先级为02
    [ViewSortHint("02")] 
    public partial class EmptyNavigationItem : UserControl
    {
        IRegionManager _regionManager;
        ILoggerFacade logger;

        public EmptyNavigationItem(IRegionManager regionManager,ILoggerFacade logger)
        {
            logger.Log("初始化【空示例】按钮", Category.Info, Priority.Low); //显示Log信息
            InitializeComponent();
            this._regionManager = regionManager;
            this.logger = logger;
        }

        private void Button_Click(object sender, RoutedEventArgs e)
        {
            Uri uri = new Uri(ViewNames.EmptyPage, UriKind.Relative);
            //导航到MainRegion,把Uri指向的Page显示在PrismRegionShell里命名为MainRegion的Region里
            _regionManager.RequestNavigate(RegionNames.MainRegion, uri);
            //显示Log信息
            logger.Log("导航到Empty示例", Category.Info, Priority.Low);
        }
    }
}

这里需要注意的是，一个Region里需要同时显示多个视图时，视图的顺序问题。比如ItemsControl，哪个先被注册就哪个显示在上面，但是由于Module的加载速度等原因，这时候就无法判断哪个视图会在上面，现在我们需要指定[导航示例]这个按钮在上，那么Prism为我们提供了ViewSortHintAttribute来解决这个问题。在需要进行排序的视图上添加上相应的Attribute就可以了。

7. 在EmptyDemoModule里新建一个EmptyPage的Usercontrol，用于显示在点击“空示例”后，在MainRegion里显示的Page：

8. 在EmptyDemoModule里新建一个类EmptyModule用于初始化Empty模块，该类实现了Prism的IModule接口。

using System;
using System.Net;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Documents;
using System.Windows.Ink;
using System.Windows.Input;
using System.Windows.Media;
using System.Windows.Media.Animation;
using System.Windows.Shapes;
using Microsoft.Practices.Prism.Modularity;
using Microsoft.Practices.Prism.Regions;
using Microsoft.Practices.Unity;
using Microsoft.Practices.Prism.Logging;
using Infrastrcture;

namespace EmptyDemoModule
{
    public class EmptyModule:IModule
    {
        IRegionManager _regionManager;
        IUnityContainer _container;
        ILoggerFacade logger;

        public EmptyModule(IUnityContainer container,IRegionManager regionManager,ILoggerFacade logger)
        {
            _container = container;
            _regionManager = regionManager;
            this.logger = logger;
        }

        public void Initialize()
        {
            //添加显示Log信息
            logger.Log("初始化Empty模块", Category.Debug, Priority.Low);
            //把EmptyNavigationItem这个"按钮"View注册到RegionName为NavRegion的Region上
            _regionManager.RegisterViewWithRegion(RegionNames.NavRegion, typeof(EmptyNavigationItem));
            //由于EmptyPage是需要显示在ContentControl里的，同一时刻只能显示一个视图，所以在添加进去之后还需要一个Active的过程，
            //因为Prism无法确定每个视图是什么类型，所以就使用了Object，因此在根据ViewName获取实例时，
            //会使用IServiceLocator.GetInstance