Flutter访问联系人插件access_contacts的使用

使用说明

access_contacts 是一个用于访问和管理设备联系人的 Flutter 插件。通过该插件，您可以轻松地获取设备上的联系人信息，并实现添加新联系人的功能。

安装与配置

1. 在 pubspec.yaml 文件中添加依赖：

   dependencies:
     access_contacts: ^版本号
   

2. 运行以下命令以安装依赖：

   flutter pub get
   

3. 确保在 Android 和 iOS 平台上正确配置权限：

   • Android：在 AndroidManifest.xml 中添加读取联系人的权限：

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

   • iOS：在 Info.plist 中添加隐私权限描述：

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

示例代码

以下是一个完整的示例代码，展示如何使用 access_contacts 插件访问和管理联系人。

示例代码

import 'package:flutter/material.dart';
import 'dart:async';

import 'package:flutter/services.dart';
import 'package:access_contacts/access_contacts.dart';

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

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

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

class _MyAppState extends State<MyApp> {
  String _platformVersion = 'Unknown';
  final _accessContactsPlugin = AccessContacts();

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

  // 初始化平台状态
  Future<void> initPlatformState() async {
    String platformVersion;
    try {
      platformVersion = await _accessContactsPlugin.getPlatformVersion() ?? 'Unknown platform version';
    } on PlatformException {
      platformVersion = 'Failed to get platform version.';
    }

    if (!mounted) return;

    setState(() {
      _platformVersion = platformVersion;
    });
  }

  // 获取联系人列表
  Future<List<Map<String, String>>> getContacts() async {
    List<Map<String, String>> contactList = await _accessContactsPlugin.getAllCotntacts();
    return contactList;
  }

  // 添加新联系人
  Future<void> addNewContact() async {
    var addContact = await _accessContactsPlugin.addNewContact();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          backgroundColor: Colors.transparent,
          leading: IconButton(
            icon: const Icon(Icons.arrow_back, color: Colors.white,),
            onPressed: () => Navigator.of(context).pop(),
          ),
          actions: [
            IconButton(
              onPressed: () {
                getContacts();
                setState(() {});
              },
              icon: const Icon(Icons.refresh)
            )
          ],
        ),
        floatingActionButton: FloatingActionButton.extended(
          onPressed: () => addNewContact(),
          label: const Text('Add New Contact'),
          icon: const Icon(Icons.add),
          backgroundColor: Colors.yellow[800],
        ),
        body: FutureBuilder(
          builder: (context, snapshot) {
            if (snapshot.connectionState == ConnectionState.active && !snapshot.hasData) {
              return Center(
                child: Text("Loading contacts"),
              );
            }
            if (snapshot.connectionState == ConnectionState.done && snapshot.hasError) {
              return Center(
                child: Text("Error"),
              );
            }
            return ListView.builder(
              itemCount: snapshot.data?.length,
              itemBuilder: (context, index) {
                return Container(
                  decoration: BoxDecoration(
                      border: Border.all(color: Colors.grey, width: 1)),
                  margin: EdgeInsets.all(5),
                  padding: EdgeInsets.all(10),
                  child: Column(
                    crossAxisAlignment: CrossAxisAlignment.start,
                    children: <Widget>[
                      Text(snapshot.data![index]["name"]!),
                      SizedBox(height: 5),
                      Text(snapshot.data![index]["phone"]!),
                    ],
                  ),
                );
              },
            );
          },
          future: getContacts(),
        ),
      ),
    );
  }
}