跑通示例项目

更新时间: 2023/12/28 01:50:50

网易云信为您提供开源的示例项目,您可以参考本文档快速跑通示例项目,体验语聊房效果。

前提条件

在开始运行示例项目之前,请确保您已完成以下操作:

开发环境要求

不同的目标平台,开发环境要求也不同,具体如下:

  • Flutter 3.10.0 及以上版本

  • Dart 3.0.0 及以上版本

  • 如果您的目标平台是 iOS:

    • Xcode 11.0 及以上版本
    • 请确保您的项目已设置有效的开发者签名
    • macOS 操作系统
    • 11.0 及以上的 iPhone 或者 iPad 真机
  • 如果您的目标平台是 Android:

    • Android Studio 4.1 及以上版本
    • macOS 或 Windows 操作系统
    • Android 系统 5.0 及以上版本的真机
  • 安装 Flutter 和 Dart 插件

运行示例源码

语聊房的示例源码仅供开发者接入参考,实际应用开发场景中,请结合具体业务需求修改使用。

若您计划将源码用于生产环境,请确保应用正式上线前已经过全面测试,以免因兼容性等问题造成损失。

  1. 克隆语聊房组件的示例项目源码仓库至您本地工程。

  2. 配置应用的 AppKey及AppSecret。

    lib/app_config.dart 文件中配置应用的 AppKey。

    // 请填写应用对应的 AppKey,可在云信控制台的”AppKey管理“页面获取
    static const String _appKey = "your appKey";
    // 请填写应用对应的 AppSecret,可在云信控制台的”AppKey管理“页面获取
    static const String _appSecret = "your sercet";
    // 如果您的 AppKey 为海外,填 true;如果您的AppKey为中国国内,填 false
    static const bool _isOverSea = false;
    
    // 默认的 BASE_URL 地址仅用于跑通体验Demo,请勿用于正式产品上线。在产品上线前,请换为实际的服务端地址
    static const String _baseUrl = 'https://yiyong.netease.im';
    static const String _baseUrlOversea = 'https://yiyong-sg.netease.im';
    
    • 获取 AppKey 和 AppSecret 的方法请参见获取 AppKey
    • BASE_URL 地址 https://yiyong.netease.im和 BASE_URL_OVERSEA 地址 https://yiyong-sg.netease.im为云信派对服务端体验地址,该地址仅用于体验 Demo,单次最大体验时长为1小时,请勿用于生产环境
    • 如果您的应用的 AppKey 为海外,设置 IS_OVERSEA 的值为 true,并联系技术支持或商务经理配置抄送地址。
  3. 在工程根目录执行如下命令引入依赖。

    flutter pub get
    
  4. 编译运行。

    iOS
    1. 打开终端,在 Podfile 所在文件夹中执行如下命令进行安装:

      pod install
      
    2. 完成安装后,通过 Xcode 打开 NEVoiceRoomExample.xcworkspace 工程。

    3. 编译并运行 Demo 工程。

    Android

    i.在工程根目录执行如下命令:

     flutter run
    

    ii.使用 Android Studio(4.1及以上的版本)打开源码工程,单击运行即可。

  5. 选中设备直接运行,即可体验 Demo。

建议在真机上运行,不支持模拟器调试。

示例项目结构

示例代码lib目录结构说明如下:


├── app_config.dart  app配置
├── base       基础模
├── constants  常量
├── generated  字符串国际化(intl自动生成目录)
├── l10n       字符串国际化
├── main.dart  app入口 
├── model      数据模型
├── pages      页面 
├── utils      工具类
├── viewmodel  页面逻辑
└── widgets    ui组件

此文档是否对你有帮助?
有帮助
去反馈
  • 前提条件
  • 开发环境要求
  • 运行示例源码
  • 示例项目结构