CoffeeChat

CoffeeChat

opensource im with server(go) and client(flutter+swift)

️ ️ Warnning ️ ️持續開發中，僅適合學習使用。

News

有網友在Issues詢問後續更新一事，這裡回覆一下：

今年事情比較多，所以進展十分緩慢，會不會放棄這個項目我也不能肯定，主要是作者精力有限，請大家原諒。發起這個專案的初衷，是為了更深入的學習IM服務端開發，如果有更好的開源go語言實現的im項目，我可能會考慮作為Contributor參與其中。

最後，放出最近的一些動態以感謝大家的關心。

最新動態：

• 至今: 生命不息，探索不止??
• 2022/07/01: 目前正在開發v2架構（基於kratos v2框架），整體設計由pb+tcp變更為http+json介面方式，降低上手成本。考慮到自由度和方便體驗，目前正在開發android app。
• 2022/04/10：制定Monthly Release計劃，每個月至少要保證一次Release
• 2021/08: 作者最近在考慮跳槽，故精力主要放在研究OpenIM，學習Kafka，微服務，收件箱，Etcd，Docker，K8S等使用，提昇技術深度。
• 2021/03 - 07: 開發QT客戶端和C++跨平台SDK，受限於精力進展緩慢。
• 2021/02: 使用sketch設計win+mac客戶端介面。

總結：

• 2022 : 再出發，學習android + kratos + k8s，實現go服務端v2版本重構
• 2021 : 主要精力在探索百萬級的架構，C++跨平台SDK，QT，Go微服務，Docker，Etcd等等， CoffeeChat幾乎沒有更新
• 2020 : 這一年CoffeeChat不斷完善，作者主要在學習ios開發，實現簡單ios app
• 2019/08 : CoffeeChat誕生，學習flutter，實現簡單flutter客戶端，後續因為flutter聊天介面下拉感覺效果不理想放棄

Client

支援的客戶端有：

• 開發中（V2）

  • Android: 基於android 7.0 + java實現，目前正在開發中（2022年8月），適用於V2版本服務端。

• 暫停中（V1）

  • iOS：基於swift5實現，目前主要維護的客戶端，建議使用。適用於V1版本服務端。
  • Flutter：基於flutter2和dart實現，目前已不再維護，僅供學習。
  • Windows：基於c++和網易duilib實現，目前只實作了登入功能。
  • Mac：基於c++和Qt6實現，目前只實現了登入功能。

請點擊對應的連結查看詳情。

Preview

flutter

see CoffeeChat -Flutter 暫不維護，僅供參考。

swift

Features

設計

• 架構設計：參考瓜子IM
• 協定設計：參考網易雲IM、環信、TeamTalk
• 資料庫設計
• 訊息分錶儲存設計
• IM 訊息ID 產生設計

單聊群聊

• flutter 用戶端
• 單聊
• 訊息格式
  • 文字
  • 表情
  • 圖片
• 會話列表
• 訊息儲存
• 歷史消息
• 漫遊訊息（用戶切換到任何裝置都可以讀取到最近的歷史訊息）
• 離線訊息（用戶離線重新上線後收到最近30 天的未讀訊息）
• 未讀訊息計數
• 訊息推播(APNS)
• 群聊
• 群最高人數：200
• 群組管理：群組主、加人、踢人
• 群消息免打擾
• 群組成員管理

服務端特有

• consul註冊中心
• 分散式配置（nacos、etcd...）
• dockerfile & docker compose
• admin後台和web介面，簡化安裝（參考wordpress）

客戶端特有

• 訊息推播提醒（系統通知欄訊息提醒）
• 訊息轉發
• 網路連線狀態
• 圖片管理器
• 尋找聊天記錄
• 訊息同步快取
• 會話同步緩存
• 頭像同步緩存
• 未讀計數桌面角標
• 免打擾模式
• 圖片壓縮

特色功能

• 閱後即焚
• 撤回
• 正在輸入
• 已讀回執（用戶發送訊息，獲取對方是否已讀狀態）
• 多終端已讀取同步（同個產品多終端情況下，同步訊息已讀未讀取的狀態）
• 端對端加密
• 高清語音訊息
• 文件上傳下載
• 語音通話(聲網FlutterSDK)
• 視訊通話
• electron 跨平台桌面用戶端
• flutter 跨平台行動端
• swift/iOS 用戶端+SDK

聊天機器人功能

• 圖靈機器人接入
• 小愛機器人接入
• 思知機器人接入
• 微信機器人接入

Architecture

模組架構:

單聊模組互動圖:

See More architecture

Quick Start

PS：請切換到master分支，編譯運行！

1. 啟動Server（要求安裝docker desktop >= 4.0.1）:

CoffeeChat/server # 从代码编译docker镜像，安装mysql,redis等依赖，并自动初始化mysql数据 $ docker-compose up -d">

$ git clone https://github.com/xmcy0011/CoffeeChat.git
$ cd CoffeeChat /server
# 从代码编译docker镜像，安装mysql,redis等依赖，并自动初始化mysql数据
$ docker-compose up -d

1. 編譯客戶端。推薦iOS客戶端（模擬器選擇iphone 11），請移步：client
2. iOS模擬器和app啟動後，點擊“註冊”，更改伺服器IP位址為本機IP（不需要輸入連接埠），註冊成功後，登入即可。
3. 內建了2個機器人（思知和微信）和3個好友，可以測試聊天功能。

更多細節，請移步：

• client
• server

停止：

CoffeeChat/server $ docker-compose down -v">

$ cd CoffeeChat /server
$ docker-compose down -v

Document

1. 產品介紹
2. 架構和協定設計
3. 訊息分錶存儲
4. IM 訊息ID 產生原理與常見技術困難
5. 進度計劃
6. MQ在IM中的實踐與選型

更多文章請移步：

• CoffeeChat -GitBook

Thinks

• mattermost：主要學習其go工程實務的一些技巧，目前仍處於研究階段。
• Open-IM-Server：透過分析它的架構和程式碼，了解收件匣機制和im 微服務(go)的分割實踐。
• goim：學習到百萬級架構下kafka是如何應用在聊天室場景的。
• Terry-Ye/im：結合goim，理解了所謂的job意義，看懂了goim的架構。
• gim：一個簡單的寫擴散項目，可以更深入地理解寫擴散的架構和原理。

更多開源im，請移步：史上最全開源IM盤點

Contact

email：[email protected]
微信交流：xuyc1992（請備註：im）

喜歡的話，追蹤下公眾號吧?
《Go與分散式IM》??

LICENSE

CoffeeChat is provided under the mit license.