Cara Membina API RESTful tanpa Rangka Kerja di Golang

Ya, dengan menggunakan Perpustakaan Standard Go, anda boleh membina API yang tenang, mengendalikan permintaan melalui NET/HTTP, pengekodan/json, dan konteks pengurusan konteks, digabungkan dengan HTTP.Servemux Routing, Resolusi Laluan Manual, Middleware Encapsulation dan Pengendalian Kesalahan yang Sesuai,

Membina API yang tenang di GO tanpa bergantung pada kerangka luaran seperti gin atau echo sepenuhnya boleh dilakukan -dan kadang -kadang lebih baik untuk pembelajaran, minimum, atau prestasi. Perpustakaan Standard Go menyediakan semua yang anda perlukan: net/http untuk pengendalian permintaan dan tindak balas, encoding/json untuk siri JSON, dan context untuk nilai-nilai dan pembatalan permintaan.

Berikut adalah cara untuk membina API Restful yang mudah tetapi berfungsi hanya menggunakan perpustakaan standard.

1. Sediakan pelayan HTTP asas

Mulakan dengan membuat pelayan HTTP minimum menggunakan net/http . Anda tidak memerlukan kerangka router -Go's http.ServeMux boleh mengendalikan penghalaan asas.

 Pakej utama

import (
    "Net/http"
)

func main () {
    mux: = http.newservemux ()

    // Tentukan laluan
    mux.handlefunc ("mendapatkan /pengguna", getUsers)
    mux.handlefunc ("pos /pengguna", createUser)
    mux.handlefunc ("get /users /{id}", getUserbyId)

    // Server Mula
    http.listenandserve (": 8080", mux)
}

Nota: Ini menggunakan sintaks penghalaan hierarki GO 1.22 ( "GET /users" ), yang membolehkan pemadanan dengan kaedah HTTP. Jika anda berada di versi yang lebih lama, anda perlu menyemak r.Method di dalam pengendali.

2. Reka bentuk pengendali tenang

Setiap pengendali harus menghuraikan input, melakukan logik, dan mengembalikan respons JSON.

Contoh: Dapatkan semua pengguna

 taipkan struct pengguna {
    Id int `json:" id "`
    Nama String `Json:" Nama "`
}

var users = [] user {
    {Id: 1, nama: "Alice"},
    {Id: 2, nama: "bob"},
}

Func GetUsers (w http.responseWriter, r *http.request) {
    W.Header (). Set ("Kandungan-Jenis", "Aplikasi/JSON")
    json.newencoder (w) .encode (pengguna)
}

• Tetapkan tajuk Content-Type .
• Gunakan json.NewEncoder untuk menulis respons JSON terus ke w .

Contoh: Buat pengguna baru

 Funce CreateUser (w http.ResponseWriter, r *http.request) {
    Pengguna var newuser
    jika err: = json.newDecoder (r.body) .decode (& newUser); err! = nil {
        http.error (W, "Invalid JSON", http.statusbadrequest)
        Kembali
    }

    // Berikan ID (kenaikan mudah)
    jika len (pengguna) == 0 {
        newuser.id = 1
    } else {
        newuser.id = pengguna [len (pengguna) -1] .id 1
    }

    Pengguna = Tambah (Pengguna, NewUser)

    W.Header (). Set ("Kandungan-Jenis", "Aplikasi/JSON")
    W.WriteHeader (http.StatusCreated)
    json.newencoder (w) .encode (NewUser)
}

• Decode permintaan badan ke dalam struktur User .
• Sahkan input (pemeriksaan asas di sini; berkembang seperti yang diperlukan).
• Pulangan 201 Created dengan sumber baru.

Contoh: Dapatkan pengguna dengan ID

 Import "Regexp"
Import "STRCONV"
Import "Strings"

func getUserbyId (w http.ResponseWriter, r *http.request) {
    // Ekstrak jalan dan id parse
    Path: = r.url.path
    idstr: = strings.trimprefix (path, "/users/")

    // Pengesahan mudah
    jika idstr == "" {
        http.error (W, "ID Pengguna Hilang", http.statusbadrequest)
        Kembali
    }

    // Gunakan regex untuk memastikan ia angka dan tidak ada bahagian jalan tambahan
    jika! regexp.mustcompile (`^\ d $`) .matchstring (idstr) {
        http.error (W, "ID Pengguna Tidak Sah", http.statusbadrequest)
        Kembali
    }

    id, _: = strconv.atoi (idstr)

    untuk _, u: = pengguna julat {
        jika u.id == id {
            W.Header (). Set ("Kandungan-Jenis", "Aplikasi/JSON")
            json.newencoder (w) .encode (u)
            Kembali
        }
    }

    http.error (W, "Pengguna tidak dijumpai", http.StatusNotFound)
}

GO's ServeMux tidak menyokong parameter URL yang dinamakan seperti /users/{id} secara asli (di luar sintaks khusus kaedah), jadi anda perlu menghuraikan jalan secara manual atau menggunakan manipulasi rentetan.

Sebagai alternatif, gunakan corak seperti:

 mux.handlefunc ("get /users /", getuserbyid) // slash trailing tidak diperlukan

Kemudian periksa sama ada laluan sepadan /users/<id> di pengendali.

3. Tambah middleware untuk logik biasa

Anda boleh menulis middleware mudah tanpa rangka kerja.

Middleware pembalakan

 Func LoggingMiddleWare (seterusnya http.handlerfunc) http.handlerfunc {
    kembali func (w http.responseWriter, r *http.request) {
        log.printf (" %s %s", r.method, r.url.path)
        Seterusnya (w, r)
    }
}

Balut Pengendali:

 mux.handlefunc ("mendapatkan /pengguna", loggingmiddleWare (getUsers))

Ralat Pemulihan Middleware

 Funcule RecoverMiddleWare (seterusnya http.handlerfunc) http.handlerfunc {
    kembali func (w http.responseWriter, r *http.request) {
        menangguhkan func () {
            jika err: = pulih (); err! = nil {
                log.printf ("Panik: %v", err)
                http.error (W, "Ralat Pelayan Dalaman", http.StatusInnalserverError)
            }
        } ()
        Seterusnya (w, r)
    }
}

4. Mengendalikan kesilapan dengan anggun

Sentiasa Mengesahkan:

• Input JSON
• Parameter URL
• Kaedah permintaan

Mengembalikan kod status yang sesuai:

• 400 Bad Request - input yang cacat
• 404 Not Found - sumber tidak wujud
• 405 Method Not Allowed - Gunakan http.Error atau biarkan ServeMux mengendalikannya
• 500 Internal Server Error - Masalah yang tidak dijangka

Anda boleh membuat penolong:

 Func WriteJson (w http.ResponseWriter, status int, antara muka data {}) {
    W.Header (). Set ("Kandungan-Jenis", "Aplikasi/JSON")
    W.WriteHeader (status)
    json.newencoder (w) .encode (data)
}

Kemudian gunakan:

 WriteJson (W, http.statusok, pengguna)

5. Susun kod untuk berskala

Walaupun tanpa rangka kerja, simpan perkara yang dapat dikekalkan:

• Letakkan pengendali dalam fail berasingan (contohnya, handlers/user.go )
• Tentukan model dalam models/ atau types/ pakej
• Gunakan main.go untuk penyediaan penghalaan dan pelayan
• Pertimbangkan struktur konfigurasi untuk aplikasi aplikasi (misalnya, sambungan pangkalan data)

Struktur Contoh:

 /API
  Main.go
  /pengendali
    user.go
  /model
    user.go
  /middleware
    Logging.go

Nota akhir

• Tidak ORM atau DB? Anda boleh menggunakan database/sql atau pgx secara langsung.
• Pengesahan? Tambah cek manual atau gunakan tag validator dengan refleksi (walaupun tanpa rangka kerja).
• Ujian? net/http/httptest berfungsi dengan sempurna dengan pengendali standard.

Membina API REST tanpa rangka kerja mengajar anda bagaimana HTTP berfungsi pada tahap yang lebih mendalam dan menghasilkan kurang sihir dan kurang ketergantungan. Ia ringan, cepat, dan sepenuhnya di bawah kawalan anda.

Pada asasnya: Gunakan net/http , Struktur pengendali anda, menghuraikan input dengan teliti, kembali JSON, dan tambah middleware dengan pembalut. Tiada kerangka kerja yang diperlukan.

Atas ialah kandungan terperinci Cara Membina API RESTful tanpa Rangka Kerja di Golang. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!