mumichat-server

README

MumiChat-Server

---

這個專案是學校暑假實訓所做的項目，使用 Golang 和 gin 進行後端開發，通訊協議採用 Websocket 連線，未來可能會增加其他 API 接口，

自行編譯(Build)

此步驟是為欲自行編譯者提供，如果是使用釋出的二進制執行檔者可跳過此步。

請先將 Golang 執行環境安裝好，安裝方法請參考官方文檔，然後將 repo clone 到 $GOPATH/src。

注意：資料夾名稱必須為 MumiChat，不然依賴套件會出現錯誤，

git clone https://github.com/junyussh/MumiChat-server.git

$GOPATH 路徑可在終端機輸入 go env 獲取 Golang 環境變數看見。

set GOEXE=.exe
set GOHOSTARCH=amd64
set GOHOSTOS=windows
set GOOS=windows
set GOPATH=C:\Users\Chun Yu\go

然後用 go get 安裝依賴套件，在中國因為 golang.org 被牆，會造成無法安裝，解決方法可以參考這篇文章。

go get

最後用 go build 產生二進制執行檔。

go build

使用(Usage)

設定

要在 MumiChat 目錄建立一個 conf 目錄，並新建一個 app.ini，conf/app.ini 目前可以設定 gin 的輸出模式，資料庫儲存位置、名稱、還有伺服器監聽的端口號，主要就這幾個選項。

# possible values : release, debug
app_mode = debug

[paths]
# Path to where grafana can store temp files, sessions, and the sqlite3 db (if that is used)
data = ./data

[server]
# The http port  to use
HTTP_PORT = 8080

[database]
TYPE = sqlite3
NAME = chat
PATH = ./
LOGMODE = false
TABLE_PREFIX = chat

執行

執行 main.go。

go run main.go

如果使用二進制執行檔者就直接執行。

./main

請求標準

當連接上伺服器，伺服器會回傳一串 key，為伺服器的公鑰，未來要做非對稱加密連線用。

{
  "key": "24AB50C2"
}

每個請求都有個 type 欄，目前有兩種值：action 和 message，註冊登入屬於 action，而訊息則是 message。

action: 要執行的動作。

{
    "type": "action",
    "action": "login"
}

回傳內容結構都有 code 和 msg 還有 data 欄位，code 通常是錯誤代碼，msg 是錯誤訊息，data 是請求伺服器的回傳資料。

{
  "code": 200,
  "msg": "操作成功",
  "data": null
}

註冊

註冊帳號必填以下欄位資訊：

• email: 使用者 Email
• password: 密碼
• firstName: 名字
• lastName: 姓氏

{
  "type": "action",
  "action": "register",
  "data": {
    "email": "abc@example.com",
    "password": "p@ssw0rd",
    "firstName": "Eric",
    "lastName": "Chen"
  }
}

登入

登入只須填 Email 和密碼，action 欄位的值改為 login 即可。

註：目前設計一個帳號僅能有一個 Websocket 連線。

{
  "type": "action",
  "action": "login",
  "data": {
    "email": "abc@example.com",
    "password": "p@ssw0rd"
  }
}

發送訊息

發送訊息前必須先進行登入。

訊息欄位須包含：

• type: 這裡必須填 message
• recipient: 接收者的 ID
• content: 訊息內容

整體請求如下：

{
  "type": "message",
  "data": {
    "recipient": "289559048",
    "content": "hello"
  }
}

發送成功後會回傳：

{
  "code": 201,
  "msg": "訊息發送成功",
  "data": null
}

然後接收者會收到發送者傳來的訊息，sender 為訊息發送者，created_at 為訊息發送時間。

{
  "sender": "271693512",
  "recipient": "289559048",
  "content": "hello",
  "created_at": "2019-07-15T09:28:10Z"
}

查詢使用者資訊

• type: action
• action: query

可以自訂條件傳入，目前接受的條件有

• email: Email
• username: 使用者名稱
• id: 使用者唯一 ID
• firstName: 名字
• lastName: 姓氏

下面的請求伺服器搜尋 Email 為 abc@example.com 且姓名為 Eric Chen 的用戶，由於 Email 算是唯一標識符，僅會回一筆資料。

{
  "type": "action",
  "action": "query",
  "data": {
    "email": "abc@example.com",
    "firstName": "Eric",
    "lastName": "Chen"
  }
}

回傳內容放在 data 中，以陣列形式回傳。

{
  "code": 200,
  "msg": "操作成功",
  "data": [{
    "id": "289559048",
    "username": "",
    "email": "abc@example.com",
    "password": "",
    "firstName": "Eric",
    "lastName": "Chen",
    "profileImage": "",
    "key": "",
    "isLogin": false
  }]
}

License

The project is under MIT License now.