單一功能學習——百度AI之身份證識別

以下內容基本是從官方接口文檔復制過來的，附帶自己封裝的代碼

 

時間：2018年4月4日

 

一、導入工具包

　　使用maven依賴：

<dependency>
    <groupId>com.baidu.aip</groupId>
    <artifactId>java-sdk</artifactId>
    <version>${version}</version>
</dependency>

　　自己下載：

　　　　下載Java SDK壓縮工具包：https://ai.baidu.com/sdk#ocr  

　　　　在Eclipse右鍵“工程 -> Properties -> Java Build Path -> Add JARs”

　　　　添加SDK工具包  aip-java-sdk-版本.jar 和第三方依賴工具包json-20160810.jar log4j-1.2.17.jar。

 

二、新建AipOcr

 　　官方示例：

public class Sample {
    //設置APPID/AK/SK
    public static final String APP_ID = "你的 App ID";
    public static final String API_KEY = "你的 Api Key";
    public static final String SECRET_KEY = "你的 Secret Key";

    public static void main(String[] args) {
        // 初始化一個AipOcr
        AipOcr client = new AipOcr(APP_ID, API_KEY, SECRET_KEY);

        // 可選：設置網絡連接參數
        client.setConnectionTimeoutInMillis(2000);
        client.setSocketTimeoutInMillis(60000);

        // 可選：設置代理服務器地址, http和socket二選一，或者均不設置
        client.setHttpProxy("proxy_host", proxy_port);  // 設置http代理
        client.setSocketProxy("proxy_host", proxy_port);  // 設置socket代理

        // 可選：設置log4j日志輸出格式，若不設置，則使用默認配置
        // 也可以直接通過jvm啟動參數設置此環境變量
        System.setProperty("aip.log4j.conf", "path/to/your/log4j.properties");

        // 調用接口
        String path = "test.jpg";
        JSONObject res = client.basicGeneral(path, new HashMap<String, String>());
        System.out.println(res.toString(2));
        
    }
}

 

 　　其中示例的log4j.properties文件內容如下：

#可以設置級別：debug>info>error
#debug：顯示debug、info、error
#info：顯示info、error
#error：只error
log4j.rootLogger=debug,appender1
#log4j.rootLogger=info,appender1
#log4j.rootLogger=error,appender1

#輸出到控制台
log4j.appender.appender1=org.apache.log4j.ConsoleAppender
#樣式為TTCCLayout
log4j.appender.appender1.layout=org.apache.log4j.PatternLayout

#自定義樣式
# %r 時間 0
# %t 方法名 main
# %p 優先級 DEBUG/INFO/ERROR
# %c 所屬類的全名(包括包名)
# %l 發生的位置，在某個類的某行
# %m 輸出代碼中指定的訊息，如log(message)中的message
# %n 輸出一個換行

log4j.appender.appender1.layout.ConversionPattern=[%d{yy/MM/dd HH:mm:ss:SSS}][%t][%p] -%l %m%n

 

 

 三、配置AipOcr

　　如果用戶需要配置AipOcr的一些細節參數，可以在構造AipOcr之后調用接口設置參數，目前只支持以下參數：

接口	說明
setConnectionTimeoutInMillis	建立連接的超時時間（單位：毫秒）
setSocketTimeoutInMillis	通過打開的連接傳輸數據的超時時間（單位：毫秒）
setHttpProxy	設置http代理服務器
setSocketProxy	設置socket代理服務器 （http和socket類型代理服務器只能二選一）

 

 四、接口調用

　　用戶向服務請求識別身份證，身份證識別包括正面和背面。

public void sample(AipOcr client) {
    // 傳入可選參數調用接口
    HashMap<String, String> options = new HashMap<String, String>();
    options.put("detect_direction", "true");
    options.put("detect_risk", "false");
    
    String idCardSide = "back";
    
    // 參數為本地圖片路徑
    String image = "test.jpg";
    JSONObject res = client.idcard(image, idCardSide, options);
    System.out.println(res.toString(2));

    // 參數為本地圖片二進制數組
    byte[] file = readImageFile(image);
    res = client.idcard(file, idCardSide, options);
    System.out.println(res.toString(2));

}

　　請求參數詳情

參數名稱	是否必選	類型	可選值范圍	默認值	說明
image	是	mixed			本地圖片路徑或者圖片二進制數據
id_card_side	是	String	front - 身份證含照片的一面 back - 身份證帶國徽的一面		front：身份證含照片的一面；back：身份證帶國徽的一面
detect_direction	否	String	true false	false	是否檢測圖像朝向，默認不檢測，即：false。朝向是指輸入圖像是正常方向、逆時針旋轉90/180/270度。可選值包括: - true：檢測朝向； - false：不檢測朝向。
detect_risk	否	String	true - 開啟 false - 不開啟		是否開啟身份證風險類型(身份證復印件、臨時身份證、身份證翻拍、修改過的身份證)功能，默認不開啟，即：false。可選值:true-開啟；false-不開啟

 

　　返回數據參數詳情

字段	是否必選	類型	說明
direction	否	number	圖像方向，當detect_direction=true時存在。 - -1:未定義， - 0:正向， - 1: 逆時針90度， - 2:逆時針180度， - 3:逆時針270度
image_status	是	string	normal-識別正常 reversed_side-未擺正身份證 non_idcard-上傳的圖片中不包含身份證 blurred-身份證模糊 over_exposure-身份證關鍵字段反光或過曝 unknown-未知狀態
risk_type	否	string	輸入參數 detect_risk = true 時，則返回該字段識別身份證類型: normal-正常身份證；copy-復印件；temporary-臨時身份證；screen-翻拍；unknow-其他未知情況
edit_tool	否	string	如果參數 detect_risk = true 時，則返回此字段。如果檢測身份證被編輯過，該字段指定編輯軟件名稱，如:Adobe Photoshop CC 2014 (Macintosh),如果沒有被編輯過則返回值無此參數
log_id	是	number	唯一的log id，用於問題定位
words_result	是	array(object)	定位和識別結果數組
words_result_num	是	number	識別結果數，表示words_result的元素個數
+location	是	array(object)	位置數組（坐標0點為左上角）
++left	是	number	表示定位位置的長方形左上頂點的水平坐標
++top	是	number	表示定位位置的長方形左上頂點的垂直坐標
++width	是	number	表示定位位置的長方形的寬度
++height	是	number	表示定位位置的長方形的高度
+words	否	string	識別結果字符串

 　　返回示例

{
    "log_id": 2648325511,
    "direction": 0,
    "image_status": "normal",
    "idcard_type": "normal",
    "edit_tool": "Adobe Photoshop CS3 Windows",
    "words_result": {
        "住址": {
            "location": {
                "left": 267,
                "top": 453,
                "width": 459,
                "height": 99
            },
            "words": "南京市江寧區弘景大道3889號"
        },
        "公民身份號碼": {
            "location": {
                "left": 443,
                "top": 681,
                "width": 589,
                "height": 45
            },
            "words": "330881199904173914"
        },
        "出生": {
            "location": {
                "left": 270,
                "top": 355,
                "width": 357,
                "height": 45
            },
            "words": "19990417"
        },
        "姓名": {
            "location": {
                "left": 267,
                "top": 176,
                "width": 152,
                "height": 50
            },
            "words": "伍雲龍"
        },
        "性別": {
            "location": {
                "left": 269,
                "top": 262,
                "width": 33,
                "height": 52
            },
            "words": "男"
        },
        "民族": {
            "location": {
                "left": 492,
                "top": 279,
                "width": 30,
                "height": 37
            },
            "words": "漢"
        }
    },
    "words_result_num": 6
}

 

 

 五、我封裝的類

package com.xxxxx.util;

import java.io.File;
import java.io.FileInputStream;
import java.io.InputStream;
import java.util.HashMap;
import org.apache.commons.lang3.StringUtils;
import org.json.JSONObject;
import com.baidu.aip.ocr.AipOcr;

public class AipOcrJDKFactory {

    // 設置APPID/AK/SK
    public static final String APP_ID = "xxxxx";
    public static final String API_KEY = "xxxxxxxxxxxxxxxxxx";
    public static final String SECRET_KEY = "xxxxxxxxxxxxxxxxxxx";

    public static final AipOcrJDKFactory INST = new AipOcrJDKFactory();
    public static AipOcr client;

    private AipOcrJDKFactory() {
        // 初始化一個AipOcr
        client = new AipOcr(APP_ID, API_KEY, SECRET_KEY);
        // 可選：設置網絡連接參數
        client.setConnectionTimeoutInMillis(2000);
        client.setSocketTimeoutInMillis(60000);
    }

    /**
     * 身份證識別
     * 
     * @param isFront
     *            :true識別身份證正面;false識別身份證背面;
     * @param isDirection
     *            :是否開啟檢測旋轉角度並矯正識別，建議為true
     * @param isRisk
     *            :是否開啟身份證風險類型(身份證復印件、臨時身份證、身份證翻拍、修改過的身份證)功能，默認不開啟
     * @param imagePath
     *            :圖片本地路徑
     * @return
     */
    public JSONObject idcardRecognition(boolean isFront, boolean isDirection, boolean isRisk, String imagePath) {
        if (StringUtils.isEmpty(imagePath)) {
            return null;
        }
        File file = new File(imagePath);
        if (!file.exists() || !file.isFile()) {
            return null;
        }
        // 傳入可選參數調用接口，默認為false
        HashMap<String, String> options = new HashMap<String, String>();
        options.put("detect_direction", isDirection ? "true" : "false");
        options.put("detect_risk", isRisk ? "true" : "false");
        // 識別身份證正面idCardSide=front;識別身份證背面idCardSide=back;
        String idCardSide = isFront ? "front" : "back";
        // 參數為本地圖片路徑
        JSONObject res = client.idcard(imagePath, idCardSide, options);
        System.out.println("(boolean isFront, String imagePath) res:" + res.toString(2));
        return res;

    }

    /**
     * 身份證識別
     * 
     * @param isFront
     *            :true識別身份證正面;false識別身份證背面;
     * @param fileBytes
     *            :圖片byte[]
     * @return
     */
    public JSONObject idcardRecognition(boolean isFront,  byte[] fileBytes) {
        if (fileBytes == null) {
            return null;
        }
        // 傳入可選參數調用接口
        HashMap<String, String> options = new HashMap<String, String>();
        options.put("detect_direction", "true");
        options.put("detect_risk", "false");
        // 識別身份證正面idCardSide=front;識別身份證背面idCardSide=back;
        String idCardSide = isFront ? "front" : "back";
        // 參數為本地圖片二進制數組
        JSONObject res = client.idcard(fileBytes, idCardSide, options);
        System.out.println("client.idcard(fileBytes, idCardSide, options) res:" + res.toString(2));
        return res;
    }
}