ABP虚拟文件系统(VirtualFileSystem)实例------定制菜单栏显示用户姓名
ABP默认的MVC启动模板在登录后, 右上角显示的是用户名:
如果想让它显示用户的姓名该如何做呢?这就需要用到ABP一个非常强大的功能------虚拟文件系统.
前期准备
使用ABP CLI创建一个名为AbpStudy
的ASP.NET MVC项目:
abp new AbpStudy
关于MVC的启动模板可以看文档, 这里就不赘述.
虚拟文件系统(VirtualFileSystem)
什么是虚拟文件系统(简称VFS)呢?来看一段官方文档的解释:
虚拟文件系统可以管理文件系统(磁盘)上实际不存在的文件。 它主要用于将(js,css,image,cshtml ...)文件嵌入到程序集中,并在运行时将它们用作物理文件。
是不是还是不太明白VFS有什么用, 没关系我第一次看完也是这样:)
我们首先要知道, ABP是一个模块化的框架, 每个模块都可以互相协作参与到整个应用程序中, 定制应用程序的各个部分, 包括UI部分.
每个模块都可以有自己的UI, 比如我有一个"人事管理"模块, 它要向菜单中增加一个名为"人事管理"的菜单入口;而另一个模块"财务管理"则需要增加一个"财务管理"的菜单入口------在不修改你的应用程序的前提下要把它们整合在一起,这是一个很难的事,ABP的前身ASP.NET BOILERPLATE未能实现这点, 而这一切在ABP中成为了可能.
而除了整合以外, 模块间的文件同样也可以覆盖, 只要文件的路径相同,VFS就允许你利用你自己的文件覆盖官方模块中的文件实现UI的定制,因为所有这些文件都是由VFS来进行管理, 它们都是虚拟的!
覆盖
如上图中MVC启动模板的外观, 是一个叫Volo.Abp.AspNetCore.Mvc.UI.Theme.Basic
的模块来控制的, 这是一个主题模块, 提供了ASP.NET MVC经典的外观. 将来ABP还会有别的主题模块,你只要整合进来,你的应用程序就会显示成另外的样子了, 当然这是题外话了.
而右上角显示的用户名也是由它控制的,我们可以通过查阅ABP的源码, 找到相关的代码是在Volo.Abp.AspNetCore.Mvc.UI.Theme.Basic\Themes\Basic\Components\Toolbar\UserMenu\Default.cshtml
中:
<a class="btn btn-link dropdown-toggle" href="#" role="button" id="dropdownMenuLink" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
@CurrentUser.UserName
</a>
这里的@CurrentUser.UserName
就是渲染用户名的代码. 找到它之后, 我们就可以实现"精准打击"式的覆盖了.
在我们的Web工程下,仿造路径结构建立一个Themes\Basic\Components\Toolbar\UserMenu\Default.cshtml
(不需要Default.cshmtl.cs)
你也可以[新建一个模块], 并在新建模块中完成覆盖,然后在你的应用程序中将该模块整合进来, 这样的好处是如果将来其他应用程序也想显示用户的姓名的话,就可以复用你的模块了. 我们这里为了简单起见,直接使用Web工程了.(Web工程同样也是一个模块)
将原Default.cshtml中的全部代码直接复制过来, 但是把其中渲染用户名的代码改成渲染姓名:
@* 显示用户的名字,而不是用户名 *@
@((await UserManager.GetByIdAsync(CurrentUser.GetId())).Name)
这里我们使用了UserManager, 通过当前登录用户的ID获取用户的信息, 其中就包括了用户的姓名. 要使用UserManager
, 首先需要在Default.cshtml的开始部分增加一行代码完成UserManager的注入:
@inject IdentityUserManager UserManager
最后我们需要告知VFS, 在Web工程中有文件需要加到VFS中. 修改AbpStudyWebModule
的ConfigureVirtualFileSystem
方法, 在开始的方法加入以下代码:
// 添加WebModule的文件到VFS
Configure<virtualfilesystemoptions>(options =>
{
options.FileSets.AddEmbedded<abpstudywebmodule>(typeof(AbpStudyWebModule).Namespace);
});
AddEmbedded
方法会将泛型类型所在的程序集中的嵌入资源(Embedded Resources)加入到VFS中. 一般来讲我们需要在文件的"属性"窗口将 "生成操作" 设置为 "嵌入式资源". 但是对于我们添加的Razor Page, VFS默认就可以处理不需要额外的设置. 另外我们传递给了AddEmbedded
一个命名空间参数, VFS会将该命名空间从文件的全路径中忽略, 剩下的路径如果一样, 则后添加的文件就会覆盖之前添加的.
OK, 运行工程让我们看看效果:
我们在"个人信息"中将admin的名字设置为"WAKU", 然后重新登录后右上角就会显示名字了.
再来一点魔法
现在我们不要关闭应用程序,保持它在运行状态, 然后回到我们添加的Default.cshtml
文件, 将刚才修改代码再添加一点装饰:
<i class="fa fa-smile-o">@((await UserManager.GetByIdAsync(CurrentUser.GetId())).Name) </i>
我们使用复用fontawesome在名字前面增加了一个笑脸☺图标, 保存修改, 回到浏览器按F5:
可以看到在未重新编译的情况下,我们的修改已经生效了! 很神奇吧?
这是因为为了方便开发, VFS设置了在开发阶段使用磁盘上的物理文件(Razor, js, css等), 所以只要我们只要保存, 不用重新编译刷新一下页面就会加载最新的文件, 这会大大提升我们的开发效率! 而在发布后, 则会使用编译后的程序集中的文件以提高运行效率.
结语
好了,到此为止我们已经完成了我们的目标------在菜单栏上显示用户的名字而不是用户名. 虽然从改动上来看只有很小的工作量, 但在这背后是有很多值得学习的东西, ABP框架已经为我们做了很多!通过本文希望你能感受到ABP框架的强大,也希望ABP v1.0能早日发布!
示例工程放到GITHUB中了.
Happy Coding!
参考文章:
- Designing Modularity on ASP.NET Core: Virtual File System
- 基于ASP.NET Core的模块化设计: 虚拟文件系统(上一篇文章的中文版, 谢谢@liangshiwei的翻译)
ABP虚拟文件系统(VirtualFileSystem)实例------定制菜单栏显示用户姓名的更多相关文章
- /proc 【虚拟文件系统】
在安装新硬件到 Linux 系统之前,你会想要知道当前系统的资源配置状况. Linux 将这类信息全集中在 /proc 文件系统下./proc 目录下的文件都是 Linux 内核虚拟出来的,当你读取它 ...
- 使用 /proc 文件系统来访问 linux操作系统 内核的内容 && 虚拟文件系统vfs及proc详解
http://blog.163.com/he_junwei/blog/static/19793764620152743325659/ http://www.01yun.com/other/201304 ...
- linux 虚拟文件系统
转自:https://www.ibm.com/developerworks/cn/linux/l-cn-vfs/ Linux 允许众多不同的文件系统共存,并支持跨文件系统的文件操作,这是因为有虚拟文件 ...
- Linux内核入门到放弃-虚拟文件系统-《深入Linux内核架构》笔记
VFS的任务并不简单.一方面,它用来提供了一种操作文件.目录及其他对象的统一方法.另一方面,它必须能够与各种方法给出的具体文件系统的实现达成妥协,这些实现在具体细节.总体设计方面都有一些不同之处. 文 ...
- Linux虚拟文件系统
从文件 I/O 看 Linux 的虚拟文件系统 1 引言 Linux 中允许众多不同的文件系统共存,如 ext2, ext3, vfat 等.通过使用同一套文件 I/O 系统 调用即可对 Linux ...
- Linux 的虚拟文件系统(强烈推荐)
1 引言 Linux 中允许众多不同的文件系统共存,如 ext2, ext3, vfat 等.通过使用同一套文件 I/O 系统 调用即可对 Linux 中的任意文件进行操作而无需考虑其所在的具体文件系 ...
- 从文件 I/O 看 Linux 的虚拟文件系统
1 引言 Linux 中允许众多不同的文件系统共存,如 ext2, ext3, vfat 等.通过使用同一套文件 I/O 系统 调用即可对 Linux 中的任意文件进行操作而无需考虑其所在的具体文件系 ...
- linux文件系统体系结构 和 虚拟文件系统(VFS)
图 1. Linux 文件系统组件的体系结构 用户空间包含一些应用程序(例如,文件系统的使用者)和 GNU C 库(glibc),它们为文件系统调用(打开.读取.写和关闭)提供用户接口.系统调用接口的 ...
- STSdb,最强纯C#开源NoSQL和虚拟文件系统 4.0 RC2 支持C/S架构
STSdb是什么 再来说明一下STSdb是什么:STSdb是C#写的开源嵌入式数据库和虚拟文件系统,支持实时索引,性能是同类产品的几倍到几十倍,访问官方网站. 温故知新 之前发了文章<STSdb ...
随机推荐
- IOCP Input/Output Completion Port IO完成端口
I/O completion ports provide an efficient threading model for processing multiple asynchronous I/O r ...
- <<Modern CMake>> 翻译 2.3 与代码通信
<<Modern CMake>> 翻译 2.3 与代码通信 配置文件 CMake 允许您使用代码通过 configure_file 存取 CMake 变量. 此命令复制一个文件 ...
- .NET Core 3.0之深入源码理解HttpClientFactory(二)
写在前面 上一篇文章讨论了通过在ConfigureServices中调用services.AddHttpClient()方法,并基于此进一步探讨了DefaultHttpClientFactory是 ...
- EF 拉姆达 linq 帮助类
(这个类是很早以前在网上找的,忘记出处请原谅.) 一.基本用法 [Route("List")] public ApiResult GetList(int page, int lim ...
- Linux系统管理----目录与文件管理作业习题
chapter02 - 03 作业 1. 分别用cat \tac\nl三个命令查看文件/etc/ssh/sshd_config文件中的内容,并用自己的话总计出这三个文档操作命令的不同之处? cat ...
- 【iOS】copy 关键字
以前没注意过 iOS 的 copy, nonatomic, assign, weak, strong 等关键字. 偏偏今天遇到了一个问题,恰恰是关键字的问题,如图: 之前用的是 assign, 没有用 ...
- DesignPattern系列__01SingletonResponsibility
单一职责原则 单一职责原则:一个类应该只有一个原因引起改变,即一个类应该只负责一个业务逻辑. 问题由来:类T负责t1, t2两个职责,当因为t1j对类T修改的时候,可能导致类T出现问题而影响职责t2. ...
- Mac OS 安装mysqlclient 遇到的坑~
最近在学习Python, 因为Django连接mysql 需要安装mysqlclient, 但Mac安装遇到各种问题,这里记录一下,避免以后再踩坑. 1. 正常情况下,安装mysqlclient ...
- Oracle_InstantClient 及PL/SQL Developer工具的安装
一.下载 InstantClient 地址: http://www.oracle.com/technology/software/tech/oci/instantclient/index.html i ...
- 如何用Hexo+Github创建自己的技术博客
注册一个github GitHub官网.按照一般的网站注册登录执行就好了,不详细说. 安装git 安装很简单,一直下一步 git安装教程 很多教程里都说要配置环境变量,我本人安装过5次左右的git,一 ...