忍者工坊
0%

如何在 VSCode 中以 Container 方式開發 FastAPI + PostgreSQL

發表於 更新於 分類於

前言

故事是這樣的，前幾天好像有微軟的開發者日(❓)，因此同事在收看完線上影片後分享給我一篇關於在 VSCode 開發 FastAPI+PostgreSQL 的影片，內容主要在講解如何在 VSCode 中以 Container 模式做開發，詳細內容以下會提到。

而因為過往我因為很懶得處理環境問題，因此都快速安裝 Python 後在使用 PyCharm 來協助處理開發問題，在這次看了影片中的使用覺得整體效果非常讚(香 🥰)，以下就來介紹一下如何使用以及範例吧！

官方範例是用 Poetry 來管理套件，我則習慣使用 PIP + requirements.txt 來管理

延伸閱讀：

TL;DR

  • 環境孤立化(在容器中)，不會污染本機環境
  • 該有的 VSCode Plugins 都在
  • 不用再找 Container IP，直接 127.0.0.1
  • Configuration Plugin 都幫你弄好了
  • 本地開發+資料庫(介面)都弄好，很夠用(香)
  • UI 感覺變直覺了? (以前不太會用 VSCode 寫 Python)

可能會遇到的問題:

  • 硬碟空間不足(容器一多可能會炸)
  • 有機會需要重開 Container
  • 有些功能還是沒 PyCharm 方便(各有好壞)

介紹

本次範例專案： fastapi-vscode-example

首先在需要在 VSCode 中安裝兩個套件，Python 以及 Remote-Container，以下是 Remote-Container 的套件截圖(大家應該知道安裝哪個 Python?)

remote container

範例專案 fastapi-vscode-example 架構

接著 Clone 這次的範例專案 fastapi-vscode-example，以下我來跟大家稍微解釋一下資料夾結構：

  • .devcontainer/: Remote-Container 使用時所需要的資料夾，下面會有三個檔案 Dockerfile、docker-compose.yml、devcontainer.json，前兩個為容器的設定檔，最後一個則是 Remote-Container 所需要的檔案。
  • .vscode/: 在 VSCode 裡面執行相關操作時幫大家儲存下來的設定檔位置。
  • Container database.session.sql: 在 VSCode 中透過介面來操作資料庫時會初始化跑的檔案。
  • main.py: 主程式要跑的檔案。
  • 其餘檔案則是專案在寫時所分類的資料夾以及 Heroku 設定檔。

開始使用 Remote Container 環境

大致了解架構後，接著按下 Command+Shift+p 開啟一個輸入框，並輸入 remote container 後找到 Reopen in Container 的選項，如下圖所示。

remote container1

接著 VSCode 會開始幫忙在 Docker 中產生容器，需要稍等它 pull 以及建立容器，建立完後可以在裡面開啟終端機看一下(pwd)自己是否真的在容器(Container)裡面。
open folder

進來之後就要來啟動專案，按下畫面上執行的按鈕，而這個按鈕則會在 .vscode 中建立 launch.json 來幫忙放相關設定檔，裡頭就是設定要跑的相關指令。
launch

執行之後會在下方出現終端機來顯示跑起來的訊息，相關 call API 的測試結果當然也都會在這邊。
launch2

Port Forward

執行完後大概果幾秒後，右下角會出現視窗來詢問你說要不要在 瀏覽器上開啟 的彈跳視窗，按下去後 VSCode 就會幫忙把相對應的 Port 全部對外，讓大家可以無痛在本地端(127.0.0.1)直接 call API

解決了：

  • 不用找 Docker IP 為了呼叫容器裡的服務
  • 跟在電腦(本地端)開發狀態一樣，而多了不會污染環境的好處

port

執行與除錯(Debug)模式

跟許多開發工具一樣，要 Debug 時就在行數的左邊點上紅點，打一次訊息到 API 後就會在想除錯的那行中停下來，左邊訊息欄就會顯示當前相關參數喔。

下方有兩個顏色，紫色是當前正在的處於的環境(Container)，紅色則是告訴你現在服務啟動了，等關閉終端機時就會變回一般的顏色囉。

debug

資料庫

這邊看資料庫解決了筆者開發的一個小痛點，左邊欄支援直接看資料庫，可以快速查詢相關開發的資料是否正確，透過介面上的內容大致可以解決許多開發上會遇到的問題。(當然其他工具(pgadmin)還是有他好用的地方)

sql1

結論

像筆者我之前都很習慣在筆電中直接灌爆所有環境需要的東西，想要時直接取用，使用速度也都很及時，到目前比較有經驗之後也很少遇到環境打架問題。

但想起以前有些開發時需要多環境切換測試時就很容易遇到污染的問題，導致本地端看似對的但部署上去都是錯的的問題，因此之後才會逐漸切換成將開發用的工具以 Docker 的方式切開來使用。

藉由這次與各位分享在 VSCode 中以 Container 的方式開發 FastAPI + PostgreSQL 中的經驗，過程中也讓我釐清了許多操作上的內容，希望透過這篇文章能夠讓各位也可以開始嘗試在 Container 裡面開始開發自己的服務，同時也讓自己系統內的環境更加乾淨喔！

本次範例專案： fastapi-vscode-example

Docker 是 Container 這個技術的解決方案之一，但是 Container 不是 Docker 喔！！