二維碼識別功能可以識別圖片(包括照片、截圖等多種圖片)中多個有效二維碼或者條形碼的位置及內容,輸出圖像中二維碼或者條形碼的位置框和其包含的文本信息。本文介紹二維碼識別的功能參數以及示例。
功能簡介
二維碼識別功能可以識別圖片(包括照片、截圖等多種圖片)中多個有效二維碼或者條形碼的位置及內容,輸出圖像中二維碼或者條形碼的位置框和其包含的文本信息。其中位置包含左上角橫坐標、左上角縱坐標、寬度和高度的值,如下圖所示。
基于獲取到的二維碼或者條形碼內容信息和位置信息,您可以在應用中實現二維碼或者條形碼的掃描和讀取,以及對圖片中的二維碼或者條形碼進行屏蔽、打碼等操作。
使用場景
掃碼支付:用戶可以通過掃描圖片中的二維碼完成支付。
營銷和廣告:二維碼可以被嵌入到廣告宣傳海報、產品包裝等中,通過掃描二維碼用戶可以獲取更多的產品信息。
前提條件
已開通智能媒體管理(IMM)服務。具體操作,請參見開通產品。
已綁定IMM項目。通過OSS控制臺綁定的具體操作,請參見快速入門。通過API綁定的具體操作,請參見AttachOSSBucket。
注意事項
二維碼識別僅支持同步處理(x-oss-process處理方式)。
一張圖片中有多個二維碼的情況下,最大可支持識別5個二維碼。
不支持匿名訪問。
必須擁有IMM處理所需的相關權限。更多信息,請參見權限。
參數說明
操作名稱:image/codes
具體返回參數,請參看DetectImageCodes - 圖片二維碼檢測。
使用示例
使用SDK
以下僅列舉常見SDK通過處理參數的方式使用二維碼識別的代碼示例。如需使用其他SDK進行二維碼識別,請參見以下常見SDK自行調整。
Java
要求使用3.17.4及以上版本的Java SDK。
import com.aliyun.oss.ClientBuilderConfiguration;
import com.aliyun.oss.OSS;
import com.aliyun.oss.OSSClientBuilder;
import com.aliyun.oss.common.auth.CredentialsProviderFactory;
import com.aliyun.oss.common.auth.EnvironmentVariableCredentialsProvider;
import com.aliyun.oss.common.comm.SignVersion;
import com.aliyun.oss.model.OSSObject;
import com.aliyun.oss.model.GetObjectRequest;
import com.aliyuncs.exceptions.ClientException;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
public class Demo {
public static void main(String[] args) throws ClientException, ClientException {
// yourEndpoint填寫Bucket所在地域對應的Endpoint。
String endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// 填寫Endpoint對應的Region信息,例如cn-hangzhou。
String region = "cn-hangzhou";
// 從環境變量中獲取訪問憑證。運行本代碼示例之前,請確保已設置環境變量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();
// 指定Bucket名稱。
String bucketName = "examplebucket";
// 如果圖片位于Bucket根目錄,則直接填寫圖片名稱。如果圖片不在Bucket根目錄,需攜帶圖片完整路徑,例如exampledir/example.jpg。
String key = "example.jpg";
// 創建OSSClient實例。
ClientBuilderConfiguration clientBuilderConfiguration = new ClientBuilderConfiguration();
clientBuilderConfiguration.setSignatureVersion(SignVersion.V4);
OSS ossClient = OSSClientBuilder.create()
.endpoint(endpoint)
.credentialsProvider(credentialsProvider)
.clientConfiguration(clientBuilderConfiguration)
.region(region)
.build();
try {
// 構建二維碼識別的處理指令。
GetObjectRequest getObjectRequest = new GetObjectRequest(bucketName, key);
getObjectRequest.setProcess("image/codes");
// 使用getObject方法,并通過process參數傳入處理指令。
OSSObject ossObject = ossClient.getObject(getObjectRequest);
// 讀取并打印信息。
ByteArrayOutputStream baos = new ByteArrayOutputStream();
byte[] buffer = new byte[1024];
int bytesRead;
while ((bytesRead = ossObject.getObjectContent().read(buffer)) != -1) {
baos.write(buffer, 0, bytesRead);
}
String imageCodes = baos.toString("UTF-8");
System.out.println("Image Codes:");
System.out.println(imageCodes);
} catch (IOException e) {
System.out.println("Error: " + e.getMessage());
} finally {
// 關閉OSSClient。
ossClient.shutdown();
}
}
}
Python
要求使用Python SDK 2.18.4及以上版本。
# -*- coding: utf-8 -*-
import oss2
from oss2.credentials import EnvironmentVariableCredentialsProvider
# 從環境變量中獲取訪問憑證。運行本代碼示例之前,請確保已設置環境變量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
auth = oss2.ProviderAuthV4(EnvironmentVariableCredentialsProvider())
# 填寫Bucket所在地域對應的Endpoint。以華東1(杭州)為例,Endpoint填寫為https://oss-cn-hangzhou.aliyuncs.com。
endpoint = 'https://oss-cn-hangzhou.aliyuncs.com'
# 填寫阿里云通用Region ID。
region = 'cn-hangzhou'
bucket = oss2.Bucket(auth, endpoint, 'examplebucket', region=region)
# 如果圖片位于Bucket根目錄,則直接填寫圖片名稱。如果圖片不在Bucket根目錄,需攜帶圖片完整路徑,例如exampledir/example.jpg。
key = 'example.jpg'
# 構建二維碼識別的處理指令。
process = 'image/codes'
try:
# 使用get_object方法,并通過process參數傳入處理指令。
result = bucket.get_object(key, process=process)
# 讀取并打印信息。
image_codes = result.read().decode('utf-8')
print("Image Codes:")
print(image_codes)
except oss2.exceptions.OssError as e:
print("Error:", e)
Go
要求使用Go SDK 3.0.2及以上版本。
package main
import (
"fmt"
"io"
"os"
"github.com/aliyun/aliyun-oss-go-sdk/oss"
)
func main() {
// 從環境變量中獲取臨時訪問憑證。運行本代碼示例之前,請確保已設置環境變量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
provider, err := oss.NewEnvironmentVariableCredentialsProvider()
if err != nil {
fmt.Println("Error:", err)
os.Exit(-1)
}
// 創建OSSClient實例。
// yourEndpoint填寫Bucket對應的Endpoint,以華東1(杭州)為例,填寫為https://oss-cn-hangzhou.aliyuncs.com。其他Region請按實際情況填寫。
// yourRegion指定阿里云通用Region ID,例如cn-hangzhou。
client, err := oss.New("https://oss-cn-hangzhou.aliyuncs.com", "", "", oss.SetCredentialsProvider(&provider), oss.AuthVersion(oss.AuthV4), oss.Region("cn-hangzhou"))
if err != nil {
fmt.Println("Error:", err)
os.Exit(-1)
}
// 指定Bucket名稱,例如examplebucket。
bucketName := "examplebucket"
bucket, err := client.Bucket(bucketName)
if err != nil {
fmt.Println("Error:", err)
os.Exit(-1)
}
// 如果圖片位于Bucket根目錄,則直接填寫圖片名稱。如果圖片不在Bucket根目錄,需攜帶圖片完整路徑,例如exampledir/example.jpg。
// 通過oss.Process方法構建二維碼識別的處理指令。
body, err := bucket.GetObject("example.jpg", oss.Process("image/codes"))
if err != nil {
fmt.Println("Error:", err)
os.Exit(-1)
}
defer body.Close()
data, err := io.ReadAll(body)
if err != nil {
fmt.Println("Error:", err)
os.Exit(-1)
}
fmt.Println("data:", string(data))
}
PHP
要求使用PHP SDK 2.7.0及以上版本。
<?php
if (is_file(__DIR__ . '/../autoload.php')) {
require_once __DIR__ . '/../autoload.php';
}
if (is_file(__DIR__ . '/../vendor/autoload.php')) {
require_once __DIR__ . '/../vendor/autoload.php';
}
use OSS\Credentials\EnvironmentVariableCredentialsProvider;
use OSS\OssClient;
try {
// 從環境變量中獲取訪問憑證。運行本代碼示例之前,請確保已設置環境變量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
$provider = new EnvironmentVariableCredentialsProvider();
// 填寫Bucket所在地域對應的Endpoint。以華東1(杭州)為例,Endpoint填寫為https://oss-cn-hangzhou.aliyuncs.com。
$endpoint = 'https://oss-cn-hangzhou.aliyuncs.com';
// 填寫Bucket名稱,例如examplebucket。
$bucket = 'examplebucket';
// 如果圖片位于Bucket根目錄,則直接填寫圖片名稱。如果圖片不在Bucket根目錄,需攜帶圖片完整路徑,例如exampledir/example.jpg。
$key = 'example.jpg';
$config = array(
"provider" => $provider,
"endpoint" => $endpoint,
"signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
// 填寫阿里云通用Region ID。
"region" => "cn-hangzhou"
);
$ossClient = new OssClient($config);
// 構建二維碼識別的處理指令。
$options[$ossClient::OSS_PROCESS] = "image/codes";
$result = $ossClient->getObject($bucket,$key,$options);
var_dump($result);
} catch (OssException $e) {
printf($e->getMessage() . "\n");
return;
}
使用REST API
如果您的程序自定義要求較高,您可以直接發起REST API請求。直接發起REST API請求需要手動編寫代碼計算簽名。關于公共請求頭Authorization的計算方法請參見簽名版本4(推薦)。
您可以通過在GetObject接口中添加x-oss-process參數的方式來處理圖片。更多信息請參見GetObject。
處理示例
GET /example.jpg?x-oss-process=image/codes HTTP/1.1
Host: image-demo.oss-cn-hangzhou.aliyuncs.com
Date: Fri, 21 Jul 2023 08:56:50 GMT
Authorization: AuthorizationValue
返回示例
HTTP/1.1 200 OK
Server: AliyunOSS
Date: Fri, 21 Jul 2023 08:56:52 GMT
Content-Type: application/json;charset=utf-8
Content-Length: 64
Connection: keep-alive
x-oss-request-id: 64BA48531253C5383707D5B3
ETag: "2CE2EA370531B7CC1D23BE6015CF5DA5"
Last-Modified: Mon, 10 Jul 2023 13:07:30 GMT
x-oss-object-type: Normal
x-oss-hash-crc64ecma: 13420962247653419692
x-oss-storage-class: Standard
x-oss-ec: 0048-00000104
Content-Disposition: attachment
x-oss-force-download: true
x-oss-server-time: 453
{
"RequestId" : "3B7BD09F-18D8-56F0-90B7-889FBD9FFF70",
"Codes": [
{
"Content": "https://www.aliyun.com/product/imm",
"Boundary": {
"Width": 741,
"Height": 706,
"Left": 460,
"Top": 295,
}
}
]
}
常見問題
OSS控制臺綁定IMM Project后,使用二維碼識別能力報錯
原因:未申請新版本IMM數據處理能力相關配額。
解決方案:您需要開啟新版本IMM數據處理能力,訪問OSS中的圖片時需進行簽名訪問。關于簽名的更多信息,請參見簽名方式。
登錄OSS管理控制臺。
在左側導航欄,選擇自助工具 > 更多工具。
在配額中心頁簽,選擇Bucket。
單擊開啟新版本 IMM Get 數據處理能力右側的配額申請。
在配額申請對話框,單擊確認調整,然后單擊確定。