uni.scanCode(options?) GitCode GitHub

扫码（包括一维码和二维码）

scanCode 兼容性

Web	微信小程序	Android	iOS	iOS uni-app x UTS 插件	HarmonyOS
x	4.41	4.71	4.71	4.71	4.61

参数

名称	类型	必填	默认值	兼容性	描述
options	ScanCodeOptions	否	-	Web 微信小程序 Android iOS HarmonyOS x - - - -	uni.scanCode参数定义
名称 类型 必备 默认值 兼容性 描述 onlyFromCamera boolean 否 - Web 微信小程序 Android iOS HarmonyOS x 4.41 - - - 是否只能从相机扫码，不允许从相册选择图片 scanType Array<string> 否 - Web 微信小程序 Android iOS HarmonyOS x 4.41 - - - 扫码类型 合法值 兼容性 描述 barCode Web 微信小程序 Android iOS HarmonyOS x - - - - - qrCode Web 微信小程序 Android iOS HarmonyOS x - - - - - datamatrix Web 微信小程序 Android iOS HarmonyOS x - - - - - pdf417 Web 微信小程序 Android iOS HarmonyOS x - - - - - success (res: ScanCodeSuccess) => void 否 - Web 微信小程序 Android iOS HarmonyOS x 4.41 - - - uni.scanCode成功回调函数定义 fail (res: ScanCodeFail) => void 否 - Web 微信小程序 Android iOS HarmonyOS x 4.41 - - - uni.scanCode失败回调函数定义 complete (res: any) => void 否 - Web 微信小程序 Android iOS HarmonyOS x 4.41 - - - uni.scanCode完成回调函数定义

ScanCodeSuccess 的属性值

名称	类型	必备	默认值	兼容性	描述
result	string	是	-	Web 微信小程序 Android iOS HarmonyOS x - - - -
scanType	string	是	-	Web 微信小程序 Android iOS HarmonyOS x - - - -
charSet	string	否	-	Web 微信小程序 Android iOS HarmonyOS x 4.41 - - -	所扫码的字符集
path	string	否	-	Web 微信小程序 Android iOS HarmonyOS x 4.41 - - -	当所扫的码为当前小程序二维码时，会返回此字段，内容为二维码携带的 path
rawData	string	否	-	Web 微信小程序 Android iOS HarmonyOS x 4.41 - - -	原始数据，base64编码

示例

示例为 alpha 分支：hello uni-app x（alpha）

master 分支：hello uni-app x（master）

该 API 不支持 Web，请运行 hello uni-app x 到 App 平台体验

扫码体验（手机浏览器跳转到App直达页）

扫码体验

<template>
	<view>
		<page-head :title="title"></page-head>
		<view class="uni-padding-wrap uni-common-mt">
			<view class="uni-title">扫码结果：</view>
			<view v-if="result" class="scan-result">
				{{result}}
			</view>
			<view class="uni-btn-v">
				<button type="primary" @click="scan">扫一扫</button>
			</view>
		</view>
	</view>
</template>
<script lang="uts">
	export default {
		data() {
			return {
				title: 'scanCode',
				result: ''
			}
		},
		methods: {
			scan() {
				uni.scanCode({
					success: (res: ScanCodeSuccess) => {
            console.log('res: ',res);
						this.result = res.result
					},
					fail: (err: ScanCodeFail) => {
            console.log('err: ',err);
						// 需要注意的是小程序扫码不需要申请相机权限
					}
				});
			}
		}
	}
</script>

<style>
	.scan-result {
		min-height: 25px;
		line-height: 25px;
	}
</style>

参见

• 相关 Bug
• 微信小程序文档
• 支付宝小程序文档
• 百度小程序文档
• 抖音小程序文档
• 飞书小程序文档
• 钉钉小程序文档
• QQ小程序文档
• 快手小程序文档
• 京东小程序文档
• 华为快应用文档
• 360小程序文档

通用类型

GeneralCallbackResult

名称	类型	必备	默认值	兼容性	描述
errMsg	string	是	-	Web 微信小程序 Android iOS HarmonyOS - 4.41 - - -	错误信息

平台实现说明

• uni-app x的Android/iOS平台的扫码基于Google的机器学习库，对各种一维、二维码都有较好的识别效果。超过了uni-app的扫码。 扫码API，其实是一个开源的uvue页面，页面中内嵌了camera组件，camera组件提供扫码模式。源码在文档上方点击右侧gitcode或github。
  如需连续扫码，推荐使用camera组件
• 鸿蒙、小程序直接调用了其平台提供的扫码API，UI不可自定义。但各种一维、二维码均可识别。

依赖库版本

Android端实现扫码所使用的依赖库

"androidx.camera:camera-core:1.4.1",
"com.google.mlkit:barcode-scanning:17.2.0",
"com.github.albfernandez:juniversalchardet:2.0.4"

iOS端实现扫码所使用的依赖库

pod 'GoogleMLKit/BarcodeScanning', '6.0.0'