Skip to content

开始

本章描述将 Loxily Localize iOS SDK 接入到你的应用的三个步骤:先在 Loxily Localize 后台创建应用拿到 App Key,再把 XCFramework 集成到你的 Xcode 项目,最后在 AppDelegate 里完成 SDK 初始化。三步完成后即可使用获取词条、切换语言等基础功能。

注册应用信息

在接入 SDK 之前,你需要在 Loxily Localize 控制台 创建项目并获取 App Key(应用唯一标识,SDK 初始化时需要)。

登录 Loxily Localize 控制台 → 选择或创建项目 → 进入 开放平台 页面 → 复制 App Key 备用。若暂未开通控制台访问,请联系 Loxily 对接人员协助开通。

SDK 接入

XCFramework 集成(推荐)

  1. 下载 loxilyLocalizeSDK-1.2.3.zip 文件:
  1. 解压 zip 文件,得到 loxilyLocalizeSDK.xcframework 文件夹;

  2. loxilyLocalizeSDK.xcframework 拖拽到你的 Xcode 项目中;

  3. 在项目设置中配置:

    • GeneralFrameworks, Libraries, and Embedded Content 中,将 loxilyLocalizeSDK.xcframework 设置为 Do Not Embed(静态库)
    • Build SettingsOther Linker Flags 中添加 -ObjC
  4. 在需要使用的地方导入头文件:

objc
#import <iLocalizeSDK/LoxilyLocalize.h>

接入完成后,接下来就可以初始化 Loxily Localize 了。

初始化

在项目的 AppDelegate 中调用初始化方法:

objc
#import <iLocalizeSDK/LoxilyLocalize.h>

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    // SDK 初始化
    [LoxilyLocalize initWithAppKey:@"YOUR_APP_KEY"
                     language:@"zh-cn"
          isInternationalizing:YES
                      isDebug:NO];
    return YES;
}

参数说明

参数类型必填说明示例
appKeyNSString应用唯一标识,从 Loxily Localize 后台获取"4b290d495c67075db7b80b845d80e244"
languageNSString目标语言代码"zh-cn", "en", "ja"
isInternationalizingBOOL是否国际化版本(YES=海外,NO=中国大陆)YES / NO
isDebugBOOL环境区分(YES=测试,NO=正式)YES / NO

初始化回调

你可以在初始化后添加回调,监听初始化完成状态。推荐使用 block 形态 setTranslationPreparedBlock:,失败时携带具体 errorMsg

objc
[LoxilyLocalize setTranslationPreparedBlock:^(BOOL success, NSString * _Nullable errorMsg) {
    if (success) {
        // SDK 初始化成功,翻译文件准备完成
        NSLog(@"Loxily 初始化成功");
    } else {
        // SDK 初始化失败,errorMsg 给出具体原因
        // 例如:init failed: version '1.0.0' (buildType=2) not published for appKey 'xxx'
        //      init failed (code=404): xxx
        //      init request network error
        //      language file download error / diff patch merge failed
        NSLog(@"Loxily 初始化失败:%@", errorMsg);
    }
}];

重要提示:

初始化回调是异步的,请确保在回调成功后再使用 SDK 的其他功能。

关于旧接口 setTranslationPreparedCallback:

旧的 C 函数指针形态 setTranslationPreparedCallback: 仍然可用但已标 __deprecated_msg不携带 errorMsg。新集成请用上面的 block 形态,老集成可以继续工作但建议迁移。


初始化完成后,请继续阅读 基础功能 了解如何获取词条和切换语言。