Flutter联系人管理插件contacts_flutter的使用

contacts_flutter 是一个用于在 Flutter 应用中访问设备联系人的插件。本文将介绍如何使用该插件来获取和展示联系人信息。

获取开始

首先，确保您的项目已经配置好 contacts_flutter 插件。您可以使用以下命令将其添加到项目的依赖项中：

flutter pub add contacts_flutter

iOS 配置

在 iOS 平台上，您需要在 Info.plist 文件中添加权限描述，以便请求访问联系人列表的权限。

在 ios/Runner/Info.plist 文件中添加以下内容：

<key>NSContactsUsageDescription</key>
<string>我们需要访问联系人列表的原因</string>

使用示例

下面是一个完整的示例代码，展示如何使用 contacts_flutter 插件来获取和展示联系人信息。

示例代码

import 'package:flutter/material.dart';
import 'package:contacts_flutter/contacts_flutter.dart'; // 引入插件

void main() {
  runApp(const MaterialApp(home: MyApp()));
}

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

  [@override](/user/override)
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  List<ContactModel> list = []; // 存储联系人数据

  // 显示联系人对话框
  void showDialogContacts(BuildContext context) {
    showDialog<void>(
      context: context,
      builder: (context) => Material(
        child: Center(
          child: ListView(
            children: [
              for (final contact in list) // 遍历联系人列表
                Padding(
                  padding: const EdgeInsets.all(8.0),
                  child: Container(
                    padding: const EdgeInsets.all(2),
                    decoration: BoxDecoration(
                      border: Border.all(
                        color: Colors.black,
                      ),
                    ),
                    child: Text(
                      '姓名: ${contact.name}\n 电话: ${contact.phone}',
                      style: const TextStyle(
                        fontSize: 12,
                        color: Colors.black,
                      ),
                    ),
                  ),
                )
            ],
          ),
        ),
      ),
    );
  }

  // 检查权限并获取联系人
  void onTap(BuildContext context) {
    checkPermission(() => showDialogContacts(context)); // 请求权限后显示联系人
  }

  // 请求权限
  void requestPer(VoidCallback callback) async {
    final request = await ContactsFlutter.instance.requestPermission(); // 请求权限
    if (request) {
      readContact(callback); // 如果权限被授予，则读取联系人
    }
  }

  // 检查权限状态
  void checkPermission(VoidCallback callback) async {
    final checkPermission = await ContactsFlutter.instance.checkPermission(); // 检查权限
    if (checkPermission) {
      readContact(callback); // 如果已有权限，则直接读取联系人
    } else {
      requestPer(callback); // 否则请求权限
    }
  }

  // 读取联系人
  void readContact(VoidCallback callback) async {
    final data = await ContactsFlutter.instance.getContacts(); // 获取联系人数据
    setState(() => list = data); // 更新 UI
    callback.call();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('联系人管理示例'), // 设置应用标题
        ),
        body: Center(
          child: ElevatedButton(
            onPressed: () => onTap(context), // 点击按钮触发操作
            child: const Text('获取联系人数据'), // 按钮文字
          ),
        ),
      ),
    );
  }
}