Skip to content

开始 ​

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

注册应用信息 ​

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

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

SDK 接入 ​

在项目的 build.gradle 文件中添加依赖:

groovy
dependencies {
  implementation 'com.loxily:android-localize-sdk:1.7.8'
}

注意:

Loxily Localize SDK 使用到的类库有 recyclerView、material、okhttp、gson、glide。

如果有和你项目中重复的库并导致依赖冲突时,请根据具体的构建平台对冲突类库进行排除即可。

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

初始化 ​

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

java
public class App extends Application {
    @Override
    public void onCreate() {
        super.onCreate();

        // SDK 初始化
        LoxilyLocalize.init(
            this,                           // Context
            "YOUR_APP_KEY",                 // AppKey(从后台获取)
            "zh-cn",                        // 目标语言代码
            true,                           // 是否国际化版本(true=海外,false=中国大陆)
            true                            // 环境区分(true=测试,false=正式)
        );

        // 设置初始化回调(可选)
        LoxilyLocalize.setOnTranslationPreparedCallback(
            new OnTranslationPreparedListener() {
                @Override
                public void onDataRetrieved(boolean isSuccess, String errorMsg) {
                    if (isSuccess) {
                        // SDK 初始化成功,可以开始使用
                        Log.d("LoxilyLocalize", "初始化成功");
                    } else {
                        // SDK 初始化失败
                        Log.e("LoxilyLocalize", "初始化失败: " + errorMsg);
                    }
                }
            }
        );
    }
}

Cocos2d-x 项目注意

如果游戏的 C++ 侧实现了 JNI 方法 Java_net_ilocalize_init_LoxilyLocalize_onCocos2dxTranslationPrepared(用它来得知 SDK 已就绪),从 1.7.8 起 SDK 会在翻译就绪时自动调用它,与上面的 setOnTranslationPreparedCallback 互不影响,无需再调 registerCocos2dxTranslationPreparedCallback()。

1.7.7 及更早版本这两种回调共用一个槽位:只要调用了 setOnTranslationPreparedCallback,C++ 就收不到就绪通知,取文本会一直回落到游戏自带词表。旧版本请在自己的回调里补一句 LoxilyLocalize.onCocos2dxTranslationPrepared(isSuccess),或升级到 1.7.8。

参数说明 ​

参数类型必填说明示例
contextContext是应用上下文this
appKeyString是应用唯一标识,从 Loxily Localize 后台获取"7a0c1ee2622bc85a4030297uo3b"
languageString是目标语言代码"zh-cn", "en", "ja"
isInternationalizingboolean是是否国际化版本(true=海外,false=中国大陆)true / false
isBuildDebugboolean是环境区分(true=测试,false=正式)true / false

重要提示:

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


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