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

contacts_provider 是一个用于在 Flutter 应用中管理和访问设备联系人信息的插件。它提供了简单的 API，允许开发者读取、添加、更新和删除联系人信息。以下是如何使用 contacts_provider 插件的基本步骤。

1. 添加依赖

首先，你需要在 pubspec.yaml 文件中添加 contacts_provider 插件的依赖。

dependencies:
  flutter:
    sdk: flutter
  contacts_provider: ^0.1.0  # 请使用最新版本

然后运行 flutter pub get 来获取依赖。

2. 请求权限

在访问联系人信息之前，你需要在 AndroidManifest.xml 和 Info.plist 文件中添加相应的权限声明。

Android:

在 android/app/src/main/AndroidManifest.xml 中添加以下权限：

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

iOS:

在 ios/Runner/Info.plist 中添加以下键值对：

<key>NSContactsUsageDescription</key>
<string>我们需要访问您的联系人以便管理联系人信息</string>

3. 使用 contacts_provider

接下来，你可以在 Flutter 代码中使用 contacts_provider 来管理联系人。

获取联系人列表

import 'package:contacts_provider/contacts_provider.dart';

Future<void> getContacts() async {
  // 请求权限
  bool hasPermission = await ContactsProvider.requestPermission();
  if (!hasPermission) {
    print('Permission denied');
    return;
  }

  // 获取联系人列表
  List<Contact> contacts = await ContactsProvider.getContacts();
  for (var contact in contacts) {
    print('Contact: ${contact.displayName}, Phone: ${contact.phones.first}');
  }
}

添加联系人

Future<void> addContact() async {
  bool hasPermission = await ContactsProvider.requestPermission();
  if (!hasPermission) {
    print('Permission denied');
    return;
  }

  Contact newContact = Contact(
    displayName: 'John Doe',
    phones: [Phone(number: '1234567890')],
  );

  await ContactsProvider.addContact(newContact);
  print('Contact added successfully');
}

更新联系人

Future<void> updateContact() async {
  bool hasPermission = await ContactsProvider.requestPermission();
  if (!hasPermission) {
    print('Permission denied');
    return;
  }

  // 首先获取联系人列表
  List<Contact> contacts = await ContactsProvider.getContacts();
  if (contacts.isNotEmpty) {
    Contact contactToUpdate = contacts.first;
    contactToUpdate.displayName = 'Jane Doe';

    await ContactsProvider.updateContact(contactToUpdate);
    print('Contact updated successfully');
  }
}

删除联系人

Future<void> deleteContact() async {
  bool hasPermission = await ContactsProvider.requestPermission();
  if (!hasPermission) {
    print('Permission denied');
    return;
  }

  // 首先获取联系人列表
  List<Contact> contacts = await ContactsProvider.getContacts();
  if (contacts.isNotEmpty) {
    Contact contactToDelete = contacts.first;

    await ContactsProvider.deleteContact(contactToDelete);
    print('Contact deleted successfully');
  }
}

4. 处理权限请求

在 Android 和 iOS 上，访问联系人需要用户授权。你可以使用 permission_handler 插件来请求和管理权限。

import 'package:permission_handler/permission_handler.dart';

Future<void> checkPermissions() async {
  var status = await Permission.contacts.status;
  if (!status.isGranted) {
    await Permission.contacts.request();
  }
}

5. 完整示例

import 'package:flutter/material.dart';
import 'package:contacts_provider/contacts_provider.dart';
import 'package:permission_handler/permission_handler.dart';

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

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: ContactsScreen(),
    );
  }
}

class ContactsScreen extends StatefulWidget {
  [@override](/user/override)
  _ContactsScreenState createState() => _ContactsScreenState();
}

class _ContactsScreenState extends State<ContactsScreen> {
  List<Contact> contacts = [];

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

  Future<void> getContacts() async {
    var status = await Permission.contacts.status;
    if (!status.isGranted) {
      await Permission.contacts.request();
    }

    if (status.isGranted) {
      List<Contact> fetchedContacts = await ContactsProvider.getContacts();
      setState(() {
        contacts = fetchedContacts;
      });
    }
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Contacts'),
      ),
      body: ListView.builder(
        itemCount: contacts.length,
        itemBuilder: (context, index) {
          return ListTile(
            title: Text(contacts[index].displayName ?? 'No Name'),
            subtitle: Text(contacts[index].phones.isNotEmpty ? contacts[index].phones.first.number : 'No Phone'),
          );
        },
      ),
    );
  }
}