C#調百度通用翻譯API翻譯HALCON的示例描述
準備工作
HALCON示例程序的描述部分一直是英文的,看起來很不方便。我決定漢化一下HALCON示例程序的描述,準備工作如下:
- 拿到HALCON的例程描述文件index_examples_en_US.xml,我的在C:\Program Files\MVTec\HALCON-18.11-Progress\help,其它版本類似。
- 在百度翻譯開放平台註冊拿到自己的ID和密鑰,開通通用翻譯API服務。
註:百度官方有提供通用翻譯API的使用DEMO,不過比較簡單,C# DEMO下載
參數簡介
通用翻譯API的HTTPS 地址為//fanyi-api.baidu.com/api/trans/vip/translate,使用方法參考通用翻譯API接入文檔 。
輸入參數
請求方式可使用 GET 或 POST 方式(Content-Type 請指定為:application/x-www-form-urlencoded),字符編碼統一採用 UTF-8 編碼格式,單次請求長度控制在 6000 bytes以內(漢字約為輸入參數 2000 個)。
將API需要的輸入參數封裝為一個類(ID和密鑰換成自己的),代碼如下:
/// <summary>
/// 輸入產數
/// </summary>
class InputQuery
{
/// <summary>
/// APP ID
/// </summary>
private static string appId = "2021xxxxxxx0626";
/// <summary>
/// 密鑰
/// </summary>
private static string passWord = "cnblongsxtimefiles";
/// <summary>
/// 請求翻譯query UTF-8編碼
/// </summary>
public string Content { get; set; }
/// <summary>
/// 翻譯源語言 可設置為auto
/// </summary>
public string From { get; set; }
/// <summary>
/// 翻譯目標語言 不可設置為auto
/// </summary>
public string To { get; set; }
/// <summary>
/// APP ID
/// </summary>
public string AppId { get; set; }
/// <summary>
/// 隨機數 可為字母或數字的字符串
/// </summary>
public string Salt { get; set; }
/// <summary>
/// 簽名 appid+q+salt+密鑰的MD5值
/// </summary>
public string Sign { get; set; }
/// <summary>
/// 構造函數
/// </summary>
/// <param name="content">翻譯內容</param>
/// <param name="fromStr">源語言</param>
/// <param name="toStr">目標語言</param>
public InputQuery(string content, string fromStr, string toStr)
{
Content = content;
From = fromStr;
To = toStr;
AppId = appId;
string randomNum = new Random().Next().ToString();
string md5Sign = GetMD5(appId + content + randomNum + passWord).ToLower();
Salt = randomNum;
Sign = md5Sign;
}
/// <summary>
/// 計算字符串的MD5值
/// </summary>
static string GetMD5(string source)
{
MD5CryptoServiceProvider md5 = new MD5CryptoServiceProvider();
byte[] data = Encoding.UTF8.GetBytes(source);
byte[] md5Data = md5.ComputeHash(data, 0, data.Length);
md5.Clear();
string destString = string.Empty;
for (int i = 0; i < md5Data.Length; i++)
{
destString += Convert.ToString(md5Data[i], 16).PadLeft(2, '0');
}
destString = destString.PadLeft(32, '0');
return destString;
}
}
輸出參數
API返回的結果是json格式,需要反序列為對象實例後再進行處理。為了減少第三方庫的依賴,反序列化使用.NET自帶的DataContractJsonSerializer。
封裝的輸出參數類代碼如下:
/// <summary>
/// 輸出參數
/// </summary>
[DataContract]
class OutputResult
{
/// <summary>
/// 錯誤碼 僅當出現錯誤時顯示
/// </summary>
[DataMember(Name = "error_code")]
public string Error_code { set; get; }
/// <summary>
/// 錯誤信息
/// </summary>
[DataMember(Name = "error_msg")]
public string Error_msg { set; get; }
/// <summary>
/// 源語言 返回用戶指定的語言,或者自動檢測出的語種(源語言設為 auto 時)
/// </summary>
[DataMember(Name = "from")]
public string From { set; get; }
/// <summary>
/// 目標語言 返回用戶指定的目標語言
/// </summary>
[DataMember(Name = "to")]
public string To { set; get; }
/// <summary>
/// 翻譯結果 返回翻譯結果,包括 src 和 dst 字段
/// </summary>
[DataMember(Name = "trans_result")]
public TranslateContent[] Trans_result { set; get; }
}
/// <summary>
/// 翻譯結果
/// </summary>
[DataContract]
class TranslateContent
{
/// <summary>
/// 原文
/// </summary>
[DataMember(Name = "src")]
public string Src { set; get; }
/// <summary>
/// 譯文
/// </summary>
[DataMember(Name = "dst")]
public string Dst { set; get; }
}
使用HttpClient
調用API需要一個類發送 HTTP 請求以及接收HTTP響應,推薦使用HttpClient類(微軟不建議使用WebClient、HttpWebRequest類)。
需要注意的是:HttpClient 用於在應用程序的整個生存期內實例化一次並重複使用,也就是說一個應用程序只需要一個HttpClient單例即可,代碼如下:
public class GoodController
{
public static readonly HttpClient HttpClient;
static GoodController()
{
HttpClient = new HttpClient();
}
}
翻譯工具類
將API的調用方法封裝成一個Translate類,目前只提供一個英翻中的方法,其它翻譯需求可以參考 常見語種列表 自己擴展。
Translate類代碼如下(注意添加System.Web依賴項):
/// <summary>
/// 百度通用翻譯API工具類
/// </summary>
class Translate
{
/*
* 代碼鏈接://www.cnblogs.com/timefiles/p/BaiduTranslateAPI.html
* 創建時間:2021/06/26
* 主頁鏈接://www.cnblogs.com/timefiles/
*
* 常用的語種代碼:
* 自動檢測 auto
* 中文 zh
* 英語 en
* 日語 jp
*/
/// <summary>
/// 英文翻譯為中文
/// </summary>
/// <param name="content">翻譯內容</param>
/// <returns></returns>
public static string EnToZh(string content)
{
string languageFrom = "en", languageTo = "zh";
return GetTranslateResult(content, languageFrom, languageTo);
}
/// <summary>
/// 獲取翻譯結果
/// </summary>
/// <param name="content">翻譯內容</param>
/// <param name="fromStr">源語言</param>
/// <param name="toStr">目標語言</param>
/// <returns></returns>
static string GetTranslateResult(string content, string fromStr, string toStr)
{
InputQuery input = new InputQuery(content, fromStr, toStr);
Uri uri = GetUri(input);
var task = GetOutputResultAsync(uri);
//個人認證後API的每秒請求量最高為10,異步意義不大,直接使用同步的方式
OutputResult output = task.Result;
if (output.Error_code == null)
{
return output.Trans_result[0].Dst;
}
else
{
throw new Exception("翻譯異常,錯誤代碼:" + output.Error_msg);
}
}
/// <summary>
/// 獲取請求Uri
/// </summary>
/// <param name="input"></param>
/// <returns></returns>
static Uri GetUri(InputQuery input)
{
var query = HttpUtility.ParseQueryString(string.Empty);
query["q"] = input.Content;
query["from"] = input.From;
query["to"] = input.To;
query["appid"] = input.AppId;
query["salt"] = input.Salt;
query["sign"] = input.Sign;
//構造Uri,不建議直接拼字符串
UriBuilder uriBur = new UriBuilder("//api.fanyi.baidu.com/api/trans/vip/translate");
uriBur.Query = query.ToString();
//Uri會自動進行轉義
return uriBur.Uri;
}
/// <summary>
/// 獲取API返回的結果
/// </summary>
/// <param name="uri">請求的uri</param>
/// <returns></returns>
static async Task<OutputResult> GetOutputResultAsync(Uri uri)
{
OutputResult result = null;
var response = await GoodController.HttpClient.GetStringAsync(uri);
var ser = new DataContractJsonSerializer(typeof(OutputResult));
using (var ms = new MemoryStream(Encoding.UTF8.GetBytes(response)))
{
result = (OutputResult)ser.ReadObject(ms);
}
return result;
}
}
個人認證後API的每秒請求量最高為10,此處使用同步方式獲取翻譯結果,有異步需求的可以自己更改。
應用:翻譯HALCON的示例描述
static void Main(string[] args)
{
XmlDocument xd = new XmlDocument();
xd.Load("index_examples_en_US.xml");
//查找固定名稱 節點名要從根節點開始寫
XmlNodeList nodelist = xd.DocumentElement.SelectNodes("/examples/example/desc");
for (int i = 0; i < nodelist.Count; i++)
{
string desc = nodelist[i].InnerText;
//百度翻譯有時不太準確,建議保留原文
nodelist[i].InnerText = Translate.EnToZh(desc)+"("+ nodelist[i].InnerText+")";
Console.WriteLine("翻譯結果"+i+":" + nodelist[i].InnerText);
Console.WriteLine();
}
StreamWriter sw = new StreamWriter("index_examples_en_US_翻譯.xml", false, new UTF8Encoding(false));
//為了和原文件保存一致,原文件是使用的是"\n"換行
sw.NewLine = "\n";
xd.Save(sw);
sw.Close();
Console.WriteLine("完成");
Console.Read();
}
註:大概有1000多條需要翻譯,需要等待10幾分鐘。考慮過使用特定字符組合成幾個大字符串翻譯後再拆分,但特定字符在翻譯過程中有丟失導致拆分失敗,只能使用這種方式。
將原HALCON的xml文件重命名作為備份,將翻譯後的文件複製到HALCON程序目錄下命名為index_examples_en_US.xml,效果如下: