MAUI 访问联系人信息,核心靠
Microsoft.Maui.ApplicationModel.Communication.Contacts命名空间提供的 API,但要注意:它不是“直接读取全部联系人”的万能接口,而是以**用户主动选择为主、平台能力为限**的设计逻辑。尤其在 Windows 上完全不支持选择联系人,iOS 和 Android 行为也有差异。
必须先配置平台权限和设置
不配好,
PickContactAsync()会静默失败或返回
null,连错误提示都不一定有。 Android:在
AndroidManifest.xml中添加权限:
<uses-permission android:name="android.permission.READ_CONTACTS"></uses-permission>;从 Android 6.0(API 23)起还需运行时请求授权(MAUI 会自动触发,但需确保用户点“允许”) iOS / Mac Catalyst:在
Info.plist中添加键
NSContactsUsageDescription,值为向用户说明“为什么需要访问通讯录”(例如:“用于邀请好友加入”),否则系统直接拒绝授权 Windows:官方明确不支持
PickContactAsync(),调用后直接返回
null,无回退方案
推荐方式:让用户手动选一个联系人
这是最稳定、兼容性最好、也最符合隐私规范的做法。调用
PickContactAsync()会唤起系统原生联系人选择器,用户点选后返回结构化数据。 代码里直接 await 调用,无需自己处理 UI 或权限弹窗(MAUI 封装了) 返回的
Contact对象包含
DisplayName、
GivenName、
FamilyName、
Phones(
List<contactphone></contactphone>)、
Emails(
List<contactemail></contactemail>)等字段 如果用户取消或没选,结果是
null,务必判空再取属性,否则崩溃 示例关键片段:
var contact = await Contacts.Default.PickContactAsync();
if (contact == null) return;
string name = contact.DisplayName;
string phone = contact.Phones.FirstOrDefault()?.Number ?? "";
谨慎使用:获取全部联系人列表
GetAllAsync()理论上可拉取全部联系人,但实际限制多、性能差、且 iOS 上默认被禁用(需额外权限+用户授权+大量字段显式声明)。 iOS 必须先通过
CNContactStore请求
.contacts权限,并在
keysToFetch显式列出要读的字段(如
CNContactGivenNameKey),否则返回空 Android 可能因联系人数量大而卡顿或 OOM,建议加限流或分页逻辑(MAUI 原生不支持分页) 返回的是
IAsyncEnumerable<contact></contact>,适合用
await foreach遍历,别直接转
List或
ToArray多数场景下,真没必要全量读——优先用“选一个”满足核心需求
常见问题与避坑点
很多人写完发现 contact 总是 null,大概率卡在这几个地方:
没在对应平台配置描述字段(iOS 的NSContactsUsageDescription缺失或为空) Android 用户首次运行时点了“拒绝”,之后 MAUI 不再弹窗,需引导用户去系统设置里手动开启权限 误以为
GetAllAsync()在所有平台都可用,其实 Windows 完全不支持,iOS 默认只返回空集合 在非主线程(比如后台任务)中调用 UI 相关 API,导致异常或无响应 没检查
contact.Phones或
contact.Emails是否为空就直接取
[0],引发
IndexOutOfRangeException
基本上就这些。用好
PickContactAsync()+ 做好平台适配,就能覆盖绝大多数联系人交互场景,不复杂但容易忽略细节。
