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

contacts_helper 是一个用于在 Flutter 应用中访问和管理设备联系人的插件。它允许你读取、添加、更新和删除联系人信息。以下是如何使用 contacts_helper 插件的基本步骤：

1. 添加依赖

首先，在 pubspec.yaml 文件中添加 contacts_helper 依赖：

dependencies:
  flutter:
    sdk: flutter
  contacts_helper: ^0.1.0

然后运行 flutter pub get 以安装依赖。

2. 请求权限

在 Android 和 iOS 上，访问联系人需要用户授权。在 Android 上，你需要在 AndroidManifest.xml 中添加以下权限：

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

在 iOS 上，你需要在 Info.plist 中添加以下权限：

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

然后，在 Dart 代码中请求权限：

import 'package:permission_handler/permission_handler.dart';

Future<void> requestContactsPermission() async {
  if (await Permission.contacts.request().isGranted) {
    // 权限已授予
  } else {
    // 权限被拒绝
  }
}

3. 读取联系人

使用 contacts_helper 读取联系人非常简单。以下是一个读取所有联系人的示例：

import 'package:contacts_helper/contacts_helper.dart';

Future<void> fetchContacts() async {
  List<Contact> contacts = await ContactsHelper.getContacts();
  for (var contact in contacts) {
    print('Name: ${contact.displayName}');
    print('Phone: ${contact.phones}');
    print('Email: ${contact.emails}');
  }
}

4. 添加联系人

你可以使用 ContactsHelper 来添加新的联系人：

Future<void> addContact() async {
  Contact newContact = Contact(
    displayName: 'John Doe',
    phones: [Item(label: 'Mobile', value: '1234567890')],
    emails: [Item(label: 'Work', value: 'john.doe@example.com')],
  );

  await ContactsHelper.addContact(newContact);
}

5. 更新联系人

更新联系人需要先获取联系人的 ID，然后使用 ContactsHelper.updateContact 方法：

Future<void> updateContact(Contact contact) async {
  contact.displayName = 'Jane Doe';
  await ContactsHelper.updateContact(contact);
}

6. 删除联系人

删除联系人同样需要先获取联系人的 ID，然后使用 ContactsHelper.deleteContact 方法：

Future<void> deleteContact(Contact contact) async {
  await ContactsHelper.deleteContact(contact);
}

7. 监听联系人变化

你可以监听联系人数据库的变化：

void listenToContactsChanges() {
  ContactsHelper.onContactsChanged.listen((event) {
    print('Contacts changed: $event');
  });
}

8. 处理异常

在实际应用中，你可能需要处理各种异常情况，例如权限被拒绝或操作失败：

try {
  List<Contact> contacts = await ContactsHelper.getContacts();
} catch (e) {
  print('Failed to fetch contacts: $e');
}

9. 完整示例

以下是一个完整的示例，展示了如何读取、添加、更新和删除联系人：

import 'package:flutter/material.dart';
import 'package:contacts_helper/contacts_helper.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();
    requestContactsPermission();
    fetchContacts();
    listenToContactsChanges();
  }

  Future<void> requestContactsPermission() async {
    if (await Permission.contacts.request().isGranted) {
      fetchContacts();
    } else {
      print('Contacts permission denied');
    }
  }

  Future<void> fetchContacts() async {
    try {
      List<Contact> fetchedContacts = await ContactsHelper.getContacts();
      setState(() {
        contacts = fetchedContacts;
      });
    } catch (e) {
      print('Failed to fetch contacts: $e');
    }
  }

  Future<void> addContact() async {
    Contact newContact = Contact(
      displayName: 'John Doe',
      phones: [Item(label: 'Mobile', value: '1234567890')],
      emails: [Item(label: 'Work', value: 'john.doe@example.com')],
    );

    await ContactsHelper.addContact(newContact);
    fetchContacts();
  }

  Future<void> updateContact(Contact contact) async {
    contact.displayName = 'Jane Doe';
    await ContactsHelper.updateContact(contact);
    fetchContacts();
  }

  Future<void> deleteContact(Contact contact) async {
    await ContactsHelper.deleteContact(contact);
    fetchContacts();
  }

  void listenToContactsChanges() {
    ContactsHelper.onContactsChanged.listen((event) {
      print('Contacts changed: $event');
      fetchContacts();
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Contacts Helper Example'),
      ),
      body: ListView.builder(
        itemCount: contacts.length,
        itemBuilder: (context, index) {
          Contact contact = contacts[index];
          return ListTile(
            title: Text(contact.displayName ?? 'No Name'),
            subtitle: Text(contact.phones?.first.value ?? 'No Phone'),
            trailing: Row(
              mainAxisSize: MainAxisSize.min,
              children: [
                IconButton(
                  icon: Icon(Icons.edit),
                  onPressed: () => updateContact(contact),
                ),
                IconButton(
                  icon: Icon(Icons.delete),
                  onPressed: () => deleteContact(contact),
                ),
              ],
            ),
          );
        },
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: addContact,
        child: Icon(Icons.add),
      ),
    );
  }
}