투덜이의 리얼 블로그

[KMP] KMP 라이브러리를 Flutter에서 사용하기 - flutter plugin에서 dll load #4

뚜덜이~ — Sun, 26 Jan 2025 17:29:19 +0900

fultter에서 dll 파일을 로드하려면 두가지 방법이 존재합니다.

이전 포스팅에서 사용했던 method channel을 사용하는 방법, ffi plugin을 사용하는 방법인데, 전자의 경우 구현하기가 까다롭습니다.

mac os에서는 method channel을 통하여 xcFramework의 함수를 호출하기 위해서 swift 코드에 호출할 함수를 맵핑시켜 주는 코드를 아주 조금만 수정하면 가능했으나, windows dll의 경우 C++ 언어로 이 작업을 해야 합니다.

kmp 는 kotlin으로

Mac용 flutter에 로드하기 위해서 swift로

Windows용 flutter에 로드하기 위해서 C++로

이 두 OS에서 맵핑된 함수를 dart로 뽑아내기 위해서는 dart로..

따라서 사용해야 하는 언어가 너무 많아지고 복잡해 지므로 여기서는 flutter plugin중 하나의 ffi를 사용합니다.

FFI 설정

flutter plugin의 pubspec.yaml에 아래와 같이 ffi 를 추가합니다.

...

dependencies:
  flutter:
    sdk: flutter
  ffi: ^2.1.3
  ...

...

생성했던 dll 파일을 plugin 프로젝트의 windows 폴더 아래 복사합니다. 단 주의할 점은 plugin 프로젝트에서 이를 실행시키이 위한 example/windows 폴더도 존재합니다. 여기에 복사하지 않됩니다.

"프로젝트명/windows/MyLib.dll" 의 경로에 복사되어야 합니다.

Library Load

라이브러리의 로드는 open 함수 바로 수행할 수 있습니다.

    DynamicLibrary dyLib = DynamicLibrary.open('../windows/MyLib.dll');

다만 library를 로드할때 singleton으로 만들어 한번만 로드하여 사용하도록 아래와 같이 만듭니다.

//load_libaray.dart

import 'dart:ffi';
import 'dart:io';

/// Library load를 처리
class LoadLibrary {
  LoadLibrary._privateConstructor();

  static final LoadLibrary _instance = LoadLibrary._privateConstructor();

  factory LoadLibrary() {
    return _instance;
  }

  DynamicLibrary? loadLib() {
    print("current Directory: ${Directory.current.path}");

    DynamicLibrary dyLib;

    try {
      if (Platform.isWindows) {
        dyLib = DynamicLibrary.open('../windows/MyLib.dll');
      } else {
        print("Not supported OS");
        return null;
      }
      print("load lib success");
    } catch (e) {
      print('F11ailed to load DLL: $e');
      return null;
    }

    return dyLib;
  }
}

dll을 파일을 정확한 위치에 잘 복사했다면 load 성공 메시지를 확인할 수 있습니다.

Libarary 함수 호출

함수 호출시 호출할 라이브러리 함수의 signature와 이를 maping할 dart 함수의 signature를 선언합니다.

@OptIn(ExperimentalNativeApi::class)
@CName("inputTest")
fun inputTest(name: String): Int {
    println("inputTest() - name:$name")
    return 100
}

이 함수가 kmp로 선언했던 함수입니다. 이 함수가 dll로 컴파일되면 String같은 경우 char*로 변경되면서 pointer로 접근해야 합니다. (참고로 kmp 빌드시 dll과 함께 header파일이 같이 제공 됩니다. 실제로는 dll 파일만사용하지만 header 파일을 열어 extern c로 구성된 함수의 함수 signature를 확인할 수 있습니다.)

typedef InputTestNative = Int32 Function(Pointer<Utf8> name); //dll 함수 타입
typedef InputTestDart = int Function(Pointer<Utf8> name);     //dart 함수 타입

함수를 호출할때는 lookup 함수를 사용합니다.

// library에서 inputTest() 함수 검색
final InputTestDart inputTest = dyLib
         .lookup<NativeFunction<InputTestNative>>("inputTest")
         .asFunction();

// 입력값 pointer로 변환
final paramPointer = "홍길동".toNativeUtf8();

// 함수 호출
final int result = inputTest(paramPointer);

// param으로 만들었던 pointer 해제
calloc.free(paramPointer);

print('result: $result');

param으로 넘겨야 하는 값이 char* 이기 때문에 pointer를 만들어 담아서 dll 함수를호출하고, 사용 이후에 반드시 free로 해제해야 합니다.

실제 전체 함수를 보면 아래와 같습니다.

import 'dart:ffi';
import 'package:ffi/ffi.dart';
import '../load_library.dart';
import 'dart:io' show Directory, Platform;

typedef InputTestNative = Int32 Function(Pointer<Utf8> name); //dll 함수 타입
typedef InputTestDart = int Function(Pointer<Utf8> name);     //dart 함수 타입

class TestCall {
  static final TAG = 'TestCall';
  final loadedLibrary = LoadLibrary();
  final nativeFunctionName = 'inputTest';

  Future<String?> invoke() {
    print('current Directory: ${Directory.current.path}');
    print('requestTest: $requestTest');

    int? result;
    Pointer<Utf8>? paramPointer;
    try {
      // library 로드
      final dyLib = loadedLibrary.loadLib();
      if (dyLib != null) {
          // 함수 호출
          InputTestDart inputTest = dyLib
            .lookup<NativeFunction<InputTestNative>>(nativeFunctionName)
            .asFunction();

          // param 준비
          final paramPointer = "내 이름은 홍길동".toNativeUtf8();
          result = inputTest(paramPointer);
          print('result: $result');
      }      
    } catch (e) {
      print('Failed to load DLL: $e');
    } finally {
      //dart에서 선언한 pointer는 dart에서 해제해야 한다.
      if (paramPointer != null) {
        calloc.free(paramPointer);
      }
    }
    return Future.value(result ?? "Failed to call inputTest() Native function");
  }
}

Pointer를 사용하는 추가 예제

@OptIn(ExperimentalNativeApi::class)
@CName("returnParam")
fun returnParam(name: String): String {
    println("inputTest() - name:$name")
    return name
}

만약 위와 같이 String을 param으로 받고 String을 반환하는 함수라면 아래와 같이 선언하고 호출해야 합니다.

호출 코드

typedef ReturnParamNative = Pointer<Utf8> Function(Pointer<Utf8> name); //dll 함수 타입
typedef ReturnParamDart = Pointer<Utf8> Function(Pointer<Utf8> name);   //dart 함수 타입

// library에서 inputTest() 함수 검색
final ReturnParamDart inputTest = dyLib
         .lookup<NativeFunction<ReturnParamNative>>("returnParam")
         .asFunction();

// 입력값 pointer로 변환
final paramPointer = "임꺽정".toNativeUtf8();

// 함수 호출
Pointer<Utf8>? name = inputTest(paramPointer);
String result = name.toDartString(); // dart string으로 변환

// param으로 만들었던 pointer 해제
calloc.free(paramPointer);

print('result: $result');

여기서 주위할 점은 함수의 return값이 pointer 이므로 이를 재변환하는 toDartString() 함수를 사용한다는점 입니다.

[KMP] KMP 라이브러리를 Flutter에서 사용하기 - Windows용 dll 빌드 #3

뚜덜이~ — Sun, 26 Jan 2025 16:29:28 +0900

앞선 내용에서 kmp로 만든 코드를 macOS용 library를 만들고, 이를 flutter plugin에 포함시키는 방법을 알아봤습니다.

이번에는 kmp로 작성한 코드를 windows용도의 dll로 빌드하고 flutter plugin으로 만드는 방법을 설명합니다.

하고자 하는것은 아래와 같은습니다.

kmp로 공용화시킬 함수를 작성한다
windows 용 dll 파일로 빌드한다.
flutter plugin에서 dll 파일을 읽어 해당 함수를 호출한다.
flutter에서 사용 가능하도록 생성한 plugin을 배포한다.

호출할 함수의 정의

flutter에서 dll을 로드하고 함수를 호출하려면 반드시 extern C로 선언된 함수만 가능합니다. 또한 kmp로 작성한 코드를 flutter에서 호출하려면 이는 top-level function으로 선언되어야만 가능합니다. 이 두가지가 가장 핵심이므로 꼭 지켜야 합니다.

또한 호출하려는 함수는 shared/commonMain안에 위치해야 합니다.

//TestInterface.kt

@OptIn(ExperimentalNativeApi::class)
@CName("inputTest")
fun inputTest(number: String): Int {
    println("inputTest() - number:$number")
    return 100
}

shared/commonMain/kotlin/com.xxx.xx.../TestInterface.kt 를 생성합니다.

Top level function으로 inputTest() 함수를 생성하고 @CName을 주어 외부에서 호출하기 쉽도록 선언합니다.

Gradle 구성

shared/build.gradle.kts에 아래와 같이 추가합니다.

kotlin {
   ...
   
   mingwX64("native") {
        binaries {
            sharedLib {
                baseName = "TestLib"
            }
        }
    }
    
   ...
}

터미널에서 하기와 같은 명령어를 수행합니다.

./gradlew linkNative

또는 해당 명령어를 gradle task 목록에서 직접 찾아서 수행할수 도 있습니다. (debug, release 각각 따로 빌드 가능)

물론 해당 빌드는 윈도우 pc에서 수행해야 합니다. (macOS용 xcFramework을 만드는건 mac os에서만 가능하듯이..)

빌드된 DLL 파일은 "shared/build/bin/native/" 폴더 아래 존재합니다.

flutter plugin에서 dll를 load하는 방법은 다음 포스팅에서 확인 가능합니다.

[Tensorflow] Mac에서 tensorflow 설정

뚜덜이~ — Sun, 26 Jan 2025 12:10:23 +0900

Photy by unsplash

Mac에도 GPU가 있지만 tensorflow 환경 설정치 주로 NVIDIA의 cuda 코드를 사용하는 설정만 나와 있기에 간략하게 사용 방법을 설명해 보겠습니다. (흠..실제로 잘 돌지는....)

Anaconda, VS code 설치

anaconda와 visual studio code는 이미 설치되었다고 가정하고 진행 합니다..하지만 아쉬울수 있으니 간략하게 설명하자면

- 아나콘다를 다운로드 받아 설치 합니다[1] https://docs.anaconda.com/anaconda/install/

- VS Code를 다운로드 받아 설치 합니다.[2] https://code.visualstudio.com/download

왼쪽에 네모 모양의 아이콘을 클릭한뒤 python을 설치 합니다.

그리고 나서 jupyter로 설치해 줍니다.

Anaconda 가상환경 생성 및 tensorflow 설치

anaconda가 이미 환경변수에 추가되었다는 가정하에 하기 명령어를 입력하여 현재 가상환경을 확인 합니다.

conda env list

저는 이미 tensorflow라는 이름으로 환경을 만들었지만 기본적으로는 base만 존재 합니다. 그리고 기본적으로 * 표시는 현재 선택된 환경을 의미 합니다. 처음 생성하면 base에 * 표시가 되어 있습니다.

하기 명령어로 새로운 virtual 환경을 만들고 activate 시킵니다.

conda create -n tensorflow python=3.9 //'tensorflow' 라는 가상환경 생성, 버전은 3.9
conda activate tensorflow //'tensorflow' 환경을 사용하도록 변경

다시 한번 conda env list를 실행하면 위 그림처럼 tensorflow에 * 표시가 된것을 알수 있습니다.

현재 python의 버전은 3.12.xx까지 나와 있으나, 해당 버전으로 설치시 tensorflow가 설치가 안되더군요... 따라서 실행 최소 버전인 3.9를 명시적으로 넣고 virtual 환경을 생성합니다.

참고로 'python=3.9' 부분을 생략하면 가장 최신 버전의 python을 설치하여 줍니다.

conda install -c apple tensorflow-deps //Apple 의존성 설치
pip intall tensorflow //tensorflow 설치
pip install tensorflow-metal // GPU 지원

위와 같이 새로 생성한 가상 공간에 tensorflow를 설치해 줍니다.[3][4]

Tensorflow 확인

VS code에서 ipynb 파일을 하나 생성합니다. "Command + Shift + P"를 누르면 선택창이 뜨고, "jupyter"를 입력하면 "Create: New Jupyter NoteBook" 을 선택할수 있습니다.

새로 주피터 노트북 파일 하나 생깁니다.

그리고 이 주피터 파일을 수행할 interpreter를 아까 생성해 놓은 가상 머신으로 바꿔 줍니다.

다시 "Command + Shift + P"를 눌러 선택창에서 "Interpre"를 입력하면 "Python: Select Interpreter" 을 선택할수 있습니다.

그럼 이미 생성해 놓은 여러 interpreter들이 나열되는데, 아까 만들어 놓은 'tensorflow'를 선택합니다.

우상단에 현재 사용하고 있는 interpreter가 사진과 같이 보여집니다.

그럼 간단하게 잘 설치되었는지 아래 코드르 넣어서 실행 시킵니다.[3]

import tensorflow as tf

# Check for tensorflow GPU acess
print("TensorFlow has access to the following devices:", tf.config.list_physical_devices())

# See TensorFlow version
print("TensorFlow version:", tf.__version__)

설치된 tensorflow의 버전과 사용할수 있는 CPU / GPU를 표시해 줍니다. (이 코드 몇줄 수행하는데 40s나 걸렸네요..)

또는 확인을 위해서 metal 설명 페이지에서 제시한 실제 learning을 돌리는 코드를 수행해 볼수도 있습니다. [4]

import tensorflow as tf

cifar = tf.keras.datasets.cifar100
(x_train, y_train), (x_test, y_test) = cifar.load_data()
model = tf.keras.applications.ResNet50(
    include_top=True,
    weights=None,
    input_shape=(32, 32, 3),
    classes=100,)

loss_fn = tf.keras.losses.SparseCategoricalCrossentropy(from_logits=False)
model.compile(optimizer="adam", loss=loss_fn, metrics=["accuracy"])
model.fit(x_train, y_train, epochs=5, batch_size=64)

실제 구동 화면

Virtual env 삭제

지우기 위해서는 먼저 activate가 된 상태이면 불가 합니다. 따라서 base로 activate를 돌린 이후에 삭제를 진행 합니다.

conda activate base
conda remove --name tensorflow --all

Reference

[1] https://docs.anaconda.com/anaconda/install/

[2] https://code.visualstudio.com/download

[3] https://toward-the-future.tistory.com/entry/MacOS

[4] https://developer.apple.com/metal/tensorflow-plugin/

[KMP] KMP 라이브러리를 Flutter에서 사용하기 - Flutter Plugin에 KMP xcFramework Library import #2

뚜덜이~ — Tue, 14 Jan 2025 16:41:30 +0900

Photo by unsplash

이전글에서 생성한 xcfFramework을 flutter plugin으로 만드는 과정을 설명합니다. 이렇게 만들면 KMP를 통해서 생성한 library를 flutter에도 plugin 형태로 배포할수 있습니다.

Flutter Plugin Project 생성

먼저 Flutter Plugin Project를 생성합니다. Android studio에서 flutter plugin이 설정되어 있다면 "File -> New -> New Flutter Project"에서도 UI를 통해서 만들수 있지만, 여기서는 cmd 명령어로 생성해 보겠습니다.

flutter create --template=plugin --platforms=windows,macos kmm_plugin

plugin 템플릿을 사용하고, windows와 macos에서 사용할수 있도록 합니다. (물론 window에서는 생성된 library를 호출하지 않습니다만, 추후 desktop을 지원하기 위하여 추가해 놓습니다.)

project 이름은 kmm_plugin으로 하겠습니다.

생성된 project는 아래와 같습니다.

example: 생성된 plugin을 테스트해 볼수 있도록 flutter에서 제공하는 폴더 (main.dart가 존재)
lib: import된 library를 wrapping하여 dart함수를 제공하는 부분
macos: import된 library를 위치시키고 plugin에 연결하기위해 설정하는 부분

macos 폴더 설정

먼저 이전에 빌드한 framework을 그대로 macos아래로 복사합니다.

생성된 framework중에 debug 용으로 생성된 framework을 이동시키겠습니다.

위 그림과 같이 project 구조로 봤을때 최상위의 macos/share.xcframework에 위치하게 됩니다. (example 안에도 macos 폴더가 있습니다만 거기에 복사하는게 아닙니다.)

위 캡쳐사진에 보이는 macos/kmm_plugin.podspec에 아래와 vendored_frameworks를 같이 추가합니다.

  s.vendored_frameworks = 'shared.xcframework'

이때 'shared.xcframework'은 방금 복사해서 넣은 이름을 넣어야 합니다.

실제 추가되고 나면 kmm_plugin.podspec 파일은 아래와 같습니다.

Pod::Spec.new do |s|
  s.name             = 'kmm_plugin'
  s.version          = '0.0.1'
  ...
  s.swift_version = '5.0'
  s.vendored_frameworks = 'shared.xcframework'
end

터미널을 열어 "example/macos/"로 이동한 후 하기 명령어를 수행하여 Runner.xcworkspace 파일에 추가한 xcframework을 통합 시킵니다.

pod install

Library 호출을 위한 macos 작업

하기 위치의 macos/KmmPlugin.swift 를 열면 아래와 같이 기본설정이 되어 있습니다.

public class KmmPlugin: NSObject, FlutterPlugin {
  public static func register(with registrar: FlutterPluginRegistrar) {
    let channel = FlutterMethodChannel(name: "kmm_plugin", binaryMessenger: registrar.messenger)
    let instance = KmmPlugin()
    registrar.addMethodCallDelegate(instance, channel: channel)
  }

  public func handle(_ call: FlutterMethodCall, result: @escaping FlutterResult) {
    switch call.method {
    case "getPlatformVersion":
      result("macOS " + ProcessInfo.processInfo.operatingSystemVersionString)
    default:
      result(FlutterMethodNotImplemented)
    }
  }
}

이미 methodChannel이 연결되어 있고, 추가한 함수만 새로 정의하면 됩니다.

참고로 KMP에서 kotlin 코드로 생성했던 함수는 아래와 같습니다.

이 함수를 호출할수 있도록 library의 baseName을 import해주고, handle()쪽에 아래와 같이 추가해 줍니다.

import Cocoa
import FlutterMacOS
import Shared //import 추가 kmm 빌드시 사용했던 baseName

public class KmmPlugin: NSObject, FlutterPlugin {
 ...
  public func handle(_ call: FlutterMethodCall, result: @escaping FlutterResult) {
    switch call.method {
    case "getPlatformVersion":
      result("macOS " + ProcessInfo.processInfo.operatingSystemVersionString)
    // library에 정의한 함수 추가
    case "connectTest":
      let resultValue = MyLibInterface().connectTest()
            result(resultValue)
    default:
      result(FlutterMethodNotImplemented)
    }
  }
}

참고로 baseName은 kmm project에서 아래와 같이 build.gradle.kt에 설정한 이름 입니다.

앞선 빌드쪽 포스팅에서 언급했지만 connectTest()함수는 class의 멤버함수로 객체의 instance가 필요합니다. 따라서 여기서는 MyLibInterface()라는 객체 생성후에 호출하도록 하였으나, 사실 이는 바람직 하지 않습니다.

실제 호출이 되기는 하나, 함수가 parameter를 받는 형태라면 호출 실패가 날수도 있습니다. 따라서 kmp에서 함수는 top-level function으로 노출되어야 합니다.

//MyLibInterface.kt

@OptIn(ExperimentalNativeApi::class)
@CName("test")
fun test(): String {
    return "Connection Test Success !!!"
}

만약 위와 같은 함수를 MyLibInterface.kt 파일에서 Top-level 함수로 노출시켜 놓았다면 아래와 같이 호출함수를 만들어야 합니다.

import Cocoa
import FlutterMacOS
import Shared //import 추가 kmm 빌드시 사용했던 baseName

public class KmmPlugin: NSObject, FlutterPlugin {
 ...
  public func handle(_ call: FlutterMethodCall, result: @escaping FlutterResult) {
    switch call.method {
      ...
    case "connectTest":
      ...
    case "test":
      let topLevelFuncResult = MyLibInterfaceKt .test()
            result(topLevelFuncResult)
    default:
      result(FlutterMethodNotImplemented)
    }
  }
}

호출시 "파일명Kt.함수명()"으로 호출해야 정상적으로 호출됩니다. -> MyLibInterfaceKt.test()

Library 호출을 위한 Dart wrapping

이번엔 lib 폴더의 파일을 수정하여 library에서 생성한 함수를 호출할수 있도록 native 함수를 dart로 wrapping하겠습니다.

kmm_plugin_method_interface.dart 파일을 엽니다. 기본적인 코드는 하기와 같이 작성되어 있습니다.

abstract class KmmPluginPlatform extends PlatformInterface {
  /// Constructs a KmmPluginPlatform.
  KmmPluginPlatform() : super(token: _token);

  static final Object _token = Object();

  static KmmPluginPlatform _instance = MethodChannelKmmPlugin();

...

  Future<String?> getPlatformVersion() {
    throw UnimplementedError('platformVersion() has not been implemented.');
  }
}

실제 추가해 놓은 함수를 여기에 정의 합니다. 이 interface는 kmm_plugin_method_channel.dart에서 상속받아 구현합니다.

lib에서 생성했던 함수의 정의를 아래와 같이 합니다.

abstract class KmmPluginPlatform extends PlatformInterface {
...

  static set instance(KmmPluginPlatform instance) {
    PlatformInterface.verifyToken(instance, _token);
    _instance = instance;
  }

  Future<String?> getPlatformVersion() {
    throw UnimplementedError('platformVersion() has not been implemented.');
  }

  //호출할 함수 추가
  Future<String> connectTest() {
    throw UnimplementedError('connectTest() has not been implemented.');
  }
}

이제 kmm_plugin_method_channel.dart 파일을 열어 위에서 정의해 놓은 함수를 override 합니다.

/// An implementation of [KmmPluginPlatform] that uses method channels.
class MethodChannelKmmPlugin extends KmmPluginPlatform {
  /// The method channel used to interact with the native platform.
  @visibleForTesting
  final methodChannel = const MethodChannel('kmm_plugin');

  @override
  Future<String?> getPlatformVersion() async {
    final version = await methodChannel.invokeMethod<String>('getPlatformVersion');
    return version;
  }
}

기본적으로 channel을 생성해 놓고 있습니다. 이때 MethodChannel의 'kmm_plugin'은 프로젝트 이름으로 다른 plugin과 중복되지 않도록 하기위해 자동으로 프로젝트 이름으로 설정 됩니다. invokeMethod()를 통해서 호출하며, 이때 인자로 함수명을 적어줍니다.

/// An implementation of [KmmPluginPlatform] that uses method channels.
class MethodChannelKmmPlugin extends KmmPluginPlatform {
  /// The method channel used to interact with the native platform.
  @visibleForTesting
  final methodChannel = const MethodChannel('kmm_plugin');

  @override
  Future<String?> getPlatformVersion() async {
    final version = await methodChannel.invokeMethod<String>('getPlatformVersion');
    return version;
  }
  
  //library 함수를 호출
  @override
  Future<String> connectTest() async {
    final connectMsg = await methodChannel.invokeMethod<String>('connectTest');
    if (connectMsg == null) {
      return 'library connection failed';
    } else {
      return connectMsg;  
    }
  }
}

마지막으로 kmm_plugin.dart를 열고, 새로 추가한 connectTest()함수를 추가합니다.

class KmmPlugin {
  Future<String?> getPlatformVersion() {
    return KmmPluginPlatform.instance.getPlatformVersion();
  }

  //실제 외부에서 호출되는 함수
  Future<String> connectTest() {
    return KmmPluginPlatform.instance.connectTest();
  }
}

이로써 plugin에 library 연결은 끝났습니다.

이제 test를 통해 해당 함수가 잘 호출되는지 확인하면 됩니다.

example을 통한 동작 확인

이제 example package를 이용하여 plugin에 추가한 함수를 호출해 보겠습니다.

example/lib/main.dart 함수를 열면 이미 기본적인 샘플 코드가 들어가 있습니다.

단순히 실행하면 아래와 같은 화면이 뜨면 maing.dart의 코드는 아래와 같습니다.

void main() {
  runApp(const MyApp());
}

class MyApp extends StatefulWidget {
  const MyApp({super.key});

  @override
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  String _platformVersion = 'Unknown';
  final _kmmPlugin = KmmPlugin();

  @override
  void initState() {
   ...
  }

  // Platform messages are asynchronous, so we initialize in an async method.
  Future<void> initPlatformState() async {
     ...
  }

  @override
  Widget build(BuildContext context) {
    ...
  }
}

저 화면에 libraray를 호출하여 받은 string을 하위에 노출시켜 보도록 하겠습니다.

아래와 같이 주석으로 처리된 코드를 넣어 줍니다.

void main() {
  runApp(const MyApp());
}

class MyApp extends StatefulWidget {
  const MyApp({super.key});

  @override
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  String _platformVersion = 'Unknown';
  final _kmmPlugin = KmmPlugin();

  String _kmmLibConnectValue = "Not connected!"; //추가

  @override
  void initState() {
    super.initState();
    initPlatformState();
    connectMacOSLibrary(); //추가
  }

  // Platform messages are asynchronous, so we initialize in an async method.
  Future<void> initPlatformState() async {
     ...
  }

  // 추가
  Future<void> connectMacOSLibrary() async {
    String connectValue;
    try {
      connectValue =
          await _kmmPlugin.connectTest();
    } on PlatformException {
      connectValue = 'Failed to connect mac os';
    }

    if (!mounted) return;

    setState(() {
      _kmmLibConnectValue = connectValue;
    });
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Plugin example app'),
        ),
        body: Center(
          //추가 - 마지막에 호출한 함수의 결과값이 담인 _KmmLibConnectValue를 찍도록 함.
          child: Text('Running on: $_platformVersion\n\n lib connect: $_kmmLibConnectValue'),
        ),
      ),
    );
  }
}

이제 실행하면 아래와 같은 화면이 나타납니다.

추가 사항

만약 library에서 호출하는 함수가 network에 접근해야 한다면 아래와 같은 permission을 추가 해야 합니다.

Network 권한 추가

network 권한은 plugin을 호출하는 외부 앱에 선언되어 있어야 합니다. (즉 plugin 프로젝트에서는 example/macos/Runner 내부의 파일에 권한을 추가해야 합니다.)

example/macos/Runner/DebugProfile.entitlements
example/macos/Runner/Release.entitlements

파일 내부에 아래 내용을 추가 합니다.

    <key>com.apple.security.network.client</key>
    <true/>

실제 파일에서 추가 위치

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    ...
    <key>com.apple.security.network.client</key>
    <true/>
</dict>
</plist>

https 가 아닌 http url에 접속시

info.plist에 아래 권한 추가

    <key>NSAppTransportSecurity</key>
    <dict>
        <key>NSAllowsArbitraryLoads</key>
        <true/>
    </dict>
    <key>NSLocalNetworkUsageDescription</key>
    <string>로컬 네트워크에 접근하기 위해 필요합니다.</string>

실제 파일에서 추가 위치

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <key>NSAppTransportSecurity</key>
    <dict>
        <key>NSAllowsArbitraryLoads</key>
        <true/>
    </dict>
    <key>NSLocalNetworkUsageDescription</key>
    <string>로컬 네트워크에 접근하기 위해 필요합니다.</string>	
    ...
</dict>
</plist>

References

[1] https://proandroiddev.com/how-to-use-kmp-library-inside-the-flutter-plugin-5f74722c7b3c

[KMP] KMP 라이브러리를 Flutter에서 사용하기 - MacOS SharedLibrary 빌드 #1

뚜덜이~ — Tue, 14 Jan 2025 16:02:17 +0900

Photo by unsplash

Mutilple OS에 공용 library를 delivery하기 위해서 Kotlin MultiPlatform을 사용합니다. 일반적인 목적, 구조에 대한 설명들은 이미 많은 블로그나 정리된 문서들에서 다루고 있으니, 여기서는 shared에 위치한 MacOS 코드를 bulid하는 절차를 간단하게 정리해 봅니다.

최종 목적은 Flutter의 Mac OS Desktop에 KMP에서 빌드된 라이브러리를 적용하기 위한 첫번째 작업입니다.

또 다른 Multi platform인 Flutter에서 KMP Library를 import 해서 사용한다는 생각이 무리라고 여겨 질 수는 있으나, 상황에 따라 KMP로 만든 공용 library를 AOS, iOS native에 제공하고 flutter에 까지 제공 가능하다면 활용성 범위에서 매력적일 수 있습니다.

호출할 함수의 정의

KMP 프로젝트를 생성하면 하기와 같은 구조로 생성됩니다.

androidMain: android에서 전용으로 사용 할 소스코드를 포함
commonMain: 각 Platform에서 공용으로 들어갈 소스 코드를 포함
iosMain: ios에서 전용으로 사용 할 소스코드를 포함
jvmMain: jvm으로 빌드

iOS와 MacOS를 기본적을 동일한 구조를 갖는다고는 하지만 macOS에서만 따로 호출할 수 있는 코드를 하나 정의 하겠습니다.

먼저 src에 macosMain 폴더를 위와 같은 구조로 만듭니다.

jvmMain이나 iosMain도 동일한 구조를 가지고 있습니다.

'macosMain/kotlin/com.example.test.sample'

Platform.macos.kt는 공통으로 적용해야 하는 함수가 있기 때문에 jvmMain이나, iosMain등에서 복사해와서 적절하게 변경해 줍니다.

//Platform.macos.kt

class MACOSPlatform: Platform {
    override val name: String = "Mac OS!"
}
actual fun getPlatform(): Platform = MACOSPlatform()

getPlatform() 함수는 commonMain에서 expect로 설정된 함수이기 때문에 반드시 구현해야 합니다.

다음으로 테스트를 위해 외부에서 호출할 함수 하나를 정의해 줍니다. 위 캡쳐된 구조에서 MyLibInterface를 아래와 같이 구성하겠습니다.

//MyLibInterface.kt

class MyLibInterface {
    fun connectTest(): String {
        println("Mac OS Connected")
        return "Mac OS Connected"
    }
}

호출시 단순히 Mac OS Connected를 찍습니다.

다만 KMP에서 만든 함수를 라이브러리로 만들어 외부에서 호출되도록 하는경우 빌드가 extern C로 되어야 하며, Top-level function을 권고하고 있습니다. MacOS와 Windows 모두에게서 호출되는 함수를 선언하려면 아래와 같이 함수를 선언해야 합니다.

@CName은 외부에서 함수 호출시 package명부터 시작하여 함수 이름까지 전체의 경로로 호출하지 않고 정해진 이름으로 호출할 수 있도록 도와 줍니다. (단! 동일한 이름이 존재해서는 안됩니다.)

instance를 생성하고 나서 호출해야 하는 방법과 Top-level function으로 선언했을때의 함수를 호출하는 방법은 다음 글에서 상세하게 다룹니다. 다만, Top-level function과 @CName을 사용하는 방법을 권고하며, 위 connectTest()처럼 instance를 생성하여 호출하는 방법은 지양해야 합니다.

XCFramework 빌드

이번에는 shared계위의 build.gradle.kts에 빌드를 설정 합니다.

kotlin {
    androidTarget {
       ...
    }

////////// 이 부분을 변경 - START //////////////
    val xcFramework = XCFramework()

    listOf(
//        iosX64(),
//        iosArm64(),
//        iosSimulatorArm64(),
        macosX64(),
        macosArm64()
    ).forEach { iosTarget ->
        iosTarget.binaries.framework {
            baseName = "Shared"
            xcFramework.add(this)
        }
    }
////////// 이 부분을 변경 - END //////////////

    jvm()
    ...

외부에서 import하기위해서 XCFramework()으로 한번에 만들어 빌드하도록 합니다. 그렇지 않으면 각 os별로 따로 빌드되어 Xcode에서 다시 xcxFramework으로 합치는 작업을 해야 합니다.

XCfFramework()을 생성하여 macosX64()와 macosArm64()를 scfFramework으로 묶습니다.

여기서 baseName은("Shared") 외부에서 import할 대상이 됩니다.

iosXXX() 빌드는 일단 주석처리해 놓았습니다. 주석처리가 되지 않으면 모두 빌드되어 xcFramework으로 묶이는데, 시간이 오래 걸립니다.

XCFramework()을 추가한후 gradle을 sync하면 오른쪽 gradle창에 "assembleSCFramework"이 생긴걸 볼수 있습니다.

이 명령어를 더블클릭해도 되고, terminal에서 하기 명령어를 수행해도 됩니다.

./gradlew assembleXCFramework

빌드가 잘 되었다면 하기 경로에서 빌드된 framework을 확인할 수 있습니다.

해당 폴더아래에는 debug와 release가 존재하고 각각 "shared.xcframework"을 가지고 있습니다.

Cocoapods를 이용한 빌드

KMP 설치 당시 cocoapods[1]를 설정했다면 이를 통해서도 빌드를 할수 있습니다. Android studio Gradle 설정창을 보면 아래와 같이 빌드를 할수 있는 명령어 셋이 보입니다.

debug나 release만 또는 두개모두를 빌드할수 있는 명령어셋이 존재하여 클릭시 'shared/build/cocoapods' 폴더에서 빌드된 결과를 얻을 수 있습니다.

"shared.xcframework"을 가지고 flutter에 import하는 작업은 다음글에 이어 집니다.

References

[1] https://kotlinlang.org/docs/native-cocoapods.html

[KMM] Windows dll 빌드 방법 및 함수 설정 방법

뚜덜이~ — Sun, 12 Jan 2025 17:54:41 +0900

Kotlin Multiplatform을 사용하여 Windows에서 사용할 수 있는 DLL을 생성하고 사용하는 방법은 다음과 같습니다:

## DLL 생성

1. Kotlin Multiplatform 프로젝트 설정:
   - `build.gradle.kts` 파일에서 Windows 타겟을 지정하고 공유 라이브러리를 생성하도록 설정합니다:

```kotlin
kotlin {
    mingwX64("native") { // Windows 타겟 지정
        binaries {
            sharedLib {
                baseName = "mylib" // DLL 파일명 지정
            }
        }
    }
}
```

2. Kotlin 코드 작성:
   - `nativeMain` 소스 세트에 DLL로 노출할 함수를 작성합니다.
   - `@CName` 어노테이션을 사용하여 C에서 호출 가능한 함수명을 지정합니다:

```kotlin
@CName("myFunction")
fun myFunction(): Int {
    return 42
}
```

3. DLL 빌드:
   - 터미널에서 다음 명령을 실행하여 DLL을 생성합니다:
     ```
     ./gradlew linkNative
     ```
   - 생성된 DLL은 `build/bin/native/releaseShared/` 디렉토리에 위치합니다.

## Windows에서 DLL 사용

1. 헤더 파일 생성:
   - Kotlin 컴파일러가 자동으로 생성한 C 헤더 파일(`mylib_api.h`)을 사용합니다.

2. C/C++ 프로그램에서 DLL 로드 및 사용:
   - 헤더 파일을 포함하고 DLL을 로드하여 함수를 호출합니다:

```c
#include <windows.h>
#include "mylib_api.h"

int main() {
    HMODULE hDLL = LoadLibrary("mylib.dll");
    if (hDLL != NULL) {
        typedef int (*MyFunction)();
        MyFunction myFunction = (MyFunction)GetProcAddress(hDLL, "myFunction");
        if (myFunction != NULL) {
            int result = myFunction();
            printf("Result: %d\n", result);
        }
        FreeLibrary(hDLL);
    }
    return 0;
}
```

3. 컴파일 및 실행:
   - C/C++ 프로그램을 컴파일하고 실행합니다. DLL 파일이 실행 파일과 같은 디렉토리에 있어야 합니다.

이 방법을 통해 Kotlin Multiplatform에서 생성한 함수를 Windows DLL로 만들고 C/C++ 프로그램에서 사용할 수 있습니다[1][2][14].

Citations:
[1] https://juyeop.tistory.com/72
[2] https://discuss.kotlinlang.org/t/calling-a-dll-in-my-kotlin-multiplatform-project/13616
[3] https://ca.indeed.com/career-advice/career-development/how-to-open-dll-files
[4] https://en.wikipedia.org/wiki/Dynamic-link_library
[5] https://velog.io/@ams770/Android%EC%99%80-iOS%EC%97%90%EC%84%9C-Jetbrains-Compose%EB%A5%BC-%EC%82%AC%EC%9A%A9%ED%95%98%EC%97%AC-UI-%EC%BD%94%EB%93%9C-%EA%B3%B5%EC%9C%A0%ED%95%98%EA%B8%B0-2
[6] https://kotlinlang.org/docs/native-dynamic-libraries.html
[7] https://learn.microsoft.com/en-us/troubleshoot/windows-client/setup-upgrade-and-drivers/dynamic-link-library
[8] https://velog.io/@mraz3068/Compose-multiplatform-apply-font-by-moko-resources
[9] https://www.youtube.com/watch?v=M1JWWHc50Kw
[10] https://hik-coding.tistory.com/175
[11] https://youtrack.jetbrains.com/issue/KT-51726/Kotlin-Multiplatform-konan-llvm-1110-windows-unable-to-find-library
[12] https://stackoverflow.com/questions/68782815/skeleton-for-kotlin-native-multiproject-with-dll-library-for-backend-and-fronten
[13] https://deview.kr/data/deview/session/attach/6_Kotlin%20Multiplatform%20Mobile%EC%9D%84%20%ED%99%9C%EC%9A%A9%ED%95%9C%20%EB%8D%B0%EB%A7%88%EC%97%90%EC%B9%B8%20%EB%93%9C%EB%9D%BC%EC%9D%B4%EB%B2%84%EC%95%B1%20%EA%B0%9C%EB%B0%9C%20%EC%9D%B4%EC%95%BC%EA%B8%B0.pdf
[14] https://proandroiddev.com/kotlin-native-use-kotlin-in-c-and-apple-framework-part-2-495a7952f831?gi=ae10bb42dd65
[15] https://www.jetbrains.com/help/kotlin-multiplatform-dev/multiplatform-create-first-app.html
[16] https://book.kotlincn.net/text/whatsnew1530.html
[17] https://www.youtube.com/watch?v=XXkxkruDRmA
[18] https://www.indeed.com/career-advice/career-development/how-to-open-dll-files
[19] https://stackoverflow.com/questions/66000859/how-are-dlls-usually-packaged-with-applications
[20] https://www.fortect.com/fix-dll-errors/run-dll-file/
[21] https://learn.microsoft.com/en-us/cpp/build/walkthrough-creating-and-using-a-dynamic-link-library-cpp?view=msvc-170&redirectedfrom=MSDN
[22] https://stackoverflow.com/questions/35401050/how-to-use-a-dll
[23] https://kb.blackbaud.com/knowledgebase/articles/Article/48280

[전주] 다슬기 나라, 다슬기탕 다슬기 수제비

뚜덜이~ — Sat, 21 Sep 2024 22:08:00 +0900

전주가 백반과 가맥으로 유명한건 알았지만 다니다 보니 다슬기 식당이 꽤 보입니다.

흠...

다슬기도 유명했었나 싶은데, 뭐..여튼 꽤 음식점이 보이는 데다가 검색해 보니 줄서서 먹는 다슬기 집도 있더군요.

다만 늦은시간에 저녁을 먹으려고 찾은터라 정말!! 아무 블로그도, 리뷰도 없는 동네 식당을 찾아 들어갔습니다.

주택가 근처에 있는 동네 식당입니다.

손님도 광관객은 없고 동네사람들만 있습니다. 어떤 아저씨가 술을 거하게 자시고 시끄럽게 떠들긴 했습니다만, 동네식당이 다 그렇죠~

다슬기 탕이 나왔습니다.

맑은 국물에 부추가 한가득 띄워져 나왔는데...숟가락으로 바닥을 떠보니 다슬이가 한주먹은 들어 있네요..

키아...

다슬기 수제비도 비슷합니다.

사진에 보이는거 보다 다슬기가 훨씬 많습니다..

정말 손이 미끄러져서 다슬이 통을 부으셨다 싶을정도..

국물은 깔끔하고 시원 합니다.

다슬기 무침도 하나 시켰는데, 이게 양이 어마어마 하더군요.

사실 중국집에서 여러명이 짜장면 하나씩 시키고, "탕수육도 하나 시킬까?" 라는 생각으로 시켰는데, 주문할때 양이 많아서 다 못먹는다고, 아주머니가 걱정을 하셨습니다.

그래서 한사람분 식사를 덜시키고 무침을 시킨건데...

그래도 양이 많았습니다.

사진에는 그냥저냥 보이지만..저거 안쪽에 전부 다슬기 입니다.

걍 다슬기를 퍼먹는 느낌...

새콤달콤하니 맛나더군요~

요새 블로그를 잘 안올리는데, 이 가게 때문에 다시 쓰기 시작했습니다.

핸드폰 사진첩이 아니라 이렇게 블로그에 남겨놔야, 나중에 찾기가 편하더군요. 기억으로 연상해 내기도 쉽고..

가격이나, 양이나, 맛에서 정말 괜찮은 가게였습니다.

다음에 전주에 가게 된다면 꼭 다시 방문해야할것 같은..(제가 원래 음식점 칭찬을 이렇게 까지는 안하는데..)

정말 푸짐하게 다슬기를 먹을수 있는곳이니 전주에 간다면 꼭 들러보시기 바랍니다.

[전주] 한벽굴, 한벽당

뚜덜이~ — Sat, 21 Sep 2024 21:56:18 +0900

다시 전주로 돌아와서..

전주에서 살짝 외곽으로 나오면 길가 옆으로 한벽당과 한벽굴이 보입니다.

원래는 한벽당의 정기를 자르려고 일제시대에 뚫었던 굴이고 철길이었다고 하네요.

지금은 사람도, 차도, 자전거도 다니는길이 되었습니다.

메인 도로로 이어지는 굴밖의 차선은 안쪽으로 들어오면 자전거를 탈수도 있고, 산책을할수 있는 도로가 나있기도 합니다.

한적하니, 산책하기 좋은길 입니다.

사실 보면서 호텔 델루나에 나왔던굴이가 싶기도 했는데, 그건 아니고;;; 이정도 비주얼이면 조만간 드라마나 영화에 한번 나오지 않을까 싶네요~ㅎㅎ

전주 팔경중 하나라는 한벽당 입니다.

진짜 풍경하나 기가막힌 곳에 정차를지었네요.

조선시대였다면 저기 올라가서 드러누워서 강바람 쐬면서 데굴데굴 굴렀을것 같은데 말이죠..ㅎㅎ

정자에 올라가 보려면 한벽굴을 들어오기 전에 강쪽으로 내려가는 산책길로 돌아 들어가야 합니다.

저는 날이 더워서 그냥 밖에서 보는걸로 만족;;

한벽굴에는 이런 설명이 같이 붙어있습니다.

같이 붙여진 흑백 사진이 정말 추억이 돗는듯 합니다.

전주가시면 한번 들러서 보시지요. 가을에 가면 단풍이들어 정말 예쁠것 같습니다.

[완주 대둔산] 케이블카, 구름다리, 삼선계단

뚜덜이~ — Sat, 21 Sep 2024 21:47:09 +0900

운주에서 물짜장을 먹고 가는길에 들렀습니다.

여기도 한 10년도 더 지난 예전에 친구들과 왔었던 곳인데, 부모님과도 한번 와봅니다.

산행을 하는건 아니고, 케이블카를 타고 살수 있으니, 녹아내릴듯한 더위지만 짤막한 산행을 도전해 봅니다. ㅎㅎ

케이블카 내부에 에어콘이 한대 달려있긴 한데, 그것만으로는 버티가 어려운 더위 입니다..

진짜..너무 더웠습니다.ㅠ.ㅠ 이때가 7월말이었으니..

너무 더운때라 사람도...없을줄 알았는데, 그래도 저같이 구경 온 사람들이 있네요 ㅎㅎ

정상에 도착하니 밖으로 보이는 산세와 풍경이 심상치 않습니다.

케이블카 건물 옥상 전망대 입니다.

간단하게 음료하나 사 먹고 주위를 구경해 봅니다.

간간히 불어오는 산바람이 더위를 달래 줍니다.

전망대에서 내려다본 산세입니다.

우리나라..참 굽이굽이 산도 많네요~

대둔산이 유명한 이유는 이 구름다리 때문 입니다.

이렇게 보면 별거 아닌거 같지만..

건너와서 내려다 보면..키아..다리가 오들오들 떨립니다.

어머니가 처음에는 못건던다고 하셨는데, 간신히 건너갔다 오셨습니다. ㅎㅎㅎㅎ

실제로 걸어보면 아래가 뻥 뚫려서 더 공포감이 있습니다.

사진 찍다가 핸드폰 떨굴까봐 엄청 꼭잡고 있었네요.

저는 한 15년전쯤에 왔어서 2세대 다리도 건너 봤습니다. 그때 현수교였는데, 역시...제 기억이 틀린게 아니라, 2021년에 다리를 교체했네요.

좀더 탄탄해진 느낌입니다. 사실 흔들림도 좀더 적어진것 같습니다.

사람 없을때 찰칵!!

거의 기절할만큼 덥긴 했는데, 대신 날씨는 너무 깨끗하고 좋았습니다.

사신에 잘 보시면 삼선계단도 보입니다.

매번..저기까지는 못가보고 그냥 내려오는데, 저긴..너무 무섭습니다. 나이가 들고 나니, 정말 다리가 후들거릴것 같습니다. 초딩정도 되면 생각없이 뛰어 올라갈것 같습니다만..ㅎㅎㅎ 나중에 애들 데리고 와봐야 겠네요

[선릉, 양재] 삼겹살 맛집 - 돈그리아

뚜덜이~ — Sat, 21 Sep 2024 21:32:51 +0900

양재에서 회식할일이 생겨서 찾은 가게 입니다.

이 동네 주민 한명이 입에 침이 마르도록 추천한 곳인데, 과연 맛있다고 자부할만 하네요.

일단 고기가 엄청 두껍습니다. 그러다 보니, 고기를 자른 모양이 일정하지는 않은데, 두껍지만 직원분이 잘 익혀 주십니다.

조금 지나고 나니 노릇노릇 고기가 다 익었네요~

보시는것처럼 숯도 정말 좋은걸 쓰는듯 하고, 특히나 고기 불판이 제가 정말 좋아하는 불판입니다.

싸~악 불맛을 입으면서 숯에 맛있게 구워지거든요.~~

김치찌게밥도 하나 시켜봅니다.

역시..

훌륭합니다~~짝짝짝~~

고추송송, 애호박까지 알차게 들어가 있어 보기만 해도 시원한 국물맛이 느껴집니다.ㅋㅋ

어제 과음을 했더니..이 사진 보고 있노라니, 한그릇 하고 싶네요...

또 이 가게의 시그니처 메뉴인 술리또 입니다.

죽처럼 끓여서 나오는데, 고소하니 참 맛있습니다.

좀 떠서 먹고 바질을 넣어서 한번더 끓이면 이런 비주얼이 됩니다.

사실 비주얼은 별로인데, 맛은 정말 좋습니다.

시각과 미각이 따로 노는 느낌..

마지막으로 가격!!

가격은 비싸지도 않고 여느 고기집과 마찬가지로 무난 합니다.

다만 비싸지 않은 가격에 좋은 고기를 쓰다보니, 기다리는 줄도 한참 되더군요.

사실 예약이 가능하니, 방문 예정이라면 미리 예약하고 가시면 좋습니다~