.NET系統(tǒng)學(xué)習(xí)----Globalization & Resources
2024-07-10 12:59:31
供稿：網(wǎng)友
.net系統(tǒng)學(xué)習(xí)----globalization & resources
l 前言
l 了解資源文件
l 創(chuàng)建資源文件
l 在程序中使用資源文件
l 資源文件的命名和部署
l 參考
前言：
在學(xué)習(xí)如何使用.net資源文件以及如何開發(fā)world-ready程序之前，我們先通過一個(gè)例子來(lái)看看為什么要使用資源文件，以及使用它的好處。
假設(shè)要在程序中根據(jù)當(dāng)前的culutre來(lái)設(shè)置form的title和logo：
private void form1_load(object sender, system.eventargs e) {
cultureinfo ci = new cultureinfo(thread.currentthread.currentuiculture.tostring());
switch (ci.tostring().tolower()) {
case "zh-cn": // 中文版本
this.text=formtitle_zh_cn;
imglogo.image = new bitmap(application.startuppath + "/logo_zh_cn.jpg");
break;
case "en-us": // 英文版本
this.text=formtitle_en_us;
imglogo.image = new bitmap(application.startuppath + "/logo_en_us.jpg");
break;
default: // 默認(rèn)版本
this.text=formtitle_neutral;
imglogo.image = new bitmap(application.startuppath + "/logo_neutral.jpg");
break;
}
}
這段代碼有兩個(gè)問題：
首先，logo文件是暴露給用戶的，而且是以普通文件的格式存儲(chǔ)的，這導(dǎo)致其他程序或是用戶很容易修改這些文件；節(jié)省硬盤空間的用戶還可能會(huì)選擇刪除它，這些都可能會(huì)導(dǎo)致應(yīng)用程序出錯(cuò)。確保圖片或任何其他文件和代碼在一起的唯一的安全方式是將它作為資源文件嵌入在程序集中并加載。
其次，這是一個(gè)world-ready程序，如果需要新加入一個(gè)新的culture，你可能不得不更改你的源代碼，加入新的case，然后重新編譯來(lái)適應(yīng)新的culture的需要，這對(duì)一個(gè)world-ready程序來(lái)說(shuō)是不現(xiàn)實(shí)的。開發(fā)world-ready程序很重要的一點(diǎn)就是要保證程序的邏輯界面和資源界面的隔離。任何時(shí)候加入一個(gè)新的culture資源，我們都不應(yīng)該重新編譯源程序，相反，我們只需要把新的資源文件準(zhǔn)備好，然后發(fā)布給用戶并部署在合適的目錄下就可以了。應(yīng)用程序應(yīng)該能夠根據(jù)不同的culture來(lái)自動(dòng)尋找合適的資源。
本文的目的就是通過實(shí)例來(lái)幫助讀者了解什么是resources，以及如何使用resources來(lái)消除上面所提到的兩個(gè)問題。
全文分為四部分：
第一部分是一些和資源相關(guān)的概念。
第二部分是一個(gè)實(shí)例程序（resourcegenerator），用來(lái)說(shuō)明如何創(chuàng)建資源文件。
第三部分是另外一個(gè)實(shí)例程序（worldapp），用來(lái)說(shuō)明如何在程序中使用資源文件
第四部分是關(guān)于資源文件的命名和部署。分別介紹.net中資源文件的命名方式和如何在world-ready程序中配置資源文件。
第一部分 概念
先來(lái)了解一些概念：
1. 什么是資源文件
顧名思義，資源文件當(dāng)然包含的全是資源。不過，什么是資源？這里所謂的資源就是程序中可利用的任何數(shù)據(jù)，譬如：字符串、圖片或任何二進(jìn)制格式的數(shù)據(jù)。一個(gè)資源文件可以有多種語(yǔ)言文化版本，比如，一個(gè)culture.resources 文件可以有英語(yǔ)版、簡(jiǎn)體中文版日文版等。resourcemanager可以自動(dòng)根據(jù)culture和資源文件名來(lái)確認(rèn)調(diào)用哪個(gè)版本。只不過不同的資源版本需要在文件名中加入語(yǔ)言文化信息（.resource文件有一套嚴(yán)格的命名規(guī)范，參考第四部分：資源文件的命名和部署）。
2. 資源文件的類型
system.resources名稱空間支持三種類型的資源：
.txt文件，只能有字符串資源。因?yàn)椴荒鼙磺度氲絘ssembly中，所以很容易暴露，被其他程序或用戶修改。最大缺點(diǎn)是僅支持字符串資源，不推薦使用。
.resx文件，由xml組成，可以加入任何資源，包括二進(jìn)制格式的。同樣不能被嵌入到assembly中。在system.resources 名稱空間中有專用讀寫的類。vs.net中創(chuàng)建的這種文件也是將其轉(zhuǎn)成.resources 文件然后根據(jù)設(shè)置將其嵌入到assembly中。
.resources文件，pe格式，可以加入任何資源。是唯一可以被嵌入到assembly的文件，在system.resources名稱空間中有專用讀寫的類（resourcemanager）。
3. 調(diào)用資源文件的幾種方法
resourcemanager可以根據(jù)不同的uiculture設(shè)置返回不同的本地資源，不同culture的資源文件有一套嚴(yán)格的命名規(guī)則，只有按照這個(gè)規(guī)則命名，crl才可以根據(jù)culture找到這個(gè)本地資源。ps：因?yàn)檫@個(gè)很重要，所以才一再出現(xiàn)j。參考第四部分：資源文件的命名和部署）
.txt 文件：
不可以直接調(diào)用，得先將其轉(zhuǎn)換成 .resources 文件才能使用。
.resx 文件：
可以用resxresourcereader來(lái)讀取，但是這種方法不直觀也不安全，不推薦直接調(diào)用.resx文件。正確的方法是將其轉(zhuǎn)換成.resources文件，然后用resourcemanager讀取。注意，如果是在vs.net中添加的.resx文件，那么它們自動(dòng)被設(shè)為 embedded resource，然后被轉(zhuǎn)成.resources文件后嵌入到assembly中。
.resources 文件：
分成兩種情況：
· 被嵌入或編譯成衛(wèi)星程序集（satellite assembly）：
用resourcemanager的各種constructor來(lái)獲得在assembly中的資源。
· 單獨(dú)文件，沒有被編譯或嵌入到assembly中：
可以用resourcemanager.createfilebasedresourcemanager來(lái)獲得資源集（resourceset），就是所有的資源。
特殊情況：
還有一種特殊情況，那就是當(dāng)你直接嵌入一資源時(shí)，也就是說(shuō)，不通過一個(gè)資源文件（.resources）而直接將一資源（object）嵌入到 assembly 中。這可以通過al.exe（assembly linker）的參數(shù)/embed:<object>把資源嵌入在assembly中。在這種情況下resourcemanager就沒有用了，因?yàn)樗荒塬@取.resources資源文件（在或不在assembly中）。
調(diào)用這類直接嵌入在assembly中的資源，我們就需要利用reflection的一些特性來(lái)完成。在system.reflection.assembly類中有一些相關(guān)函數(shù)可以幫助我們拿到這些資源。通過assembly.getmanifestresourcenames可以拿到所有的資源的名字，然后我們就可以通過assembly.getmanifestresourcestream（<object_name>）這個(gè)函數(shù)拿到對(duì)應(yīng)的資源并以stream的方式返回，然后我們可以將這個(gè)stream轉(zhuǎn)成在.net中可用的對(duì)象。比如，如果嵌入資源是一圖片，那么我們可以利用new bitmap（stream）的constructor獲得這個(gè)圖片資源的bitmap對(duì)象。
第二部分 創(chuàng)建資源文件
創(chuàng)建資源文件有兩種方式，一種是使用.net sdk自帶的resgen工具來(lái)創(chuàng)建，另外一種是自己寫code來(lái)創(chuàng)建。分別來(lái)介紹：
1. resgen：
這個(gè)工具是.net自帶的，它可以把.txt，.resx，轉(zhuǎn)換為.resources文件。.resources文件是以一種以鍵-值方式對(duì)應(yīng)存儲(chǔ)的xml格式文件，每一個(gè)鍵<data>對(duì)應(yīng)一個(gè)值<value>，這個(gè)<value>可以是任何的二進(jìn)制格式。如果是格式為（鍵=值）對(duì)應(yīng)得.txt文件，resgen會(huì)自動(dòng)生成鍵-值對(duì)應(yīng)的xml文件。但是resgen有一個(gè)局限性，它不能直接嵌入其他格式的文件，比如你就不能把.bmp以鍵-值得方式對(duì)應(yīng)起來(lái)，因?yàn)槟闶紫炔荒芎苋菀椎冒?bmp以（鍵=值）對(duì)應(yīng)的格式儲(chǔ)存在.txt文件中。所以resgen主要是針對(duì)txt文件使用。
一個(gè)例子：company1.txt文件內(nèi)容為：
title = company1
address = company1 address
phone = 12345678
----------------------------------------------------------------
resgen company.txt <outputfilename>.resources
如果不指定<outputfilename>，默認(rèn)會(huì)生成company1.resources。
然后就可以通過resourcemanager來(lái)使用了。
還可以再進(jìn)一步，通過al.exe把resources文件變?yōu)橐粋€(gè)assembly（使用assembly有很多好處（比如可以加入版本信息和culture信息等）詳見（.net系統(tǒng)學(xué)習(xí)----assembly）。
al /out:company1.dll /embed:company1.resources
通過設(shè)置resourcesmanager的不同的constructor就可以訪問assembly中包含的.resources文件（下面的例子會(huì)講到）。
2. 通過編程使用iresourcswrite來(lái)生成資源文件
上面的方法的一個(gè)最大的缺點(diǎn)是不能很方便的嵌入其他格式的資源，因?yàn)榘哑渌袷降馁Y源變?yōu)殒I-值對(duì)應(yīng)得txt文件并不是一件很容易的事。所以我們介紹另一種方法，通過編程，使用.net提供的iresourceswrite類來(lái)實(shí)現(xiàn)把任何資源嵌入到resources文件中。
resourcegenerator就是用這種方式實(shí)現(xiàn)的。
程序的主界面：
用到的主要方法就是：
private void ongenerateresource(object sender, system.eventargs e)
{
iresourcewriter rw = new resourcewriter(“c:/test.resources”);
switch (stype)
{
case "system.string":
rw.addresource(skey,svalue);
break;
case "system.drawing.bitmap":
bitmap bmp = new bitmap(svalue);
rw.addresource(skey,bmp);
break;
case "system.drawing.image":
image img= new bitmap(svalue);
rw.addresource(skey,img);
break;
}
}
根據(jù)資源的類型，如果不是string類型的，我們就把它分實(shí)例化為相應(yīng)的stream，然后加入到resoruces中即可（string類型可以直接加入）。生成的就是.net可以直接使用的.resources文件。但是這樣生成的資源clr并不能根據(jù)不同的culture自動(dòng)識(shí)別。要想crl自動(dòng)識(shí)別并加載正確的資源文件，首先必須把.resources轉(zhuǎn)換為assembly，并根據(jù)嚴(yán)格的命名方式命名（參考第四部分：資源文件的命名和部署），并部署到正確的目錄下，然后clr就可以根據(jù)不同的culture來(lái)加載正確的資源。
第三部分 在程序中使用資源文件
worldapp.cs是一個(gè)world-ready的程序，它的邏輯界面和資源界面是分開的，可以實(shí)現(xiàn)邏輯界面只bulid一次，運(yùn)行時(shí)根據(jù)當(dāng)前的culture調(diào)用相應(yīng)的satellite assembly（衛(wèi)星資源程序集）來(lái)實(shí)現(xiàn)本地化。添加一個(gè)新的culture資源不需要重新build源程序，只需要把相應(yīng)的資源程序集部署到合適的目錄就可以了。
下面說(shuō)明worldapp的實(shí)現(xiàn)方式：
程序主界面：
程序在啟動(dòng)的時(shí)候會(huì)根據(jù)當(dāng)前的currentuiculutre去加載相應(yīng)的資源文件。
讀取資源文件的代碼為：
private void setculture( cultureinfo ci )
{
// change current ui culture
thread.currentthread.currentuiculture = ci;
// load culture resources.
string assemblypath = application.startuppath + "//culture.dll";
assembly asm = assembly.loadfrom(assemblypath);
// resorucemanager constructor will load different resources acording to the
// currentuiculture. which means, if currentuiculutre is "en-us", rm will load
// "culture.en-us.resources" automaticly.
// when loaded, give the resource name only.
resourcemanager rm = new resourcemanager("culture", asm);
// set title, culture info and logo.
this.lbltitle.text = rm.getstring("title");
this.lblculture.text = rm.getstring("culture");
this.lbllogo.text = rm.getstring("logotitle");
this.imglogo.image=(bitmap)rm.getobject("logo");
}
如果當(dāng)前的uiculture改變，可以通過顯式調(diào)用setculture( cultureinfo ci )來(lái)加載相應(yīng)的culture資源。
現(xiàn)在如果我們有了一個(gè)新的culture資源版本，我們只需要把它部署在對(duì)應(yīng)的culture目錄下，worldapp.exe就可以自動(dòng)加載，worldapp.exe程序本身并不用做任何更改（不需要編譯）。
你可以通過上面制作的小工具resorucegenerator來(lái)生成對(duì)應(yīng)不同culture的資源，然后把生成的assembly正確部署就可以了。worldapp就又有了一個(gè)新的culture版本。哈!!
第四部分 資源文件的命名和部署
這部分說(shuō)明資源文件的部署方式和clr是如何識(shí)別并加載不同的culture資源的。
· 資源文件的命名方式
假設(shè)我們的應(yīng)用程序名為worldapp.exe，默認(rèn)的資源文件為culture.resources，根據(jù)這個(gè)資源文件生成的assembly為culutre.dll（這個(gè)是默認(rèn)版本的資源文件）。然后我們有了一個(gè)en-us culture版本的資源文件，則en-us的資源文件得名稱必須為culture.en-us.resources，根據(jù)這個(gè)資源文件生成的en-us版本的assembly必須命名為culture.resources.dll且必須加入culture信息（把一個(gè).resources生成一個(gè)assembly：resgen /out:cluture.resources.dll /c:en-us /embedcluture.en-us.resources），生成的assembly必須放在程序運(yùn)行目錄下的en-us目錄下，這樣clr才能自動(dòng)找到。同樣，如果我們有了一個(gè)zh-cn版本的資源文件，則資源文件的名稱必須為culture.zh-cn.resources，生成的assembly必須為culture.resources.dll，并放在zh-cn目錄下。
重要：因?yàn)樯傻?resources文件本身并不包含culture信息，它的culture信息就體現(xiàn)在它的文件名上，所以.resources的命名必須加入cluture信息（如果不加的話，生成的就是默認(rèn)版本）。從.resources生成assembly時(shí)，因?yàn)閍ssembly可以指定culture信息（通過/c:<culture>來(lái)指定），所以assembly的名稱中不需要加入culture信息，但是assembly的名字必須是：默認(rèn)版本名+<.resources>.dll，就是：culture.[resources].dll。
· 資源文件的部署方式
應(yīng)用程序正確的部署方式（目錄結(jié)構(gòu)）應(yīng)該是：
<worldapp> （應(yīng)用程序主目錄）
worldapp.exe （主程序）
culture.dll （包含culture.resources資源文件）
<en-us> （en-us資源目錄）
culture.resources.dll （包含culture.en-us.resources資源文件）
<zh-cn> （zh-cn資源目錄）
culture.resources.dll （包含culture.zh-cn.resources資源文件）
<new-culture> （net-culture資源目錄）
culture.resources.dll （包含cluture.new-culture.resources）
<…>
有了上面的部署，app.exe在運(yùn)行時(shí)，會(huì)首先根當(dāng)前thread的currentuiculuture到對(duì)應(yīng)的目錄去尋找資源文件，比如當(dāng)前的currentuiculture=”en-us”，則en-us目錄下的culture.resources.dll assembly中的culture.en-us.resources會(huì)被加載。如果clr遍歷整個(gè)目錄還沒有找到對(duì)應(yīng)的資源文件，則默認(rèn)的資源文件版本就被加載（msdn中稱為hub and spoke model方式 詳見：ms-help://ms.msdnqtr.2004apr.1033/cpguide/html/cpconpackagingdeployingresources.htm）。
· clr如何加載資源文件
重要：clr在匹配資源文件的時(shí)候，不是按文件來(lái)匹配的，它是按照<data>字段一個(gè)key一個(gè)key的去匹配。舉個(gè)例子：
默認(rèn)版本的culture資源文件中包含四個(gè)key：title, culture, logotitle,logo。
中文版本的culture資源文件中包含只有三個(gè)key：title, culture, logo。（沒有l(wèi)ogotitle）
如果當(dāng)前的culture是”zh-cn”，則zh-cn版本的title, culture, logo都會(huì)被加載，但是因?yàn)閦h-cn版本沒有l(wèi)ogotitle，所以clr會(huì)自動(dòng)加載和zh-cn文化最匹配的一個(gè)資源版本的logotitle。如果都沒有，最后才會(huì)去加載默認(rèn)版本的資源文件。
這樣做有一個(gè)很大的好處：就是說(shuō)并不是所有資源都必須要有對(duì)應(yīng)culture的版本，我們可以把共通的資源放在默認(rèn)版本中，只把和特定culture相關(guān)的資源隔離就可以了。
重要：關(guān)于culture：
culture信息是由主標(biāo)記（文化）和次標(biāo)記（地域）兩部分組成的。舉個(gè)例子：
en-us （英語(yǔ)-美國(guó)）
en-gb （英語(yǔ)-英國(guó)）
en-au （英語(yǔ)-澳大利亞）
主標(biāo)記是en，表示culture都是英語(yǔ)文化，次標(biāo)記（地域）區(qū)分了它們分別是哪個(gè)地區(qū)的英語(yǔ)。
說(shuō)這個(gè)有什么用呢？
因?yàn)閏lr在尋找資源的時(shí)候是以一種回退的方式來(lái)尋找的，就是說(shuō)，他會(huì)首先去尋找最批的那個(gè)資源文件，如果沒有，則會(huì)搜索文化層次結(jié)構(gòu)，以查找最接近于請(qǐng)求的匹配資源文件，并把生成異常作為最后一種手段。比如clr在尋找en-us資源的時(shí)候沒有找到，clr不會(huì)立即就去用默認(rèn)版本匹配，而是會(huì)首先搜索文化層次結(jié)構(gòu)，以查找最接近于en-us的資源（可能是en-gb或別的），如果找到，運(yùn)行時(shí)就使用這個(gè)資源，如果還找不到，則會(huì)繼續(xù)搜索下一層，最后才會(huì)用默認(rèn)版本匹配（如果默認(rèn)版本也沒有，則會(huì)拋出一個(gè)異常）。
參考資料：
l applied microsoft .net framework programming ---- jeffrey richter
l msnd library
