Пошаговое руководство. Использование MSBuild для создания проекта Visual C++

  • Статья

В этом пошаговом руководстве показано, как создать проект Visual Studio C++ из командной строки с помощью MSBuild. Вы узнаете, как создать файл проекта на основе XML .vcxproj для консольного приложения Visual C++. После сборки проекта вы узнаете, как настроить процесс сборки.

Важно!

Не используйте этот подход, если позднее вы намереваетесь изменять файл проекта с помощью интегрированной среды разработки Visual Studio. Если вы создадите файл .vcxproj вручную, есть вероятность того, что среде Visual Studio не удастся загрузить или изменить его, особенно если в элементах проекта используются подстановочные знаки. Дополнительные сведения см. в разделах Структура файлов .vcxproj и .props, а также Файлы .vcxproj и подстановочные знаки.

В данном пошаговом руководстве рассмотрены следующие задачи:

  • Создание исходных файлов C++ для проекта
  • Создание XML-файла проекта MSBuild
  • Сборка проекта с помощью MSBuild
  • Настройка проекта с помощью MSBuild

Необходимые компоненты

Для выполнения данного пошагового руководства вам потребуется следующее.

  • Копия Visual Studio с установленной рабочей нагрузкой Разработка классических приложений на C++.
  • Общее представление о системе MSBuild.

Примечание.

Большинство низкоуровневых инструкций сборки содержится в файлах .targets и .props, которые определяются в заданном по умолчанию целевом каталоге, хранящемся в свойстве $(VCTargetsPath). В нем вы найдете такие файлы, как Microsoft.Cpp.Common.props. По умолчанию в Visual Studio 2015 и более ранних версий эти файлы находятся по пути %ProgramFiles(x86)%\MSBuild\Microsoft.Cpp\v4.0\<version>\.

Примечание.

Большинство низкоуровневых инструкций сборки содержится в файлах .targets и .props, которые определяются в заданном по умолчанию целевом каталоге, хранящемся в свойстве $(VCTargetsPath). В нем вы найдете такие файлы, как Microsoft.Cpp.Common.props. По умолчанию в Visual Studio 2017 эти файлы находятся по пути %VSINSTALLDIR%Common7\IDE\VC\VCTargets\. В Visual Studio 2015 и более ранних версий они хранились по пути %ProgramFiles(x86)%\MSBuild\Microsoft.Cpp\v4.0\<version>\.

Примечание.

Большинство низкоуровневых инструкций сборки содержится в файлах .targets и .props, которые определяются в заданном по умолчанию целевом каталоге, хранящемся в свойстве $(VCTargetsPath). В нем вы найдете такие файлы, как Microsoft.Cpp.Common.props. По умолчанию эти файлы находятся по пути %VSINSTALLDIR%MSBuild\Microsoft\VC\<version>\. Значение элемента пути <version> зависит от версии Visual Studio. v160 соответствует версии Visual Studio 2019. В Visual Studio 2017 эти файлы хранятся по пути %VSINSTALLDIR%Common7\IDE\VC\VCTargets\. В Visual Studio 2015 и более ранних версий они хранились по пути %ProgramFiles(x86)%\MSBuild\Microsoft.Cpp\v4.0\<version>\.

Создание исходных файлов C++

В этом пошаговом руководстве будет создан проект, включающий в себя исходный файл и файл заголовка. Исходный файл main.cpp содержит функцию main для консольного приложения. Файл заголовка main.h содержит код для включения файла заголовка <iostream>. Эти файлы C++ можно создать в Visual Studio или текстовом редакторе, таком как Visual Studio Code.

Создание исходных файлов C++ для проекта

  1. Создайте каталог для своего проекта.

  2. Создайте файл с именем main.cpp и добавьте в него следующий код.

    // main.cpp : the application source code.
#include <iostream>
#include "main.h"
int main()
{
   std::cout << "Hello, from MSBuild!\n";
   return 0;
}

  3. Создайте файл с именем main.h и добавьте в него следующий код.

    // main.h: the application header code.
/* Additional source code to include. */

Создание XML-файла проекта MSBuild

Файл проекта MSBuild — это XML-файл, содержащий корневой элемент проекта (<Project>). В примере проекта, который вам предстоит создать, элемент <Project> содержит семь дочерних элементов.

  • Три тега групп элементов (<ItemGroup>) определяют конфигурацию и платформу проекта, имя исходного файла и имя файла заголовка.
  • Три тега импорта (<Import>) определяют расположение параметров Microsoft Visual C++.
  • Тег группы свойств (<PropertyGroup>) определяет параметры проекта.

Создание файла проекта MSBuild

  1. В текстовом редакторе создайте файл проекта с именем myproject.vcxproj, а затем добавьте приведенный ниже корневой элемент <Project>. (Используйте ToolsVersion="14.0" для Visual Studio 2015, ToolsVersion="15.0" для Visual Studio 2017 или ToolsVersion="16.0" для Visual Studio 2019.)

    <Project DefaultTargets="Build" ToolsVersion="16.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
</Project>

    В следующих шагах процедуры между корневыми тегами <Project> будут вставлены элементы.

  2. В элемент <ItemGroup> добавьте приведенные ниже два дочерних элемента <ProjectConfiguration>. Они определяют конфигурации отладки и выпуска для 32-разрядной операционной системы Windows:

    <ItemGroup>
  <ProjectConfiguration Include="Debug|Win32">
    <Configuration>Debug</Configuration>
    <Platform>Win32</Platform>
  </ProjectConfiguration>
  <ProjectConfiguration Include="Release|Win32">
    <Configuration>Release</Configuration>
    <Platform>Win32</Platform>
  </ProjectConfiguration>
</ItemGroup>

  3. Добавьте элемент <Import>, определяющий путь к параметрам C++ по умолчанию для проекта.

    <Import Project="$(VCTargetsPath)\Microsoft.Cpp.default.props" />

  4. Добавьте элемент группы свойств (<PropertyGroup>), определяющий свойства проекта <ConfigurationType> и <PlatformToolset>. (Используйте значение v140 для <PlatformToolset> для Visual Studio 2015, v141 для Visual Studio 2017 или v142 для Visual Studio 2019.)

    <PropertyGroup>
  <ConfigurationType>Application</ConfigurationType>
  <PlatformToolset>v142</PlatformToolset>
</PropertyGroup>

  5. Добавьте элемент <Import>, определяющий путь к текущим параметрам C++ для проекта.

    <Import Project="$(VCTargetsPath)\Microsoft.Cpp.props" />

  6. Добавьте в элемент <ItemGroup> дочерний элемент <ClCompile>. Он указывает имя исходного файла C/C++, подлежащего компиляции:

    <ItemGroup>
  <ClCompile Include="main.cpp" />
</ItemGroup>

    Примечание.

    <ClCompile> — это цель сборки, которая определяется в целевом каталоге по умолчанию.

  7. Добавьте в элемент <ItemGroup> дочерний элемент <ClInclude>. Он указывает имя файла заголовка для исходного файла C/C++:

    <ItemGroup>
  <ClInclude Include="main.h" />
</ItemGroup>

  8. Добавьте элемент <Import>, определяющий путь к файлу, в котором определен целевой объект проекта.

    <Import Project="$(VCTargetsPath)\Microsoft.Cpp.Targets" />

Полный файл проекта

Ниже приведен полный код файла проекта, созданного в предыдущей процедуре. (Используйте ToolsVersion="15.0" для Visual Studio 2017 или ToolsVersion="14.0" для Visual Studio 2015.)

<Project DefaultTargets="Build" ToolsVersion="16.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
  <ItemGroup>
    <ProjectConfiguration Include="Debug|Win32">
      <Configuration>Debug</Configuration>
      <Platform>Win32</Platform>
    </ProjectConfiguration>
    <ProjectConfiguration Include="Release|Win32">
      <Configuration>Release</Configuration>
      <Platform>Win32</Platform>
    </ProjectConfiguration>
  </ItemGroup>
  <Import Project="$(VCTargetsPath)\Microsoft.Cpp.default.props" />
  <PropertyGroup>
    <ConfigurationType>Application</ConfigurationType>
    <PlatformToolset>v142</PlatformToolset>
  </PropertyGroup>
  <Import Project="$(VCTargetsPath)\Microsoft.Cpp.props" />
  <ItemGroup>
    <ClCompile Include="main.cpp" />
  </ItemGroup>
  <ItemGroup>
    <ClInclude Include="main.h" />
  </ItemGroup>
  <Import Project="$(VCTargetsPath)\Microsoft.Cpp.Targets" />
</Project>

Сборка проекта с помощью MSBuild

Чтобы выполнить сборку консольного приложения, в командной строке введите следующую команду.

msbuild myproject.vcxproj /p:configuration=debug

MSBuild создаст каталог для выходных файлов, а затем скомпилирует и скомпонует проект для создания программы Myproject.exe. По завершении процесса сборки используйте следующую команду для запуска приложения из папки отладки.

myproject

Приложение должно отображать "Hello, from MSBuild!" в окне консоли.

Настройка проекта

MSBuild позволяет выполнять предварительно определенные целевые объекты сборки, применять пользовательские свойства и использовать настраиваемые средства, события и этапы сборки. В этом разделе рассмотрены следующие задачи.

  • Использование MSBuild с целевыми объектами сборки
  • Использование MSBuild со свойствами сборки
  • Использование MSBuild с 64-разрядным компилятором и средствами
  • Использование MSBuild с разными наборами средств
  • Добавление настроек MSBuild

Использование MSBuild с целевыми объектами сборки

Целевой объект сборки — это именованный набор предварительно определенных или пользовательских команд, которые могут выполняться во время сборки. Для указания целевого объекта сборки используйте параметр командной строки target (/t). В примере проекта myproject предварительно определенный целевой объект clean удаляет все файлы в папке отладки и создает новый файл журнала.

В командной строке введите следующую команду для очистки myproject.

msbuild myproject.vcxproj /t:clean

Использование MSBuild со свойствами сборки

Параметр командной строки property (/p) позволяет переопределить свойство в файле сборки проекта. В примере проекта myproject конфигурация сборки выпуска или отладки указывается в свойстве Configuration. Операционная система, в которой будет выполняться собранное приложение, указывается в свойстве Platform.

В командной строке введите приведенную ниже команду, чтобы создать сборку отладки приложения myproject, предназначенную для выполнения в 32-разрядной версии Windows.

msbuild myproject.vcxproj /p:configuration=debug /p:platform=win32

Допустим, что в примере проекта myproject также определена конфигурация для 64-разрядной версии Windows и еще одна конфигурация для пользовательской операционной системы myplatform.

В командной строке введите приведенную ниже команду, чтобы создать сборку выпуска, предназначенную для выполнения в 64-разрядной версии Windows.

msbuild myproject.vcxproj /p:configuration=release /p:platform=x64

В командной строке введите приведенную ниже команду, чтобы создать сборку выпуска, предназначенную для выполнения на платформе myplatform.

msbuild myproject.vcxproj /p:configuration=release /p:platform=myplatform

Использование MSBuild с 64-разрядным компилятором и средствами

Если вы установили Visual Studio в 64-разрядной версии Windows, по умолчанию были также установлены 64-разрядные собственные и кроссплатформенные средства. Чтобы настроить сборку приложения с использованием 64-разрядного компилятора и средств в MSBuild, задайте свойство PreferredToolArchitecture. Оно не влияет на конфигурацию проекта или свойства платформы. По умолчанию используется 32-разрядная версия средств. Чтобы использовать 64-разрядную версию компилятора и средств, добавьте следующий элемент группы свойств в файл проекта Myproject.vcxproj после элемента <Import /> файла Microsoft.Cpp.default.props.

<PropertyGroup>
    <PreferredToolArchitecture>x64</PreferredToolArchitecture>
</PropertyGroup>

Чтобы выполнить сборку приложения с помощью 64-разрядных средств, в командной строке введите приведенную ниже команду.

msbuild myproject.vcxproj /p:PreferredToolArchitecture=x64

Использование MSBuild с другим набором средств

Если у вас установлены наборы средств и библиотеки для других версий Visual C++, MSBuild может выполнять сборку приложений как для текущей версии Visual C++, так и для других установленных версий. Например, если у вас установлена версия Visual Studio 2012, то, чтобы указать набор средств Visual C++ 11.0 для Windows XP, добавьте следующий элемент группы свойств в файл проекта Myproject.vcxproj после элемента <Import /> файла Microsoft.Cpp.props.

<PropertyGroup>
    <PlatformToolset>v110_xp</PlatformToolset>
</PropertyGroup>

Чтобы выполнить повторную сборку проекта с использованием набора средств Visual C++ 11.0 для Windows XP, введите следующую команду.

msbuild myproject.vcxproj /p:PlatformToolset=v110_xp /t:rebuild

Добавление настроек MSBuild

MSBuild предоставляет различные способы настройки процесса сборки. В этих статьях рассказывается о том, как можно добавить пользовательские этапы сборки, средства и события в проект MSBuild.

См. также