36、SharePoint 解决方案的打包与部署全解析

最新推荐文章于 2025-12-17 09:17:46 发布

omega

最新推荐文章于 2025-12-17 09:17:46 发布

阅读量73

点赞数

CC 4.0 BY-SA版权

分类专栏：掌握SharePoint开发利器文章标签： SharePoint 解决方案打包部署

本文链接：https://blog.youkuaiyun.com/omega/article/details/150836790

掌握SharePoint开发利器专栏收录该内容

43 篇文章 ¥499.90

订阅专栏¥69.90

会员秒杀 ¥9.9 重磅福利

超级会员免费看

SharePoint 解决方案的打包与部署全解析

1. 功能停用与解决方案打包概述

在 SharePoint 中，停用功能的命令与其他操作命令类似。当你只需安装单个 SharePoint 功能时，手动安装、卸载、激活和停用功能的过程并不复杂。但如果需要一次性安装多个功能，手动操作就会变得繁琐。这时，SharePoint 解决方案打包就派上用场了。

SharePoint 解决方案是一个或多个 SharePoint 功能的集合。它以具有 .WSP 扩展名的 cabinet 文件（.CAB）形式存在，也被称为解决方案包或包文件。解决方案的核心是解决方案清单文件 Manifest.xml，它是一个 XML 文件，用于指示解决方案中包含的内容以及部署位置。此外，它还有一个唯一标识解决方案的 SolutionId。

以下是一个用于部署三个功能的示例解决方案清单文件：

<?xml version="1.0" encoding="utf-8"?>
<Solution xmlns="http://schemas.microsoft.com/sharepoint/" SolutionId="your-solution-guid">
    <FeatureManifests>
        <FeatureManifest Location="Feature1\Feature.xml" />
        <FeatureManifest Location="Feature2\Feature.xml" />
        <FeatureManifest Location="Feature3\Feature.xml" />
    </FeatureManifests>
</Solution>

2. 解决方案清单文件的 XML 元素

3. 手动创建和部署 SharePoint 解决方案

3.1 准备解决方案文件夹结构

创建 SharePoint 解决方案包，首先要准备解决方案文件夹结构，并将所需文件复制到相应文件夹。以包含两个功能的解决方案为例，文件夹结构如下：

Root Folder
├── Manifest.xml
├── Feature1
│   ├── Feature.xml
│   ├── Element1
│   │   └── Elements.xml
│   └── Element2
│       └── Elements.xml
└── Feature2
    ├── Feature.xml
    └── Element3
        └── Elements.xml

对应的 Manifest.xml 文件如下：

<?xml version="1.0" encoding="utf-8"?>
<Solution xmlns="http://schemas.microsoft.com/sharepoint/" SolutionId="your-solution-guid">
    <FeatureManifests>
        <FeatureManifest Location="Feature1\Feature.xml" />
        <FeatureManifest Location="Feature2\Feature.xml" />
    </FeatureManifests>
</Solution>

3.2 创建 Diamond Directive 文件（.DDF）

接下来，需要创建一个 Diamond Directive 文件（.DDF）来定义包的文件夹结构。以下是一个示例：

.OPTION EXPLICIT
.Set CabinetNameTemplate=MySolution.wsp
.Set DiskDirectoryTemplate=Package
.Set CompressionType=MSZIP
.Set UniqueFiles=OFF
.Set Cabinet=on
.Set Compress=on
.Set DestinationDir=Feature1
Feature1\Feature.xml
.Set DestinationDir=Feature1\Element1
Feature1\Element1\Elements.xml
.Set DestinationDir=Feature1\Element2
Feature1\Element2\Elements.xml
.Set DestinationDir=Feature2
Feature2\Feature.xml
.Set DestinationDir=Feature2\Element3
Feature2\Element3\Elements.xml
.Set DestinationDir=.
Manifest.xml

3.3 创建 .CAB 文件

保存 .DDF 文件后，使用操作系统自带的 MAKECAB 工具创建 .CAB 文件。确保在 .DDF 文件所在的文件夹中运行以下命令：

makecab /f MySolution.ddf

此命令将在执行 Makecab 的文件夹中创建一个名为 “Package” 的子文件夹，并将 MySolution.wsp 文件放入其中。

3.4 使用 stsadm.exe 安装解决方案

有了 .WSP 文件后，就可以使用 stsadm.exe 将解决方案安装到 SharePoint 服务器。以下是相关命令：
- 添加解决方案到 SharePoint 解决方案存储：

stsadm -o addsolution -filename MySolution.wsp

部署解决方案：

stsadm -o deploysolution -name MySolution.wsp -immediate -allcontenturls

收回解决方案：

stsadm -o retractsolution -name MySolution.wsp -immediate

删除解决方案：

stsadm -o deletesolution -name MySolution.wsp

4. Visual Studio 中的 SharePoint 项目结构

4.1 项目结构概述

在 Visual Studio 2010 中创建新的 SharePoint 2010 项目时，它会自动为你创建一个项目结构。每个 SharePoint 项目都包含以下元素：
- 功能文件夹（Features）
- 包文件夹（Package）
- 零个或多个 SharePoint 项目项文件夹

以工作流项目为例，其结构如下：

Workflow Project
├── Features
│   └── WorkflowFeature
│       └── Feature.xml
├── Package
│   └── Package.package
└── Workflow1
    ├── Elements.xml
    └── Workflow1.cs

4.2 项目项文件的部署属性

每个 Visual Studio SharePoint 项目项中的项目项文件都设置了属性，用于定义文件在 SharePoint 服务器上的部署位置。这些属性可以在“属性”窗口的“SharePoint”类别中查看。

部署类型属性决定文件的部署位置，不同的部署类型对应不同的默认根路径和路径。以下是一些常见的部署类型及其默认值：
| 部署类型 | 根路径 | 路径 |
| — | — | — |
| NoDeployment | / | N/A |
| ElementManifest | {SharePointRoot}\Template\Features{FeatureName}{ProjectItemName} | |
| ElementFile | {SharePointRoot}\Template\Features{FeatureName}{ProjectItemName} | |
| TemplateFile | {SharePointRoot}\Template{ProjectName}{ProjectItemName} | |
| RootFile | {SharePointRoot}{ProjectName}{ProjectItemName} | |
| ClassResource | {ClassResourcePath}{ProjectName}{ProjectItemName} | |
| ApplicationResource | {WebApplicationRoot}\Resources{ProjectName}{ProjectItemName} | |
| AppGlobalResource | {WebApplicationRoot}\App_GlobalResources{ProjectName}{ProjectItemName} | |
| PackageOnly | / | {ProjectName}{ProjectItemName} |
| Resource | {SharePointRoot}\Template\Features\ | N/A |
| DwpFile | {WebApplicationRoot}\wpcatalog{ProjectName}{ProjectItemName} | |

当项目打包时，会枚举项目中的所有文件并检查其部署类型。如果文件的部署类型设置为 TemplateFile，例如，XML 元素 TemplateFile 将被添加到项目的 Manifest.xml 解决方案清单文件中。

4.3 功能设计器

功能文件夹中的功能可以通过双击打开功能设计器。功能设计器提供了功能清单文件（Feature.xml）的设计视图，通过它和“属性”窗口可以设置在 Feature.xml 文件中可直接编辑的所有内容。

5. 使用 Visual Studio 创建 SharePoint 元素示例

5.1 创建空 SharePoint 项目

以下是创建空 SharePoint 项目并添加自定义操作元素的步骤：
1. 以管理员权限打开 Visual Studio 2010。
2. 点击“文件”>“新建项目”。
3. 展开“Visual C#”>“SharePoint”>“2010”节点，选择“空 SharePoint 项目”模板。
4. 将项目命名为 “HiddenFeatureAndImage”，然后点击“确定”启动 SharePoint 自定义向导。
5. 选择“作为场解决方案部署”，然后点击“完成”创建项目。

5.2 添加 SharePoint 项目项

由于空 SharePoint 项目默认没有任何功能，可以通过以下两种方式创建功能：
- 添加 SharePoint 项目项：每次向项目中添加 SharePoint 项目项时，它会自动重用项目中具有兼容范围的现有功能，或者如果项目中没有具有兼容范围的功能（或根本没有功能），则会创建一个新功能。
- 直接添加新的空功能：右键单击“功能”文件夹，从上下文菜单中选择“添加功能”。

接下来，添加一个 SharePoint 项目项：
1. 右键单击项目名称，选择“添加”>“新建项…”。
2. 选择“空元素”项目项模板，并将其命名为 “My Custom Action”。
3. 点击“添加”将项目项添加到项目中。

5.3 创建自定义操作元素

添加空元素项目项后，会得到一个空的 Elements.xml 文件。要使元素发挥作用，需要编写一些 XML。以下是一个创建自定义操作元素的示例，该元素将 Bing 搜索引擎的链接添加到 SharePoint 的“站点操作”菜单中：

<Elements xmlns="http://schemas.microsoft.com/sharepoint/">
    <CustomAction
        Id="MyCustomAction"
        GroupId="SiteActions"
        Location="Microsoft.SharePoint.StandardMenu"
        Sequence="100"
        Title="Bing"
        Description="Search with Bing"
        ImageUrl="/_layouts/images/MyImage.png"
        Url="http://www.bing.com">
    </CustomAction>
</Elements>

5.4 部署项目

将上述 XML 代码添加到 Elements.xml 文件后，按 F5 部署项目。在 Web 浏览器中导航到 SharePoint 主页，打开“站点操作”菜单，会看到一个名为 “Bing” 的菜单项。

为了使自定义操作更美观，可以添加描述和图像。添加描述只需在 CustomAction 元素中添加 Description 属性。要部署图像，可以使用映射文件夹。

6. 总结

通过手动方式和使用 Visual Studio 两种方法，我们可以完成 SharePoint 解决方案的打包和部署。手动方式有助于我们深入理解 SharePoint 解决方案的工作原理，而 Visual Studio 则提供了更便捷的自动化工具，提高了开发效率。在实际开发中，可以根据具体需求选择合适的方法。无论是手动操作还是使用 Visual Studio，都需要掌握解决方案清单文件、项目结构和部署属性等关键知识，以确保解决方案的正确部署和运行。

7. 映射文件夹部署图像

7.1 映射文件夹的概念

映射文件夹是 Visual Studio 中用于简化 SharePoint 项目文件部署的一种机制。它允许开发者将本地项目中的文件夹与 SharePoint 服务器上的特定文件夹进行映射，这样在部署项目时，这些文件夹中的文件会自动被部署到对应的 SharePoint 位置。

7.2 使用映射文件夹部署图像的步骤

添加映射文件夹 ：
- 在 Visual Studio 中，右键单击项目名称，选择“添加”>“映射文件夹”。
- 从弹出的列表中选择合适的目标文件夹，例如“Images”，这将在项目中创建一个与 SharePoint 服务器上的图像文件夹相对应的映射文件夹。
将图像文件添加到映射文件夹 ：
- 将准备好的图像文件（如 .png 、 .jpg 等格式）复制到刚刚创建的映射文件夹中。
更新 CustomAction 元素的 ImageUrl 属性 ：
- 打开之前创建的 Elements.xml 文件，找到 CustomAction 元素。
- 修改 ImageUrl 属性，使其指向映射文件夹中的图像文件。例如：

<Elements xmlns="http://schemas.microsoft.com/sharepoint/">
    <CustomAction
        Id="MyCustomAction"
        GroupId="SiteActions"
        Location="Microsoft.SharePoint.StandardMenu"
        Sequence="100"
        Title="Bing"
        Description="Search with Bing"
        ImageUrl="/_layouts/15/MyProjectName/Images/MyImage.png"
        Url="http://www.bing.com">
    </CustomAction>
</Elements>

这里的 MyProjectName 是你的项目名称， Images 是映射文件夹的名称， MyImage.png 是具体的图像文件名。

部署项目 ：
- 再次按 F5 部署项目。部署完成后，在 SharePoint 的“站点操作”菜单中，“Bing” 菜单项将显示你添加的图像。

8. 不同部署类型的深入分析

8.1 资源部署类型对比

部署类型	适用场景	部署位置	访问方式
ClassResource	用于部署程序集中控件所需的资源，如 Web 部件项目中的图像、脚本等	取决于程序集的部署位置（GAC 或 Web 应用程序）	可以通过 `SPWebPartManager` 类中的 `GetServerRelativeClassResourcePath` 方法从 Web 部件代码文件中访问
ApplicationResource	用于部署 SharePoint Web 应用程序所需的资源文件	`C:\inetpub\wwwroot\wss\VirtualDirectories\[PORTNUMBER]\resources\MyProjectName\MyProjectItemName\`	可在 Web 应用程序中直接引用
AppGlobalResource	用于部署供 ASPX 页面和程序集使用的资源文件	`C:\inetpub\wwwroot\wss\VirtualDirectories\[PORTNUMBER]\App_GlobalResources\MyProjectName\MyProjectItemName\`	可在 ASPX 页面和程序集中直接引用
Resource	用于部署特定于功能的资源	`{SharePointRoot}\Template\Features\{Feature Name}\Resources\`	可在功能相关的代码中访问

8.2 不同部署类型的选择策略

考虑资源的使用范围 ：如果资源仅在某个功能内使用，选择 Resource 部署类型；如果资源供整个 Web 应用程序使用，选择 ApplicationResource 或 AppGlobalResource 部署类型；如果资源与程序集中的控件相关，选择 ClassResource 部署类型。
考虑资源的部署位置 ：根据 SharePoint 服务器的文件夹结构和项目需求，选择合适的部署位置。例如，如果希望资源直接位于 SharePoint 根目录下，可以选择 RootFile 部署类型。

9. 功能范围与 Visual Studio 的选择逻辑

9.1 功能范围概述

功能范围定义了功能在 SharePoint 中的作用域，主要包括 Web （网站）和 Site （网站集）两种范围。不同的 SharePoint 元素可能与一种或多种范围兼容。

9.2 Visual Studio 选择功能范围的逻辑

当创建新的 SharePoint 项目时，Visual Studio 会遵循以下逻辑选择功能范围：
mermaid
graph TD;
A[创建新 SharePoint 项目] –> B{元素有多种兼容范围?};
B – 是 –> C[选择最低可用范围];
B – 否 –> D[使用唯一兼容范围];
C –> E[创建对应范围的功能];
D –> E;
F[项目已有高范围功能] –> G{新元素与高范围功能兼容?};
G – 是 –> H[添加到现有高范围功能];
G – 否 –> E;

例如，在创建列表定义项目时，列表模板与 Site 和 Web 范围都兼容，Visual Studio 会选择 Web 范围创建新功能。但如果项目中已经存在 Site 范围的功能，且新的列表定义项目与该功能兼容，Visual Studio 会将其添加到现有的 Site 范围功能中。

10. 总结与最佳实践

10.1 手动与自动化部署的权衡

手动部署 ：适合深入学习 SharePoint 解决方案的工作原理，在需要对部署过程进行精细控制时使用。但手动操作繁琐，容易出错，不适合大规模项目。
Visual Studio 自动化部署 ：提供了便捷的开发和部署环境，大大提高了开发效率。但开发者需要了解项目结构、部署属性等关键知识，以确保自动化部署的正确性。