如何让ASP.NET默认的资源编程“.NET研究”方式支持非.ResX资源存储

简介:   之前写了两篇文章《.NET资源并不限于.ResX文件》(上篇、下篇),介绍了如何通过自定义ResourceManager的方式来扩展资源的存储形式。在那篇文章中,我定义了三种基于独立文件的ResourceManager(ResXResourceManager、BinaryResourceManager和XmlResoureManager)分别实现对.ResX,.Resource和.xml三种资源文件的访问。

  之前写了两篇文章《.NET资源并不限于.ResX文件》(上篇下篇),介绍了如何通过自定义ResourceManager的方式来扩展资源的存储形式。在那篇文章中,我定义了三种基于独立文件的ResourceManager(ResXResourceManager、BinaryResourceManager和XmlResoureManager)分别实现对.ResX,.Resource和.xml三种资源文件的访问。在本篇文章中我们将实现自定义ResourceManager和ASP.NET之间的集成,让ASP.NET现有的资源编程方式支持我们自定义的ResourceManager。

一、回顾一下之前创建的XmlResourceManager
二、创建自定义ResourceProvider
三、创建自定义ResourceProviderFactory
四、Global Resource编程
五、Local Resource编程

  一、回顾一下之前创建的XmlResourceManager

  本篇文章将会以我们之前创建的XmlResourceManager为例。通过自定义的XmlResourceManager,我们实现了将资源内容定义在了一个自定义结构的XML文件。该XML具有如下一个简单的结构。

 
   
<? xml version="1.0" encoding="utf-8" ?>
< resources >
< add name ="Greeting4Chris" value ="Merry Christmas!" />
< add name ="Greeting4NewYear" value ="Happy Chinese New Year!" />
</ resources >

  和.ResX文件一样,为了提供多多语言的支持,我们用带有Culture Code后缀的文件名来区分资源文件所基于语言文化。如右图所示,我在一个Web Application中,定义了两套资源文件:Global Resource和Local Resource。两种资源类型的概念,不用多说你也应该知道。前者是一个全局意义的资源文件,供所有Web页共享;后者则是基于某个Web页单独使用的本地资源。

  二、创建自定义ResourceProvider

  要让ASP.NET现有的资源编程方式将我们添加的XML作为资源存储,必须了解ASP.NET内部采用的资源读取机制。实际上,ASP.NET在后台采用一个特殊的组件进行资源的读取,这个组件就是ResourceProvider。我们只需要创建一个基于XmlResourceManager的自定义ResourceProvider,并将它注册到ASP.NET中就可以了。

  为此我创建了如下一个XmlResourceProvider,它实现了IResourceProvider。IResourceProvider具有一个GetObject方法和一个ResourceReader只读属性。前者实现了对指定键值的资源条目的读取,后者则返回一个ResourceReader。在GetObject方法中,我们利用自定义的XmlResourceManager进行资源的获取,而ResourceReader属性的实现中,我们返回的我们之前创建的XmlResourceReader。

 
   
public class XmlResourceProvider:IResourceProvider
{
public XmlResourceManager ResourceManager { get ; private set ; }
public XmlResourceProvider( string directory, string baseName)
{
this .ResourceManager = new XmlResourceManager(directory, baseName);
}

public object GetObject( string resourceKey, CultureInfo culture)
{
return this .ResourceManager.GetObject(resourceKey, culture);
}

public IResourceReader ResourceReader
{
get
{
return new XmlResourceReader(Path.Combine( this .ResourceManager.Directory, this .ResourceManager.BaseName + " .xml " ));
}
}

  三、创建自定义ResourceProviderFactory

  XmlResourceProvider创建完毕,但是它不能直接被注册,我们需要创建一个对应的工厂类。为此,如下一个名称为XmlResourceProviderFactory类被创建出来。

 
   
public class XmlResourceProviderFactory:ResourceProviderFactory
{
public override IResourceProvider CreateGlobalResourceProvider( string classKey)
{
string directory = HttpContext.Current.Server.MapPath( " GlobalResources " );
return new XmlResourceProvider(directory, classKey);
}

public override IResourceProvider CreateLocalResourceProvider( string virtualPath)
{
string directory = HttpContext.Current.Server.MapPath(VirtualPathUtility.GetDirectory(virtualPath));
string baseName = VirtualPathUtility.GetFileName(virtualPath);
return new XmlResourceProvider(directory, baseName);
}
}

  XmlResourceProviderFactory继承自抽象类ResourceProviderFactory,并实现了两个抽象方法CreateGlobalResourceProvider和CreateLocalResourceProvider。这两个方法均返回一个ResourceProvider对象,它们分别用于基于Global Resource和Local Resource的读取。在XmlResourceProviderFactory中,这两个方法均返回一个XmlResourceProvider对象。所不同的是,CreateGlobalResourceProvider方法返回的XmlResourceProvider基于的资源文件是一个存储在GlobalResources目录下指定名称(classKey)的XML文件,而CreateLocalResourceProvider返回的XmlResourceProvider基于的资源则是和当前访问.aspx文件处于同级目录下,并且名称和.aspx文件同名的XML文件。

  在web.config中,XmlResourceProviderFactory通过<system.web>/<globalization>配置节进行注册,下面是相应的配置。

 
   
<? xml version="1.0" ?>
< configuration >
< system.web >
< globalization uiCulture ="zh-CN" resourceProviderFactoryType ="Artech.ResourceAppBlock.XmlResourceProviderFactory, Artech.ResourceAppBlock.Lib" />
< compilation debug ="true" /></ system.web >
</ configuration >

  四、Global Resource编程

  现在我们来验证以下通过ASP.NET原生的资源编程模式是否能够正常读取我们指定的XML。我们先来演示Global Resource的读取,为此我们创建了一个Web项目,并进行了如上的配置。如上面途中所示,我们在GlobalResources目录下添加了3个XML文件,其中GreetingMessages.xml作为语言文化中性的资源文件,而GreetingMessages.en-US.xml和GreetingMessages.zh-CN.xml则基于美式英语和简体中文。GreetingMessages.xml和GreetingMessages.en-US.xml具有相同的内容。

 
   
<? xml version="1.0" encoding="utf-8" ?>
< resources >
< add name ="Greeting4Chris" value ="Merry Christmas!" />
< add name ="Greeting4NewYear" value ="Happy Chinese New Year!" />
</ resources >

  而GreetingMessages.zh-CN.xml则为中文。

 
   
<? xml version="1.0" encoding="utf-8" ?>
< resources >
上海徐汇企业网站制作an><add name="Greeting4Chris" value="圣诞快乐!" />
<add name="Greeting4NewYear" value="新年快乐!" />
</resources>

  现在我们创建一个文件名称为Defualt.aspx的Web页,并在其中放置两个Label控件相应的HTML如下所示。

 
   
< body >
< form id ="form1" runat ="server" >
< div >
< asp:Label id ="LabelGreeting4NewYear" runat ="server" />
< br />
< asp:Label id ="LabelGreeting4Chris" runat ="server" />
</ div >
</ form >
</ body >

  在Page加载的时候,通过如下的代码将两个Label和相应的资源条目进行绑定。

 
   
protected void Page_Load( object sender, EventArgs e)
{
this .LabelGreeting4NewYear.Text = this .GetGlobalResourceObject( " GreetingMessages " , " Greeting4NewYear " ).ToString();
this .LabelGreeting4Chris.Text = this .GetGlobalResourceObject( " GreetingMessages " , " Greeting4Chris " ).ToString();
}

  在浏览器中访问页面,你会得到如下的文字。

 
   
新年快乐 !
圣诞快乐
!

  如果当前的语言文化为en-US,或者其它非zh-CN,页面的文字将显示为英文。比如,你通过如下的配置将默认的UI Culture替换成en-US,你将在页面中得到如下的显示。

 
   
<? xml version="1.0" ?>
< configuration >
< system.web >
< globalization uiCulture ="en-US" resourceProviderFactoryType ="Artech.ResourceAppBlock.XmlResourceProviderFactory, Artech.ResourceAppBlock.Lib" />
< compilation debug ="true" /></ system.web >
</ configuration >

  实现结果:

 
   
Happy Chinese New Year!
Merry Christmas!

  实际上对于Global Resource的读取,你可以采用更为简洁的编程方式,就是以内联的方式,以<%$ Resources:ClassKey, ResourceKey%>的形式直接写在HTML中。在本例中,你可以不用编写任何代码,直接将HTML改成如下的形式即可。

 
   
< body >
< form id ="form1" runat ="server" >
< div >
< asp:Label id ="LabelGreeting4NewYear" runat ="server" Text ="<%$ Resources:GreetingMessages, Greeting4NewYear%>" />
< br />
< asp:Label id ="LabelGreeting4Chris" runat ="server" Text ="<%$ Resources:GreetingMessages, Greeting4Chris%>" />
</ div >
</ form >
</ body >

  五、LocalResource编程

  上面演示了读取或者绑定Global Resource的编程方式,现在来看看Local Resource。Local Resource,顾名思义,就是每个.aspx页面对应一个独自使用的资源文件。按照如上图所示的结构,我为Default.aspx添加了三个本地资源文件:Default.aspx.xml、Default.aspx.zh-CN.xml和Default.aspx.en-US.xml。

  由于Local Resource中的资源条没有自动和页面中某个控件的某个属性进行绑定。在本例中,我们希望资源文本自定义绑定到两个Label的Text属性上,所以我们需要在ResourceKey中加上属性名(Text)后缀,下面是基于英文和中文的内容。

  Default.aspx.xml & Default.aspx.en-US.xml

 
   
<? xml version="1.0" encoding="utf-8" ?>
< resources >
< add name ="Greeting4Chris.Text" value ="Merry Christmas!" />
< add name ="Greeting4NewYear.Text" value ="Happy Chinese New Year!" />
</ resources >

  Default.aspx.zh-CN.xml

 
   
<? xml version="1.0" encoding="utf-8" ?>
< resources >
< add name ="Greeting4Chris.Text" value ="圣诞快乐!" />
< add name ="Greeting4NewYear.Text" value ="新年快乐!" />
</ resources >

  那么资源的绑定通过meta:resourcekey=”…” 直接写在定义控件的HTML中即可。所以我们的Default.aspx可以进行如下的改写,便从基于Global Resource的绑定转变成针对Local Resource的绑定。

上海网站建设
 
   
< body >
< form id ="form1" runat ="server" >
< div >
< asp:Label id ="LabelGreeting4NewYear" runat ="server" meta:resourcekey ="Greeting4NewYear" />
< 上海闵行企业网站设计与制作tyle="color: #800000;">br />
< asp:Label id ="LabelGreeting4Chris" runat ="server" meta:resourcekey 上海企业网站制作"color: #0000ff;">="Greeting4Chris" />
</上海闵行企业网站制作an>div>
</form>
</body>

  实际上,我们也可以通过代码的方式获取本地资源,我们只需要调用Page的GetLocalResourceObject方法即可。上面针对本地资源的绑定与下面的代码是等效的。

 
   
protected void Page_Load( object sender, EventArgs e)
{
this .LabelGreeting4NewYear.Text = this .GetLocalResourceObject ( " Greeting4NewYear.Text " ).ToString();
this .LabelGreeting4Chris.Text = this .GetLocalResourceObject( " Greeting4Chris.Text " ).ToString();
}

目录
相关文章
|
9月前
|
存储 JSON 开发工具
Visual Studio编程效率提升技巧集(提高.NET编程效率)
Visual Studio编程效率提升技巧集(提高.NET编程效率)
175 0
Visual Studio编程效率提升技巧集(提高.NET编程效率)
|
2月前
|
人工智能 机器人
D1net阅闻 | 谷歌DeepMind研究发现LLM新特性
D1net阅闻 | 谷歌DeepMind研究发现LLM新特性
|
6月前
|
传感器 数据采集 物联网
探索.NET nanoFramework:为嵌入式设备编程的新途径
探索.NET nanoFramework:为嵌入式设备编程的新途
235 7
|
8月前
|
大数据 开发工具 开发者
从零到英雄:.NET核心技术带你踏上编程之旅,构建首个应用,开启你的数字世界探险!
【8月更文挑战第28天】本文带领读者从零开始,使用强大的.NET平台搭建首个控制台应用。无论你是新手还是希望扩展技能的开发者,都能通过本文逐步掌握.NET的核心技术。从环境搭建到创建项目,再到编写和运行代码,详细步骤助你轻松上手。通过计算两数之和的小项目,你不仅能快速入门,还能为未来开发更复杂的应用奠定基础。希望本文为你的.NET学习之旅开启新篇章!
66 1
|
8月前
|
开发框架 JSON .NET
ASP.NET Core 标识(Identity)框架系列(三):在 ASP.NET Core Web API 项目中使用标识(Identity)框架进行身份验证
ASP.NET Core 标识(Identity)框架系列(三):在 ASP.NET Core Web API 项目中使用标识(Identity)框架进行身份验证
114 1
|
8月前
|
存储 C#
揭秘C#.Net编程秘宝:结构体类型Struct,让你的数据结构秒变高效战斗机,编程界的新星就是你!
【8月更文挑战第4天】在C#编程中,结构体(`struct`)是一种整合多种数据类型的复合数据类型。与类不同,结构体是值类型,意味着数据被直接复制而非引用。这使其适合表示小型、固定的数据结构如点坐标。结构体默认私有成员且不可变,除非明确指定。通过`struct`关键字定义,可以包含字段、构造函数及方法。例如,定义一个表示二维点的结构体,并实现计算距离原点的方法。使用时如同普通类型,可通过实例化并调用其成员。设计时推荐保持结构体不可变以避免副作用,并注意装箱拆箱可能导致的性能影响。掌握结构体有助于构建高效的应用程序。
270 7
|
8月前
|
Java Spring 自然语言处理
Spring 框架里竟藏着神秘魔法?国际化与本地化的奇妙之旅等你来揭开谜底!
【8月更文挑战第31天】在软件开发中,国际化(I18N)与本地化(L10N)对于满足不同地区用户需求至关重要。Spring框架提供了强大支持,利用资源文件和`MessageSource`实现多语言文本管理。通过配置日期格式和货币符号,进一步完善本地化功能。合理应用这些特性,可显著提升应用的多地区适应性和用户体验。
79 0
|
8月前
|
传感器 数据采集 物联网
探索未来:.NET nanoFramework引领嵌入式设备编程革新之旅
【8月更文挑战第28天】.NET nanoFramework 是一款专为资源受限的嵌入式设备设计的轻量级、高性能框架,基于 .NET Core,采用 C# 进行开发,简化了传统底层硬件操作的复杂性,极大提升了开发效率。开发者可通过 Visual Studio 或 Visual Studio Code 快速搭建环境并创建项目,利用丰富的库和驱动程序轻松实现从基础 LED 控制到网络通信等多种功能,显著降低了嵌入式开发的门槛。
165 0
|
8月前
分享一份 .NET Core 简单的自带日志系统配置,平时做一些测试或个人代码研究,用它就可以了
分享一份 .NET Core 简单的自带日志系统配置,平时做一些测试或个人代码研究,用它就可以了
102 0
|
8月前
|
开发框架 .NET 数据库连接
ASP.NET Core 标识(Identity)框架系列(一):如何使用 ASP.NET Core 标识(Identity)框架创建用户和角色?
ASP.NET Core 标识(Identity)框架系列(一):如何使用 ASP.NET Core 标识(Identity)框架创建用户和角色?
120 0