使用 ClickOnce 部署Office解决方案

适用于:yesnoVisual Studio Visual Studio for Mac noVisual Studio Code

如果使用 ClickOnce,则部署 Office 解决方案的步骤更少。 如果发布更新,解决方案将自动检测并安装更新。 不过,ClickOnce 需要你分别为计算机的每个用户安装解决方案。 因此,如果多个用户在同一台计算机上运行解决方案,应考虑使用 Windows Installer (.msi) 。

本主题内容

发布解决方案

可以使用发布向导Project设计器发布解决方案。 在此过程中,你将使用Project设计器,因为它提供了完整的发布选项集。 请参阅Visual Studio) 中的发布向导 (Office开发

发布解决方案

  1. 解决方案资源管理器中,选择为项目命名的节点。

  2. 在菜单栏上,选择ProjectProjectName属性

  3. Project设计器中,选择下图显示的“发布”选项卡。

    The publish tab of the Project Designer

  4. “发布文件夹位置” (ftp 服务器或文件路径) 框中,输入希望Project设计器复制解决方案文件的文件夹的路径。

    可以输入以下任一类型的路径。

    • 本地路径 (,例如 C:\FolderName\FolderName) 。

    • 统一命名约定 (UNC) (网络上文件夹的路径,例如 \\ServerName\FolderName) 。

    • 相对路径 (,例如 PublishFolder\,它是默认情况下发布项目的文件夹) 。

  5. “安装文件夹 URL ”框中,输入最终用户将找到解决方案的位置的完全限定路径。

    如果还不知道位置,请不要在此字段中输入任何内容。 默认情况下,ClickOnce 将在用户从中安装解决方案的文件夹中查找更新。

  6. 选择 “系统必备” 按钮。

  7. “先决条件 ”对话框中,确保选中 “创建安装程序以安装必备组件 ”复选框。

  8. “选择要安装先决条件”列表中,选中Windows Installer 4.5 和相应.NET Framework包的复选框。

    例如,如果你的解决方案面向 .NET Framework 4.5,请选中 Windows Installer 4.5Microsoft .NET Framework 4.5 Full 的复选框。

  9. 如果解决方案面向 .NET Framework 4.5,则还选中“Visual Studio 2010 Tools for Office Runtime”复选框。

    注意

    默认情况下,不会显示此复选框。 若要显示此复选框,必须创建引导程序包。 请参阅使用 Visual Studio 2012 为 Office 2013 VSTO 外接程序创建 Bootstrapper 包

  10. “为先决条件指定安装位置”下,选择出现的选项之一,然后选择“ 确定 ”按钮。

    下表对每个选项进行了描述。

    选项 说明
    从组件供应商的网站下载系统必备组件 系统将提示用户从供应商处下载并安装这些系统必备组件。
    从与我的应用程序相同的位置下载系统必备组件 系统必备软件与解决方案一起安装。 如果选择此选项,Visual Studio 会将所有系统必备组件包为你复制到发布位置。 要让此选项正常工作,系统必备包必须位于开发计算机上。
    从下列位置下载系统必备组件 Visual Studio 将所有系统必备组件包复制到你指定的位置,并与解决方案一起安装。

    请参阅 “先决条件”对话框

  11. 选择 “更新 ”按钮,指定希望每个最终用户的 VSTO 外接程序或自定义项检查更新的频率,然后选择 “确定 ”按钮。

    注意

    如果要使用 CD 或可移动驱动器进行部署,请选择“ 从不检查更新 ”选项按钮。

    有关如何发布更新的信息,请参阅 发布更新

  12. 选择 “选项 ”按钮,查看“ 选项 ”对话框中的选项,然后选择“ 确定 ”按钮。

  13. 选择“ 立即发布 ”按钮。

    Visual Studio 将向你先前在此过程中指定的发布文件夹添加以下文件夹和文件。

    • 应用程序文件文件夹。

    • 安装程序。

    • 部署清单,指向最新版本的部署清单。

      应用程序文件文件夹包含发布的每个版本的子文件夹。 每个特定于版本的子文件夹均包含以下文件。

    • 应用程序清单。

    • 部署清单。

    • 自定义程序集。

      下图显示了 Outlook VSTO 外接程序的发布文件夹的结构。

      Publish Folder Structure

    注意

    ClickOnce将 .deploy 扩展名追加到程序集,以便安全安装 Internet Information Services (IIS) 不会阻止文件,因为扩展名不安全。 当用户安装解决方案时,ClickOnce删除 .deploy 扩展。

  14. 将解决方案文件复制到你先前在此过程中指定的安装位置。

决定如何向解决方案授予信任

要让解决方案在用户计算机上运行,你必须授予信任,或用户必须在安装解决方案时响应信任提示。 要向解决方案授予信任,请使用能识别已知受信任发布者的证书为清单签名。 请参阅通过对应用程序和部署清单进行签名来信任解决方案

如果要部署文档级自定义项,并且想要将文档放入用户计算机上的文件夹中,或使文档在SharePoint网站上可用,请确保Office信任文档的位置。 请参阅 授予对文档的信任

帮助用户安装解决方案

用户可以通过运行安装程序、打开部署清单或在文档级自定义期间直接打开文档来安装解决方案。 作为最佳做法,用户应使用安装程序来安装解决方案。 其他两种方法不确保已安装必备软件。 如果用户希望从安装位置打开文档,则必须将此文档添加到 Office 应用程序信任中心的受信任位置列表。

打开文档级自定义项的文档

若要打开文档集自定义项的文档,用户可以直接将其从安装位置打开,也可以将此文档复制到本地计算机并打开副本。

作为最佳做法,用户应打开其计算机上的文档副本,这样,多个用户不会同时尝试打开同一文档。 要实施此做法,可以将安装程序配置为将文档复制到用户计算机。 请参阅 将解决方案的文档放入最终用户的计算机, (仅) 文档级自定义 项。

通过从 IIS 网站打开部署清单来安装解决方案

用户可以通过从 Web 打开部署清单来安装 Office 解决方案。 但是,Internet Information Services (IIS) 的安全安装将阻止扩展名为 .vsto 的文件。 要使用 IIS 来部署 Office 解决方案,必须在 IIS 中定义 MIME 类型。

向 IIS 6.0 添加 .vsto MIME 类型
  1. 在运行 IIS 6.0 的服务器上,选择“"开始"菜单>所有程序>管理工具>Internet Information Services (IIS) 管理器

  2. 选择计算机名称、 网站 文件夹或要配置的网站。

  3. 在菜单栏上,选择 “操作>属性”。

  4. “HTTP 标头 ”选项卡上,选择 “MIME 类型 ”按钮。

  5. “MIME 类型” 窗口中,选择“ 新建 ”按钮。

  6. MIME 类型 窗口中,输入 .vsto 作为扩展,输入 application/x-ms-vsto 作为 MIME 类型,然后应用新设置。

    注意

    为使更改生效,必须重新启动万维网发布服务或者等待工作进程回收。 然后,必须刷新浏览器的磁盘缓存,然后再次尝试打开 .vsto 文件。

向 IIS 7.0 添加 .vsto MIME 类型
  1. 在运行 IIS 7.0 的服务器上,选择"开始"菜单>“所有程序>附件”。

  2. 打开 命令提示符的快捷菜单,然后选择“ 以管理员身份运行”。

  3. “打开 ”框中,输入以下路径,然后选择“ 确定 ”按钮。

    %windir%\system32\inetsrv
    
  4. 输入以下命令,然后应用新设置。

    set config /section:staticContent /+[fileExtension='.vsto',mimeType='application/x-ms-vsto']
    

    注意

    为使更改生效,必须重新启动万维网发布服务或者等待工作进程回收。 然后,必须刷新浏览器的磁盘缓存,然后再次尝试打开 .vsto 文件。

将解决方案文档置于最终用户计算机上(仅限文档级自定义项)

可以通过创建帖子部署操作,将解决方案的文档复制到最终用户的计算机。 这样,用户无需在安装解决方案后将文档从安装位置手动复制到其计算机。 必须创建一个类,该类定义帖子部署操作、生成和发布解决方案、修改应用程序清单,以及重新对应用程序和部署清单签名。

以下过程假定项目名称为 ExcelWorkbook ,并将解决方案发布到计算机上名为 C:\publish 的已创建文件夹中。

创建定义后期部署操作的类

  1. 在菜单栏上,选择“文件>添加新>Project

  2. 在“添加新Project”对话框中的“已安装模板”窗格中,选择Windows文件夹。

  3. “模板 ”窗格中,选择 “类库 ”模板。

  4. “名称” 字段中,输入 FileCopyPDA,然后选择“ 确定 ”按钮。

  5. 解决方案资源管理器中,选择 FileCopyPDA 项目。

  6. 在菜单栏上,选择“项目”>“添加引用”。

  7. .NET 选项卡上,添加对 Microsoft.VisualStudio.Tools.Applications.RuntimeMicrosoft.VisualStudio.Tools.Applications.ServerDocument的引用。

  8. 将类重命名为 FileCopyPDA,然后使用代码替换文件内容。 此代码执行以下任务:

    • 将文档复制到用户桌面。

    • 将_AssemblyLocation属性从相对路径更改为部署清单的完全限定路径。

    • 如果用户卸载此解决方案,则删除该文件。

      using Microsoft.VisualStudio.Tools.Applications.Deployment;
      using Microsoft.VisualStudio.Tools.Applications;
      using System.IO;
      
      namespace FileCopyPDA
      {
          public class FileCopyPDA : IAddInPostDeploymentAction
          {
              public void Execute(AddInPostDeploymentActionArgs args) 
              {
                  string dataDirectory = @"Data\ExcelWorkbook.xlsx";
                  string file = @"ExcelWorkbook.xlsx";
                  string sourcePath = args.AddInPath;
                  Uri deploymentManifestUri = args.ManifestLocation;
                  string destPath = Environment.GetFolderPath(Environment.SpecialFolder.DesktopDirectory);
                  string sourceFile = System.IO.Path.Combine(sourcePath, dataDirectory);
                  string destFile = System.IO.Path.Combine(destPath, file);
      
                  switch (args.InstallationStatus)
                  {
                      case AddInInstallationStatus.InitialInstall:
                      case AddInInstallationStatus.Update:
                          File.Copy(sourceFile, destFile);
                          ServerDocument.RemoveCustomization(destFile);
                          ServerDocument.AddCustomization(destFile, deploymentManifestUri);
                          break;
                      case AddInInstallationStatus.Uninstall:
                          if (File.Exists(destFile))
                          {
                              File.Delete(destFile);
                          }
                          break;
                  }
              }
          }
      }
      

生成并发布解决方案

  1. 解决方案资源管理器中,打开 FileCopyPDA 项目的快捷菜单,然后选择“生成”。

  2. 打开 ExcelWorkbook 项目的快捷菜单,然后选择“ 生成”。

  3. 打开 ExcelWorkbook 项目的快捷菜单,然后选择 “添加引用”。

  4. 在“ 添加引用 ”对话框中,选择“ 项目 ”选项卡,选择 “FileCopyPDA”,然后选择“ 确定 ”按钮。

  5. 解决方案资源管理器中,选择 ExcelWorkbook 项目。

  6. 在菜单栏上,选择Project>“新建文件夹”。

  7. 输入 数据,然后选择 Enter 键。

  8. 解决方案资源管理器中,选择“数据”文件夹。

  9. 在菜单栏上,选择“项目”>“添加现有项” 。

  10. 在“ 添加现有项 ”对话框中,浏览到 ExcelWorkbook 项目的输出目录,选择 ExcelWorkbook.xlsx 文件,然后选择“ 添加 ”按钮。

  11. 解决方案资源管理器选择ExcelWorkbook.xlsx文件。

  12. “属性 ”窗口中,将 “生成操作 ”属性更改为 “内容 ”,并将 “复制到输出目录 ”属性更改为 “复制”(如果更新)。

    完成这些步骤后,项目将类似于下图。

    Project structure of the post deployment action.

  13. 发布 ExcelWorkbook 项目。

修改应用程序清单

  1. 使用 文件资源管理器打开解决方案目录 c:\publish

  2. 打开 应用程序文件 文件夹,然后打开对应于解决方案最新版本的文件夹。

  3. 在文本编辑器(如 记事本)中打开 ExcelWorkbook.dll.manifest 文件。

  4. </vstav3:update> 元素之后添加以下代码。 对于元素的 <vstav3:entryPoint> 类属性,请使用以下语法: NamespaceName.ClassName。 在以下示例中,命名空间和类名称相同,因此生成的入口点名称为 FileCopyPDA.FileCopyPDA

    <vstav3:postActions>
      <vstav3:postAction>
        <vstav3:entryPoint
          class="FileCopyPDA.FileCopyPDA">
          <assemblyIdentity
            name="FileCopyPDA"
            version="1.0.0.0"
            language="neutral"
            processorArchitecture="msil" />
        </vstav3:entryPoint>
        <vstav3:postActionData>
        </vstav3:postActionData>
      </vstav3:postAction>
    </vstav3:postActions>
    

对应用程序清单和部署清单进行重新签名

  1. %USERPROFILE%\Documents\Visual Studio 2013\Projects\ExcelWorkbook\ExcelWorkbook 文件夹中,复制 ExcelWorkbook_TemporaryKey.pfx 证书文件,然后将其粘贴到 PublishFolder\Application Files\ExcelWorkbook_MostRecentPublishedVersion 文件夹中。

  2. 打开Visual Studio命令提示符,然后将目录更改为 c:\publish\Application Files\ExcelWorkbook_MostRecentPublishedVersion 文件夹 (,例如 c:\publish\Application Files\ExcelWorkbook_1_0_0_4) 。

  3. 通过运行以下命令对修改的应用程序清单进行签名:

    mage -sign ExcelWorkbook.dll.manifest -certfile ExcelWorkbook_TemporaryKey.pfx
    

    将出现“ExcelWorkbook.dll.manifest 已成功签名”消息。

  4. 更改为 c:\publish 文件夹,然后运行以下命令更新并签名部署清单:

    mage -update ExcelWorkbook.vsto -appmanifest "Application Files\Ex
    celWorkbookMostRecentVersionNumber>\ExcelWorkbook.dll.manifest" -certfile "Application Files\ExcelWorkbookMostRecentVersionNumber>\ExcelWorkbook_TemporaryKey.pfx"
    

    注意

    在前面的示例中,请将 MostRecentVersionNumber 替换为解决方案的最新发布的版本号 (,例如 1_0_0_4) 。

    将出现“ExcelWorkbook.vsto 已成功签名”消息。

  5. ExcelWorkbook.vsto 文件复制到 c:\publish\Application Files\ExcelWorkbook_MostRecentVersionNumber 目录。

将解决方案文档置于运行 SharePoint 的服务器上(仅限文档级自定义项)

可以使用 SharePoint 将文档级自定义项发布到最终用户。 当用户转到 SharePoint 站点并打开文档时,运行时会将解决方案从共享网络文件夹自动安装到用户的本地计算机。 将解决方案安装到本地后,即使将文档复制到其他位置(例如桌面),自定义项仍可正常工作。

将文档置于运行 SharePoint 的服务器上

  1. 将解决方案文档添加到 SharePoint 站点上的某个文档库中。

  2. 执行以下一种方法的步骤:

    • 使用 Office 配置工具将运行 SharePoint 的服务器添加到所有用户计算机上 Word 或 Excel 中的信任中心。

      请参阅 2010 Office中的安全策略和设置

    • 确保每个用户执行以下步骤。

      1. 在本地计算机上,打开 Word 或Excel,选择“文件”选项卡,然后选择“选项”按钮。

      2. “信任中心 ”对话框中,选择 “受信任的位置 ”按钮。

      3. 选中 “我的网络上允许受信任的位置” (不建议) 复选框,然后选择“ 添加新位置 ”按钮。

      4. “路径”框中,输入包含上传的文档SharePoint文档库的 URL, http://SharePointServerName/TeamName/ProjectName/DocumentLibraryName 例如 () 。

        不要添加默认网页的名称,例如 default.aspxAllItems.aspx

      5. 选中 此位置的子文件夹也是受信任的 复选框,然后选择“ 确定 ”按钮。

        当用户从 SharePoint 站点打开文档时,将打开文档,并安装自定义项。 用户可将文档复制到他们的桌面。 自定义项仍将运行,因为文档中的属性指向文档的网络位置。

创建自定义安装程序

可以为Office解决方案创建自定义安装程序,而不是使用发布解决方案时为你创建的安装程序。 例如,可以使用登录脚本启动安装,也可以使用批处理文件来安装解决方案,而无需用户交互。 如果最终用户计算机上已安装了系统必备组件,则这些方案都能顺利实现。

在自定义安装过程中,请调用安装程序工具,以便Office解决方案 (VSTOInstaller.exe) ,默认安装在以下位置:

%commonprogramfiles%\microsoft shared\VSTO\10.0\VSTOInstaller.exe

如果该工具不在该位置,可以使用 HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\VSTO Runtime Setup\v4\InstallerPathHKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\VSTO Runtime Setup\v4\InstallerPath 注册表项查找该工具的路径。

可以将以下参数用于 VSTOinstaller.exe

参数 定义
/Install 或 /I 安装解决方案。 此选项必须后跟部署清单的路径。 您可以在本地计算机上指定路径,一个通用命名约定 (UNC) 文件共享。 可以指定本地路径 (C:\FolderName\PublishFolder) 、相对路径 (Publish\) ,或完全限定的位置 (\\ServerName\FolderName 或 http:// ServerName/FolderName) 。
/Uninstall 或 /U 卸载解决方案。 此选项必须后跟部署清单的路径。 您可以指定可以在本地计算机上的路径,一个 UNC 文件共享。 可以指定本地路径 (c:\FolderName\PublishFolder) 、相对路径 (Publish\) ,或完全限定的位置 (\\ServerName\FolderName 或 http:// ServerName/FolderName) 。
/Silent 或 /S 在不提示用户输入或不显示任何消息的情况下进行安装或卸载。 如果需要信任提示,则不会安装或更新自定义项。
/Help 或 /? 显示帮助信息。

运行VSTOinstaller.exe时,可能会出现以下错误代码。

错误代码 定义
0 已成功安装或卸载解决方案,或者显示 VSTOInstaller 帮助。
-100 一个或多个命令行选项无效或多次设置。 有关详细信息,请输入“vstoinstaller /?” 或请参阅为ClickOnce Office解决方案创建自定义安装程序
-101 一个或多个命令行选项无效。 有关详细信息,请输入“vstoinstaller /?”。
-200 部署清单 URI 无效。 有关详细信息,请输入“vstoinstaller /?”。
-201 无法安装解决方案,因为部署清单无效。 请参阅Office解决方案的部署清单
-202 无法安装解决方案,因为应用程序清单的Visual Studio Tools for Office部分无效。 有关Office解决方案,请参阅应用程序清单
-203 无法安装解决方案,因为发生了下载错误。 检查部署清单的 URI 或网络文件位置,然后重试。
-300 无法安装解决方案,因为发生了安全异常。 请参阅安全Office解决方案
-400 无法安装解决方案。
-401 无法卸载解决方案。
-500 由于未能安装或卸载解决方案,或者未能下载部署清单,操作已取消。

发布更新

若要更新解决方案,请使用Project设计器发布向导再次发布该解决方案,然后将更新的解决方案复制到安装位置。 将文件复制到安装位置时,请确保覆盖先前文件。

解决方案下次检查更新时,会自动查找并加载新版本。

更改解决方案的安装位置

可以在发布解决方案后添加或更改安装路径。 你可能需要出于以下一个或多个原因更改安装路径:

  • 在编译安装程序时,安装路径未知。

  • 已将解决方案文件复制到其他位置。

  • 托管安装文件的服务器已具有新名称或位置。

    若要更改解决方案的安装路径,必须更新安装程序,用户随后必须运行安装程序。 对于文档级自定义项,用户还必须更新其文档中的属性以指向新位置。

注意

如果不想要求用户更新其文档属性,可以要求用户从安装位置获取更新的文档。

更改安装程序中的安装路径

  1. 打开 命令提示符 窗口,然后将目录更改为安装文件夹。

  2. 运行安装程序并包括 /url 参数,该参数采用字符串形式的新安装路径。

    以下示例演示如何将安装路径更改为 Fabrikam 网站上的位置,你也可以使用你需要的路径替换此 URL:

    setup.exe /url="http://www.fabrikam.com/newlocation"
    

    注意

    如果显示消息,表明可执行文件的签名将无效,用于对解决方案进行签名的证书将不再有效,并且发布者未知。 因此,用户需要先确认他们信任解决方案的源,才能安装解决方案。

    注意

    若要显示 URL 的当前值,请运行 setup.exe /url

    对于文档级自定义项,用户必须打开该文档,然后更新其_AssemblyLocation属性。 下面的步骤描述用户如何执行此任务。

更新文档中的 _AssemblyLocation 属性

  1. 在“ 文件 ”选项卡上,选择“ 信息”,如下图所示。

    Info tab in Excel

  2. “属性 ”列表中,选择“ 高级属性”,下图显示了该属性。

    Advanced Properties in Excel.

  3. “属性”列表中的“自定义”选项卡上,选择_AssemblyLocation,如下图所示。

    The AssemblyLocation property.

    “值”框包含部署清单标识符。

  4. 在标识符之前,输入文档的完全限定路径,后跟条形,格式为 路径|标识符 (例如, File://ServerName/FolderName/FileName|74744e4b-e4d6-41eb-84f7-ad20346fe2d9

    有关如何设置此标识符格式的详细信息,请参阅 自定义文档属性概述

  5. 选择“ 确定 ”按钮,然后保存并关闭文档。

  6. 不带 /url 参数运行安装程序,以便在指定的位置中安装解决方案。

将解决方案回滚到早期版本

在回滚解决方案时,会将用户还原到此解决方案的早期版本。

回滚解决方案

  1. 打开解决方案的安装位置。

  2. 在顶级发布文件夹中, (.vsto 文件) 删除部署清单。

  3. 找到要回滚到的版本的子文件夹。

  4. 将相应部署清单从该子文件夹复制到顶级发布文件夹。

    例如,若要将名为 OutlookAddIn1 的解决方案从版本 1.0.0.1 回滚到版本 1.0.0.0,请将文件 OutlookAddIn1.vstoOutlookAddIn1_1_0_0_0 文件夹中复制。 将文件粘贴到顶级发布文件夹中,覆盖已存在 OutlookAddIn1_1_0_0_1 的版本特定的部署清单。

    下图显示了此示例中的发布文件夹结构。

    Publish Folder Structure

    用户下次打开应用程序或自定义文档时,系统将检测到此部署清单更改。 此 Office 解决方案的早期版本会从 ClickOnce 缓存运行。

注意

仅为解决方案的一个早期版本保存本地数据。 如果回滚两个版本,则不会保留本地数据。 有关本地数据的详细信息,请参阅访问ClickOnce应用程序中的本地数据和远程数据

请参阅