VS 2008 Package 备忘

    今天研究了一下vs 2008 package的部署,即怎样放置package中的dll、ProjectTemplate和ItemTemplate，趁着热乎劲先记录下来，免得以后忘记。

    首先，创建一个简单的package，供测试之用。

    打开visual studio 2008，新建项目，选择其他项目类型->扩展性->Visual Studio Integration Package，输入项目名称为DeployPackage，如下图：

    点击确定后，弹出创建package的向导，选择C#作为开发语言，选中Menu Command。如下两图：

  

   

    完成向导后，vs帮我们创建了空的package项目，如下图：

   

    双击Guids.cs文件，添加一个guid，作为接下来要创建的ProjectFactory的guid，修改后的Guids.cs文件如下：

using System;

namespace Company.DeployPackage
{
    static class GuidList
    {
        public const string guidDeployPackagePkgString = "bad3390c-b2a2-4bfc-a3ad-87e8119df413";
        public const string guidDeployPackageCmdSetString = "b09083be-4856-4364-8bb1-243d133c7177";


        //该Guid为接下来要创建的ProjectFactory的guid
        public const string guidDixProjectFactoryString = "9819EC75-61CC-468c-9823-E853AEE0FE8C";

        public static readonly Guid guidDeployPackageCmdSet = new Guid(guidDeployPackageCmdSetString);
    };
}

 

    新增一个ProjectFactory，名为DixProjectFactory，如下：

using System;
using System.Runtime.InteropServices;
using Microsoft.VisualStudio.Project;
using IOleServiceProvider = Microsoft.VisualStudio.OLE.Interop.IServiceProvider;

namespace Company.DeployPackage
{
    //注意这个guid
    [Guid(GuidList.guidDixProjectFactoryString)]
    public class DixProjectFactory : ProjectFactory
    {
        public DixProjectFactory(DeployPackagePackage package)
            : base(package)
        {
        }

        protected override ProjectNode CreateProject()
        {
            DixProjectNode node = new DixProjectNode();
            node.SetSite((IOleServiceProvider)((IServiceProvider)Package).GetService(typeof(IOleServiceProvider)));
            return node;
        }
    }
}

    注意DixProjectFactory的Guid就是刚刚在Guids.cs文件中的那个Guid。

    注意：需要下载MPFProjectBase才能使用ProjectFactory,以及下面的ProjectNode、ProjectPackage

    新增一个ProjectNode类，名为DixProjectNode，如下：

using System;
using Microsoft.VisualStudio.Project;

namespace Company.DeployPackage
{
    public class DixProjectNode : ProjectNode
    {
        /// <summary>
        /// 返回DixProjectFactory的Guid
        /// </summary>
        public override Guid ProjectGuid
        {
            get { return typeof(DixProjectFactory).GUID; }
        }

        public override string ProjectType
        {
            get { return "Dix"; }
        }
    }
}

    修改DeployPackagePackage类，使它继承于ProjectPackage（原来是继承与Package的），并添加一个ProvideProjectFactoryAttribute，如下：

...
[ProvideProjectFactory(typeof(DixProjectFactory), "我的dix项目", "Dix Project Files (*.dixproj);*.dixproj", "dixproj", "dixproj", "", LanguageVsTemplate = "DiX")]
public sealed class DeployPackagePackage : ProjectPackage
{
    ...
}

    修改DeployPackagePackage类的Initialize方法，添加RegisterProjectFactory(new DixProjectFactory(this))语句，修改后的Initialize方法如下：

protected override void Initialize()
{
    Trace.WriteLine (string.Format(CultureInfo.CurrentCulture, "Entering Initialize() of: {0}", this.ToString()));
    base.Initialize();

    // Add our command handlers for menu (commands must exist in the .vsct file)
    OleMenuCommandService mcs = GetService(typeof(IMenuCommandService)) as OleMenuCommandService;
    if ( null != mcs )
    {
        // Create the command for the menu item.
        CommandID menuCommandID = new CommandID(GuidList.guidDeployPackageCmdSet, (int)PkgCmdIDList.cmdidMyCommand);
        MenuCommand menuItem = new MenuCommand(MenuItemCallback, menuCommandID );
        mcs.AddCommand( menuItem );
    }

    //注册ProjectFactory
    RegisterProjectFactory(new DixProjectFactory(this));
}

    下面为该package添加ProjectTemplate和ItemTemplate。

    添加Templates、Projects、Items等文件夹和文件，添加后如下图：

   

    注意这里面的cs文件需要改一下Build Action，否则编译不过。也可以把这堆文件的Build Action设置成ZipProject和ZipItem，但为了更加清楚模板的部署方式，我只是把他们的Build Action设置成了None。

    Projects文件夹中放置Project模板，Items文件夹中放置ProjectItem模板。

    Project模板以WinForm为例，要注意WinForm.vstemplate文件，该文件的定义如下：

<VSTemplate Version="2.0.0" Type="Project" xmlns="http://schemas.microsoft.com/developer/vstemplate/2005">
    <TemplateData>
        <Name>DiX WinForm Application</Name>
        <Description>Create Dix WinForm Application</Description>
        <Icon>WinForm.ico</Icon>
        <!--ProjectType要和Package里的LanguageVsTemplate相同-->
        <ProjectType>DiX</ProjectType>
        <SortOrder>20</SortOrder>
        <NumberOfParentCategoriesToRollUp>1</NumberOfParentCategoriesToRollUp>
        <CreateNewFolder>true</CreateNewFolder>
        <DefaultName>WinFormApplication</DefaultName>
        <ProvideDefaultName>true</ProvideDefaultName>
        <PromptForSaveOnCreation>false</PromptForSaveOnCreation>
    </TemplateData>
    <TemplateContent>
        <Project File="WinForm.dixproj" TargetFileName="$safeprojectname$.dixproj" ReplaceParameters="true">
            <ProjectItem ReplaceParameters="true" OpenInEditor="true" TargetFileName="Form1.dix">Form1.dix</ProjectItem>
        </Project>
    </TemplateContent>
</VSTemplate>

    ProjectItem模板以Class为例，要注意Class.vstemplate文件，该文件的定义如下：

<?xml version="1.0" encoding="utf-8"?>
<VSTemplate Version="3.0.0" Type="Item" xmlns="http://schemas.microsoft.com/developer/vstemplate/2005">
  <TemplateData>
    <Name Package="{FAE04EC1-301F-11d3-BF4B-00C04F79EFBC}" ID="2245" />
    <Description Package="{FAE04EC1-301F-11d3-BF4B-00C04F79EFBC}" ID="2262" />
    <Icon Package="{FAE04EC1-301F-11d3-BF4B-00C04F79EFBC}" ID="4515" />
    <TemplateID>Dix.Class</TemplateID>
    <ProjectType>Dix</ProjectType>
    <RequiredFrameworkVersion>2.0</RequiredFrameworkVersion>
    <NumberOfParentCategoriesToRollUp>1</NumberOfParentCategoriesToRollUp>
    <DefaultName>Class.cs</DefaultName>
  </TemplateData>
  <TemplateContent>
    <ProjectItem ReplaceParameters="true">Class.cs</ProjectItem>
  </TemplateContent>
</VSTemplate>

    在这两个vstemplate文件里，ProjectType要和DeployPackagePackage类声明中的ProvideProjectFactoryAttribute标记的LanguageVsTemplate相同，即都要是“Dix”。其他的文件是随便写的，里面的内容对于本次测试并不重要。

    好了，用于测试的Package已经做完了，编译成功后，下面开始测试如何在vs 2008里应用它。

1.在visual studio Experimental hive中测试

    在visual studio Experimental hive中测试比较简单，不需要再手动注册package了，因为我们的Package项目在编译成功后已经被自动注册到visual studio Experimental hive中了。编译时的输出片段如下：

f:\Microsoft Visual Studio 2008 SDK\VisualStudioIntegration\Tools\bin\RegPkg.exe /root:Software\Microsoft\VisualStudio\9.0Exp "/pkgdeffile:obj\Debug\DeployPackage.pkgdef" "D:\DeployPackage\DeployPackage\bin\Debug\DeployPackage.dll"
f:\Microsoft Visual Studio 2008 SDK\VisualStudioIntegration\Tools\bin\RegPkg.exe /root:Software\Microsoft\VisualStudio\9.0Exp /ranu /codebase "D:\DeployPackage\DeployPackage\bin\Debug\DeployPackage.dll"
C:\Program Files\Microsoft Visual Studio 9.0\Common7\IDE\devenv.com /rt "Software\Microsoft\VisualStudio\9.0Exp" /RANU /setup /nosetupvstemplates

    前两句执行完之后，在注册表的HKEY_CURRENT_USER\Software\Microsoft\VisualStudio\9.0Exp\Configuration\InstalledProducts下可以看到该package的名称，在HKEY_CURRENT_USER\Software\Microsoft\VisualStudio\9.0Exp\Configuration\Packages可以看到以该package的GUID为名的子项，在Projects，Menus等目录下也可以找到该package的信息。

    编译成功后，点击开始菜单，依次选择所有程序，Microsoft Visual Studio 2008 SDK，Tools，Start Microsoft Visual Studio 2008 SP1 under Experimental hive打开visual studio Experimental hive，可以看到在工具菜单下已经有了我们的package中的Menu Command，但是新建一个项目的时候，并没有出现我们的项目模板。这是因为我们并没有把模板部署到vs。

    注意上面的编译时输出的第3句C:\Program Files\Microsoft Visual Studio 9.0\Common7\IDE\devenv.com /rt "Software\Microsoft\VisualStudio\9.0Exp" /RANU /setup /nosetupvstemplates，这句命令最后有个/nosetupvstemplates的开关，意思是不需要安装vstemplate。编译package自动加上这个开关的原因是vs并不知道我们的package中存在template，如果我们把上面那堆模板文件设置成ZipProject或者ZipItem的话，vs在编译这个package的时候，就不会自动加这个开关了，这样编译后，模板就会自动拷贝到vs识别的目录里。

    由于我并没有设置Build Action为ZipProject或者ZipItem，所以现在要手动的去压缩模板：

    将Project模板分别压缩成WinForm.zip和ConsoleApp.zip，在C:\Documents and Settings\User Name\Application Data\Microsoft\VisualStudio\9.0Exp\ProjectTemplates\下建立Dix目录，并在Dix目录下建立Windows和控制台两个子目录，把WinForm.zip和ConsoleApp.zip分别放到这两个目录下。

    将ProjectItem模板分别压缩成WinForm.zip和Class.zip，在C:\Documents and Settings\kongxiangxin\Application Data\Microsoft\VisualStudio\9.0Exp\ItemTemplates下建立Dix目录，并在Dix目录下建立Windows Form和代码两个子目录，把WinForm.zip和Class.zip分别放到这两个目录下。

    注意，在压缩成zip文件的时候，只压缩文件，不要把文件夹整个压缩。

    运行"C:\Program Files\Microsoft Visual Studio 9.0\Common7\IDE\devenv.com" /rt "Software\Microsoft\VisualStudio\9.0Exp" /RANU /installvstemplates，等这条命令运行成功后，启动visual studio Experimental hive，新建项目，可以看到项目模板已经出现在新建项目对话框里了。

 

    新建一个Dix WinForm Application的项目，然后添加新项，可以看到项模板出现在添加新项对话框里：

2.在visual studio中测试

    在visual studio里测试需要自己运行命令去注册package，可以参考package编译时执行的命令，把root参数和ranu参数去掉就可以了：

f:\Microsoft Visual Studio 2008 SDK\VisualStudioIntegration\Tools\bin\RegPkg.exe /codebase "D:\DeployPackage\DeployPackage\bin\Debug\DeployPackage.dll"

C:\Program Files\Microsoft Visual Studio 9.0\Common7\IDE\devenv.com /setup

    后记：完成这篇文章的时候，已经离开始写这篇文章有两个星期的时间了。一开始是没有时间写，拖的久了也就不想写了。所以后面的内容写的不够详细。