Flutter原生联系人选择插件flutter_native_contact_picker的使用

flutter_native_contact_picker简介

flutter_native_contact_picker 是一个Flutter插件，允许应用请求用户从其通讯录中选择联系人或多个联系人，并可以选择特定的电话号码。所选联系人的信息将返回给应用程序。

该插件使用操作系统原生的UI来选择联系人，不需要用户授予特殊的权限，即使是在Android上也无需READ_CONTACTS权限。

功能特性

iOS支持

• 选择单个联系人
• 选择多个联系人
• 从联系人中选择特定电话号码
• 返回所有选定联系人的电话号码

Android支持

• 选择单个联系人
• 从联系人中选择特定电话号码（仅返回选定号码）
• 不需要READ_CONTACTS权限

使用方法

基本联系人选

// 创建选择器实例
final FlutterNativeContactPicker _contactPicker = FlutterNativeContactPicker();

// 选择单个联系人
Contact? contact = await _contactPicker.selectContact();
print(contact?.fullName);
print(contact?.phoneNumbers);

// 选择多个联系人 (仅iOS支持)
List<Contact>? contacts = await _contactPicker.selectContacts();
for (var contact in contacts ?? []) {
  print(contact.fullName);
  print(contact.phoneNumbers);
}

电话号码选择

// 选择特定电话号码
Contact? contact = await _contactPicker.selectPhoneNumber();
print(contact?.fullName);
print(contact?.selectedPhoneNumber); // 特定选择的号码
print(contact?.phoneNumbers); // 所有可用号码 (仅iOS)

Contact模型

Contact类提供了以下属性：

class Contact {
  final String? fullName;           // 联系人的全名
  final List<String>? phoneNumbers; // 所有电话号码 (iOS: 所有号码, Android: 仅选定号码)
  final String? selectedPhoneNumber; // 使用selectPhoneNumber()时特别选定的电话号码
}

平台差异

iOS

• 支持选择多个联系人
• 返回与联系人关联的所有电话号码
• 使用selectPhoneNumber()时，返回选定号码和所有可用号码
• 使用原生CNContactPickerViewController

Android

• 仅支持单个联系人选择
• 使用selectPhoneNumber()时，仅返回选定的电话号码
• 不需要READ_CONTACTS权限
• 使用原生联系人选择Intent

示例代码

以下是完整的示例demo，演示了如何在Flutter应用中使用flutter_native_contact_picker插件：

import 'package:flutter/material.dart';
import 'package:flutter_native_contact_picker/flutter_native_contact_picker.dart';
import 'package:flutter_native_contact_picker/model/contact.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatefulWidget {
  const MyApp({super.key});

  @override
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  final FlutterNativeContactPicker _contactPicker =
      FlutterNativeContactPicker();
  List<Contact>? _contacts;
  String? _selectedPhoneNumber;

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Contact Picker Example App'),
        ),
        body: Center(
          child: Column(
            mainAxisSize: MainAxisSize.min,
            children: <Widget>[
              const Text(
                'Contact Selection',
                style: TextStyle(fontSize: 18, fontWeight: FontWeight.bold),
              ),
              const SizedBox(height: 8),
              Row(
                mainAxisAlignment: MainAxisAlignment.center,
                children: [
                  MaterialButton(
                    color: Colors.blue,
                    textColor: Colors.white,
                    child: const Text("Single Contact"),
                    onPressed: () async {
                      Contact? contact = await _contactPicker.selectContact();
                      setState(() {
                        _contacts = contact == null ? null : [contact];
                        _selectedPhoneNumber = null;
                      });
                    },
                  ),
                  const SizedBox(width: 8),
                  MaterialButton(
                    color: Colors.blue,
                    textColor: Colors.white,
                    child: const Text("Multiple Contacts"),
                    onPressed: () async {
                      final contacts = await _contactPicker.selectContacts();
                      setState(() {
                        _contacts = contacts;
                        _selectedPhoneNumber = null;
                      });
                    },
                  ),
                ],
              ),
              const SizedBox(height: 16),
              const Text(
                'Phone Number Selection',
                style: TextStyle(fontSize: 18, fontWeight: FontWeight.bold),
              ),
              const SizedBox(height: 8),
              MaterialButton(
                color: Colors.green,
                textColor: Colors.white,
                child: const Text("Select Phone Number"),
                onPressed: () async {
                  Contact? contact = await _contactPicker.selectPhoneNumber();
                  setState(() {
                    _contacts = contact == null ? null : [contact];
                    _selectedPhoneNumber = contact?.selectedPhoneNumber;
                  });
                },
              ),
              const SizedBox(height: 24),
              if (_contacts != null) ...[
                const Text(
                  'Selected Contact(s):',
                  style: TextStyle(fontSize: 16, fontWeight: FontWeight.w500),
                ),
                const SizedBox(height: 8),
                ..._contacts!.map(
                  (contact) => Padding(
                    padding: const EdgeInsets.symmetric(vertical: 4),
                    child: Column(
                      crossAxisAlignment: CrossAxisAlignment.center,
                      children: [
                        Text(
                          contact.fullName ?? 'No name',
                          style: const TextStyle(fontWeight: FontWeight.w500),
                        ),
                        if (_selectedPhoneNumber != null)
                          Text(
                            'Selected number: $_selectedPhoneNumber',
                            style: const TextStyle(color: Colors.green),
                          ),
                        ...?contact.phoneNumbers?.map(
                          (number) => Text(
                            number,
                            style: TextStyle(
                              color: number == _selectedPhoneNumber
                                  ? Colors.green
                                  : Colors.black54,
                            ),
                          ),
                        ),
                        const SizedBox(height: 8),
                      ],
                    ),
                  ),
                ),
              ],
            ],
          ),
        ),
      ),
    );
  }
}

此示例展示了如何创建一个简单的Flutter应用，其中包含选择单个联系人、多个联系人以及选择特定电话号码的功能。希望这个例子能帮助您更好地理解和使用flutter_native_contact_picker插件。