IApp接口

框架封装了整个应该程序的启动过程，也实现了启动画面、系统更新、同步日期、全局异常等常规功能，简化了系统的开发，因此需要提供功能扩展接口，系统中把相关的扩展点都封装在此接口中。

接口定义如下：

  1. /// <summary>
  2. /// 应用程序扩展接口
  3. /// <para>
  4. /// 框架封装了整个应该程序的启动过程，也实现了启动画面\系统更新\同步日期\全局异常等常规功能
  5. /// 简化了系统的开发，因此需要提供功能扩展接口，系统中把相关的扩展点都封装在此接口中。
  6. /// </para>
  7. /// </summary>
  8. public interface IApp
  9. {
  10.     /// <summary>
  11.     /// 读取应用程序配置
  12.     /// <para>
  13.     /// 定义应用程序在启动之初，如何读取系统配置信息，此函数是启动的第一步执行。
  14.     /// </para>
  15.     /// </summary>
  16.     WinFormSetting GetSetting();
  18.     /// <summary>
  19.     /// 保存应用程序配置
  20.     /// <para>
  21.     /// 当系统配置信息发生变化时，如何保存系统配置信息。
  22.     /// </para>
  23.     /// </summary>
  24.     /// <param name="setting">配置对象</param>
  25.     void SaveSetting(WinFormSetting setting);
  27.     /// <summary>
  28.     /// 获取表格配置对象
  29.     /// <para>
  30.     /// 系统中对表格控件可以进行属性自定义，此函数返回表格配置信息操作类。
  31.     /// </para>
  32.     /// </summary>
  33.     IGridSetting GetGridSetting();
  35.     /// <summary>
  36.     /// 获取登陆窗口
  37.     /// <para>
  38.     /// 定义系统登录窗口，如不需要登录，请返回null。
  39.     /// </para>
  40.     /// </summary>
  41.     Form GetLoginForm();
  43.     /// <summary>
  44.     /// 获取主窗口
  45.     /// <para>
  46.     /// 定义系统主界面。不允许为null。
  47.     /// </para>
  48.     /// </summary>
  49.     Form GetMainForm();
  51.     /// <summary>
  52.     /// 获取启动屏幕
  53.     /// <para>
  54.     /// 定义系统启动屏幕，必须遵守DevExpress组件启动屏幕规范。
  55.     /// </para>
  56.     /// </summary>
  57.     Type GetSplashScreen();
  59.     /// <summary>
  60.     /// 获取等待窗体
  61.     /// <para>
  62.     /// 定义系统等待窗体，必须遵守DevExpress组件等待窗体规范。
  63.     /// </para>
  64.     /// </summary>
  65.     Type GetWaitForm();
  67.     /// <summary>
  68.     /// 获取接口对象
  69.     /// <para>
  70.     /// 定义系统后台通讯接口操作对象。
  71.     /// </para>
  72.     /// </summary>
  73.     /// <param name="setting">应用设置</param>
  74.     WebApi GetApi(WinFormSetting setting);
  76.     /// <summary>
  77.     /// 用户登录
  78.     /// <para>
  79.     /// 定义用户登录过程。
  80.     /// </para>
  81.     /// </summary>
  82.     /// <param name="account">账号</param>
  83.     /// <param name="password">密码</param>
  84.     /// <param name="captcha">验证码</param>
  85.     /// <returns>成功返回True</returns>
  86.     BoolMessage<SysUser> UserLogin(string account, string password, string captcha);
  88.     /// <summary>
  89.     /// 验证用户
  90.     /// <para>
  91.     /// 验证用户账号密码是否正确，与登录函数不同的是，此函数只验证账号密码，而用户登录还会有其他安全相关的操作和日志记录。
  92.     /// </para>
  93.     /// </summary>
  94.     /// <param name="account">账号</param>
  95.     /// <param name="password">密码</param>
  96.     /// <param name="captcha">验证码</param>
  97.     /// <returns>成功返回True</returns>
  98.     BoolMessage UserValid(string account, string password, string captcha);
  100.     /// <summary>
  101.     /// 获取用户拥有的模块集合
  102.     /// <para>
  103.     /// 获取当前用户拥有的系统模块集合。
  104.     /// </para>
  105.     /// </summary>
  106.     /// <param name="user">用户对象</param>
  107.     IList<SysModule> GetModules(SysUser user);
  109.     /// <summary>
  110.     /// 客户端与服务端网络测试
  111.     /// <para>
  112.     /// 客户端和服务端进行网络测试。
  113.     /// </para>
  114.     /// </summary>
  115.     bool Ping();
  117.     /// <summary>
  118.     /// 客户端心跳
  119.     /// <para>
  120.     /// 激活当前用户，保持当前客户端在线。
  121.     /// </para>
  122.     /// </summary>
  123.     /// <param name="id">当前应用或者用户标识</param>
  124.     bool Active(string id);
  126.     /// <summary>
  127.     /// 全局处理异常
  128.     /// <para>
  129.     /// 定义系统全局异常处理，只有用户未处理的异常才会再此统一处理，如果用户在函数中编写try catch，则不会触发此函数。
  130.     /// </para>
  131.     /// </summary>
  132.     /// <param name="e">异常对象</param>
  133.     void GlobalExceptionProcess(Exception e);
  134. }

默认实现

以下为系统默认实现，默认实现中所有的函数都是虚函数，每个函数都可以重写，根据自身的业务情况，重新相关函数。

  1. namespace XCI.Sys
  2. {
  3.     /// <summary>
  4.     /// 系统默认应用程序接口
  5.     /// <para>
  6.     /// 默认实现了系统应用程序接口，所有函数都是虚函数，可根据业务情况，重新父类函数。
  7.     /// </para>
  8.     /// </summary>
  9.     public class BaseApplication : IApp
  10.     {
  11.         /// <summary>
  12.         /// 读取应用程序配置
  13.         /// <para>
  14.         /// 定义应用程序在启动之初，此函数是启动的第一步执行。
  15.         /// 默认实现是从输出目录下的app.json文件中读取配置信息
  16.         /// </para>
  17.         /// </summary>
  18.         public virtual WinFormSetting GetSetting()
  19.         {
  20.             return ConfigFactory.Default.Get("WinForm", () => new WinFormSetting());
  21.         }
  23.         /// <summary>
  24.         /// 保存应用程序配置
  25.         /// <para>
  26.         /// 当系统配置信息发生变化时，把配置信息保存到输出目录下的app.json文件
  27.         /// </para>
  28.         /// </summary>
  29.         /// <param name="setting">配置对象</param>
  30.         public virtual void SaveSetting(WinFormSetting setting)
  31.         {
  32.             ConfigFactory.Default.Save();
  33.         }
  35.         /// <summary>
  36.         /// 获取表格配置对象
  37.         /// <para>
  38.         /// 系统中对表格控件可以进行属性自定义，此函数返回对象可以对用户保存的配置文件上传到服务器，也可以指定本地模式，不上传到服务器。
  39.         /// </para>
  40.         /// </summary>
  41.         public virtual IGridSetting GetGridSetting()
  42.         {
  43.             //如果没有指定服务器地址,则使用本地模式
  44.             return new DefaultGridSetting(SysRuntime.Setting.GridSettingLocalMode);
  45.         }
  47.         /// <summary>
  48.         /// 获取登陆窗口
  49.         /// <para>
  50.         /// 定义系统登录窗口，如不需要登录，请返回null。
  51.         /// </para>
  52.         /// </summary>
  53.         public virtual Form GetLoginForm()
  54.         {
  55.             return new FrmStandardLogin();
  56.         }
  58.         /// <summary>
  59.         /// 获取主窗口
  60.         /// <para>
  61.         /// 定义系统主界面。不允许为null。
  62.         /// </para>
  63.         /// </summary>
  64.         public virtual Form GetMainForm()
  65.         {
  66.             return new FrmStandardMain();
  67.         }
  69.         /// <summary>
  70.         /// 获取启动屏幕
  71.         /// <para>
  72.         /// 定义系统启动屏幕，必须遵守DevExpress组件启动屏幕规范。
  73.         /// </para>
  74.         /// </summary>
  75.         public virtual Type GetSplashScreen()
  76.         {
  77.             return typeof(FrmSplashScreen);
  78.         }
  80.         /// <summary>
  81.         /// 获取等待窗体
  82.         /// <para>
  83.         /// 定义系统等待窗体，必须遵守DevExpress组件等待窗体规范。
  84.         /// </para>
  85.         /// </summary>
  86.         public virtual Type GetWaitForm()
  87.         {
  88.             return typeof(FrmWait);
  89.         }
  91.         /// <summary>
  92.         /// 获取接口对象
  93.         /// <para>
  94.         /// 定义系统后台通讯接口操作对象,函数返回值实现了在请求服务器时自动添加应用标识、时间戳、token等请求头。
  95.         /// </para>
  96.         /// </summary>
  97.         /// <param name="setting">应用设置</param>
  98.         public virtual WebApi GetApi(WinFormSetting setting)
  99.         {
  100.             return new SysWebApi(setting.Id,
  101.                     setting.ApiUrl,
  102.                     TimeSpan.FromMilliseconds(setting.ApiTimeout),
  103.                     setting.IsDebugMode);
  104.         }
  107.         /// <summary>
  108.         /// 用户登录
  109.         /// <para>
  110.         /// 定义用户登录过程。
  111.         /// </para>
  112.         /// </summary>
  113.         /// <param name="account">账号</param>
  114.         /// <param name="password">密码</param>
  115.         /// <param name="captcha">验证码</param>
  116.         /// <returns>成功返回True</returns>
  117.         public virtual BoolMessage<SysUser> UserLogin(string account, string password, string captcha)
  118.         {
  119.             return UserService.Instance.Login(account, password, captcha);
  120.         }
  122.         /// <summary>
  123.         /// 验证用户
  124.         /// <para>
  125.         /// 验证用户账号密码是否正确，与登录函数不同的是，此函数只验证账号密码，而用户登录还会有其他安全相关的操作和日志记录。
  126.         /// </para>
  127.         /// </summary>
  128.         /// <param name="account">账号</param>
  129.         /// <param name="password">密码</param>
  130.         /// <param name="captcha">验证码</param>
  131.         /// <returns>成功返回True</returns>
  132.         public virtual BoolMessage UserValid(string account, string password, string captcha)
  133.         {
  134.             return UserService.Instance.ValidUser(account, password, captcha);
  135.         }
  137.         /// <summary>
  138.         /// 获取用户拥有的模块集合
  139.         /// <para>
  140.         /// 获取当前用户拥有的系统模块集合。
  141.         /// </para>
  142.         /// </summary>
  143.         /// <param name="user">用户对象</param>
  144.         public virtual IList<SysModule> GetModules(SysUser user)
  145.         {
  146.             return ModuleService.Instance.SelectListByUserId(user.Id);
  147.         }
  149.         /// <summary>
  150.         /// 客户端与服务端网络测试
  151.         /// <para>
  152.         /// 客户端和服务端进行网络测试。
  153.         /// </para>
  154.         /// </summary>
  155.         public virtual bool Ping()
  156.         {
  157.             return SysService.Instance.Ping();
  158.         }
  160.         /// <summary>
  161.         /// 客户端心跳
  162.         /// <para>
  163.         /// 激活当前用户，保持当前客户端在线。
  164.         /// </para>
  165.         /// </summary>
  166.         /// <param name="id">当前应用或者用户标识</param>
  167.         public virtual bool Active(string id)
  168.         {
  169.             return OnlineUserService.Instance.Active(id);
  170.         }
  172.         /// <summary>
  173.         /// 全局处理异常
  174.         /// <para>
  175.         /// 定义系统全局异常处理，只有用户未处理的异常才会再此统一处理，如果用户在函数中编写try catch，则不会触发此函数。
  176.         /// </para>
  177.         /// </summary>
  178.         /// <param name="e">异常对象</param>
  179.         public virtual void GlobalExceptionProcess(Exception e)
  180.         {
  181.             if (e is ControlValueException)
  182.             {
  183.                 return;
  184.             }
  185.             if (e is SocketException se)
  186.             {
  187.                 MessageBoxHelper.ShowError(DebugHelper.BuildAllMessage(se));
  188.             }
  189.             else if (e is AggregateException ae)
  190.             {
  191.                 ae.Handle(p => true);
  192.                 MessageBoxHelper.ShowError(DebugHelper.BuildAllMessage(ae.InnerExceptions.ToArray()));
  193.             }
  194.             else if (e is WebApiException || e is BoolMessageFailException || e is BoolMessageValidException)
  195.             {
  196.                 MessageBoxHelper.ShowError(e.Message);
  197.             }
  198.             else
  199.             {
  200.                 var ef = new FrmException(e);
  201.                 ef.ShowDialog();
  202.                 ef.Dispose();
  203.             }
  204.             DebugHelper.Catch(e.Message);
  205.         }
  206.     }
  207. }

常见使用场景

  1. 快速原形测试

重新下面的函数，可以实现快速原形测试

  1. public override Form GetLoginForm()
  2. {
  3.     return null;
  4. }
  6. public override Form GetMainForm()
  7. {
  8.     return new Form1();
  9. }
  1. 临时修改系统配置
  1. public override WinFormSetting GetSetting()
  2. {
  3.     var setting = base.GetSetting();
  4.     setting.ApiUrl = "";//临时修改服务器根Url
  5.     setting.ApiTimeout = 3000;//临时修改超时时间
  6.     //修改其他属性值
  7.     return setting;
  8. }
  1. 固定账号登录
  1. public override BoolMessage<SysUser> UserLogin(string account, string password, string captcha)
  2. {
  3.     var user = new SysUser
  4.     {
  5.         Id = "123456780",   //用户主键
  6.         Account = "admin",  //用户账号
  7.         Name = "管理员"      //用户姓名
  8.         };
  9.     //使用固定账号登录，实现快速登录
  10.     return new BoolMessage<SysUser>(true,user);
  11. }

运行时对象

系统启动成功后，会把启动过程中产生的各种对象都保存在SysRuntime对象下面，这是一个静态类。

在后续的业务处理中有需要的时候直接调用SysRuntime的静态属性或者静态方法。

  1. namespace XCI.Sys
  2. {
  3.     /// <summary>
  4.     /// 应用程序运行时数据
  5.     /// </summary>
  6.     public static class SysRuntime
  7.     {
  8.         /// <summary>
  9.         /// 启动参数
  10.         /// </summary>
  11.         public static string[] StartupArgs { get; set; }
  13.         /// <summary>
  14.         /// 当前应用程序对象
  15.         /// </summary>
  16.         public static IApp App { get; set; }
  18.         /// <summary>
  19.         /// 服务器名称
  20.         /// </summary>
  21.         public static string ServerName { get; set; }
  23.         /// <summary>
  24.         /// 应用程序设置
  25.         /// </summary>
  26.         public static WinFormSetting Setting { get; set; }
  28.         /// <summary>
  29.         /// 登陆窗口
  30.         /// </summary>
  31.         public static Form LoginForm { get; set; }
  33.         /// <summary>
  34.         /// 主窗口
  35.         /// </summary>
  36.         public static Form MainForm { get; set; }
  38.         /// <summary>
  39.         /// 启动屏幕类型
  40.         /// </summary>
  41.         public static Type SplashScreenType { get; set; }
  43.         /// <summary>
  44.         /// 加载等待窗体类型
  45.         /// </summary>
  46.         public static Type WaitFormType { get; set; }
  48.         /// <summary>
  49.         /// 业务接口操作对象
  50.         /// </summary>
  51.         public static WebApi Api { get; set; }
  53.         /// <summary>
  54.         /// 当前应用程序登陆用户
  55.         /// </summary>
  56.         public static SysUser CurrentUser { get; set; }
  58.         /// <summary>
  59.         /// 添加主页面文档
  60.         /// </summary>
  61.         /// <param name="code">编码</param>
  62.         /// <param name="form">窗体</param>
  63.         public static void AddTabDocument(string code, Form form);
  65.         /// <summary>
  66.         /// 是否有指定模块编码的权限
  67.         /// </summary>
  68.         /// <param name="codes">模块编码集合</param>
  69.         /// <returns>存在返回true,否则返回false</returns>
  70.         public static bool IsAuthorize(params string[] codes);
  71.     }
  72. }