Взаимодействие со Swift/Objective-C

Перевод имен

Классы Objective-C импортируются в Kotlin со своими оригинальными именами. Протоколы импортируются как интерфейсы с добавленным суффиксом имени Protocol, например, @protocol Foo-> interface FooProtocol. Эти классы и интерфейсы помещаются в пакет, указанный в настройках сборки (platform.* пакеты для предварительно настроенных системных фреймворков).

Имена классов и интерфейсов Kotlin добавляют префикс при импорте в Objective-C. Префикс берется из имени фреймворка.

Objective-C не поддерживает пакеты в фреймворке. Поэтому компилятор Kotlin переименовывает классы Kotlin, имеющие одинаковое имя, но разные пакеты в одном фреймворке. Этот алгоритм пока не стабилен и может меняться между версиями Kotlin. В качестве обходного решения вы можете переименовать конфликтующие классы Kotlin в фреймворке.

Чтобы избежать переименования объявлений Kotlin, используйте аннотацию @ObjCName. Она указывает компилятору Kotlin использовать пользовательское имя Objective-C и Swift для классов, интерфейсов и других концепций Kotlin:

@ObjCName(swiftName = "MySwiftArray")
class MyKotlinArray {
    @ObjCName("index")
    fun indexOf(@ObjCName("of") element: String): Int = TODO()
}


// Usage with the ObjCName annotations
let array = MySwiftArray()
let index = array.index(of: "element")

Инициализаторы

Инициализаторы Swift/Objective-C импортируются в Kotlin как конструкторы и методы-фабрики с именем create. Последнее происходит с инициализаторами, объявленными в Objective-C категории или как Swift расширение, так как в Kotlin нет концепции расширенных конструкторов.

Конструкторы Kotlin импортируются как инициализаторы в Swift/Objective-C.

Свойства с установкой

Записываемые свойства Objective-C, переопределяющие только для чтения свойства суперкласса, представляются как метод setFoo() для свойства foo. То же самое относится к свойствам только для чтения протокола, которые реализованы как изменяемые.

Внедренные функции и свойства

Внедренные функции и свойства Kotlin доступны как члены специальных классов. Каждый файл Kotlin переводится в такой класс. Например,

// MyLibraryUtils.kt
package my.library

fun foo() {}

можно вызвать из Swift как

MyLibraryUtilsKt.foo()

Перевод имен методов

Как правило, метки аргументов Swift и части селектора Objective-C сопоставляются с именами параметров Kotlin. Тем не менее, эти две концепции имеют разную семантику, поэтому иногда методы Swift/Objective-C могут импортироваться с конфликтующим сигнатурой Kotlin. В этом случае конфликтующие методы можно вызвать из Kotlin, используя именованные аргументы, например:

[player moveTo:LEFT byMeters:17]
[player moveTo:UP byInches:42]

В Kotlin это будет:

player.moveTo(LEFT, byMeters = 17)
player.moveTo(UP, byInches = 42)

Методы kotlin.Any (equals(), hashCode() и toString()) сопоставляются с методами isEquals:, hash и description в Objective-C, и с методом isEquals(_:) и свойствами hash, description в Swift.

Можно указать более подходящее имя в Swift или Objective-C вместо переименования объявления Kotlin. Используйте аннотацию @ObjCName, которая указывает компилятору Kotlin использовать пользовательское имя Objective-C и Swift для методов или параметров.

Ошибки и исключения

В Kotlin нет понятия проверяемых исключений, все исключения Kotlin являются непроверяемыми. Swift имеет только проверяемые ошибки. Поэтому, если код Swift или Objective-C вызывает метод Kotlin, который выбрасывает исключение для обработки, то метод Kotlin должен быть помечен аннотацией @Throws, указывающей список «ожидаемых» классов исключений.

При компиляции в фреймворк Objective-C/Swift функции, не являющиеся suspend, имеющие или наследующие аннотацию @Throws, представляются как методы, возвращающие NSError* в Objective-C и как методы throws в Swift. Представления для suspend функций всегда имеют параметр NSError*/Error в обработчике завершения.

Когда функция Kotlin, вызываемая из кода Swift/Objective-C, выбрасывает исключение, которое является экземпляром одного из классов, указанных в @Throws, или их подклассов, оно распространяется как NSError. Другие исключения Kotlin, достигающие Swift/Objective-C, считаются необработанными и приводят к завершению программы.

Функции suspend без @Throws распространяют только CancellationException как NSError. Функции, не являющиеся suspend, без @Throws вообще не распространяют исключения Kotlin.

Обратите внимание, что обратный перевод не реализован: методы Swift/Objective-C, выбрасывающие ошибки, не импортируются в Kotlin как выбрасывающие исключения.

Функции приостановки

Функции приостановки Kotlin (функции приостановки) (suspend) представлены в сгенерированных заголовках Objective-C как функции с обратными вызовами или обработчиками завершения в терминах Swift/Objective-C.

Начиная со Swift 5.5, функции suspend Kotlin также доступны для вызова из Swift как async функции без использования обработчиков завершения. В настоящее время эта функциональность находится в стадии активного эксперимента и имеет определённые ограничения. Подробности см. в этом вопросе YouTrack.

Узнайте больше о механизме async/await в Swift.

Расширения и члены категорий

Члены категорий Objective-C и расширений Swift импортируются в Kotlin в виде расширений. Поэтому эти объявления не могут быть переопределены в Kotlin. И инициализаторы расширений недоступны как конструкторы Kotlin.

Расширения Kotlin для «обычных» классов Kotlin импортируются в Swift и Objective-C как расширения и члены категорий соответственно. Расширения Kotlin для других типов рассматриваются как объявления верхнего уровня с дополнительным параметром получателя. Эти типы включают:

• Тип Kotlin String

• Типы коллекций Kotlin и подтипы

• Типы Kotlin interface

• Примитивные типы Kotlin

• Классы Kotlin inline

• Тип Kotlin Any

• Типы функций Kotlin и подтипы

• Классы и протоколы Objective-C

Синглетоны Kotlin

Синглетон Kotlin (созданный с помощью объявления object, включая companion object) импортируется в Swift/Objective-C как класс с единственным экземпляром.

Экземпляр доступен через свойства shared и companion

Для следующего кода Kotlin:

object MyObject {
    val x = "Some value"
}

class MyClass {
    companion object {
        val x = "Some value"
    }
}

Доступ к этим объектам осуществляется следующим образом:

MyObject.shared
MyObject.shared.x
MyClass.companion
MyClass.Companion.shared

NSNumber

Коробки примитивных типов Kotlin отображаются на специальные классы Swift/Objective-C. Например, коробка kotlin.Int представлена экземпляром класса KotlinInt в Swift (или экземпляром класса ${prefix}Int в Objective-C, где prefix — префикс имени фреймворка). Эти классы являются производными от NSNumber, поэтому экземпляры являются правильными NSNumber, поддерживающими все соответствующие операции.

Тип NSNumber не преобразуется автоматически в примитивные типы Kotlin при использовании в качестве типа параметра или возвращаемого значения Swift/Objective-C. Причина в том, что тип NSNumber не предоставляет достаточной информации о типе обернутого примитивного значения, т. е. NSNumber статически неизвестно, является ли он Byte, Boolean или Double. Поэтому значения примитивных типов Kotlin должны быть преобразованы в/из NSNumber вручную (см. ниже).

NSMutableString

Класс Objective-C NSMutableString недоступен из Kotlin. Все экземпляры NSMutableString копируются при передаче в Kotlin.

Коллекции

Коллекции Kotlin преобразуются в коллекции Swift/Objective-C, как описано в таблице выше. Коллекции Swift/Objective-C отображаются в Kotlin таким же образом, за исключением NSMutableSet и NSMutableDictionary. NSMutableSet не преобразуется в Kotlin MutableSet. Чтобы передать объект для Kotlin MutableSet, можно создать такую коллекцию Kotlin явно, либо создав ее в Kotlin, например, с помощью mutableSetOf(), или используя класс KotlinMutableSet в Swift (или ${prefix}MutableSet в Objective-C, где prefix — префикс имени фреймворка). То же самое относится к MutableMap

Типы функций

Объекты типа функции Kotlin (например, лямбды) преобразуются в функции Swift/блоки Objective-C. Однако есть различие в том, как отображаются типы параметров и возвращаемых значений при переводе функции и типа функции. В последнем случае примитивные типы отображаются в их упакованное представление. Возвращаемое значение Kotlin Unit представляется как соответствующий синглетон Unit в Swift/Objective-C. Значение этого синглетона можно получить так же, как и для любого другого синглетона Kotlin (см. синглетоны в таблице выше).

fun foo(block: (Int) -> Unit) { ... }

будет представлено в Swift как

func foo(block: (KotlinInt) -> KotlinUnit)

и может быть вызвано как

foo {
    bar($0 as! Int32)
    return KotlinUnit()
}

Обобщения

Objective-C поддерживает «лёгкие обобщения», определённые для классов, с относительно ограниченным набором функций. Swift может импортировать обобщения, определённые для классов, чтобы предоставить дополнительную информацию о типе компилятору.

Поддержка функций обобщения для Objective-C и Swift отличается от Kotlin, поэтому перевод неизбежно потеряет некоторую информацию, но поддерживаемые функции сохраняют значимую информацию.

class Sample<T>() {
  fun myVal(): T
}

class Sample<T>() {
  fun myVal(): T?
}

class Sample<T : Any>() {
  fun myVal(): T
}

data class SomeData(val num: Int = 42) : BaseData()
class GenVarOut<out T : Any>(val arg: T)

let variOut = GenVarOut<SomeData>(arg: sd)
let variOutAny : GenVarOut<BaseData> = variOut as! GenVarOut<BaseData>

binaries.framework {
     freeCompilerArgs += "-Xno-objc-generics"
}