文本翻译 Android SDK 简介

概述

(1) 概念解释

文本翻译：将一段源语言文本转换成目标语言文本，可根据语言参数的不同实现多国语音之间的互译

(2) 说明

Hi，您好，欢迎使用有道智云文本翻译Android SDK。如果您想快速体验服务，建议您前往翻译体验中心 或者在体验中心右下侧找到小程序二维码，扫描进行体验。

本文档主要针对需要集成文本翻译服务Android SDK的开发工程师，详细描述有道文本翻译能力及集成过程。

如果您有与我们商务合作的需求，可以通过以下方式联系我们：

商务邮箱： AIcloud_Business@corp.youdao.com

如果您对文档内容有任何疑问，可以通过以下几种方式联系我们：

客服QQ：1906538062

智云翻译技术交流QQ 1群: 652880659

智云翻译技术交流QQ 2群: 669384425

智云翻译技术交流QQ 3群: 807539209

智云翻译技术交流QQ 4群: 936752411

联系邮箱： zhiyun@corp.youdao.com

温馨提示：
本文档主要针对开发人员，接入测试前需要在后台创建Android应用，并绑定文本翻译实例；如果您还没有，请按照 新手指南操作。
平台向每个账户赠送50元的体验金，供用户集成前测试所用，具体资费规则详见 文本翻译服务报价 。

功能介绍

文本翻译SDK是有道在线文本翻译服务进行封装，同时支持离线中英查词。提供快速的接入方式；同时提供数据统计能力，方便了解用户翻译使用情况。

兼容性

支持设备：运行了 Android 4.0.3以及以上系统的 Android 设备

文本翻译 Android SDK集成指南

集成前提

开始集成SDK之前开发者需要登录 有道智云平台，创建应用获取应用ID（或者通过运营人员获取应用ID），以便使用翻译服务。

集成步骤

(1) SDK包导入

请在工程文件根目录下创建一个名为 libs 的子目录(有的话则不需要创建)，并将以下jar包拷贝到 libs 目录下：

将以下代码添加到app的build.gradle中：

android {
    sourceSets.main.jniLibs.srcDirs = ['libs']
    ...
}
dependencies {
    compile files('libs/YoudaoBase_v20230803.jar')
    compile files('libs/online_auth.jar')
    compile files('libs/zhiyun_offline_common.jar')
    compile files('libs/YoudaoTranslateOnline_v2.0.1.jar')
    compile files('libs/YoudaoCnDictOffline.jar')
    compile files('libs/YoudaoTranslateOffline.jar')
}

(2) AndroidManifest配置

<uses-permission android:name="android.permission.INTERNET" />
        <!-- 获取WiFi状态 -->
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
        <!-- 获取网络信息状态，如当前的网络连接是否有效 -->
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
        <!-- 读取手机状态 phone group -->
<uses-permission android:name="android.permission.READ_PHONE_STATE" />
        <!-- 往SDCard读写数据权限   storage group -->
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />

(3) 代码混淆配置

代码混淆文件proguard-project.txt，添加如下内容：

-ignorewarnings
-libraryjars libs/ YoudaoBase_v20230803.jar
-libraryjars libs/ YoudaoCnDictOffline.jar
-libraryjars libs/ YoudaoTranslateOnline_v2.0.1.jar
-libraryjars libs/ YoudaoTranslateOffline.jar

-keep class com.youdao.sdk.ydtranslate.** { *;}
-keep class com.youdao.sdk.chdict.** { *;}
-keep class com.youdao.localtransengine.** { *;}
-keep class com.youdao.sdk.ydonlinetranslate.** { *;}

(4) SDK初始化

使用图片翻译SDK，请在程序的Application中调用SDK初始化代码，可以参考demo中DemoApplication。
注：appKey即应用ID

//appKey即应用ID
YouDaoApplication.init(this, appkey,appSecret);

功能集成

1.离线汉语词典翻译功能集成

(1) 构造查词对象

提供了两种初始化方法，如下所示：

/*
 * 可以查词之前设置离线词库路径，则采用默认路径Environment
 *   .getExternalStorageDirectory().getPath() + "/yuwen/backup/"
 * 请确保设置的路径或者默认路径下包含汉语词典的离线包
 */
chDictor = new ChDictor();
/*
*表*示Environment.getExternalStorageDirectory().getAbsolutePath()* + dictFilePath路径下存在离线库
*/
chDictor = new ChDictor(dictFilePath);

(2) 查词对象初始化和查询

//注意，每次查询之前都需要初始化
chDictor.init();
chDictor.lookup(text, new DictListener() {
       @Override
       public void onResult(final List<ChDictTranslate> chTs) {
         //针对多音字的情况，可能返回多个ChDictTranslate对象，比如查询“会”
         // 注意：回调是在子线程中进行，拿到查询结果之后若有更新UI操作，请切换到主线程执行
         MainHandler.getInstance().post(new Runnable() {
             @Override
             public void run() {
             }
         });
       }
       @Override
       public void onError(String q, String info) {
         // TODO Auto-generated method stub
       }
});

注意： 使用离线汉语词典前，请确认 最新汉语词库v1.1\最新汉语词库\hh 在设置的路径或者默认路径下

2.在线查词和翻译功能（支持小语种）功能集成

说明：请参考 demo 中 TranslateActivity 的使用

(1) 参数说明

from：表示源语言

to：表示目标语言

source：设置为app对应的名称（英文字符串）

注意：若from设置为自动，则查询自动识别源语言，自动识别不能保证完全正确，最好传源语言类型

(2) 构造查词参数对象

Language langFrom = LanguageUtils.getLangByName("中文");
Language langTo = LanguageUtils.getLangByName("英文");

TranslateParameters tps = new TranslateParameters.Builder()
       .source("ydtranslate-demo")
       .from(langFrom)
       .to(langTo)
       .build();

(3) 设置回调和开始翻译

通过Translator，设置上一步构造的查词对象，调用lookup方法传入文本数据和回调接口开始查询，方法中参数"requestId"，SDK并未使用，在回调中会再返回给开发者，用于区分每次调用，开发者可传null或者任意字符串。

识别回调接口包含两个方法：onResult表示识别成功，相关结果存储在result参数中，onError表示失败，失败信息放在TranslateErrorCode枚举类中。

注意：整个识别是异步的，回调在子线程进行，若涉及到界面操作，请切回主线程。

Translator.getInstance(tps).lookup(input, "requestId", new TranslateListener() {

        @Override
        public void onResult(Translate result, String input, String requestId) {//查询成功

        }

        @Override
        public void onError(TranslateErrorCode error, String requestId) {//查询失败

        }

        @Override
        public void onResult(List<Translate> results, List<String> input, List<TranslateErrorCode> errors, String requestId) {//查询成功

        }
});

3.离线查词和离线句子翻译功能集成

说明：请参考 demo 中 TranslateOfflineActivity 的使用

(1) 查词对象初始化

translatorOffline = new TranslatorOffline();

(2) 初始化词库

若使用离线查词，请通过方式一、方式二或者方式三初始化词库，三种方式只能选择一种；

初始化词库方式一，词库在assets/dict目录下,不支持直接放在assets目录下

translatorOffline.initWordDict("dict", true, new EnWordTranslator.EnWordInitListener() {
            @Override
            public void success() {

            }
            public void fail(TranslateErrorCode errorCode){
                Log.d("translatorOffline","init false");
            }
        });

初始化词库方式二，指定词库绝对路径,比如sd卡下：

translatorOffline.initWordDict(Environment.getExternalStorageDirectory().getAbsolutePath() + "/Youdao/localdict1/", false, new EnWordTranslator.EnWordInitListener() {
            @Override
            public void success() {
                Log.d("translatorOffline", "init success");
                long end = System.currentTimeMillis();
                long time = end - start;
                Log.i("1111111111111111", "111111111初始化时间" + time);
            }

            public void fail(TranslateErrorCode errorCode) {
                Log.d("translatorOffline", "init false");
            }
        });

初始化词库方式三，分别指定每个词库的路径：

//初始化中日词库，若使用日中还需要初始化日中词库
       translatorOffline.initWordDictWithWordConvert("dict", true, WordConvert.CH2JA, new EnWordTranslator.EnWordInitListener() {
            @Override
            public void success() {
            }
            public void fail(TranslateErrorCode errorCode){

            }
        });
//初始化韩中词库，若使用中韩，还需要初始化中韩词库
        translatorOffline.initWordDictWithWordConvert(Environment.getExternalStorageDirectory().getAbsolutePath() + "/Youdao/localdict2/", false, WordConvert.KO2CH, new EnWordTranslator.EnWordInitListener() {
            @Override
            public void success() {
            }
            public void fail(TranslateErrorCode errorCode){
            }
        });
//初始化中英、英中词库
        translatorOffline.initWordDictWithWordConvert("dict", true, WordConvert.EN2CH, new EnWordTranslator.EnWordInitListener() {
            @Override
            public void success() {
            }
            public void fail(TranslateErrorCode errorCode){

            }
        });

(3) 初始化离线句子库

translatorOffline.initLineDict(Environment.getExternalStorageDirectory().getAbsolutePath() + "/Youdao/Translator/transdata/data/ce2");

(4) 获取词库和句子库是否初始化成功

translatorOffline.isLineInited();        translatorOffline.isWordInited();

(5) 执行查询

String from = "中文";
String to = "英文";
Language langFrom = LanguageUtils.getLangByName(from);
Language langTo = LanguageUtils.getLangByName(to);
TranslateParameters parameters = new TranslateParameters.Builder().
        from(langFrom).to(langTo).useAutoConvertWord(true).useAutoConvertLine(false).build();
translatorOffline.lookupNative(input, parameters, "requestId", new TranslateListener() {
    @Override
    public void onResult(final Translate result, String input, String requestId) {
        handler.post(new Runnable() {
            @Override
            public void run() {

            }
        });
    }

    @Override
    public void onError(final TranslateErrorCode error, String requestId) {
        handler.post(new Runnable() {
            @Override
            public void run() {
                T
            }
        });
    }
});

注意：

1.若查词和查句子都初始化了，则每次查询，先去词库中找，若找不到去句子库中查询

2.离线查词功能，词库支持放在assets目录下，此时需要将词库localdict.datx解压到对应目录下（解压得到三个文件），若是sd卡路径，开发者可以直接放置解压前或者解压后的文件。使用离线句子翻译前，请确定"离线句子\ce"文件夹下的2个文件夹，e2c和c2e在设置的离线路径中或者默认路径下是存在的。

3.useAutoConvertWord和useAutoConvertLine参数是指定是否自动识别中英文，若设置为true，则查询时自动忽略from和to参数，根据实际输入查询，若设置为false，则严格按照from和to参数返回查询结果

4.若想查询不常见的变形词，如，countries，请使用扩展词库。将wordlib.zip中的文件解压到中英词库同级目录。wordlib下的文件跟localdict.datx在同一级目录，不需要wordlib文件夹。当离线查询countries有查询结果时，说明扩展词库生效。

4.deeplink功能

说明：请参考 demo 中 TranslateDetailActivity、HanyuActivity 查看更多功能的使用

SDK中查询结果 Translate（英语单词、句子在线、离线查询返回结果类）和 ChDictTranslate（汉语词典查询结果类）中提供了 openMore(Context context)方法来实现查看更多的跳转，若用户安装词典则打开词典 app，否则打开词典移动 web 页面。

代码使用:

translate.openMore(context);

注意：若上面跳转逻辑不能满足开发需求，可调用

translate.getDictWebUrl() 方法得到对应的查词 web 页面地址

translate.openDict(context) 方法跳转到词典，若跳转成功，返回 true，否则返回 false

支持语言

下表为各语言对应代码：

注意：
其中auto可以识别中文、英文、日文、韩文、法文、西班牙文、葡萄牙文、俄文、越南文、德文、阿拉伯文、印尼文、意大利文，其他语种无法识别，为提高准确率，请指定语种。

错误代码列表

常见问题及注意事项

1.运行程序崩溃？
检查下是否对应的 so 是否放到当前工程目录下。

2.翻译没结果？
检查下翻译接口回调的错误信息，保证申请的应用ID是有效且提前绑定了。

3.如何获得应用ID
注册账号， 登录后台创建应用和实例并完成绑定， 可获得应用ID和应用密钥等信息。

4.出现错误HTTP_REQUEST_ERROR("Http requesterror.",1)
在确保有网情况下，若调用过程中出现这个错误，HTTP_REQUEST_ERROR("Http requesterror.",1) ,请检查是否是在主线程中调用的翻译识别方法，请确保在主线程调用。

版本更新记录

1. 修复已知 bug|
   |2017.06.30 |v1.2.0 |修复已知 bug|

|2017.07.24 |v1.3.0 |1. 修复 deeplink 相关 bug

1. demo 开发环境更改为 Android Studio|
   |2017.08.16 |v1.4.0 |1. 修复已知 bug
2. 提供多版本的 so 文件|
   |2017.11.16 |v1.5.0 |1. 合并离线查词和句子翻译
3. 统一路径设置和结果回调
4. 支持非主线程调用
5. 离线查词和汉语词典，支持词库放在安装包
6. bug修复|
   |2018.02.09 |v1.7.0 |1. 新增每种词库不同路径初始化
7. 支持在线语音翻译|
   |2018.04.26 |v1.7.1 |1. 新增越南语和繁体中文
8. 支持在线语音翻译
   3.修复查询结果from和to不对问题|

|2018.05.16 |v1.7.2 |支持在线图片翻译|
|2019.11.05 |v2.0.0 |兼容多个sdk同时使用|
|2023.08.07 |v2.0.0 |升级sdk|