Настройка экспорта Swift-пакета

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

В следующем примере общий код проекта Kotlin Multiplatform хранится локально в модуле shared. Если структура вашего проекта отличается, замените "shared" в примерах кода и путей на имя вашего модуля.

Чтобы настроить публикацию XCFramework:

1. Обновите файл конфигурации shared/build.gradle.kts, добавив вызов XCFramework в список целевых платформ iOS:

   import org.jetbrains.kotlin.gradle.plugin.mpp.apple.XCFramework
   
   kotlin {
       // Other Kotlin Multiplatform targets
       // ...
       // Name of the module to be imported in the consumer project
       val xcframeworkName = "Shared"
       val xcf = XCFramework(xcframeworkName)
   
       listOf(
           iosArm64(),
           iosSimulatorArm64(),
       ).forEach { 
           it.binaries.framework {
               baseName = xcframeworkName
   
               // Specify CFBundleIdentifier to uniquely identify the framework
               binaryOption("bundleId", "org.example.${xcframeworkName}")
               xcf.add(this)
               isStatic = true
           }
       }
       //...
   }
   

2. Запустите задачу Gradle, чтобы создать фреймворк:

   ./gradlew :shared:assembleSharedXCFramework
   

   Созданный фреймворк будет находиться в папке shared/build/XCFrameworks/release/Shared.xcframework в каталоге проекта.

3. Если у вас есть несколько модулей с общим кодом, которые вы хотите экспортировать (например, модуль общей логики и модуль общего пользовательского интерфейса), объедините их в один новый модуль и распространяйте вместо них этот модуль-обёртку.

Подготовка XCFramework и манифеста Swift-пакета

1. Сожмите папку Shared.xcframework в ZIP-файл и вычислите контрольную сумму полученного архива, например:

   swift package compute-checksum Shared.xcframework.zip

2. Загрузите ZIP-файл в выбранное вами файловое хранилище. Файл должен быть доступен по прямой ссылке. Например, вот как это можно сделать с помощью релизов на GitHub:

   Загрузка в релиз GitHub

   1. Перейдите на GitHub и войдите в свою учётную запись.

   2. Перейдите в репозиторий, где хотите создать релиз.

   3. В разделе Релизы справа нажмите ссылку Создать новый релиз.

   4. Заполните сведения о релизе, добавьте или создайте новый тег, укажите заголовок релиза и напишите описание.

   5. Загрузите ZIP-файл с XCFramework с помощью поля Прикрепите бинарные файлы, перетащив их сюда или выбрав внизу:

      

   6. Нажмите Опубликовать релиз.

   7. В разделе Ресурсы релиза щёлкните правой кнопкой мыши ZIP-файл и выберите Копировать адрес ссылки или аналогичный пункт в браузере:

      

3. [Рекомендуется] Проверьте, что ссылка работает и файл можно скачать. В терминале выполните следующую команду:

   curl <downloadable link to the uploaded XCFramework ZIP file>
   

4. Если ваш проект использует зависимости SwiftPM, начиная с Kotlin 2.4.20-RC3 задача Gradle assembleSharedXCFramework создаёт файл Package.swift рядом с XCFramework.

   Если это не так, вы можете создать файл Package.swift вручную по следующему шаблону:

   // swift-tools-version:5.3
   import PackageDescription
   
   let package = Package(
      name: "Shared",
      platforms: [
        .iOS(.v14),
      ],
      products: [
         .library(name: "Shared", targets: ["Shared"])
      ],
      targets: [
         .binaryTarget(
            name: "Shared",
            url: "<link to the uploaded XCFramework ZIP file>",
            checksum:"<checksum calculated for the ZIP file>")
      ]
   )
   

5. Укажите недостающие поля:

   • В поле url укажите ссылку на ZIP-архив с XCFramework.

   • В поле checksum укажите контрольную сумму, ранее вычисленную для ZIP-файла.

6. [Рекомендуется] Чтобы проверить полученный манифест, выполните следующую команду оболочки в каталоге с файлом Package.swift:

   swift package reset && swift package show-dependencies --format json
   

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

7. Отправьте файл Package.swift в удалённый репозиторий. Не забудьте создать и отправить тег Git с семантической версией пакета.

Добавление зависимости от пакета

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

1. В Xcode выберите Файл | Добавить зависимости пакета.

2. В поле поиска введите URL репозитория Git, содержащего файл Package.swift:

   

3. Нажмите кнопку Добавить пакет, затем выберите продукты и соответствующие целевые платформы для пакета.

Проверка настройки

Чтобы проверить, что всё настроено правильно, проверьте импорт в Xcode:

1. В проекте перейдите к файлу представления пользовательского интерфейса, например ContentView.swift.

2. Замените код следующим фрагментом:

   import SwiftUI
   import Shared
   
   struct ContentView: View {
       var body: some View {
           VStack {
               Image(systemName: "globe")
                   .imageScale(.large)
                   .foregroundStyle(.tint)
               Text("Hello, world! \(Shared.Platform_iosKt.getPlatform().name)")
           }
           .padding()
       }
   }
   
   #Preview {
       ContentView()
   }
   

   Здесь вы импортируете XCFramework Shared, а затем используете его, чтобы получить название платформы из поля Text.

3. Убедитесь, что предварительный просмотр обновился и отображает новый текст.