再回來另一個迷你項目,這次是用 Go 寫的計算器後端 API 工具!
我最近完成了一個為無狀態計算器建立 HTTP JSON API 的項目,讓我告訴你——它比我預期的有趣得多(也更具挑戰性)。從表面上看,這可能聽起來很簡單:「嘿,這只是一個計算器,對吧?」但一旦你深入研究,你就會開始發現使 API 真正適合生產的所有細節。
所以,讓我分享這個過程、學到的教訓,以及如果我必須再做一次的話我會調整什麼。
~ 原始碼:在這裡找到
任務很簡單:為不儲存任何資料的計算器建立一個 API-沒有資料庫,沒有記憶體快取。每個計算都是孤立發生的。無國籍。乾淨的。簡單的。該 API 遵循 OpenAPI 規範,該規範列出了所有端點和預期行為。
輸入驗證
我學到的第一個教訓就是輸入驗證的重要性。你不能信任用戶,即使是像數學這樣基本的東西。例如:
如果有人寄非號碼會怎麼樣?繁榮。
除以零怎麼樣?雙重繁榮。
為了解決這個問題,我確保在 API 考慮處理每個輸入之前都對其進行了清理和驗證。如果出現問題,用戶會收到一條有用且友善的錯誤訊息,例如:
{ "error": "Division by zero is not allowed. Please provide a valid denominator." }
沒有人喜歡神秘的「500 伺服器錯誤」訊息。
偵錯日誌
你知道這句話嗎? “原木是你最好的朋友”?這是真的。我使用 Go golang.org/x/exp/slog 套件實作了結構化日誌記錄,它節省了我很多時間。每個請求都記錄有詳細信息,例如:
這是我如何設定文字日誌的片段:
logger := slog.New(slog.NewTextHandler(os.Stdout, nil))
或 JSON 日誌(非常適合與監控工具整合):
logger := slog.New(slog.NewJSONHandler(os.Stdout, nil))
當某些事情沒有如預期般運作時,擁有這些日誌可以讓除錯變得輕而易舉。
我最初並沒有計劃在基於瀏覽器的應用程式中使用這個 API,但隨著專案的發展,很明顯 CORS(跨來源資源共享)是必要的。
使用 github.com/rs/cors 包,我快速添加了所需的標頭,以允許基於瀏覽器的客戶端與 API 互動。
{ "error": "Division by zero is not allowed. Please provide a valid denominator." }
1) net/http:Go 的標準函式庫,用於設定 HTTP 伺服器和路由請求。
2)encoding/json:處理請求和回應的JSON編碼/解碼。
3) golang.org/x/exp/slog:用於以文字或 JSON 格式記錄每個請求。
4) github.com/rs/cors:處理 Web 整合的跨域請求。
我為這些計算製作了一些處理程序,它們本質上非常基本,主要關注計算的核心功能(加法、減法、除法和乘法)。
logger := slog.New(slog.NewTextHandler(os.Stdout, nil))
除此之外,使用著名的 net/http 套件處理我的 HTTP 請求非常簡單,並且有許多以不同方式執行此操作的範例。我的情況非常簡單,我只需要提供一些 HTTP,處理回應編寫器和請求。
logger := slog.New(slog.NewJSONHandler(os.Stdout, nil))
以下是一些使用案例範例:
c := cors.New(cors.Options{ AllowedOrigins: []string{"*"}, AllowedMethods: []string{"GET", "POST", "OPTIONS"}, AllowedHeaders: []string{"Content-Type"}, AllowCredentials: true, })
請求:
//handlers.go func AddHandler(logger *slog.Logger) http.HandlerFunc { return func(w http.ResponseWriter, r *http.Request) { handleOperation(logger, w, r, func(a, b float64) float64 { return a + b }) } } func SubtractHandler(logger *slog.Logger) http.HandlerFunc { return func(w http.ResponseWriter, r *http.Request) { handleOperation(logger, w, r, func(a, b float64) float64 { return a - b }) } } func MultiplyHandler(logger *slog.Logger) http.HandlerFunc { return func(w http.ResponseWriter, r *http.Request) { handleOperation(logger, w, r, func(a, b float64) float64 { return a * b }) } } func DivideHandler(logger *slog.Logger) http.HandlerFunc { return func(w http.ResponseWriter, r *http.Request) { handleOperation(logger, w, r, func(a, b float64) float64 { if b == 0 { panic("division by zero") } return a / b }) } }
是的!差不多就這樣了!這是一個我喜歡的快速而有趣的迷你項目!請隨意嘗試並以您想要的方式改進和增強。
下次見,乾杯! ? ?
以上是Go 中的計算器後端 API的詳細內容。更多資訊請關注PHP中文網其他相關文章!