文本翻譯 Android SDK 簡(jiǎn)介

概述

(1) 概念解釋

文本翻譯：將一段源語(yǔ)言文本轉(zhuǎn)換成目標(biāo)語(yǔ)言文本，可根據(jù)語(yǔ)言參數(shù)的不同實(shí)現(xiàn)多國(guó)語(yǔ)音之間的互譯

(2) 說(shuō)明

Hi，您好，歡迎使用有道智云文本翻譯Android SDK。如果您想快速體驗(yàn)服務(wù)，建議您前往翻譯體驗(yàn)中心 或者在體驗(yàn)中心右下側(cè)找到小程序二維碼，掃描進(jìn)行體驗(yàn)。

本文檔主要針對(duì)需要集成文本翻譯服務(wù)Android SDK的開(kāi)發(fā)工程師，詳細(xì)描述有道文本翻譯能力及集成過(guò)程。

如果您有與我們商務(wù)合作的需求，可以通過(guò)以下方式聯(lián)系我們：

商務(wù)郵箱： AIcloud_Business@corp.youdao.com

如果您對(duì)文檔內(nèi)容有任何疑問(wèn)，可以通過(guò)以下幾種方式聯(lián)系我們：

客服QQ：1906538062

智云翻譯技術(shù)交流QQ 1群: 652880659

智云翻譯技術(shù)交流QQ 2群: 669384425

智云翻譯技術(shù)交流QQ 3群: 807539209

智云翻譯技術(shù)交流QQ 4群: 936752411

聯(lián)系郵箱： zhiyun@corp.youdao.com

溫馨提示：
本文檔主要針對(duì)開(kāi)發(fā)人員，接入測(cè)試前需要在后臺(tái)創(chuàng)建Android應(yīng)用，并綁定文本翻譯實(shí)例；如果您還沒(méi)有，請(qǐng)按照 新手指南操作。
平臺(tái)向每個(gè)賬戶贈(zèng)送50元的體驗(yàn)金，供用戶集成前測(cè)試所用，具體資費(fèi)規(guī)則詳見(jiàn) 文本翻譯服務(wù)報(bào)價(jià) 。

功能介紹

文本翻譯SDK是有道在線文本翻譯服務(wù)進(jìn)行封裝，提供快速的接入方式。

兼容性

支持設(shè)備：運(yùn)行了 Android 4.0.3以及以上系統(tǒng)的 Android 設(shè)備

文本翻譯 Android SDK集成指南

集成前提

開(kāi)始集成SDK之前開(kāi)發(fā)者需要登錄 有道智云平臺(tái)，創(chuàng)建應(yīng)用獲取應(yīng)用ID（或者通過(guò)運(yùn)營(yíng)人員獲取應(yīng)用ID），以便使用翻譯服務(wù)。

集成步驟

(1) SDK包導(dǎo)入

請(qǐng)?jiān)诠こ涛募夸浵聞?chuàng)建一個(gè)名為 libs 的子目錄(有的話則不需要?jiǎng)?chuàng)建)，并將以下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狀態(tài) -->
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
        <!-- 獲取網(wǎng)絡(luò)信息狀態(tài)，如當(dāng)前的網(wǎng)絡(luò)連接是否有效 -->
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
        <!-- 讀取手機(jī)狀態(tài) phone group -->
<uses-permission android:name="android.permission.READ_PHONE_STATE" />
        <!-- 往SDCard讀寫(xiě)數(shù)據(jù)權(quán)限   storage group -->
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />

(3) 代碼混淆配置

代碼混淆文件proguard-project.txt，添加如下內(nèi)容：

-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，請(qǐng)?jiān)诔绦虻腁pplication中調(diào)用SDK初始化代碼，可以參考demo中DemoApplication。
注：appKey即應(yīng)用ID

//appKey即應(yīng)用ID
YouDaoApplication.init(this, appkey,appSecret);

功能集成

1.漢語(yǔ)詞典翻譯功能集成

(1) 構(gòu)造查詞對(duì)象

提供了兩種初始化方法，如下所示：

/*
 * 可以查詞之前設(shè)置詞庫(kù)路徑，則采用默認(rèn)路徑Environment
 *   .getExternalStorageDirectory().getPath() + "/yuwen/backup/"
 * 請(qǐng)確保設(shè)置的路徑或者默認(rèn)路徑下包含漢語(yǔ)詞典的包
 */
chDictor = new ChDictor();
/*
*表*示Environment.getExternalStorageDirectory().getAbsolutePath()* + dictFilePath路徑下存在庫(kù)
*/
chDictor = new ChDictor(dictFilePath);

(2) 查詞對(duì)象初始化和查詢

//注意，每次查詢之前都需要初始化
chDictor.init();
chDictor.lookup(text, new DictListener() {
       @Override
       public void onResult(final List<ChDictTranslate> chTs) {
         //針對(duì)多音字的情況，可能返回多個(gè)ChDictTranslate對(duì)象，比如查詢“會(huì)”
         // 注意：回調(diào)是在子線程中進(jìn)行，拿到查詢結(jié)果之后若有更新UI操作，請(qǐng)切換到主線程執(zhí)行
         MainHandler.getInstance().post(new Runnable() {
             @Override
             public void run() {
             }
         });
       }
       @Override
       public void onError(String q, String info) {
         // TODO Auto-generated method stub
       }
});

注意： 使用漢語(yǔ)詞典前，請(qǐng)確認(rèn) 最新漢語(yǔ)詞庫(kù)v1.1\最新漢語(yǔ)詞庫(kù)\hh 在設(shè)置的路徑或者默認(rèn)路徑下

2.在線查詞和翻譯功能（支持小語(yǔ)種）功能集成

說(shuō)明：請(qǐng)參考 demo 中 TranslateActivity 的使用

(1) 參數(shù)說(shuō)明

from：表示源語(yǔ)言

to：表示目標(biāo)語(yǔ)言

source：設(shè)置為app對(duì)應(yīng)的名稱（英文字符串）

注意：若from設(shè)置為自動(dòng)，則查詢自動(dòng)識(shí)別源語(yǔ)言，自動(dòng)識(shí)別不能保證完全正確，最好傳源語(yǔ)言類型

(2) 構(gòu)造查詞參數(shù)對(duì)象

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

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

(3) 設(shè)置回調(diào)和開(kāi)始翻譯

通過(guò)Translator，設(shè)置上一步構(gòu)造的查詞對(duì)象，調(diào)用lookup方法傳入文本數(shù)據(jù)和回調(diào)接口開(kāi)始查詢，方法中參數(shù)"requestId"，SDK并未使用，在回調(diào)中會(huì)再返回給開(kāi)發(fā)者，用于區(qū)分每次調(diào)用，開(kāi)發(fā)者可傳null或者任意字符串。

識(shí)別回調(diào)接口包含兩個(gè)方法：onResult表示識(shí)別成功，相關(guān)結(jié)果存儲(chǔ)在result參數(shù)中，onError表示失敗，失敗信息放在TranslateErrorCode枚舉類中。

注意：整個(gè)識(shí)別是異步的，回調(diào)在子線程進(jìn)行，若涉及到界面操作，請(qǐng)切回主線程。

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.查詞和句子翻譯功能集成

(1) 查詞對(duì)象初始化

translatorOffline = new TranslatorOffline();

(2) 初始化詞庫(kù)

若使用查詞，請(qǐng)通過(guò)方式一、方式二或者方式三初始化詞庫(kù)，三種方式只能選擇一種；

初始化詞庫(kù)方式一，詞庫(kù)在assets/dict目錄下,不支持直接放在assets目錄下

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

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

初始化詞庫(kù)方式二，指定詞庫(kù)絕對(duì)路徑,比如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初始化時(shí)間" + time);
            }

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

初始化詞庫(kù)方式三，分別指定每個(gè)詞庫(kù)的路徑：

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

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

            }
        });

(3) 初始化句子庫(kù)

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

(4) 獲取詞庫(kù)和句子庫(kù)是否初始化成功

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

(5) 執(zhí)行查詢

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.若查詞和查句子都初始化了，則每次查詢，先去詞庫(kù)中找，若找不到去句子庫(kù)中查詢

2.查詞功能，詞庫(kù)支持放在assets目錄下，此時(shí)需要將詞庫(kù)localdict.datx解壓到對(duì)應(yīng)目錄下（解壓得到三個(gè)文件），若是sd卡路徑，開(kāi)發(fā)者可以直接放置解壓前或者解壓后的文件。使用句子翻譯前，請(qǐng)確定"句子\ce"文件夾下的2個(gè)文件夾，e2c和c2e在設(shè)置的路徑中或者默認(rèn)路徑下是存在的。

3.useAutoConvertWord和useAutoConvertLine參數(shù)是指定是否自動(dòng)識(shí)別中英文，若設(shè)置為true，則查詢時(shí)自動(dòng)忽略from和to參數(shù)，根據(jù)實(shí)際輸入查詢，若設(shè)置為false，則嚴(yán)格按照f(shuō)rom和to參數(shù)返回查詢結(jié)果

4.若想查詢不常見(jiàn)的變形詞，如，countries，請(qǐng)使用擴(kuò)展詞庫(kù)。將wordlib.zip中的文件解壓到中英詞庫(kù)同級(jí)目錄。wordlib下的文件跟localdict.datx在同一級(jí)目錄，不需要wordlib文件夾。當(dāng)查詢countries有查詢結(jié)果時(shí)，說(shuō)明擴(kuò)展詞庫(kù)生效。

4.deeplink功能

說(shuō)明：請(qǐng)參考 demo 中 TranslateDetailActivity、HanyuActivity 查看更多功能的使用

SDK中查詢結(jié)果 Translate（英語(yǔ)單詞、句子在線、查詢返回結(jié)果類）和 ChDictTranslate（漢語(yǔ)詞典查詢結(jié)果類）中提供了 openMore(Context context)方法來(lái)實(shí)現(xiàn)查看更多的跳轉(zhuǎn)，若用戶安裝詞典則打開(kāi)詞典 app，否則打開(kāi)詞典移動(dòng) web 頁(yè)面。

代碼使用:

translate.openMore(context);

注意：若上面跳轉(zhuǎn)邏輯不能滿足開(kāi)發(fā)需求，可調(diào)用

translate.getDictWebUrl() 方法得到對(duì)應(yīng)的查詞 web 頁(yè)面地址

translate.openDict(context) 方法跳轉(zhuǎn)到詞典，若跳轉(zhuǎn)成功，返回 true，否則返回 false

支持語(yǔ)言

下表為各語(yǔ)言對(duì)應(yīng)代碼：

注意：
其中auto可以識(shí)別中文、英文、日文、韓文、法文、西班牙文、葡萄牙文、俄文、越南文、德文、阿拉伯文、印尼文、意大利文，其他語(yǔ)種無(wú)法識(shí)別，為提高準(zhǔn)確率，請(qǐng)指定語(yǔ)種。

錯(cuò)誤代碼列表

常見(jiàn)問(wèn)題及注意事項(xiàng)

1.運(yùn)行程序崩潰？
檢查下是否對(duì)應(yīng)的 so 是否放到當(dāng)前工程目錄下。

2.翻譯沒(méi)結(jié)果？
檢查下翻譯接口回調(diào)的錯(cuò)誤信息，保證申請(qǐng)的應(yīng)用ID是有效且提前綁定了。

3.如何獲得應(yīng)用ID
注冊(cè)賬號(hào)， 登錄后臺(tái)創(chuàng)建應(yīng)用和實(shí)例并完成綁定， 可獲得應(yīng)用ID和應(yīng)用密鑰等信息。

4.出現(xiàn)錯(cuò)誤HTTP_REQUEST_ERROR("Http requesterror.",1)
在確保有網(wǎng)情況下，若調(diào)用過(guò)程中出現(xiàn)這個(gè)錯(cuò)誤，HTTP_REQUEST_ERROR("Http requesterror.",1) ,請(qǐng)檢查是否是在主線程中調(diào)用的翻譯識(shí)別方法，請(qǐng)確保在主線程調(diào)用。

版本更新記錄