Kotlin/Native 作为动态库 - 教程

你可以创建动态链接库（dynamic libraries）以在现有程序中使用 Kotlin 代码。这使得跨多个平台或语言（包括 JVM、Python、Android 等）的代码共享成为可能。

备注

对于 iOS 和其他 Apple 目标平台，我们建议生成 framework。请参阅 Kotlin/Native 作为 Apple framework 教程。

你可以从现有的原生应用程序或库中使用 Kotlin/Native 代码。为此，你需要将 Kotlin 代码编译成 .so、.dylib 或 .dll 格式的动态链接库。

在本教程中，你将：

• 将 Kotlin 代码编译为动态链接库
• 检查生成的 C 头文件
• 从 C 语言中使用 Kotlin 动态链接库
• 编译并运行项目

你可以使用命令行直接或通过脚本文件（例如 .sh 或 .bat 文件）生成 Kotlin 库。但是，对于具有数百个文件和库的大型项目，这种方法的可扩展性不佳。使用构建系统可以简化此过程，它能下载并缓存 Kotlin/Native 编译器二进制文件和具有传递依赖关系的库，并运行编译器和测试。Kotlin/Native 可以通过 Kotlin Multiplatform 插件 使用 Gradle 构建系统。

让我们来研究一下 Kotlin/Native 和带有 Gradle 的 Kotlin Multiplatform 构建的高级 C 互操作相关用法。

如果你使用 Mac 并且想要为 macOS 或其他 Apple 目标平台创建和运行应用程序，你还需要先安装 Xcode Command Line Tools，启动它并接受许可条款。

创建 Kotlin 库

Kotlin/Native 编译器可以从 Kotlin 代码生成动态链接库。动态链接库通常带有一个 .h 头文件，你可以使用它从 C 语言调用编译后的代码。

让我们创建一个 Kotlin 库，并在 C 程序中使用它。

备注

有关如何创建新的 Kotlin/Native 项目并在 IntelliJ IDEA 中打开它的详细初始步骤和说明，请参阅 Kotlin/Native 入门教程。

1. 导航到 src/nativeMain/kotlin 目录并创建包含以下库内容的 lib.kt 文件：

   package example
    
   object Object { 
       val field = "A"
   }
    
   class Clazz {
       fun memberFunction(p: Int): ULong = 42UL
   }
    
   fun forIntegers(b: Byte, s: Short, i: UInt, l: Long) { }
   fun forFloats(f: Float, d: Double) { }
    
   fun strings(str: String) : String? {
       return "That is '$str' from C"
   }
    
   val globalString = "A global String"

2. 使用以下内容更新你的 build.gradle(.kts) Gradle 构建文件：

   Kotlin

   plugins {
       kotlin("multiplatform") version "2.1.20"
   }
   
   repositories {
       mavenCentral()
   }
   
   kotlin {
       macosArm64("native") {    // macOS on Apple Silicon
       // macosX64("native") {   // macOS on x86_64 platforms
       // linuxArm64("native") { // Linux on ARM64 platforms
       // linuxX64("native") {   // Linux on x86_64 platforms
       // mingwX64("native") {   // Windows
           binaries {
               sharedLib {
                   baseName = "native"       // macOS and Linux 
                   // baseName = "libnative" // Windows
               }
           }
       }
   }
   
   tasks.wrapper {
       gradleVersion = "8.10"
       distributionType = Wrapper.DistributionType.ALL
   }

   Groovy

   plugins {
       id 'org.jetbrains.kotlin.multiplatform' version '2.1.20'
   }
   
   repositories {
       mavenCentral()
   }
   
   kotlin {
       macosArm64("native") {    // Apple Silicon macOS
       // macosX64("native") {   // macOS on x86_64 platforms
       // linuxArm64("native") { // Linux on ARM64 platforms
       // linuxX64("native") {   // Linux on x86_64 platforms
       // mingwX64("native") {   // Windows
           binaries {
               sharedLib {
                   baseName = "native"       // macOS and Linux 
                   // baseName = "libnative" // Windows
               }
           }
       }
   }
   
   wrapper {
       gradleVersion = "8.10"
       distributionType = "ALL"
   }
   • binaries {} 代码块配置项目以生成动态链接库或共享库。
   • libnative 用作库名，生成的头文件名的前缀。它还为头文件中的所有声明添加前缀。

3. 在 IDE 中运行 linkDebugSharedNative Gradle 任务，或在终端中使用以下控制台命令来构建库：

   ./gradlew linkDebugSharedNative

构建会将库生成到 build/bin/native/debugShared 目录中，其中包含以下文件：

• macOS：libnative_api.h 和 libnative.dylib
• Linux：libnative_api.h 和 libnative.so
• Windows：libnative_api.h、libnative.def 和 libnative.dll

你还可以使用 linkNative Gradle 任务来生成库的 debug 和 release 变体。

Kotlin/Native 编译器使用相同的规则来为所有平台生成 .h 文件。让我们看看 Kotlin 库的 C API。

生成的头文件

让我们检查一下 Kotlin/Native 声明如何映射到 C 函数。

在 build/bin/native/debugShared 目录中，打开 libnative_api.h 头文件。第一部分包含标准的 C/C++ 头部和尾部：

#ifndef KONAN_LIBNATIVE_H
#define KONAN_LIBNATIVE_H
#ifdef __cplusplus
extern "C" {
#endif

/// The rest of the generated code

#ifdef __cplusplus
}  /* extern "C" */
#endif
#endif  /* KONAN_LIBNATIVE_H */

在此之后，libnative_api.h 包含一个带有通用类型定义的代码块：

#ifdef __cplusplus
typedef bool            libnative_KBoolean;
#else
typedef _Bool           libnative_KBoolean;
#endif
typedef unsigned short     libnative_KChar;
typedef signed char        libnative_KByte;
typedef short              libnative_KShort;
typedef int                libnative_KInt;
typedef long long          libnative_KLong;
typedef unsigned char      libnative_KUByte;
typedef unsigned short     libnative_KUShort;
typedef unsigned int       libnative_KUInt;
typedef unsigned long long libnative_KULong;
typedef float              libnative_KFloat;
typedef double             libnative_KDouble;
typedef float __attribute__ ((__vector_size__ (16))) libnative_KVector128;
typedef void*              libnative_KNativePtr;

Kotlin 对创建的 libnative_api.h 文件中的所有声明使用 libnative_ 前缀。以下是类型映射的完整列表：

Kotlin 定义	C 类型
libnative_KBoolean	bool 或 _Bool
libnative_KChar	unsigned short
libnative_KByte	signed char
libnative_KShort	short
libnative_KInt	int
libnative_KLong	long long
libnative_KUByte	unsigned char
libnative_KUShort	unsigned short
libnative_KUInt	unsigned int
libnative_KULong	unsigned long long
libnative_KFloat	float
libnative_KDouble	double
libnative_KVector128	float __attribute__ ((__vector_size__ (16))
libnative_KNativePtr	void*

libnative_api.h 文件的定义部分显示了 Kotlin 原始类型如何映射到 C 原始类型。Kotlin/Native 编译器会自动为每个库生成这些条目。反向映射在 从 C 映射原始数据类型 教程中进行了描述。

在自动生成的类型定义之后，你将找到库中使用的单独类型定义：

struct libnative_KType;
typedef struct libnative_KType libnative_KType;

/// Automatically generated type definitions

typedef struct {
  libnative_KNativePtr pinned;
} libnative_kref_example_Object;
typedef struct {
  libnative_KNativePtr pinned;
} libnative_kref_example_Clazz;

在 C 语言中，typedef struct { ... } TYPE_NAME 语法声明了结构体。

有关此模式的更多解释，请参见 此 StackOverflow 帖子。

从这些定义中可以看出，Kotlin 类型使用相同的模式进行映射：Object 映射到 libnative_kref_example_Object，Clazz 映射到 libnative_kref_example_Clazz。所有结构体都只包含带有指针的 pinned 字段。字段类型 libnative_KNativePtr 在文件中较早的位置定义为 void*。

由于 C 语言不支持命名空间，因此 Kotlin/Native 编译器会生成长名称，以避免与现有原生项目中的其他符号发生任何可能的冲突。

服务运行时函数

libnative_ExportedSymbols 结构体定义了 Kotlin/Native 和你的库提供的所有函数。它大量使用嵌套的匿名结构体来模拟包。libnative_ 前缀来自库名。

libnative_ExportedSymbols 在头文件中包含几个辅助函数：

typedef struct {
  /* Service functions. */
  void (*DisposeStablePointer)(libnative_KNativePtr ptr);
  void (*DisposeString)(const char* string);

这些函数处理 Kotlin/Native 对象。调用 DisposeStablePointer 以释放对 Kotlin 对象的引用，调用 DisposeString 以释放 Kotlin 字符串，该字符串在 C 语言中具有 char* 类型。

libnative_api.h 文件的下一部分由运行时函数的结构体声明组成：

libnative_KBoolean (*IsInstance)(libnative_KNativePtr ref, const libnative_KType* type);
libnative_KBoolean (*IsInstance)(libnative_KNativePtr ref, const libnative_KType* type);
libnative_kref_kotlin_Byte (*createNullableByte)(libnative_KByte);
libnative_KByte (*getNonNullValueOfByte)(libnative_kref_kotlin_Byte);
libnative_kref_kotlin_Short (*createNullableShort)(libnative_KShort);
libnative_KShort (*getNonNullValueOfShort)(libnative_kref_kotlin_Short);
libnative_kref_kotlin_Int (*createNullableInt)(libnative_KInt);
libnative_KInt (*getNonNullValueOfInt)(libnative_kref_kotlin_Int);
libnative_kref_kotlin_Long (*createNullableLong)(libnative_KLong);
libnative_KLong (*getNonNullValueOfLong)(libnative_kref_kotlin_Long);
libnative_kref_kotlin_Float (*createNullableFloat)(libnative_KFloat);
libnative_KFloat (*getNonNullValueOfFloat)(libnative_kref_kotlin_Float);
libnative_kref_kotlin_Double (*createNullableDouble)(libnative_KDouble);
libnative_KDouble (*getNonNullValueOfDouble)(libnative_kref_kotlin_Double);
libnative_kref_kotlin_Char (*createNullableChar)(libnative_KChar);
libnative_KChar (*getNonNullValueOfChar)(libnative_kref_kotlin_Char);
libnative_kref_kotlin_Boolean (*createNullableBoolean)(libnative_KBoolean);
libnative_KBoolean (*getNonNullValueOfBoolean)(libnative_kref_kotlin_Boolean);
libnative_kref_kotlin_Unit (*createNullableUnit)(void);
libnative_kref_kotlin_UByte (*createNullableUByte)(libnative_KUByte);
libnative_KUByte (*getNonNullValueOfUByte)(libnative_kref_kotlin_UByte);
libnative_kref_kotlin_UShort (*createNullableUShort)(libnative_KUShort);
libnative_KUShort (*getNonNullValueOfUShort)(libnative_kref_kotlin_UShort);
libnative_kref_kotlin_UInt (*createNullableUInt)(libnative_KUInt);
libnative_KUInt (*getNonNullValueOfUInt)(libnative_kref_kotlin_UInt);
libnative_kref_kotlin_ULong (*createNullableULong)(libnative_KULong);
libnative_KULong (*getNonNullValueOfULong)(libnative_kref_kotlin_ULong);

你可以使用 IsInstance 函数来检查 Kotlin 对象（通过其 .pinned 指针引用）是否为类型的实例。生成的实际操作集取决于实际用法。

Kotlin/Native 有自己的垃圾回收器（garbage collector），但它不管理从 C 访问的 Kotlin 对象。但是，Kotlin/Native 提供了 与 Swift/Objective-C 的互操作性，并且垃圾回收器 与 Swift/Objective-C ARC 集成。

你的库函数

让我们看一下库中使用的单独结构体声明。libnative_kref_example 字段使用 libnative_kref. 前缀来模拟 Kotlin 代码的包结构：

typedef struct {
  /* User functions. */
  struct {
    struct {
      struct {
        struct {
          libnative_KType* (*_type)(void);
          libnative_kref_example_Object (*_instance)();
          const char* (*get_field)(libnative_kref_example_Object thiz);
        } Object;
        struct {
          libnative_KType* (*_type)(void);
          libnative_kref_example_Clazz (*Clazz)();
          libnative_KULong (*memberFunction)(libnative_kref_example_Clazz thiz, libnative_KInt p);
        } Clazz;
        const char* (*get_globalString)();
        void (*forFloats)(libnative_KFloat f, libnative_KDouble d);
        void (*forIntegers)(libnative_KByte b, libnative_KShort s, libnative_KUInt i, libnative_KLong l);
        const char* (*strings)(const char* str);
      } example;
    } root;
  } kotlin;
} libnative_ExportedSymbols;

该代码使用匿名结构体声明。在这里，struct { ... } foo 声明了外部结构体中匿名结构体类型的字段，该字段没有名称。

由于 C 语言也不支持对象，因此使用函数指针来模拟对象语义。函数指针声明为 RETURN_TYPE (* FIELD_NAME)(PARAMETERS)。

libnative_kref_example_Clazz 字段表示 Kotlin 中的 Clazz。libnative_KULong 可以通过 memberFunction 字段访问。唯一的区别是 memberFunction 接受 thiz 引用作为第一个参数。由于 C 语言不支持对象，因此 thiz 指针是显式传递的。

Clazz 字段中有一个构造函数（也称为 libnative_kref_example_Clazz_Clazz），它充当构造函数函数来创建 Clazz 的实例。

Kotlin object Object 可作为 libnative_kref_example_Object 访问。_instance 函数检索对象的唯一实例。

属性被转换为函数。get_ 和 set_ 前缀分别命名 getter 和 setter 函数。例如，Kotlin 中的只读属性 globalString 在 C 语言中转换为 get_globalString 函数。

全局函数 forFloats、forIntegers 和 strings 在 libnative_kref_example 匿名结构体中转换为函数指针。

入口点

现在你了解了 API 的创建方式，libnative_ExportedSymbols 结构体的初始化是起点。然后让我们看一下 libnative_api.h 的最后一部分：

extern libnative_ExportedSymbols* libnative_symbols(void);

libnative_symbols 函数允许你打开从本机代码到 Kotlin/Native 库的网关。这是访问库的入口点。库名称用作函数名称的前缀。

可能需要为每个线程托管返回的 libnative_ExportedSymbols* 指针。

从 C 语言中使用生成的头文件

从 C 语言中使用生成的头文件非常简单。在库目录中，创建包含以下代码的 main.c 文件：

#include "libnative_api.h"
#include "stdio.h"

int main(int argc, char** argv) {
  // Obtain reference for calling Kotlin/Native functions
  libnative_ExportedSymbols* lib = libnative_symbols();

  lib->kotlin.root.example.forIntegers(1, 2, 3, 4);
  lib->kotlin.root.example.forFloats(1.0f, 2.0);

  // Use C and Kotlin/Native strings
  const char* str = "Hello from Native!";
  const char* response = lib->kotlin.root.example.strings(str);
  printf("in: %s
out:%s
", str, response);
  lib->DisposeString(response);

  // Create Kotlin object instance
  libnative_kref_example_Clazz newInstance = lib->kotlin.root.example.Clazz.Clazz();
  long x = lib->kotlin.root.example.Clazz.memberFunction(newInstance, 42);
  lib->DisposeStablePointer(newInstance.pinned);

  printf("DemoClazz returned %ld
", x);

  return 0;
}

编译并运行项目

在 macOS 上

要编译 C 代码并将其与动态链接库链接，请导航到库目录并运行以下命令：

clang main.c libnative.dylib

编译器会生成一个名为 a.out 的可执行文件。运行它以从 C 库执行 Kotlin 代码。

在 Linux 上

要编译 C 代码并将其与动态链接库链接，请导航到库目录并运行以下命令：

gcc main.c libnative.so

编译器会生成一个名为 a.out 的可执行文件。运行它以从 C 库执行 Kotlin 代码。在 Linux 上，你需要将 . 包含到 LD_LIBRARY_PATH 中，以使应用程序知道从当前文件夹加载 libnative.so 库。

在 Windows 上

首先，你需要安装一个支持 x64_64 目标的 Microsoft Visual C++ 编译器。

最简单的方法是在 Windows 计算机上安装 Microsoft Visual Studio。在安装过程中，选择使用 C++ 所需的组件，例如 使用 C++ 的桌面开发。

在 Windows 上，你可以通过生成静态库包装器或使用 LoadLibrary 或类似的 Win32API 函数手动包含动态链接库。

让我们使用第一个选项，并为 libnative.dll 生成静态包装库：

1. 从工具链调用 lib.exe 以生成静态库包装器 libnative.lib，该包装器自动执行代码中的 DLL 用法：

   lib /def:libnative.def /out:libnative.lib

2. 将你的 main.c 编译为可执行文件。将生成的 libnative.lib 包含到构建命令中并启动：

   cl.exe main.c libnative.lib

   该命令生成 main.exe 文件，你可以运行它。

接下来做什么

• 详细了解与 Swift/Objective-C 的互操作性
• 查看 Kotlin/Native 作为 Apple framework 的教程