Язык программирования C#9 и платформа .NET5 - Троелсен Эндрю

Для начала создайте новый проект консольного приложения по имени ExportDataToOfficeApp, откройте диалоговое окно Add COM Reference (Добавление ссылки СОМ), перейдите на вкладку СОМ и отыщите желаемую библиотеку СОМ, которой в данном случае является Microsoft Excel 16.0 Object Library (рис. 18.1).

После выбора СОМ-библиотеки IDE-среда отреагирует генерацией новой сборки, которая включает описания .NET Core метаданных СОМ. Формально она называется сборкой взаимодействия и не содержит какого-либо кода реализации кроме небольшой порции кода, который помогает транслировать события СОМ в события .NET Core. Тем не менее, сборки взаимодействия полезны тем, что защищают кодовую базу .NET Core от сложностей внутреннего механизма СОМ.

В коде C# можно напрямую работать со сборкой взаимодействия, которая отображает типы данных .NET Core на типы СОМ и наоборот. "За кулисами" данные маршализируются между приложениями .NET Core и СОМ с применением вызываемой оболочки времени выполнения (runtime callable wrapper — RCW), по существу являющейся динамически сгенерированным посредником. Такой посредник RCW будет маршализировать и трансформировать типы данных .NET Core в типы СОМ и отображать любые возвращаемые значения СОМ на их эквиваленты .NET Core.

Роль основных сборок взаимодействия

Многие библиотеки СОМ, созданные поставщиками библиотек СОМ (вроде библиотек Microsoft СОМ, обеспечивающих доступ к объектной модели продуктов Microsoft Office), предоставляют "официальную" сборку взаимодействия, которая называется основной сборкой взаимодействия (primary interop assembly — PIA). Сборки PIA — это оптимизированные сборки взаимодействия, которые приводят в порядок (и возможно расширяют) код, обычно генерируемый при добавлении ссылки на библиотеку СОМ с помощью диалогового окна Add Reference.

После добавления ссылки на библиотеку Microsoft Excel 16.0 Object Library просмотрите проект в окне Solution Explorer. Внутри узла Dependencies (Зависимости) вы увидите новый узел (СОМ) с элементом по имени Interop.Microsoft.Office.Interop.Excel. Это сгенерированный файл взаимодействия.

Встраивание метаданных взаимодействия

До выхода версии .NET 4.0, когда приложение C# задействовало библиотеку СОМ (через PIA или нет), на клиентской машине необходимо было обеспечить наличие копии сборки взаимодействия. Помимо увеличения размера установочного пакета приложения сценарий установки должен был также проверять, присутствуют ли сборки PIA, и если нет, тогда устанавливать их копии в глобальный кеш сборок (GAC).

На заметку! Глобальный кеш сборок был центральным хранилищем для сборок .NET Framework. В .NET Core он больше не используется.

Однако в .NET 4.0 и последующих версиях данные взаимодействия теперь можно встраивать прямо в скомпилированное приложение. В таком случае поставлять копию сборки взаимодействия вместе с приложением .NET Core больше не понадобится, т.к. все необходимые метаданные взаимодействия жестко закодированы в приложении .NET. В .NET Core встраивание сборки PIA является обязательным.

Чтобы встроить сборку PIA в среде Visual Studio, разверните узел Dependencies внутри узла проекта, разверните узел СОМ, щелкните правой кнопкой мыши на элементе Interop.Microsoft.Office.Interop.Excel и выберите в контекстном меню пункт Properties (Свойства). В диалоговом окне Properties (Свойства) выберите в раскрывающемся списке Embed Interop Types (Встраивать типы взаимодействия) пункт Yes (Да), как показано на рис. 18.2.

(window.adrunTag = window.adrunTag || []).push({v: 1, el: 'adrun-4-390', c: 4, b: 390})

Для изменения свойства посредством файла проекта добавьте узел <EmbedInteropTypes>true</EmbedInteropTypes>:

<ItemGroup>

  <COMReference Include="Microsoft.Office.Excel.dll">

    <Guid>00020813-0000-0000-c000-000000000046</Guid>

    <VersionMajor>1</VersionMajor>

    <VersionMinor>9</VersionMinor>

    <WrapperTool>tlbimp</WrapperTool>

    <Lcid>0</Lcid>

    <Isolated>false</Isolated>

<b>    &lt;EmbedInteropTypes&gt;true&lt;/EmbedInteropTypes&gt;</b>

  &lt;/COMReference&gt;

&lt;/ItemGroup&gt;

Компилятор C# будет включать только те части библиотеки взаимодействия, которые вы используете. Таким образом, даже если реальная библиотека взаимодействия содержит описания .NET Core сотен объектов СОМ, в приложение попадет только подмножество определений, которые действительно применяются в написанном коде С#. Помимо сокращения размера приложения, поставляемого клиенту, упрощается и процесс установки, т.к. не придется устанавливать сборки PIA, которые отсутствуют на целевой машине.

Общие сложности взаимодействия с СОМ

Многие библиотеки СОМ определяют методы, принимающие необязательные аргументы, которые вплоть до выхода .NET 3.5 в языке C# не поддерживались. Это требовало указания значения Type.Missing для каждого вхождения необязательного аргумента. К счастью, в .NET 3.5 и последующих версиях (включая .NET Core) значение Type.Missing вставляется на этапе компиляции, если не указано какое-то специфическое значение.

В качестве связанного замечания: многие методы СОМ поддерживают именованные аргументы, которые, как объяснялось в главе 4, позволяют передавать значения членам в любом порядке. Учитывая наличие поддержки той же самой возможности в языке С#, допускается просто "пропускать" необязательные аргументы, которые неважны, и устанавливать только те из них, которые нужны в текущий момент.

Еще одна распространенная сложность взаимодействия с СОМ была связана с тем фактом, что многие методы СОМ проектировались так, чтобы принимать и возвращать специфический тип данных по имени Variant. Во многом похоже на ключевое слово dynamic языка С#, типу данных Variant может быть присвоен на лету любой тип данных СОМ (строка, ссылка на интерфейс, числовое значение и т.д.). До появления ключевого слова dynamic передача и прием элементов данных типа Variant требовали немалых ухищрений, обычно связанных с многочисленными операциями приведения.

Когда свойство EmbedlnteropTypes установлено в true, все COM-типы Variant автоматически отображаются на динамические данные. В итоге не только сокращается потребность в паразитных операциях приведения при работе с типами данных Variant, но также еще больше скрываются некоторые сложности, присущие СОМ, вроде работы с индексаторами СОМ.