Flutter联系人获取插件contact_fetcher的使用

contact_fetcher 是一个用于从移动设备获取联系人的 Flutter 插件。

开始使用

这个项目是一个 Flutter 的插件包起点，它包含适用于 Android 和/或 iOS 的平台特定实现代码。

对于如何开始 Flutter 开发的帮助，可以查看 在线文档，其中提供了教程、示例、移动开发指南以及完整的 API 参考。

完整示例代码

以下是一个完整的示例代码，展示了如何使用 contact_fetcher 插件来获取并展示联系人信息：

import 'package:contact_fetcher/contact.dart';
import 'package:contact_fetcher/contact_fetcher.dart';
import 'package:flutter/material.dart';
import 'package:flutter/services.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> {
  List<Contact> _contacts = [];
  final _contactFetcherPlugin = ContactFetcher();
  final ScrollController _controller = ScrollController();
  int _pageNumber = 0;

  [@override](/user/override)
  void initState() {
    super.initState();
    _controller.addListener(() async {
      // 滚动到底部时加载更多联系人
      if (_controller.position.pixels == _controller.position.maxScrollExtent) {
        updated();
      }
    });
    updated();
  }

  // 更新联系人列表
  updated() async {
    try {
      // 获取指定页数的联系人
      List<Contact> contacts = await _contactFetcherPlugin.getAllContact(
          limit: 10, pageNumber: _pageNumber);
      // 将新获取的联系人添加到现有列表中
      _contacts.addAll(contacts);
      _pageNumber++;
    } on PlatformException {
      // 处理异常情况
      _contacts = [];
    }
    // 更新UI
    setState(() {});
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text('联系人获取器 (${_contacts.length})')),
        body: ListView.builder(
            key: Key("keyyyy"),
            controller: _controller,
            itemCount: _contacts.length,
            itemBuilder: (BuildContext context, int index) {
              return Padding(
                padding: const EdgeInsets.all(8.0),
                child: Card(
                  child: Padding(
                    padding: const EdgeInsets.all(8.0),
                    child: Center(
                      child: Column(
                        crossAxisAlignment: CrossAxisAlignment.start,
                        children: [
                          // 显示联系人头像
                          if (_contacts[index].photo != null)
                            Image.memory(_contacts[index].photo!,
                                width: 40, height: 40),
                          // 显示联系人姓名
                          Text("姓名: ${_contacts[index].name}"),
                          // 显示联系人电话号码
                          ListView.builder(
                              physics: const NeverScrollableScrollPhysics(),
                              shrinkWrap: true,
                              itemCount: _contacts[index].phoneNumbers.length,
                              itemBuilder: (context, phoneIndex) {
                                return Padding(
                                  padding: const EdgeInsets.only(top: 8),
                                  child: Text(
                                      "电话 ${phoneIndex + 1} : ${_contacts[index].phoneNumbers[phoneIndex]}"),
                                );
                              })
                        ],
                      ),
                    ),
                  ),
                ),
              );
            }),
      ),
    );
  }
}

代码解释

1. 导入必要的库

   import 'package:contact_fetcher/contact.dart';
   import 'package:contact_fetcher/contact_fetcher.dart';
   import 'package:flutter/material.dart';
   import 'package:flutter/services.dart';
   

2. 主应用类

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

3. 状态管理类

   class _MyAppState extends State<MyApp> {
     List<Contact> _contacts = [];
     final _contactFetcherPlugin = ContactFetcher();
     final ScrollController _controller = ScrollController();
     int _pageNumber = 0;
   

4. 初始化方法

   [@override](/user/override)
   void initState() {
     super.initState();
     _controller.addListener(() async {
       if (_controller.position.pixels == _controller.position.maxScrollExtent) {
         updated();
       }
     });
     updated();
   }
   

5. 更新联系人列表的方法

   updated() async {
     try {
       List<Contact> contacts = await _contactFetcherPlugin.getAllContact(
           limit: 10, pageNumber: _pageNumber);
       _contacts.addAll(contacts);
       _pageNumber++;
     } on PlatformException {
       _contacts = [];
     }
     setState(() {});
   }
   

6. 构建UI

   [@override](/user/override)
   Widget build(BuildContext context) {
     return MaterialApp(
       home: Scaffold(
         appBar: AppBar(title: Text('联系人获取器 (${_contacts.length})')),
         body: ListView.builder(
             key: Key("keyyyy"),
             controller: _controller,
             itemCount: _contacts.length,
             itemBuilder: (BuildContext context, int index) {
               return Padding(
                 padding: const EdgeInsets.all(8.0),
                 child: Card(
                   child: Padding(
                     padding: const EdgeInsets.all(8.0),
                     child: Center(
                       child: Column(
                         crossAxisAlignment: CrossAxisAlignment.start,
                         children: [
                           if (_contacts[index].photo != null)
                             Image.memory(_contacts[index].photo!,
                                 width: 40, height: 40),
                           Text("姓名: ${_contacts[index].name}"),
                           ListView.builder(
                               physics: const NeverScrollableScrollPhysics(),
                               shrinkWrap: true,
                               itemCount: _contacts[index].phoneNumbers.length,
                               itemBuilder: (context, phoneIndex) {
                                 return Padding(
                                   padding: const EdgeInsets.only(top: 8),
                                   child: Text(
                                       "电话 ${phoneIndex + 1} : ${_contacts[index].phoneNumbers[phoneIndex]}"),
                                 );
                               })
                         ],
                       ),
                     ),
                   ),
                 ),
               );
             }),
       ),
     );
   }