📞 콜백 처리하기

Test Solution SDK는 테스트 진행 중 발생하는 주요 이벤트나 로그 데이터를 Host 앱으로 비동기적으로 전달합니다. 이 통신은 콜백(Callback) 매커니즘을 통해 이루어집니다.

Host 앱에서는 onResult, onLog, onInfo 세 가지 콜백을 통해 SDK의 상태를 수신하고 필요한 후속 조치를 취할 수 있습니다.

---

onResult 콜백

onResult는 테스트의 핵심적인 상태 변경이 발생했을 때 호출됩니다. 예를 들어, 사용자가 모든 문항을 완료했거나, 중간에 테스트를 종료했거나, 또는 예기치 않은 오류가 발생한 경우가 해당됩니다.

⚠️ 중요: onResult 콜백은 성격 유형 분석 결과를 반환하지 않습니다. 테스트의 완료 여부와 같은 상태 값을 전달하는 용도입니다.

데이터 구조

onResult는 아래와 같은 구조의 JSON 객체(또는 각 플랫폼에 맞는 Map/Dictionary 형태)를 전달합니다.

필드명	타입	설명
status	String	필수. 콜백의 원인을 나타내는 상태 코드입니다. ('COMPLETED', 'USERCANCELLED', 'ERROR')
data	Object	필수. 상태에 대한 사람이 읽을 수 있는 메시지입니다. 디버깅이나 사용자 안내에 활용할 수 있습니다.
sdkVersion	String	필수. SDK의 버전 정보입니다.
customData	Object	필수. startTest 호출 시 전달했던 customData 객체를 그대로 반환합니다. Host 앱의 세션 정보 등을 유지하는 데 유용합니다.

상태(Status) 코드 종류

• 'COMPLETED': 사용자가 180개 문항을 모두 완료하고 SDK가 정상적으로 종료되었음을 의미합니다.
• 'USERCANCELLED': 사용자가 테스트를 완료하기 전에 의도적으로 '나가기'와 같은 UI를 통해 종료했음을 의미합니다.
• 'ERROR': 유효하지 않은 파라미터 전달, 네트워크 오류 등 예기치 않은 문제로 테스트가 중단되었음을 의미합니다.

데이터 예시

1. 테스트 정상 완료 시

{
  "status": "COMPLETED",
  "data": {
    "suid": "[SUID]",
    "goodsId": "[GOODS_ID]",
    "language": "[LANGUAGE]",
    "completedAt": "2025-01-01T00:00:00.000000"
  },
  "sdkVersion": "1.0.0+10000",
  "customData": { "internalUserId": "user-1234" }
}

2. 오류 발생 시

{
  "status": "USERCANCELLED",
  "data": { "errorCode": "N005", "errorMessage": "DATA_PARSE_FAILED" },
  "sdkVersion": "1.0.0+10000",
  "customData": { "internalUserId": "user-1234" }
}

---

onLog 콜백

onLog는 SDK 내부의 상세 동작 로그를 Host 앱으로 전달하기 위한 디버깅용 콜백입니다. 이 콜백은 startTest 호출 시 isDevelopment 와 enableHostLogging 값을 true로 설정해야만 활성화됩니다.

💡 Tip: 개발 및 테스트 단계에서는 enableHostLogging을 활성화하여 문제의 원인을 빠르게 파악하고, 프로덕션(릴리즈) 버전에서는 비활성화하는 것을 권장합니다.

데이터 구조

필드명	타입	설명
level	String	필수. 로그 레벨입니다. ('INFO', 'WARNING', 'ERROR')
message	String	필수. 실제 로그 메시지 내용입니다.
error	String	오류 정보입니다.
timestamp	String	필수. 로그가 발생한 시각 (ISO 8601 형식)

데이터 예시

{
  "level": "INFO",
  "message": "개발 모드로 설정 되었습니다.",
  "error": null,
  "timestamp": "2025-01-01T00:00:00.000000"
}

---

onInfo 콜백

onInfo는 SDK의 버전 정보를 Host 앱으로 전달하기 위한 콜백입니다.

데이터 구조

필드명	타입	설명
version	String	필수. SDK 버전 정보입니다.

데이터 예시

{
  "version": "1.0.0+10000"
}

---

구현 예제

아래는 각 네이티브 플랫폼에서 콜백을 수신하고 처리하는 코드 예시입니다.

🤖 Android (Kotlin)

Flutter와의 통신을 위해 MethodChannel을 설정하고 setMethodCallHandler를 통해 콜백을 리스닝합니다.

import io.flutter.embedding.android.FlutterActivity
import io.flutter.embedding.engine.FlutterEngine
import io.flutter.plugin.common.MethodChannel

class MainActivity: FlutterActivity() {
    private val CHANNEL = "com.mscbrain.sdk.test_solution_sdk/channel"

    override fun configureFlutterEngine(flutterEngine: FlutterEngine) {
        super.configureFlutterEngine(flutterEngine)

        val channel = MethodChannel(flutterEngine.dartExecutor.binaryMessenger, CHANNEL)

        channel.setMethodCallHandler { call, result ->
            when (call.method) {
                "onResult" -> {
                    val resultMap = call.arguments as? Map<String, Any>
                    val status = resultMap?.get("status") as? String
                    
                    Log.d("TestSolutionSDK", "onResult received: $resultMap")

                    when (status) {
                        "COMPLETED" -> {
                            // 테스트 완료 후 처리 로직
                            showCompletionDialog()
                        }
                        "USERCANCELLED" -> {
                            // 사용자 이탈 처리 로직
                        }
                        "ERROR" -> {
                            // 오류 처리 로직
                            val data = resultMap?.get("data") as? Map<*, *>?
                            val errorMsg = data?.get("errorMessage") as? String
                            showErrorToast(errorMsg)
                        }
                    }
                }
                "onInfo" -> {
                    val versionMap = call.arguments as? Map<String, Any>
                    Log.d("TestSolutionSDK_VERSION", "$versionMap") // 버전 정보 출력
                    result.success(null)
                }
                "onLog" -> {
                    val logMap = call.arguments as? Map<String, Any>
                    Log.d("TestSolutionSDK_LOG", "$logMap") // 디버그 로그 출력
                }
                else -> {
                    result.notImplemented()
                }
            }
        }

        // ...
    }
    // ...
}

🍎 iOS (Swift)

UIKit (Storyboard)

AppDelegate 또는 화면을 표시하는 UIViewController에서 FlutterMethodChannel을 설정하여 콜백을 처리합니다.

ViewController.swift

import UIKit
import Flutter

class ViewController: UIViewController {

    private let CHANNEL: String = "com.mscbrain.sdk.test_solution_sdk/channel"
    
    override func viewDidLoad() {
        super.viewDidLoad()
        
        guard let flutterEngine = (UIApplication.shared.delegate as? AppDelegate)?.flutterEngine else { return }
        let channel = FlutterMethodChannel(name: CHANNEL, binaryMessenger: flutterEngine.binaryMessenger)
        
        channel.setMethodCallHandler({(call: FlutterMethodCall, result: @escaping FlutterResult) -> Void in
            
            switch call.method {
            case "onResult":
                guard let resultMap = call.arguments as? [String: Any],
                    let status = resultMap["status"] as? String else {
                    return
                }
                
                print("onResult received: \(resultMap)")

                if status == "COMPLETED" {
                    // 테스트 완료 후 처리 로직
                } else if status == "ERROR" {
                    // 오류 처리 로직
                }
                break

            case "onInfo":
                guard let versionMap = call.arguments as? [String: Any] else { return }
                print("TestSolutionSDK_VERSION: \(versionMap)") // 버전 정보 출력
                break

            case "onLog":
                guard let logMap = call.arguments as? [String: Any] else { return }
                print("TestSolutionSDK_LOG: \(logMap)") // 디버그 로그 출력
                break
                
            default:
                result(FlutterMethodNotImplemented)
            }
        })
    }
    // ...
}

SwiftUI

FlutterView에서 FlutterMethodChannel을 설정하여 콜백을 처리합니다.

FlutterView.swift

import SwiftUI
import Flutter

struct FlutterView: UIViewControllerRepresentable {
    @Environment(FlutterEngineManager.self) private var flutterEngineManager
    
    private let CHANNEL: String = "com.mscbrain.sdk.test_solution_sdk/channel"
    
    func makeUIViewController(context: Context) -> some UIViewController {
        let flutterViewController = FlutterViewController(engine: flutterEngineManager.engine, nibName: nil, bundle: nil)
        let channel = FlutterMethodChannel(name: CHANNEL, binaryMessenger: flutterViewController.binaryMessenger)
        
        channel.setMethodCallHandler({(call: FlutterMethodCall, result: @escaping FlutterResult) -> Void in
            switch call.method {
            case "onResult":
                guard let resultMap = call.arguments as? [String: Any],
                    let status = resultMap["status"] as? String else {
                    return
                }
                
                print("onResult received: \(resultMap)")
                
                if status == "COMPLETED" {
                    // 테스트 완료 후 처리 로직
                } else if status == "ERROR" {
                    // 오류 처리 로직
                }
                break
                
            case "onInfo":
                guard let versionMap = call.arguments as? [String: Any] else { return }
                print("TestSolutionSDK_VERSION: \(versionMap)") // 버전 정보 출력
                break
                
            case "onLog":
                guard let logMap = call.arguments as? [String: Any] else { return }
                print("TestSolutionSDK_LOG: \(logMap)") // 디버그 로그 출력
                break
                
            default:
                result(FlutterMethodNotImplemented)
            }
        })
        
        let startData: [String: Any] = [
            "suid": "[SUID]",              // 사용자를 식별할 수 있는 고유 ID를 입력하세요.
            "goodsId": "[GOODS_ID]",       // 발급받은 상품 ID를 입력하세요.
            "language": "[LANGUAGE]"       // 지원 언어 코드를 입력하세요.
        ]
        
        channel.invokeMethod("startTest", arguments: startData)
        
        return flutterViewController
    }
    
    // ...
}