readme.md

    uni-im 已开放需求征集和投票 点此前往

    简介

    uni-im 是一款云端一体、全平台、免费且开源的即时通讯系统

    • 基于uni-app,App、小程序、web全端兼容
    • 基于uniCloud,前后端都使用js开发
    • 基于uni-push2,专业稳定的全端消息推送系统(聚合多个手机厂商推送通道,App关闭后也能收到消息)
    • 开放性高,支持非uniCloud(即支持服务端是php、java、go、.net、python、c#等开发语言的项目),甚至非uni-app开发的项目都可以接入使用
    • 性价比高,前后端代码均免费开源,与同类产品相比,使用uni-im仅需支付因托管在 uniCloud(serverless 服务器)而产生的少量费用,详情可查看文末费用说明部分

    案例:

    应用名称:DCloud。此 App 的内置聊天模块即是基于 uni-im 开发的。

    web端网址(支持PC宽屏和移动端):https://im.dcloud.net.cn

    扫码体验:

    下载地址为:https://im.dcloud.net.cn/uni-portal.html

    uni-im相关功能建议或问题,可以加入由uni-im(本插件)搭建的交流群点此加入

    快速部署体验

    前提条件

    1. 获取运行uni-im服务端代码的云服务环境

      注意:这里和你自己项目服务端代码是什么语言开发的,以及运行在什么服务器环境无关。uni-im运行在专有的运行环境uniCloud(一种serverless 服务器)下。 你的项目服务端和uni-im的服务端之间分别“独立部署”,二者通过发送 http 请求并借助事件进行通讯。 当然,如果你的项目服务端也是基于uniCloud开发的,就可以部署在同一个服务空间内;通过云函数互调通讯。

    • 公有云
      开通地址:https://unicloud.dcloud.net.cn/ 服务商推荐选择“支付宝云”,性能更好。

    • 私有云
      普通中小企业项目使用公有云即可,但如果的项目存在特殊需求,例如:政务类、对信息保密性要求较高、用户都在海外的项目,这种情况下则需要进行私有化部署,详情可点击此处

    1. 开通可实时发送消息的推送服务
      这里我们需要开通uni-push,它是基于个推封装的服务;个推是A股上市公司,专业性在推送领域领先。 开通指南:点此打开

    体验步骤

    1. 下载示例项目
      打开uni-im插件下载地址:https://ext.dcloud.net.cn/plugin?name=uni-im 点击使用HBuilderX导入示例项目

    2. 绑定项目的服务空间
      在项目根目录uniCloud右键选择“关联云服务空间或项目”(注意:选择关联的服务空间,需在项目的 uni-push2.0的web控制台被关联)

    3. 运行项目
      在菜单运行->运行到浏览器 选择要运行的浏览器
      这里需要运行到两个不同的浏览器(避免同一浏览器打开多个uni-im页面,引起socket占线),注册账号并登录2个账号,体验对话效果

    4. 向指定用户发起会话
      通过访问路径:/uni_modules/uni-im/pages/chat/chat?user_id= + 指定用户的id即可。
      如果你不知道用户的id,可通过在浏览器控制台执行uni.imObservableData.currentUser._id可获取当前登录的账号id

    注意:以上为连接本地云函数体验,如果要发行为正式项目,需要把uniCloud内的文件部署到云端。操作方式为:对项目根目录uniCloud点右键选择“云服务空间初始化向导”界面按提示部署项目

    部署到自己的项目

    详情查看

    使用uniCloud产生的费用说明@cost

    uni-im本身并不收费,实际使用中需要依赖uniCloud云服务,会产生费用;而uniCloud的价格很实惠:

    • 调用10000次云函数仅需0.0133元
    • 调用10000次数据库查询仅需0.015元

    更多计费参考:支付宝云版uniCloud按量计费文档

    举例说明:

    • 单聊场景,向用户发送一条消息的过程:
    1. 调用uni-im-co云对象的sendMsg方法(产生1次云函数请求)
    2. 查询当前对话的会话记录(产生1次云数据库读操作)
    3. 根据步骤2的查询结果,如果已经有会话记录,就更新会话,否则就创建一条会话记录(产生1次云数据库写操作)
    4. 查询发送消息的用户信息,用于接收消息时在通知栏显示发送者昵称和头像(产生1次云数据库读操作)
    5. 记录发送的消息内容到数据库,用于保存消息历史记录(产生1次云数据库写操作)
    6. user_id为标识通过uni-push2向用户发送消息会产生0.00000283元uniCloud使用费用详情查看

    合计:1次云函数请求、2次数据库读操作、2次数据库写操作、1次uni-push2推送操作,即 (1 * 0.0133 + 2 * 0.015 + 2 * 0.05 + 1 * 0.0283)/10000 ≈ 0.000017元

    • 群聊场景,向用户发送一条消息的过程:
    1. 调用uni-im-co云对象的sendMsg方法(产生1次云函数请求)
    2. 查询当前用户是否为群成员,防止非群成员发送消息(产生1次云数据库读操作)
    3. 查询当前对话的会话记录(产生1次云数据库读操作)
    4. 根据步骤3的查询结果,如果已经有会话记录,就更新会话,否则就创建一条会话记录(产生1次云数据库写操作)
    5. 查询发送消息的用户信息,用于接收消息时在通知栏显示发送者昵称和头像(产生1次云数据库读操作)
    6. 记录发送的消息内容到数据库,用于保存消息历史记录(产生1次云数据库写操作)
    7. 以群id为参数,调用uni-im-co云对象的sendMsgToGroup方法,这是一个递归方法每次向500名群成员推送消息(如果群成员数量为0-500只需执行1次,500-1000需执行2次,以此类推),(会产生最少1次数据库读操作,和1次以user_id为标识通过uni-push2向用户发送消息会产生0.00000283元uniCloud使用费用详情查看

    合计:向500人群发送消息,会产生:1次云函数请求、4次数据库读操作、2次数据库写操作、1次uni-push2推送操作,即 (1 * 0.0133 + 4 * 0.015 + 2 * 0.05 + 1 * 0.0283)/10000 ≈ 0.000020元

    相比市面上同类型产品,使用uni-im仅需花费如此便宜的uniCloud(serverless服务器)费用;在价格这块uni-im性价比极高。

    开发文档详情查看

    项目简介

    当前项目暂无项目简介

    发行版本

    当前项目没有发行版本

    贡献者 5

    DCloud_JSON @LanJingLingJu
    maquan @maquan
    Anne_LXM @m0_60411761
    D DCloud_MQ @DCloud_MQ
    A Anne_LXM @Anne_LXM

    开发语言

    • Vue 54.3 %
    • JavaScript 44.1 %
    • SCSS 1.3 %
    • CSS 0.4 %