XuqmGroup-Web/docs-site/docs/flutter/setup.md
XuqmGroup bb52b8e0b7 docs: 更新文档站各平台集成指南(BugCollect/配置文件/setUserInfo)
- android/setup.md: 新增 sdk-bugcollect、配置文件、BugCollect 章节
- ios/setup.md: 新增配置文件章节、setUserInfo
- rn/setup.md: withXuqmConfig Metro 插件、@xuqm/rn-bugcollect
- flutter/setup.md: 新增配置文件章节
- harmony/setup.md: 新增配置文件章节
- guide/quickstart.md: 更新配置文件获取流程
- guide/concepts.md: 新增 BugCollect 服务概念
- guide/flow.md: 更新服务流程

Co-Authored-By: Claude <noreply@anthropic.com>
2026-06-18 15:35:13 +08:00

2.2 KiB

Flutter 安装配置

包名xuqm_flutter_sdk · 版本0.2.x · 语言Dart


安装

SDK 通过 Gitea Git 仓库发布,在 pubspec.yaml 中配置:

dependencies:
  xuqm_flutter_sdk:
    git:
      url: https://xuqinmin.com/xuqmGroup/XuqmGroup-FlutterSDK.git
      ref: v0.2.2

Gitea Package Registry 暂不支持 Dart/Flutter 包格式,因此通过 Git Tag 方式发布。


模块说明

模块 功能
xuqm_flutter_common packages/common 初始化、网络、配置管理
xuqm_flutter_im packages/im 单聊、群聊、消息收发、会话、好友、群组
xuqm_flutter_push packages/push 设备 Token 注册、厂商检测Android/ APNsiOS
xuqm_flutter_update packages/update App 版本检查、商店跳转、APK 下载Android
xuqm_flutter_license packages/license 设备授权注册与验证License SDK

配置文件

从平台控制台下载应用的 .xuqmconfig 配置文件(例如 识校宝.xuqmconfig),放置到 assets/config/ 目录,并在 pubspec.yaml 中声明:

flutter:
  assets:
    - assets/config/

SDK 启动时会自动扫描该目录并读取 .xuqmconfig 文件,无需手动指定路径。文件名不限,只要扩展名为 .xuqmconfig 即可。


初始化

import 'package:xuqm_flutter_sdk/xuqm_flutter_sdk.dart';

await XuqmSDK.initialize(XuqmInitOptions(
  appKey: 'your_app_key',
  debug: true,
));

初始化时会自动向服务端请求远程配置IM API 地址等),若网络异常则回退到内置默认值。


多模块统一登录

无论集成了哪些模块IM、Push、Update初始化和登录永远只做一次

// 初始化
await XuqmSDK.initialize(XuqmInitOptions(appKey: 'your_app_key'));

// 登录(业务登录成功后调用一次)
await XuqmImSdk().login('user_001', 'your_user_sig_jwt');

// 登出
await XuqmImSdk().logout();

下一步