Практическое руководство. Упаковка компонентов для использования установщика содержимого Visual Studio

Статья
08/11/2011

Установщик содержимого Visual Studio позволяет развернуть макросы, надстройки и фрагменты кода, расширяющие возможности Visual Studio. Дополнительные сведения о стратегиях развертывания см. в разделе Visual Studio Extension Deployment.

Чтобы подготовить расширение к установке с помощью установщика содержимого Visual Studio, упакуйте его в файл с расширением VSI, который обычно называется компонентом, разработанным членами сообщества. Установщик содержимого Visual Studio автоматически копирует элементы компонентов, разработанных членами сообщества, в соответствующие папки на компьютере разработчика, после чего эти элементы отображаются в правильных диалоговых окнах Visual Studio.

Чтобы использовать установщик содержимого Visual Studio для установки компонента, разработанного членами сообщества, необходимо создать VSCONTENT-файл для этого компонента. После создания VSCONTENT-файла его необходимо заархивировать в ZIP-файл вместе с другими файлами компонента и изменить расширение архивного файла на VSI. После этого можно распространять VSI-файл среди других разработчиков любым удобным для вас способом — например, разместить его на веб-сайте в Интернете для последующей загрузки, отправить в виде вложения сообщения электронной почты или опубликовать файл на общем сетевом ресурсе.

Файлы с расширением VSCONTENT

Для описания созданного компонента, предназначенного для совместного использования, в VSCONTENT-файлах используется XML-код на основе схемы, описанной в разделе Справочник по схеме установщика содержимого Visual Studio. Помимо других данных VSCONTENT-файл содержит сведения о типе компонентов и версии Visual Studio, в которой эти компоненты должны использоваться. После создания VSCONTENT-файла можно сформировать VSI-файл, который используется установщиком содержимого Visual Studio для установки компонентов на компьютерах разработчиков.

Чтобы создать основной VSCONTENT-файл, выполните следующие действия.

В меню Файл выберите Создать и щелкните Файл.
В категории Общие выберите Файл XML и нажмите кнопку Открыть.
Создайте допустимый VSCONTENT-файл на основе схемы, описанной в разделе Справочник по схеме установщика содержимого Visual Studio.

Примечание

Пример XML-кода для VSCONTENT-файла можно найти в подразделе "Пример" далее в этом разделе.
Сохраните VSCONTENT-файл в каталоге, в котором содержатся другие файлы соответствующего компонента, разработанного членами сообщества.

Файлы с расширением VSI

Файлы установщика содержимого Visual Studio (VSI-файлы) служат для обмена содержимым Visual Studio в сообществе разработчиков. VSI-файл представляет собой ZIP-файл, который содержит перечисленные ниже элементы.

VSCONTENT-файл с XML-содержимым, в котором описывается компонент, разработанный членами сообщества.
Файлы для данного компонента.

Установщик содержимого Visual Studio использует VSI-файлы для установки общего содержимого в правильном расположении. Дополнительные сведения об установке VSI-файлов содержатся в разделе Практическое руководство. Поиск и установка компонентов, разработанных членами сообщества.

Для поддержки некоторых возможностей установщика содержимого Visual Studio требуется реализовать некоторые дополнительные средства или службы.

Чтобы отобразить сведения об издателе компонента, разработанного членами сообщества, в установщике содержимого Visual Studio, VSI-файл необходимо подписать. Дополнительные сведения см. в разделе Службы криптографии.
Чтобы отобразить лицензионное соглашение в установщике содержимого Visual Studio, необходимо внедрить эти сведения в ZIP-файл. Программа WinZip позволяет включать внедренные сведения посредством функции комментариев. Дополнительные сведения о программе WinZip см. на веб-узле http://www.winzip.com. Дополнительные сведения о функции комментариев см. в файле справки по WinZip.

Чтобы создать основной VSI-файл, выполните следующие действия.

Если это не было сделано ранее, создайте допустимый VSCONTENT-файл для компонента. Дополнительные сведения см. в подразделе "VSCONTENT-файлы" ранее в этом разделе.
В проводнике Windows выберите файлы, которые требуются для данного компонента, в том числе VSCONTENT-файл.
Щелкните правой кнопкой мыши выбранные файлы, выберите Отправить и щелкните Сжатая ZIP-папка.

Выбранные файлы будут сжаты в один файл с расширением ZIP.
Переименуйте расширение ZIP-файла на VSI.

Пример

В следующем примере показан файл с расширением VSCONTENT для VSI-файла, содержащего надстройку. Элемент <ContentVersion> имеет значение 2.0, так как надстройка совместима только с версиями Visual Studio 9.0 и 10.0.

Ниже перечислены файлы, которые должны быть включены в VSI-файл.

VSCONTENT-файл, содержащий XML-код, показанный в этом примере.
Файл регистрации надстройки MyAddin.Addin.
Скомпилированный DLL-файл надстройки MyAddin.dll.

Файлы надстройки устанавливаются в следующий каталог:

n:\... \My Documents\Visual Studio <версия>\Addins\

Дополнительные примеры см. в разделах Практическое руководство. Публикация шаблонов проектов и Практическое руководство. Публикация фрагментов кода.

<VSContent xmlns="https://schemas.microsoft.com/developer/vscontent/2005"> 
    <Content>
        <FileName>MyAddin.Addin</FileName>
        <FileName>MyAddin.dll</FileName>
        <DisplayName>Example Add-in</DisplayName>
        <Description>An add-in created for this example.</Description>
        <FileContentType>Addin</FileContentType>
        <ContentVersion>2.0</ContentVersion>
    </Content>
</VSContent>

В следующем примере показан VSCONTENT-файл для VSI-файла, в котором содержится проект макроса, предназначенный для использования в Visual Studio 8.0, 9.0 или 10.0. Ниже перечислены файлы, которые должны быть включены в VSI-файл.

VSCONTENT-файл, содержащий XML-код, показанный в этом примере.
Файл макроса MyMacroProject.vsmacros.

Файл макроса устанавливается в следующий каталог:

n:\... \My Documents\Visual Studio <версия>\Projects\VSMacros80\

<VSContent xmlns="https://schemas.microsoft.com/developer/vscontent/2005">
    <Content>
        <FileName>MyMacroProject.vsmacros</FileName>
        <DisplayName>My Macro Project</DisplayName>
        <Description> A macro project created for this example.</Description>
        <FileContentType>Macro Project</FileContentType>
        <ContentVersion>1.0</ContentVersion>
    </Content>
</VSContent>