Modules功能模块体系
Modules 功能模块体系
位置:Source/Modules
每个模块通常包含:
Extension.cs / Extention.cs 注册入口 Options.cs 配置选项 Presenter.xaml UI 展示器 Themes/Generic.xaml 默认样式 Resources.*.resx 多语言资源模块列表:
| 模块 | 功能 |
|---|---|
H.Modules.About | 关于页面。 |
H.Modules.Feedback | 反馈模块。 |
H.Modules.Globalization | 多语言切换。 |
H.Modules.Guide | 新手引导。 |
H.Modules.Help | 帮助入口。 |
H.Modules.Home | 首页模块。 |
H.Modules.Identity | 用户、角色、权限管理。 |
H.Modules.License | 授权、许可、会员管理。 |
H.Modules.Login | 登录、注册、当前用户。 |
H.Modules.Messages.Dialog | 对话框消息。 |
H.Modules.Messages.Form | 表单消息。 |
H.Modules.Messages.Notice | 通知消息。 |
H.Modules.Messages.Snack | 轻提示消息。 |
H.Modules.Operation | 操作日志。 |
H.Modules.Project | 项目管理。 |
H.Modules.Setting | 设置页面。 |
H.Modules.SplashScreen | 启动画面。 |
H.Modules.Sponsor | 赞助展示。 |
H.Modules.Style | 样式配置。 |
H.Modules.Theme | 主题切换。 |
H.Modules.Upgrade | 自动升级。 |
以登录模块为例:
AddLoginViewPresenter()注册登录界面。AddTestLoginService()注册测试登录服务。UseLoginOptions()把登录选项加入设置系统。- 如果要接真实后端,替换
ILoginService实现即可。
以主题模块为例:
AddTheme()注册主题加载服务和主题选择界面。UseThemeOptions()加入主题配置。LoadThemeOptionsService根据配置加载资源字典。
Modules 模块系统详解
一、模块系统概述
模块是 WPF-Control 框架的功能封装单元,将相关的 UI、逻辑和配置打包在一起,便于复用和组合。
核心思想:模块负责组合,将服务和 UI 整合为可复用的功能单元。
二、模块结构
2.1 典型模块文件结构
H.Modules.About/ ├── Extension.cs # 注册入口(扩展方法) ├── Options.cs # 配置选项类 ├── Presenter.xaml # UI 展示器 ├── Presenter.xaml.cs # 展示器逻辑 ├── Themes/ │ └── Generic.xaml # 默认样式 └── Properties/ ├── Resources.resx # 中文资源 ├── Resources.en.resx # 英文资源 └── ... # 其他语言资源2.2 各文件职责
| 文件 | 作用 | 关键字 |
|---|---|---|
Extension.cs | 服务注册入口 | AddAbout(),UseAboutOptions() |
Options.cs | 配置选项 | IAboutOptions,[Display]属性 |
Presenter.xaml | UI 界面 | XAML 布局 |
Presenter.xaml.cs | 视图逻辑 | 继承Ioc<T> |
Generic.xaml | 默认样式 | 资源字典 |
Resources.resx | 多语言资源 | 国际化支持 |
三、模块注册模式
3.1 核心模式:Add + Use
publicstaticclassExtention{// 1. AddXXX:注册服务到 IOC 容器publicstaticvoidAddAbout(thisIServiceCollectionservices,Action<IAboutOptions>setupAction=null){services.AddOptions();// 添加选项支持services.TryAdd(ServiceDescriptor.Singleton<IAboutViewPresenter,AboutViewPresenter>());// 配置选项回调if(setupAction!=null)services.Configure(newAction<AboutOptions>(setupAction));}// 2. UseXXX:启用配置,加入设置系统publicstaticvoidUseAboutOptions(thisIApplicationBuilderservice,Action<IAboutOptions>action=null){action?.Invoke(AboutOptions.Instance);IocSetting.Instance.Add(AboutOptions.Instance);// 加入设置系统}}3.2 使用流程
publicpartialclassApp:ApplicationBase{// 第一步:注册模块(ConfigureServices)protectedoverridevoidConfigureServices(IServiceCollectionservices){services.AddAbout(options=>{// 可选:配置模块选项});}// 第二步:启用配置(Configure)protectedoverridevoidConfigure(IApplicationBuilderapp){app.UseAboutOptions(options=>{// 可选:进一步配置});}}四、关键模块详解
4.1 About 模块
功能介绍
显示应用的基本信息:版本号、公司信息、隐私政策等。
核心代码
// Presenter 定义[Icon(FontIcons.Info)][Display(Name="关于",GroupName=SettingGroupNames.GroupSystem)]publicclassAboutViewPresenter:Ioc<AboutViewPresenter,IAboutViewPresenter>,IAboutViewPresenter{// 继承 Ioc<T> 自动获得 Instance 属性}// Options 定义[Display(Name="关于",GroupName=SettingGroupNames.GroupSystem)]publicclassAboutOptions:IocOptionInstance<AboutOptions>,IAboutOptions{publicstringVersion{get;set;}publicstringCompany{get;set;}publicstringCopyright{get;set;}}使用示例
// 显示关于页面Ioc.GetService<IAboutViewPresenter>().Show();// 或者使用命令ShowAboutCommand.Instance.Execute(null);4.2 Login 模块
功能介绍
提供登录、注册界面和认证服务。
核心流程
AddLoginViewPresenter() → 注册登录界面 Presenter AddTestLoginService() → 注册测试登录服务(可替换) UseLoginOptions() → 加入设置系统 运行时: OnLogin() → ILoginService.Login() → 验证成功 → 显示主窗口扩展点
// 注册测试登录服务services.AddTestLoginService();// 替换为真实后端services.AddSingleton<ILoginService,MyRealLoginService>();4.3 Theme 模块
功能介绍
主题切换和样式管理。
核心流程
AddTheme() → 注册主题服务 UseThemeOptions() → 加入主题配置 LoadThemeOptionsService → 根据配置加载资源字典使用示例
// 切换主题Ioc.GetService<ISwitchThemeViewPresenter>().Switch(ThemeType.Dark);// 获取当前主题ThemeTypecurrent=ThemeOptions.Instance.ThemeType;4.4 Setting 模块
功能介绍
设置页面管理,统一管理应用配置。
核心特点
- 自动收集所有
IOption实现 - 按分组显示设置项
- 支持搜索和筛选
五、模块分类
5.1 模块功能矩阵
| 类别 | 模块 | 功能说明 |
|---|---|---|
| 基础模块 | About,Help,Feedback | 关于、帮助、反馈 |
| 认证模块 | Identity,Login,License | 用户、角色、权限、登录、授权 |
| 界面模块 | Theme,Style,Globalization | 主题、样式、多语言 |
| 消息模块 | Dialog,Form,Notice,Snack | 对话框、表单、通知、轻提示 |
| 功能模块 | Project,Operation,Guide,Upgrade | 项目管理、操作日志、新手引导、自动升级 |
5.2 消息模块详解
H.Modules.Messages/ ├── Dialog/ # 模态对话框 ├── Form/ # 表单消息 ├── Notice/ # 通知消息 └── Snack/ # 轻提示消息(底部弹出)使用示例
// 对话框消息awaitIoc.GetService<IMessageService>().ShowMessageAsync("提示信息");// Snack 消息(轻提示)Ioc.GetService<ISnackMessageService>().Show("操作成功");// 通知消息Ioc.GetService<INoticeService>().Send(newNoticeMessage{Title="标题",Content="内容"});六、创建自定义模块
6.1 步骤一:定义接口
publicinterfaceIMyModuleViewPresenter{voidShow();}publicinterfaceIMyModuleOptions{stringTitle{get;set;}boolEnabled{get;set;}}6.2 步骤二:实现选项类
[Icon(FontIcons.Star)][Display(Name="我的模块",GroupName="自定义")]publicclassMyModuleOptions:IocOptionInstance<MyModuleOptions>,IMyModuleOptions{privatestring_title="默认标题";[Display(Name="标题")]publicstringTitle{get=>_title;set{_title=value;RaisePropertyChanged();}}privatebool_enabled=true;[Display(Name="启用")]publicboolEnabled{get=>_enabled;set{_enabled=value;RaisePropertyChanged();}}}6.3 步骤三:实现 Presenter
[Icon(FontIcons.Star)][Display(Name="我的模块",GroupName="自定义")]publicclassMyModuleViewPresenter:Ioc<MyModuleViewPresenter,IMyModuleViewPresenter>,IMyModuleViewPresenter{publicvoidShow(){// 显示模块界面MyModuleWindowwindow=newMyModuleWindow();window.ShowDialog();}}6.4 步骤四:创建扩展方法
publicstaticclassMyModuleExtension{publicstaticvoidAddMyModule(thisIServiceCollectionservices,Action<IMyModuleOptions>setupAction=null){services.AddOptions();services.TryAddSingleton<IMyModuleViewPresenter,MyModuleViewPresenter>();if(setupAction!=null)services.Configure(newAction<MyModuleOptions>(setupAction));}publicstaticvoidUseMyModuleOptions(thisIApplicationBuilderapp,Action<IMyModuleOptions>action=null){action?.Invoke(MyModuleOptions.Instance);IocSetting.Instance.Add(MyModuleOptions.Instance);}}6.5 步骤五:注册和使用
// 在 App.xaml.cs 中注册protectedoverridevoidConfigureServices(IServiceCollectionservices){services.AddMyModule(options=>{options.Title="自定义标题";});}protectedoverridevoidConfigure(IApplicationBuilderapp){app.UseMyModuleOptions();}// 在代码中使用Ioc.GetService<IMyModuleViewPresenter>().Show();七、模块配置机制
7.1 Options 模式
// 定义配置类publicclassMyOptions:IocOptionInstance<MyOptions>{publicstringName{get;set;}="默认值";[Display(Name="启用功能")]publicboolEnableFeature{get;set;}=true;}// 注册配置services.Configure<MyOptions>(options=>{options.Name="自定义名称";});// 获取配置MyOptions.Instance.Name;// 静态访问7.2 属性标记
| 特性 | 作用 |
|---|---|
[Display] | 设置显示名称、分组、描述 |
[Icon] | 设置图标 |
[ReadOnly] | 标记只读属性 |
[DefaultValue] | 设置默认值 |
[PropertyItem] | 指定属性编辑器类型 |
八、模块与服务的关系
┌─────────────────────────────────────────────────────────────┐ │ Modules │ │ 功能模块组合(UI + 逻辑) │ │ ┌─────────┐ ┌─────────┐ ┌─────────┐ ┌─────────┐ │ │ │ About │ │ Login │ │ Theme │ │ Setting │ │ │ └────┬────┘ └────┬────┘ └────┬────┘ └────┬────┘ │ │ │ │ │ │ │ │ ▼ ▼ ▼ ▼ │ ├─────────────────────────────────────────────────────────────┤ │ Services │ │ 能力提供层 │ │ ┌─────────┐ ┌─────────┐ ┌─────────┐ ┌─────────┐ │ │ │ Logger │ │ Message │ │ Setting │ │ AppPath │ │ │ └─────────┘ └─────────┘ └─────────┘ └─────────┘ │ ├─────────────────────────────────────────────────────────────┤ │ IOC │ │ 服务连接与管理 │ └─────────────────────────────────────────────────────────────┘九、最佳实践
9.1 模块命名规范
H.Modules.{功能名}/ ├── {功能名}Options.cs ├── {功能名}ViewPresenter.xaml ├── {功能名}ViewPresenter.xaml.cs ├── Extension.cs └── Themes/Generic.xaml9.2 扩展方法命名
| 前缀 | 含义 | 示例 |
|---|---|---|
AddXXX | 注册模块服务 | AddAbout(),AddLogin() |
UseXXXOptions | 启用配置 | UseAboutOptions(),UseThemeOptions() |
AddXXXService | 注册特定服务 | AddTestLoginService() |
9.3 配置选项设计
// ✅ 推荐:继承 IocOptionInstancepublicclassMyOptions:IocOptionInstance<MyOptions>,IMyOptions{}// ✅ 推荐:使用 Display 特性[Display(Name="显示名称",GroupName="分组名",Description="描述")]publicstringProperty{get;set;}// ✅ 推荐:提供默认值publicstringProperty{get;set;}="默认值";十、总结
模块系统是 WPF-Control 框架的功能组织核心:
- 封装性:每个模块是独立的功能单元
- 可组合性:通过 Add/Use 模式灵活组合
- 可扩展性:轻松添加自定义模块
- 配置化:通过 Options 模式统一管理配置
掌握模块系统的使用,可以快速构建功能丰富的 WPF 应用程序。
