這是一個使用 Go 語言實現的後端應用程式，為使用者提供 RESTful API 和 gRPC API 進行操作。其中，RESTful API 針對一般使用者操作，而 gRPC API 則針對鏈結串列的編輯者進行操作。每個鏈結串列的元素都記錄了一個頁面（Page）的 ID。

• 提供 RESTful API 給串列的使用者，讓使用者可以透過 key 獲取每一篇頁面的資訊
  • GET /head/<listkey> 可獲得 {nextPageKey: xxx}
  • GET /page/<pagekey> 可獲得 {article: {title: aaa, content: bbb, ...}, nextPageKey: xxx}
• 提供 gRPC API 給鏈結串列的編輯者進行操作
  • New: 建立一個新的串列
  • Delete: 刪除一個串列
  • Begin: 獲取第一個元素的 Iterator
  • End: 獲取最後一個元素之後的 Iterator
  • Clear: 清空串列
  • Insert: 於該 Iterator 之前插入新的元素
  • Erase: 移除該 Iterator
  • Set: 設定該 Iterator 儲存的 Page ID
  • PushBack: 串列尾部新增一個元素
  • PopBack: 移除串列尾部的元素
  • PushFront: 串列首部新增一個元素
  • PopFront: 移除串列首部的元素
  • Clone: 複製一個串列

原本有打算製作 gRPC Bidirectional Streaming 的設計，並已經做過小規模測試，但是因為時間關係，所以沒有將實作加入本系統。

透過上述的 API，使用者可以獲取自己的列表，使用 RESTful API 可以取得頁面的資訊以及下一個頁面的 key。此外，ML 和後端工程師也能夠專注於列表的製作，使用 gRPC API 來進行各種操作。

• Go 1.20

在執行伺服器之前，需要先執行資料庫，這裡使用的是 PostgreSQL，可以使用 Docker Compose 來執行。

docker-compose up -d

go build

./dcard-2023-backend-intern-homework

• RESTful API 預設會在 port :3000 提供服務
• gRPC API 預設會在 port :50051 提供服務。
• 另外 gRPC 有 UI 可以使用，預設在 port :8080。

go test ./...

我使用 stretchr/testify 和 container/list 來實現測試，透過比對 list 中的資料和資料庫中的資料是否相同，以確認操作是否正確。為了方便測試，我將資料庫換成了 SQLite，因為 SQLite 可以直接運行，不需要額外的設定，而且可以在測試結束後自動清除資料。

可以透過修改 .env 檔案來自定義設定。.env.example 是範例檔案。

獲得串列的第一個元素的資訊，包含第一個元素的 key。

Response:

{
  "nextPageKey": "xxx"
}

獲得頁面的資訊，包含頁面的標題、內容、網址 slug、是否發佈等等。

Response:

{
  "article": {
    "title": "xxx",
    "content": "xxx",
    "slug": "xxx",
    "published": true
  },
  "nextPageKey": "xxx"
}

message Empty {

}

message PageList {
  string key = 1;
}

message PageIterator {
  string key = 1;
  uint32 page_id = 2;
}

message DeleteRequest {
  string list_key = 1;
}

message BeginRequest {
  string list_key = 1;
}

message EndRequest {
  string list_key = 1;
}

message NextRequest {
  string iter_key = 1;
}

message PrevRequest {
  string iter_key = 1;
}

message ClearRequest {
  string list_key = 1;
}


message InsertRequest {
  string iter_key = 1;
  uint32 page_id = 2;
}

message EraseRequest {
  string iter_key = 1;
}

message SetRequest {
  string iter_key = 1;
  uint32 page_id = 2;
}

message PushRequest {
  string list_key = 1;
  uint32 page_id = 2;
}

message PopRequest {
  string list_key = 1;
}

message CloneRequest {
  string list_key = 1;
}

建立一個新的串列。

rpc New(Empty) returns (PageList) {}

刪除一個串列。

rpc Delete(DeleteRequest) returns (Empty) {}

獲取第一個元素的 Iterator。

rpc Begin(BeginRequest) returns (PageIterator) {}

獲取最後一個元素之後的 Iterator。

rpc End(EndRequest) returns (PageIterator) {}

獲取下一個元素的 Iterator。

rpc Next(NextRequest) returns (PageIterator) {}

獲取上一個元素的 Iterator。

rpc Prev(PrevRequest) returns (PageIterator) {}

清空串列。

  rpc Clear(ClearRequest) returns (Empty) {}

於該 Iterator 之前插入新的元素。

rpc Insert(InsertRequest) returns (PageIterator) {}

移除該 Iterator。

rpc Erase(EraseRequest) returns (PageIterator) {}

設定該 Iterator 儲存的 Page ID。

rpc Set(SetRequest) returns (PageIterator) {}

串列尾部新增一個元素。

rpc PushBack(PushRequest) returns (PageIterator) {}

移除串列尾部的元素。

rpc PopBack(PopRequest) returns (Empty) {}

串列首部新增一個元素。

rpc PushFront(PushRequest) returns (PageIterator) {}

移除串列首部的元素。

rpc PopFront(PopRequest) returns (Empty) {}

複製一個串列。

rpc Clone(CloneRequest) returns (PageList) {}

我使用 PostgreSQL 作為資料庫，透過 GORM 套件進行操作。我選擇使用 PostgreSQL 是因為透過 Docker 運行資料庫非常方便，且無需額外安裝環境。此外，使用 PgAdmin 進行管理，也讓我感到更親切。而 GORM 則是一個 ORM 套件，未來更換資料庫時只需要調整 GORM 的設定即可，無需修改太多程式碼。

鏈結串列的資料結構如下：

type PageList struct {
    gorm.Model
    Key uuid.UUID `gorm:"type:uuid;uniqueIndex"`
}

type PageNode struct {
    gorm.Model
    End     bool
    Key     uuid.UUID `gorm:"type:uuid;uniqueIndex"`
    PrevKey uuid.UUID `gorm:"type:uuid"`
    NextKey uuid.UUID `gorm:"type:uuid"`
    // Page   *page.Page `gorm:"foreignkey:PageID;references:ID"`
    PageID  uint
    List    PageList  `gorm:"foreignkey:ListKey;references:Key"`
    ListKey uuid.UUID `gorm:"type:uuid;index"`
}

文章的資訊儲存在 Page 資料表中，而 PageNode 則是紀錄了鏈結串列的資訊，包含了頁面的 ID、頁面的前後頁面的 key、頁面所屬的串列的 key。

將 Page 註解掉的原因是因為 Page 相關的功能沒有實作，目前只有範例的 Page 資料表。

文章的資料結構如下：

type Page struct {
    gorm.Model `json:"-"`
    Title      string `json:"title" gorm:"not null"`
    Content    string `json:"content" gorm:"type:text;not null"`
    Slug       string `json:"slug" gorm:"uniqueIndex;not null"`
    Published  bool   `json:"-" gorm:"default:false"`
}

這邊只有簡單的紀錄了文章的標題、內容、網址 slug 和是否發佈。