Flutter二维码扫描插件barcode_scan3的使用

简介

barcode_scan3 是一个用于扫描二维条形码和QR码的Flutter插件。它封装了两个常用的iOS和Android库：

• iOS: MTBBarcodeScanner
• Android: barcodescanner

此插件支持以下功能：

• 扫描二维条形码
• 扫描QR码
• 控制闪光灯
• 权限处理

使用步骤

Android 配置

在使用插件之前，需要在 AndroidManifest.xml 文件中添加相机权限：

<uses-permission android:name="android.permission.CAMERA" />

此外，此插件使用Kotlin编写，因此需要为项目添加Kotlin支持。编辑项目级别的 build.gradle 文件：

buildscript {
    ext.kotlin_version = '1.3.61'
    // ...
    dependencies {
        // ...
        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
    }
}
// ...

然后编辑应用级别的 build.gradle 文件：

apply plugin: 'kotlin-android'
// ...
dependencies {
    implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
    // ...
}

最后，在 pubspec.yaml 文件中添加依赖：

dependencies:
    # ...
    barcode_scan3: any

运行 flutter packages get 或点击Android Studio中的“Packages get”。

iOS 配置

在iOS上使用时，需要在 Info.plist 文件中添加相机使用描述：

<key>NSCameraUsageDescription</key>
<string>Camera permission is required for barcode scanning.</string>

基本用法

以下是一个简单的示例，展示如何使用 barcode_scan3 插件进行二维码扫描：

import 'package:barcode_scan3/barcode_scan3.dart';

void main() async {
  var result = await BarcodeScanner.scan();

  print(result.type); // 结果类型（barcode, cancelled, failed）
  print(result.rawContent); // 二维码内容
  print(result.format); // 二维码格式（枚举）
  print(result.formatNote); // 如果扫描到未知格式，则包含说明
}

高级用法

可以传递选项来定制扫描行为：

import 'package:barcode_scan3/barcode_scan3.dart';

void main() async {
  var options = ScanOptions(
    strings: {
      'cancel': '取消',
      'flash_on': '打开闪光灯',
      'flash_off': '关闭闪光灯',
    },
    restrictFormat: [BarcodeFormat.qr], // 限制识别的格式
    useCamera: 0, // 使用默认摄像头
    autoEnableFlash: true, // 启动扫描时开启闪光灯
    android: AndroidOptions(
      aspectTolerance: 0.5, // 设置宽容度
      useAutoFocus: true, // 启用自动对焦
    ),
  );

  var result = await BarcodeScanner.scan(options: options);

  // 处理扫描结果
}

支持的选项

以下是 ScanOptions 中支持的选项及其说明：

示例代码

以下是一个完整的示例代码，展示了如何实现一个带有自定义选项的二维码扫描界面：

import 'dart:async';
import 'dart:io' show Platform;

import 'package:barcode_scan3/barcode_scan3.dart';
import 'package:flutter/material.dart';
import 'package:flutter/services.dart';

void main() => runApp(const App());

class App extends StatefulWidget {
  const App({Key? key}) : super(key: key);
  [@override](/user/override)
  _AppState createState() => _AppState();
}

class _AppState extends State<App> {
  ScanResult? scanResult;

  final _flashOnController = TextEditingController(text: '打开闪光灯');
  final _flashOffController = TextEditingController(text: '关闭闪光灯');
  final _cancelController = TextEditingController(text: '取消');

  var _aspectTolerance = 0.00;
  var _numberOfCameras = 0;
  var _selectedCamera = -1;
  var _useAutoFocus = true;
  var _autoEnableFlash = false;

  static final _possibleFormats = BarcodeFormat.values.toList()
    ..removeWhere((e) => e == BarcodeFormat.unknown);

  List<BarcodeFormat> selectedFormats = [..._possibleFormats];

  [@override](/user/override)
  void initState() {
    super.initState();

    Future.delayed(Duration.zero, () async {
      _numberOfCameras = await BarcodeScanner.numberOfCameras;
      setState(() {});
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    final scanResult = this.scanResult;
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('二维码扫描示例'),
          actions: [
            IconButton(
              icon: const Icon(Icons.camera),
              tooltip: '扫描',
              onPressed: _scan,
            )
          ],
        ),
        body: ListView(
          scrollDirection: Axis.vertical,
          shrinkWrap: true,
          children: <Widget>[
            if (scanResult != null)
              Card(
                child: Column(
                  children: <Widget>[
                    ListTile(
                      title: const Text('结果类型'),
                      subtitle: Text(scanResult.type.toString()),
                    ),
                    ListTile(
                      title: const Text('原始内容'),
                      subtitle: Text(scanResult.rawContent),
                    ),
                    ListTile(
                      title: const Text('格式'),
                      subtitle: Text(scanResult.format.toString()),
                    ),
                    ListTile(
                      title: const Text('格式说明'),
                      subtitle: Text(scanResult.formatNote),
                    ),
                  ],
                ),
              ),
            const ListTile(
              title: Text('摄像头选择'),
              dense: true,
              enabled: false,
            ),
            RadioListTile(
              onChanged: (v) => setState(() => _selectedCamera = -1),
              value: -1,
              title: const Text('默认摄像头'),
              groupValue: _selectedCamera,
            ),
            ...List.generate(
              _numberOfCameras,
              (i) => RadioListTile(
                onChanged: (v) => setState(() => _selectedCamera = i),
                value: i,
                title: Text('摄像头 ${i + 1}'),
                groupValue: _selectedCamera,
              ),
            ),
            const ListTile(
              title: Text('按钮文本'),
              dense: true,
              enabled: false,
            ),
            ListTile(
              title: TextField(
                decoration: const InputDecoration(
                  floatingLabelBehavior: FloatingLabelBehavior.always,
                  labelText: '闪光灯开启',
                ),
                controller: _flashOnController,
              ),
            ),
            ListTile(
              title: TextField(
                decoration: const InputDecoration(
                  floatingLabelBehavior: FloatingLabelBehavior.always,
                  labelText: '闪光灯关闭',
                ),
                controller: _flashOffController,
              ),
            ),
            ListTile(
              title: TextField(
                decoration: const InputDecoration(
                  floatingLabelBehavior: FloatingLabelBehavior.always,
                  labelText: '取消',
                ),
                controller: _cancelController,
              ),
            ),
            if (Platform.isAndroid) ...[
              const ListTile(
                title: Text('Android特定选项'),
                dense: true,
                enabled: false,
              ),
              ListTile(
                title: Text(
                  '宽容度 (${_aspectTolerance.toStringAsFixed(2)})',
                ),
                subtitle: Slider(
                  min: -1,
                  max: 1,
                  value: _aspectTolerance,
                  onChanged: (value) {
                    setState(() {
                      _aspectTolerance = value;
                    });
                  },
                ),
              ),
              CheckboxListTile(
                title: const Text('启用自动对焦'),
                value: _useAutoFocus,
                onChanged: (checked) {
                  setState(() {
                    _useAutoFocus = checked!;
                  });
                },
              ),
            ],
            const ListTile(
              title: Text('其他选项'),
              dense: true,
              enabled: false,
            ),
            CheckboxListTile(
              title: const Text('启动时开启闪光灯'),
              value: _autoEnableFlash,
              onChanged: (checked) {
                setState(() {
                  _autoEnableFlash = checked!;
                });
              },
            ),
            const ListTile(
              title: Text('条形码格式'),
              dense: true,
              enabled: false,
            ),
            ListTile(
              trailing: Checkbox(
                tristate: true,
                materialTapTargetSize: MaterialTapTargetSize.shrinkWrap,
                value: selectedFormats.length == _possibleFormats.length
                    ? true
                    : selectedFormats.isEmpty
                        ? false
                        : null,
                onChanged: (checked) {
                  setState(() {
                    selectedFormats = [
                      if (checked ?? false) ..._possibleFormats,
                    ];
                  });
                },
              ),
              dense: true,
              enabled: false,
              title: const Text('检测条形码格式'),
              subtitle: const Text(
                '如果全部未选中，则会使用所有可能的平台格式',
              ),
            ),
            ..._possibleFormats.map(
              (format) => CheckboxListTile(
                value: selectedFormats.contains(format),
                onChanged: (i) {
                  setState(() =>
                      selectedFormats.contains(format)
                          ? selectedFormats.remove(format)
                          : selectedFormats.add(format));
                },
                title: Text(format.toString()),
              ),
            ),
          ],
        ),
      ),
    );
  }

  Future<void> _scan() async {
    try {
      final result = await BarcodeScanner.scan(
        options: ScanOptions(
          strings: {
            'cancel': _cancelController.text,
            'flash_on': _flashOnController.text,
            'flash_off': _flashOffController.text,
          },
          restrictFormat: selectedFormats,
          useCamera: _selectedCamera,
          autoEnableFlash: _autoEnableFlash,
          android: AndroidOptions(
            aspectTolerance: _aspectTolerance,
            useAutoFocus: _useAutoFocus,
          ),
        ),
      );
      setState(() => scanResult = result);
    } on PlatformException catch (e) {
      setState(() {
        scanResult = ScanResult(
          type: ResultType.Error,
          format: BarcodeFormat.unknown,
          rawContent: e.code == BarcodeScanner.cameraAccessDenied
              ? '用户未授予相机权限！'
              : '未知错误: $e',
        );
      });
    }
  }
}