SharePoint 2010:部署.resx(资源)文件到App_GlobalResources的简单方法

SharePoint 2010中的资源文件

通常,在我们的自定义解决方案中,资源文件主要用于实现本地化。
同样在 SharePoint 2010中, 我们的定制开发过程也会涉及类似的本地化过程,因此开发人员不可避免的需要和各种特定语言的resx文件打交道。在开发SharePoint解决方案时,resx文件可以通过名为“Resources”SharePoint映射文件夹来实现。在此路径下存放的资源文件可以通过SPUtility.GetLocalizedString 方法来访问。但毕竟,我们会遇到很多和特定用户界面相关的定制化工作。而SharePoint 2010本身是基于ASP.NET 技术实现的。所以任何包含了资源引用的标记都会从App_GlobalResources文件夹下搜索.resx文件。对于SharePoint来说,该文件夹位于 intepub\wwroot\wss\<<Web应用程序目录>> 这个路径下。
这一点就给需要要使用传统ASP.NET UI资源本地化方式进行开发的SharePoint开发人员带来了额外的部署上的开销。我们需要确保一个resx文件必须同时被部署在经典的14目录App_GlobalResources下。

有很多办法可以部署资源文件。比如:
•    编写一个事件接收器程序(event handler)来复制 resx 文件
•    自定义timer job
•    在部署用到的PowerShell 脚本中实现
•    手工复制粘贴,等等....

但是,当我们的解决方案需要卸载,更新时该怎么办?更惨的是,如果我们的SharePoint环境还是多服务器的场环境。这时,手工部署resx 文件的工作就会变得繁琐且十分容易出错。

SharePoint 2010类型的项目支持称为“元素(Elements)”的功能(Feature)。通过元素我们可以部署一系列的文件到指定的位置。下面,我们就看一下如何使用元素来部署resx 文件,使其能够放在 App_GlobalResources 文件夹下。这么做至少有以下几点好处:

•    不需要为了部署单独写自定义的代码
•    Resx 文件被统一打包到了WSP文件中
•    不需要担心升级和卸载,因为SharePoint 自动为我们处理
•    非常适合多服务器的SharePoint场环境下部署
•    无手工步骤

步骤

•    新建一个 空白SharePoint 2010 项目。名为 ResxDeployment
•    选择一个本地站点进行调试,部署类型选择 部署为场解决方案
 

•    在解决方案资源管理器里,右击 ResxDeployment 项目,添加一个 SharePoint 映射文件夹
•    在 添加 SharePoint 映射文件夹 对话框中, 选择Resources 并点确定

•    在解决方案资源管理器里,右击 ResxDeployment 项目,添加一个新建项...
•    在Resources文件下添加一些示例 resx 文件

 •    在解决方案资源管理器里,右击 ResxDeployment 项目,添加一个新建项。添加一个 空元素 并将其命名。这里我们叫做 App_GlobalResources
 

•    在解决方案资源管理器里,点击显示所有文件图标,来查看所有的文件。打开SharePointProjectItem.spdata 文件,该文件位于 App_GlobalResources 结点下。

 •    在xml文件中添加资源文件的相关信息,包括SourceTypeType 指定成AppGlobalResourceSource 指定 resx 文件的相对路径。 如下面的例子所示:

<?xml version="1.0" encoding="utf-8"?>
<ProjectItem Type="Microsoft.VisualStudio.SharePoint.GenericElement" DefaultFile="Elements.xml" SupportedTrustLevels="All" SupportedDeploymentScopes="Web, Site, WebApplication, Farm, Package" xmlns="http://schemas.microsoft.com/VisualStudio/2010/SharePointTools/SharePointProjectItemModel">
  <Files>
    <ProjectItemFile Source="Elements.xml" Target="App_GlobalResources\" Type="ElementManifest" />
    <ProjectItemFile Source="..\Resources\Contoso.resx" Type="AppGlobalResource"/>
    <ProjectItemFile Source="..\Resources\Contoso.zh-CN.resx" Type="AppGlobalResource"/>
    <ProjectItemFile Source="..\Resources\Contoso.ko-KR.resx" Type="AppGlobalResource"/>
    <ProjectItemFile Source="..\Resources\Contoso.en-US.resx" Type="AppGlobalResource"/>
    <ProjectItemFile Source="..\Resources\Contoso.ja-JP.resx" Type="AppGlobalResource"/>
  </Files>
</ProjectItem>

•    在解决方案资源管理器里,双击默认的Feature1,打开Feature设计器。将我们刚刚创建的元素加到右侧。使其包含到Feature中。

•    在解决方案资源管理器里,右击 ResxDeployment 项目,选择部署
•    如果一切正常,该解决方案将被部署到指定的web 应用程序。同时,通过检查,我们看到resx 文件同时部署到了 App_GlobalResources14\Resources 文件夹下面。

需要注意的要点

资源文件被部署到了两个不同的位置。当然你也可以直接在元素的文件夹中添加resx文件。
1.    在这个例子中,我们不需要在Visual Studio里把文件从Resources 映射文件夹拷贝到 App_GlobalResources 元素文件夹。实际上只有一份resx 文件, 所以我们不需要担心同时修改多个位置的问题。
2.    每添加一个 resx 文件, SharePointProjectItem.spdata 文件中都应该做相应的更新。否则该文件不会被复制到web应用程序的App_GlobalResources 文件夹下。
3.    请为该项目对应的功能设置适当的范围(Scope)。 通常我们设置成web应用程序这一级别。

通过以上的方法,我们就可以利用SharePoint自带的功能框架来部署resx 文件到 App_GlobalResources

参考资料

Easy way to deploy .resx (resource) files under App_GlobalResources folder in SharePoint 2010

posted @ 2012-07-28 23:16 Sunmoonfire 阅读(...) 评论(...) 编辑 收藏