准备.Net转前端开发-WPF界面框架那些事，搭建基础框架
Posted Heavi的博客
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了准备.Net转前端开发-WPF界面框架那些事，搭建基础框架相关的知识，希望对你有一定的参考价值。
题外话
最近都没怎么写博客，主要是最近在看WPF方面的书《wpf-4-unleashed.pdf》，挑了比较重要的几个章节学习了下WPF基础技术。另外，也把这本书推荐给目前正在从事WPF开发的程序猿。 现在书看完了也该实践实践，写了个WPF项目，主要以界面框架为主。 最近的几篇博客也主要围绕这个WPF项目，介绍下WPF搭建界面框架以及怎样写自定义的Windows界面和控件。
这也许是写最后几篇关于.Net技术的博客。做.Net开发也快五年了，感觉自己搞得不温不火，另外工作中正好有一个机会转做前段开发。稳稳当当的做年几年.Net开发，也想给自己一个挑战的机会。所以这几篇博客完成后，更多的可能是涉及前段开发。
雷军通知常常爱说：不忘初心，不忘初心、，不忘初心。重要的事说三遍。走在程序猿的路上，别忘了自己的初心，是做一个牛逼的程序猿呢还是做一个非常牛逼的程序猿呢？come on-打着鸡血一般的奋斗吧！
设计思路
前段时间看了下ASP.NET请求过程的管道运行，其中包含有IHttpModule接口，通过接口的扩展，可以让各个模块独立化，例如登录认证、权限认证以及处理IHttpHandler。同理，我们可以让WPF系统启动过程中独立加载各个模块，包括系统资源模块、主题资源模块、登录模块、用户认证模块、权限管理模块、以及自定义模块等。先来看下系统仅有的两个配置文件，分别是Application.xml和Startup.xml。Application.xml结构如下图所示：
<?xml version="1.0" encoding="utf-8" ?> <Application xmlns="http://tempuri.org/ApplicationSchema.xsd" xmlns:mstns="http://tempuri.org/ApplicationSchema.xsd"> <Attributes> <Attr mstns:Name="stsdb" mstns:Value="Data/db.stsdb4"/> </Attributes> </Application>
上图中，我们很容易的看出Application.xml主要存放字典资源，例如数据库的配置。sttsdb是数据库的字典名，而"Data/db.stsdb4"是数据库的路径。节点Attr表示一个字典项。
除了Application.xml文件，Startup.xml配置文件是整个系统的核心部分，因为我们系统启动的整个流程都体现在配置内容中。先看看节点结构：
<?xml version="1.0" encoding="utf-8" ?> <Startup xmlns="http://tempuri.org/StartupSchema.xsd" xmlns:xsi="http://tempuri.org/StartupSchema.xsd"> <Startup.Modules> <ResourceModules> <Add xsi:Type="HeaviSoft.Documentor.Theme.Implements.ThemeModule, HeaviSoft.Documentor.Theme"/> </ResourceModules> <LoginModules> <Add xsi:Name="LoginModule" xsi:Type="HeaviSoft.Documentor.Presentation.Login.Implements.LoginModule,HeaviSoft.Documentor.Presentation.Login"/> </LoginModules> <AuthenticationModules> <Add xsi:Name="AuthenticationModule" xsi:Type="HeaviSoft.Documentor.Application.Security.AuthenticationModule, HeaviSoft.Documentor.Application.Security" /> </AuthenticationModules> <AuthorizationModules> </AuthorizationModules> <ExecutionModules> <Add xsi:Type="HeaviSoft.Documentor.Presentation.Docking.Implements.ExecutionModule, HeaviSoft.Documentor.Presentation.Docking"/> </ExecutionModules> </Startup.Modules> </Startup>
系统的所有资源存放在节点Startup.Modules节点下。节点说明：
| 节点 | 说明 |
| ResourceModules | 存放所有的资源模块，例如Theme资源以及语言资源，可添加多个。 |
| LoginModules | 存放登录模块资源，一般我们只用添加一个Login模块。但也支持添加多个。 |
| AuthenticationModules | 验证系统用户的身份是否合法，可添加多个。 |
| AuthorizationModules | 系统的授权管理，可添加多个。 |
| ExecutionModules | 通用执行模块，前面是个模块执行完后，可添加自己的功能模块。例如我们可以把主界面的显示流程添加到这个模块。 |
谈谈框架
比较常见的系统框架一般都包含两个部分：基础框架和业务框架。基础框架一般不会太涉及业务，主要为业务框架提供平台，提供上下文环境。本次设计的基础框架主要包括了上下文环境、安全策略、日志以及自定义组件等等。而业务框架我们主要就是考虑业务模块的功能实现。在实现业务功能的同时，我们得考虑分层设计，保证业务的高扩展性以及系统的可持续性。
基础框架
基础框架包含了七个模块，框架结构如下图所示：
接下来我们就分别介绍上图中比较重要的几个模块：Core、utility、Resource。
基础框架-Core
Core包含了Core模块和Configuration模块，两个模块都有一个共同的功能，都为系统的启动过程服务。Configuration模块定义了系统配置文件的模板。Configuration的整个工程结构如下所示：
图中的Schema文件夹下定义了两个配置规则文件，分别对应Application.xml和Startup.xml。这两个文件的具体内容在前面的“设计思路”部分已经给出。
配置已经有了，我们分析Startup.xml中的节点内容，例如：<Add xsi:Type="HeaviSoft.FrameworkBase.Client.Implements.ThemeModule, HeaviSoft.FrameworkBase.Client"/>。这一句代码的实际意义是什么？属性Type的值代表一个类的名称以及所在命名空间。在系统启动的过程中，可通过反射机制动态创建节点类型的实体对象。这些通过动态创建的类都有一个共同的特点，都需要实现某个接口来扩展一个模块的功能。而Core工程下为我们定义了这些模块接口，如下图所示：
主题和语言接口包括：IResourceModule、IThemeResourceModule、ILanguageResourceModule。IResourceModule是父接口，而IThemeResourceModule和ILanguageResourceModule是IResourceModule的扩展接口。IResourceModule定义如下：
/// <summary> /// 资源加载模块 /// </summary> public interface IResourceModule { /// <summary> /// 资源加载中 /// </summary> /// <param name="app">应用对象</param> /// <param name="name">资源名称</param> /// <returns></returns> bool Loading(ExtendedApplicationBase app, string name); /// <summary> /// 资源加载完成 /// </summary> /// <param name="app">应用对象</param> /// <param name="name">资源名称</param> /// <returns></returns> bool Loaded(ExtendedApplicationBase app, string name); /// <summary> /// 资源卸载中 /// </summary> /// <param name="app">应用对象</param> /// <param name="name">资源名称</param> /// <returns></returns> bool UnLoading(ExtendedApplicationBase app, string name); /// <summary> /// 资源卸载完成 /// </summary> /// <param name="app">应用对象</param> /// <param name="name">资源名称</param> /// <returns></returns> bool UnLoaded(ExtendedApplicationBase app, string name); }
我们可以在Loading中执行加载资源，并且接收两个参数：app和name，app的类型为ExtendedApplicationBase，ExtendedApplicationBase就是我们的应用基类，它几乎存储了系统的所有上下文信息，稍后再详解。在IResourceModule接口的方法中，我们可以获取系统的任何上下文信息。
IThemeResourceModule是IResourceModule的一个子接口，用于加载主题资源；和IThemeResourceModule相似，ILanguageResourceModule用户加载管理语言资源。如果我们要切换主题或资源，可先掉调用IResourceModule接口的UnLoading方法先卸载主题和语言资源。然后再调用新资源的Loading方法。
登录接口：ILoginModule。系统的登录操作可通过实现ILoginModule接口来执行，代码如下：
/// <summary> /// 登录模块 /// </summary> public interface ILoginModule { /// <summary> /// 登录接口 /// </summary> /// <param name="app">应用对象</param> /// <returns>返回登陆操作状态</returns> bool Login(ExtendedApplicationBase app); /// <summary> /// 登录成功 /// </summary> /// <param name="app">应用对象</param> /// <param name="message">成功消息</param> void LoginSuccessed(ExtendedApplicationBase app, object message); /// <summary> /// 登录失败 /// </summary> /// <param name="app">应用对象</param> /// <param name="message">失败消息</param> void LoginFailed(ExtendedApplicationBase app, object message); }
登录过程在Login方法中实现，登录验证后，如果登录成功则会调用LoginSuccessed方法，如果登录失败，则调用LoginFailed。
身份认证：IAuthenticationModule接口。ILoginModule接口执行后，上下文信息中缓存了加密后的登录信息，IAuthenticationModule主要对上下文中的登录信息做验证。验证有没有通过我们可以通过app中的Context.User.Identity.IsAuthenticated来判断。
授权接口：IAuthorizationModule。IAuthenticationModule执行后，我们能够知道用户身份是否合法，如果身份有效，IAuthorizationModule可到服务器上获取用户的权限信息，并保存在上下文中。如果用户要使用某个业务模块，可从上下文中调用接口IPrincipal的IsInRole方法验证授权。IPrincipal的定义如下：
public interface IPrincipal { IIdentity Identity { get; } bool IsInRole(string role); }
模块的接口就介绍到这里，在启动系统时，怎样把这些接口串联的执行。这就不得不提到系统基础ExtendedApplicationBase。
基础框架-ExtendedApplicationBase
首先，我们需要考虑系统启动后，Startup.xml中模块集合存放在哪里。ExtendedApplicationBase就是比较合适的一个容器，它定义了像ThemeResourceModules、LanguageResourceMudules等模块集合。容器有了，那么执行的步骤怎样串联起来？ExtendedApplicationBase实现了一个抽象方法BuildSteps()，用于构建系统的启动步骤。而整个系统的执行需要实现抽象方法ExecuteSteps()。还是先看看代码再分析：
/// <summary> /// 应用对象类 /// </summary> public abstract class ExtendedApplicationBase : Application { public readonly string PROPERTY_ACCOUNT = "ExtendedApplicationBase_Account"; public readonly string PROPERTY_PASSWORD = "ExtendedApplicationBase_Password"; /// <summary> /// 当前应用实例 /// </summary> public static ExtendedApplicationBase Current { get; set; } public ExtendedApplicationBase() : base() { Data = new Dictionary<object, object>(); ThemeResourceModules = new List<IThemeResourceModule>(); LanguageResourceMudules = new List<ILanguageResourceModule>(); LoginModules = new List<ILoginModule>(); AuthenticationModules = new List<IAuthenticationModule>(); AuthorizationModules = new List<IAuthorizationModule>(); ExecutionModules = new List<IExecutionModule>(); Context = new AppContext(); } /// <summary> /// 应用上下文 /// </summary> public AppContext Context { get; private set; } public Dictionary<object, object> Data { get; private set; } protected List<IThemeResourceModule> ThemeResourceModules { get; private set; } protected List<ILanguageResourceModule> LanguageResourceMudules { get; private set; } protected List<ILoginModule> LoginModules { get; private set; } protected List<IAuthenticationModule> AuthenticationModules { get; private set; } protected List<IAuthorizationModule> AuthorizationModules { get; private set; } protected List<IExecutionModule> ExecutionModules { get; private set; } /// <summary> /// 构建步骤 /// </summary> public abstract void BuildSteps(); /// <summary> /// 执行步骤 /// </summary> /// <returns>执行状态</returns> public virtual bool ExecuteSteps() { if (!ExecuteThemeResourceModulesCore()) return false; if (!ExecuteLanguageResourceModulesCore()) return false; if (!ExecuteLoginModulesCore()) return false; if (!ExecuteAuthorizationModulesCore()) return false; if (!ExecuteExecutionModulesCore()) return false; return true; } /// <summary> /// 关闭系统 /// </summary> public virtual void ExitEx() { Environment.Exit(0); } /// <summary> /// 执行主题资源加载 /// </summary> /// <returns></returns> protected abstract bool ExecuteThemeResourceModulesCore(); /// <summary> /// 执行语言资源加载 /// </summary> /// <returns></returns> protected abstract bool ExecuteLanguageResourceModulesCore(); /// <summary> /// 执行登录流程 /// </summary> /// <returns></returns> protected abstract bool ExecuteLoginModulesCore(); /// <summary> /// 执行身份验证 /// </summary> /// <returns></returns> public abstract bool ExecuteAutheticationModulesCore(); /// <summary> /// 执行身份授权 /// </summary> /// <returns></returns> protected abstract bool ExecuteAuthorizationModulesCore(); /// <summary> /// 执行常规流程 /// </summary> /// <returns></returns> protected abstract bool ExecuteExecutionModulesCore(); /// <summary> /// 激活当前应用 /// </summary> public void Activate() { this.MainWindow.Show(); this.MainWindow.Activate(); }
代码中，ExecuteSteps方法分别调用了ExecuteThemeResourceModulesCore、ExecuteLanguageResourceModulesCore、ExecuteLoginModulesCore、ExecuteAuthorizationModulesCore、ExecuteExecutionModulesCore。这几个方法都是抽象方法。具体的实现都是在子类中。我们还看到类中包括一个Data属性，类型为Dictionary。之前我们提到了Application.xml，这里边配置的所有Attr字典配置数据都会存储在Data中，取值直接通过ExtendedApplicationBase.Current.Data[Key]读取。
基础框架-ExtendedApplicationBase实现类
在系统中添加一个ExtendedApplicationBase的具体实现类ExtendedApplication。代码如下：
/// <summary> /// 系统应用 /// </summary> internal class ExtendedApplication : ExtendedApplicationBase { public ExtendedApplication() : base() { ShutdownMode = ShutdownMode.OnExplicitShutdown; } #region 系统事件 /// <summary> /// 流程启动 /// </summary> /// <param name="e"></param> protected override void OnStartup(StartupEventArgs e) { //注册事件 RegistEvent(); //开始构建步骤 try { this.BuildSteps(); //执行步骤 if (!this.ExecuteSteps()) { this.ExitEx(); } } catch (Exception ex) { //写日志 Logger.Error("Error occured during appication start-up.", ex); this.ExitEx(); } } private void RegistEvent() { //捕获UI线程 this.DispatcherUnhandledException += ExtendedApplication_DispatcherUnhandledException; //捕获其他线程异常 TaskScheduler.UnobservedTaskException += TaskScheduler_UnobservedTaskException; } private void TaskScheduler_UnobservedTaskException(object sender, UnobservedTaskExceptionEventArgs e) { //写日志 Logger.Error("Unknown error.", e.Exception); //处理异常 } /// <summary> /// 未捕获的异常 /// </summary> /// <param name="sender"></param> /// <param name="e"></param> private void ExtendedApplication_DispatcherUnhandledException(object sender, System.Windows.Threading.DispatcherUnhandledExceptionEventArgs e) { HandleUnKnownExcpetion(e.Exception); } private void HandleUnKnownExcpetion(Exception e) { //写日志 Logger.Error("Unknown error.", e); //启动过程中发生了异常。 if (e is StartupException) { //启动异常提示 } else if (e is FatalException) { //中断异常提示 } else { //其他异常 } } #endregion #region 父类抽象方法实现 public override void BuildSteps() { #region Application Attributes var applicationRoot = ConfigurationHelper.GetApplicationConfigRoot(); if (!applicationRoot.IsNull()) { var eleLayouts = new string[] { ConfigurationHelper.Config_Node_Attriutes, ConfigurationHelper.Config_Node_Attr }; var attributes = applicationRoot.GetElements(eleLayouts); foreach (var element in attributes) { var name = element.GetAttributeValue("Name"); var value = element.GetAttributeValue("Value"); if (!this.Data.ContainsKey(name)) { this.Data.Add(name, value); } } } #endregion #region Startup var startupRoot = ConfigurationHelper.GetStartupConfigRoot(); if (!startupRoot.IsNull()) { //加载ResourceModules var startups = startupRoot.GetElements(new string[] { ConfigurationHelper.Config_Node_Modules, ConfigurationHelper.Config_Node_ResourceModules, ConfigurationHelper.Config_Node_Operation }); var resourcesTypes = startups.ToList().Select(el => el.GetAttributeValue("Type")); var resourceModules = new List<IResourceModule>(); foreach (var type in resourcesTypes) { resourceModules.Add(CreateInstanceByType<IResourceModule>(type)); } this.ThemeResourceModules.AddRange(resourceModules.Where(res => res is IThemeResourceModule).Cast<IThemeResourceModule>()); this.LanguageResourceMudules.AddRange(resourceModules.Where(res => res is ILanguageResourceModule).Cast<ILanguageResourceModule>()); //加载LoginModules var loginTypes = startupRoot.GetElements(new string[] { ConfigurationHelper.Config_Node_Modules, ConfigurationHelper.Config_Node_LoginModules, ConfigurationHelper.Config_Node_Operation }).ToList().Select(el => el.GetAttributeValue("Type")); foreach (var type in loginTypes) { this.LoginModules.Add(CreateInstanceByType<ILoginModule>(type)); } //加载AuthenticationModules var authenticationTypes = startupRoot.GetElements(new string[] { ConfigurationHelper.Config_Node_Modules, ConfigurationHelper.Config_Node_AuthenticationModules, ConfigurationHelper.Config_Node_Operation }).ToList().Select(el => el.GetAttributeValue("Type")); foreach (var type in authenticationTypes) { this.AuthenticationModules.Add(CreateInstanceByType<IAuthenticationModule>(type)); } //加载AutorizationModules var authorizationTypes = startupRoot.GetElements(new string[] { ConfigurationHelper.Config_Node_Modules, ConfigurationHelper.Config_Node_AuthorizationModules, ConfigurationHelper.Config_Node_Operation }).ToList().Select(el => el.GetAttributeValue("Type")); foreach (var type in authorizationTypes) { this.AuthorizationModules.Add(CreateInstanceByType<IAuthorizationModule>(type)); } //加载执行流程 var executionTypes = startupRoot.GetElements(new string[] { ConfigurationHelper.Config_Node_Modules, ConfigurationHelper.Config_Node_ExecutionModules, ConfigurationHelper.Config_Node_Operation }).ToList().Select(el => el.GetAttributeValue("Type")); foreach (var type in executionTypes) { this.ExecutionModules.Add(CreateInstanceByType<IExecutionModule>(type)); } } #endregion } protected override bool ExecuteThemeResourceModulesCore() { //加载主题资源 foreach (var module in ThemeResourceModules) { if (!module.Loading(this, Context.CurrentTheme)) { throw new StartupException("Error occured when loading theme resource."); } } //主题资源加载完成 foreach (var module in ThemeResourceModules) { if (!module.Loaded(this, Context.CurrentTheme)) { throw new StartupException("Error occured when loaded theme resource."); } } return true; } protected override bool ExecuteLanguageResourceModulesCore() { //加载语言资源 foreach (var module in LanguageResourceMudules) { if (!module.Loading(this, Context.CurrentLanguage)) { throw new StartupException("Error occured when loading language resource."); } } //语言资源加载完成 foreach (var module in LanguageResourceMudules) { if (!module.Loaded(this, Context.CurrentLanguage)) { throw new StartupException("Error occured when loaded language resource."); } } return true; } protected override bool ExecuteLoginModulesCore() { foreach (var login in LoginModules) { try { if (!login.Login(this)) { return false; } }以上是关于准备.Net转前端开发-WPF界面框架那些事，搭建基础框架的主要内容，如果未能解决你的问题，请参考以下文章