Membina API Teguh dengan Perpustakaan Standard Go: Panduan Komprehensif-Golang-php.cn

Building Robust APIs with Go

Sebagai pembangun Go, saya mendapati bahawa perpustakaan standard menyediakan pelbagai alatan yang mengagumkan untuk membina API yang mantap. Mari kita terokai cara kita boleh memanfaatkan pakej terbina dalam ini untuk mencipta perkhidmatan web yang cekap dan berskala.

Pakej bersih/http membentuk asas pembangunan API kami. Ia menawarkan antara muka yang mudah tetapi berkuasa untuk mengendalikan permintaan dan respons HTTP. Begini cara kami boleh menyediakan pelayan asas:

package main

import (
    "fmt"
    "log"
    "net/http"
)

func main() {
    http.HandleFunc("/", handleRoot)
    log.Fatal(http.ListenAndServe(":8080", nil))
}

func handleRoot(w http.ResponseWriter, r *http.Request) {
    fmt.Fprintf(w, "Welcome to our API!")
}

Salin selepas log masuk

Ini menyediakan pelayan yang mendengar pada port 8080 dan bertindak balas kepada permintaan di laluan akar. Tetapi mari jadikan ia lebih menarik dengan menambahkan titik akhir RESTful untuk pengguna:

func main() {
    http.HandleFunc("/api/users", handleUsers)
    log.Fatal(http.ListenAndServe(":8080", nil))
}

func handleUsers(w http.ResponseWriter, r *http.Request) {
    switch r.Method {
    case "GET":
        getUsers(w, r)
    case "POST":
        createUser(w, r)
    default:
        http.Error(w, "Method not allowed", http.StatusMethodNotAllowed)
    }
}

func getUsers(w http.ResponseWriter, r *http.Request) {
    // Fetch users from database and return them
}

func createUser(w http.ResponseWriter, r *http.Request) {
    // Create a new user in the database
}

Salin selepas log masuk

Kini kami mempunyai API yang lebih berstruktur yang boleh mengendalikan kaedah HTTP yang berbeza untuk titik akhir yang sama. Tetapi bagaimana kita bekerja dengan data JSON? Masukkan pakej pengekodan/json.

Pakej pengekodan/json membolehkan kami mengawal struct Go ke dalam JSON dan menyahmarshal JSON ke dalam struct Go dengan mudah. Begini cara kami boleh menggunakannya dalam API kami:

type User struct {
    ID   int    `json:"id"`
    Name string `json:"name"`
}

func getUsers(w http.ResponseWriter, r *http.Request) {
    users := []User{
        {ID: 1, Name: "Alice"},
        {ID: 2, Name: "Bob"},
    }

    w.Header().Set("Content-Type", "application/json")
    json.NewEncoder(w).Encode(users)
}

func createUser(w http.ResponseWriter, r *http.Request) {
    var newUser User
    err := json.NewDecoder(r.Body).Decode(&newUser)
    if err != nil {
        http.Error(w, err.Error(), http.StatusBadRequest)
        return
    }

    // Save newUser to database
    w.WriteHeader(http.StatusCreated)
    json.NewEncoder(w).Encode(newUser)
}

Salin selepas log masuk

Kod ini menunjukkan cara menghantar respons JSON dan menghuraikan permintaan JSON. Barisan json.NewEncoder(w).Encode(users) menyerikan pengguna kami menghiris ke dalam JSON dan menulisnya pada respons. Sebaliknya, json.NewDecoder(r.Body).Decode(&newUser) membaca JSON daripada badan permintaan dan mengisi structUser baru kami.

Apabila API kami berkembang, kami mungkin ingin menambahkan beberapa perisian tengah untuk tugas seperti pengelogan atau pengesahan. Pakej http Go menjadikan ini mudah:

func loggingMiddleware(next http.HandlerFunc) http.HandlerFunc {
    return func(w http.ResponseWriter, r *http.Request) {
        log.Printf("Request: %s %s", r.Method, r.URL.Path)
        next.ServeHTTP(w, r)
    }
}

func authMiddleware(next http.HandlerFunc) http.HandlerFunc {
    return func(w http.ResponseWriter, r *http.Request) {
        token := r.Header.Get("Authorization")
        if token != "secret-token" {
            http.Error(w, "Unauthorized", http.StatusUnauthorized)
            return
        }
        next.ServeHTTP(w, r)
    }
}

func main() {
    http.HandleFunc("/api/users", authMiddleware(loggingMiddleware(handleUsers)))
    log.Fatal(http.ListenAndServe(":8080", nil))
}

Salin selepas log masuk

Di sini, kami telah mencipta dua fungsi middleware: satu untuk pengelogan dan satu untuk pengesahan berasaskan token yang mudah. Kami boleh merantai fungsi middleware ini untuk menggunakan berbilang lapisan pemprosesan pada permintaan kami.

Satu lagi aspek penting pembangunan API ialah pengendalian ralat yang betul. Falsafah pengendalian ralat Go menggalakkan penyemakan ralat yang jelas, yang membawa kepada kod yang lebih mantap. Mari tingkatkan fungsi createUser kami dengan pengendalian ralat yang lebih baik:

func createUser(w http.ResponseWriter, r *http.Request) {
    var newUser User
    err := json.NewDecoder(r.Body).Decode(&newUser)
    if err != nil {
        http.Error(w, "Invalid request payload", http.StatusBadRequest)
        return
    }

    if newUser.Name == "" {
        http.Error(w, "Name is required", http.StatusBadRequest)
        return
    }

    // Simulate database error
    if newUser.ID == 999 {
        http.Error(w, "Database error", http.StatusInternalServerError)
        return
    }

    w.WriteHeader(http.StatusCreated)
    json.NewEncoder(w).Encode(newUser)
}

Salin selepas log masuk

Versi ini menyemak pelbagai keadaan ralat dan mengembalikan kod status HTTP dan mesej ralat yang sesuai.

Apabila API kami berkembang, kami mungkin perlu mengendalikan senario yang lebih kompleks, seperti permintaan jangka panjang atau keperluan untuk membatalkan operasi. Di sinilah pakej konteks berguna. Ia membolehkan kami membawa nilai berskop permintaan, mengendalikan tamat masa dan mengurus pembatalan.

Begini cara kami boleh menggunakan konteks dalam API kami:

func handleLongRunningTask(w http.ResponseWriter, r *http.Request) {
    ctx, cancel := context.WithTimeout(r.Context(), 5*time.Second)
    defer cancel()

    result := make(chan string, 1)
    go func() {
        // Simulate a long-running task
        time.Sleep(6 * time.Second)
        result <- "Task completed"
    }()

    select {
    case <-ctx.Done():
        http.Error(w, "Request timed out", http.StatusRequestTimeout)
    case res := <-result:
        fmt.Fprint(w, res)
    }
}

Salin selepas log masuk

Dalam contoh ini, kami menetapkan tamat masa 5 saat untuk permintaan itu. Jika tugasan yang berjalan lama tidak selesai dalam masa ini, kami mengembalikan ralat tamat masa kepada pelanggan.

Prestasi adalah kebimbangan kritikal untuk mana-mana API. Pustaka standard Go menyediakan beberapa alatan untuk membantu kami mengoptimumkan prestasi API kami. Sebagai contoh, kita boleh menggunakan penyegerakan.Kolam untuk menggunakan semula objek dan mengurangkan beban pada pengumpul sampah:

package main

import (
    "fmt"
    "log"
    "net/http"
)

func main() {
    http.HandleFunc("/", handleRoot)
    log.Fatal(http.ListenAndServe(":8080", nil))
}

func handleRoot(w http.ResponseWriter, r *http.Request) {
    fmt.Fprintf(w, "Welcome to our API!")
}

Salin selepas log masuk

Kod ini menggunakan semula penimbal bait, yang boleh mengurangkan peruntukan memori dengan ketara dalam senario trafik tinggi.

Pertimbangan prestasi lain ialah penghalaan yang cekap. Walaupun http.ServeMux standard mencukupi untuk API mudah, untuk keperluan penghalaan yang lebih kompleks, kami mungkin mahu melaksanakan penghala tersuai:

func main() {
    http.HandleFunc("/api/users", handleUsers)
    log.Fatal(http.ListenAndServe(":8080", nil))
}

func handleUsers(w http.ResponseWriter, r *http.Request) {
    switch r.Method {
    case "GET":
        getUsers(w, r)
    case "POST":
        createUser(w, r)
    default:
        http.Error(w, "Method not allowed", http.StatusMethodNotAllowed)
    }
}

func getUsers(w http.ResponseWriter, r *http.Request) {
    // Fetch users from database and return them
}

func createUser(w http.ResponseWriter, r *http.Request) {
    // Create a new user in the database
}

Salin selepas log masuk

Penghala tersuai ini membolehkan padanan laluan yang lebih fleksibel, termasuk corak kad bebas.

Apabila API kami berkembang, kami mungkin perlu mengendalikan permintaan serentak dengan cekap. Goroutine dan saluran Go sesuai untuk ini:

type User struct {
    ID   int    `json:"id"`
    Name string `json:"name"`
}

func getUsers(w http.ResponseWriter, r *http.Request) {
    users := []User{
        {ID: 1, Name: "Alice"},
        {ID: 2, Name: "Bob"},
    }

    w.Header().Set("Content-Type", "application/json")
    json.NewEncoder(w).Encode(users)
}

func createUser(w http.ResponseWriter, r *http.Request) {
    var newUser User
    err := json.NewDecoder(r.Body).Decode(&newUser)
    if err != nil {
        http.Error(w, err.Error(), http.StatusBadRequest)
        return
    }

    // Save newUser to database
    w.WriteHeader(http.StatusCreated)
    json.NewEncoder(w).Encode(newUser)
}

Salin selepas log masuk

Kod ini mengambil data daripada tiga perkhidmatan serentak, menggabungkan hasil menjadi satu respons.

Keselamatan adalah terpenting dalam pembangunan API. Pakej crypto Go menyediakan alat untuk pencincangan, penyulitan dan banyak lagi. Berikut ialah contoh cara kami boleh mencincang kata laluan:

func loggingMiddleware(next http.HandlerFunc) http.HandlerFunc {
    return func(w http.ResponseWriter, r *http.Request) {
        log.Printf("Request: %s %s", r.Method, r.URL.Path)
        next.ServeHTTP(w, r)
    }
}

func authMiddleware(next http.HandlerFunc) http.HandlerFunc {
    return func(w http.ResponseWriter, r *http.Request) {
        token := r.Header.Get("Authorization")
        if token != "secret-token" {
            http.Error(w, "Unauthorized", http.StatusUnauthorized)
            return
        }
        next.ServeHTTP(w, r)
    }
}

func main() {
    http.HandleFunc("/api/users", authMiddleware(loggingMiddleware(handleUsers)))
    log.Fatal(http.ListenAndServe(":8080", nil))
}

Salin selepas log masuk

Fungsi ini boleh digunakan untuk menyimpan dan mengesahkan kata laluan pengguna dengan selamat.

Pengujian ialah bahagian penting dalam pembangunan API dan pakej ujian Go memudahkan untuk menulis dan menjalankan ujian. Berikut ialah contoh cara kami boleh menguji fungsi pengguna pengguna kami:

func createUser(w http.ResponseWriter, r *http.Request) {
    var newUser User
    err := json.NewDecoder(r.Body).Decode(&newUser)
    if err != nil {
        http.Error(w, "Invalid request payload", http.StatusBadRequest)
        return
    }

    if newUser.Name == "" {
        http.Error(w, "Name is required", http.StatusBadRequest)
        return
    }

    // Simulate database error
    if newUser.ID == 999 {
        http.Error(w, "Database error", http.StatusInternalServerError)
        return
    }

    w.WriteHeader(http.StatusCreated)
    json.NewEncoder(w).Encode(newUser)
}

Salin selepas log masuk

Ujian ini membuat permintaan, menyerahkannya kepada pengendali kami dan menyemak status dan badan respons.

Kesimpulannya, perpustakaan standard Go menyediakan set alat yang mantap untuk membina API yang cekap dan berskala. Daripada mengendalikan permintaan HTTP dan bekerja dengan JSON, hinggalah mengurus konkurensi dan melaksanakan langkah keselamatan, perpustakaan standard menyediakan kami. Dengan memanfaatkan pakej terbina dalam ini dengan berkesan, kami boleh mencipta API yang berkuasa tanpa bergantung pada rangka kerja luaran. Ini bukan sahaja memudahkan pengurusan pergantungan kami tetapi juga memastikan kod kami kekal berprestasi dan boleh diselenggara semasa ia berkembang. Sambil kami terus meneroka kedalaman perpustakaan standard Go, kami akan menemui lebih banyak cara untuk meningkatkan proses pembangunan API kami.

Ciptaan Kami

Pastikan anda melihat ciptaan kami:

Kami berada di Medium

Atas ialah kandungan terperinci Membina API Teguh dengan Perpustakaan Standard Go: Panduan Komprehensif. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!