Zwróć błędy postgres w odpowiedzi interfejsu API

Dec 24 2020

Mam w kodzie dwie proste metody API. Metoda z endpoind /api/user/createtworzy użytkownika. Pole usernamejest wyjątkowe. Kiedy próbuję utworzyć użytkownika o tej samej nazwie użytkownika, która już istnieje w bazie danych, pojawia się błąd w konsoli:

(/home/andrej/go/src/go_contacts/models/users.go:19) 
[2020-12-23 22:03:10]  pq: duplicate key value violates unique constraint "users_username_key"

Chcę pokazać ten błąd w odpowiedzi użytkownikowi lub w jakiś sposób zidentyfikować typ błędu w moim kodzie, aby wyświetlić różne komunikaty o błędach dla użytkownika. Wiem tylko, że jeśli mam błąd, userzwraca mi id = 0. Ale nie wygląda to na dobrą wiadomość dla użytkownika.

main.go

package main

import (
    "fmt"
    "go_contacts/controllers"
    "net/http"
    "os"

    "github.com/gorilla/mux"
    "github.com/joho/godotenv"
)

func main() {
    godotenv.Load(".env")


    router := mux.NewRouter()
    router.HandleFunc("/", controllers.ReturnHello).Methods("GET")
    router.HandleFunc("/api/user/create", controllers.CreateUser).Methods("POST")

    port := os.Getenv("PORT")
    if port == "" {
        port = "8000"
    }

    err := http.ListenAndServe(":"+port, router)
    if err != nil {
        fmt.Print(err)
    }
}

models.go ze strukturą użytkownika:

package models

import (
    u "go_contacts/utils"

    "github.com/jinzhu/gorm"
)

// User base model
type User struct {
    gorm.Model
    Username string `json:"username" gorm:"unique"`
    Password string `json:"password"`
    Email    string `json:"email"`
}

// Create new user
func (user *User) Create() map[string]interface{} {
    GetDB().Create(user)

    if user.ID <= 0 {
        return u.Message(false, "Failed to create user, connection error.")
    }

    response := u.Message(true, "Account has been created")
    response["user"] = user
    return response
}

Odpowiedzi

1 AlekseySpirin Dec 24 2020 at 17:04

Jeśli chodzi o pq v1.5.2 i gorm v1.9.12

Najpierw musisz określić, czy wywołanie metody create zwraca błąd, czy nie. Tak, tak

err := GetDB().Create(user).Error
if err != nil {
    // code to handle error
}

Wtedy pakiet pq ma specjalny typ, który mapuje na błąd serwera postgres. Zawiera pola, które pomogą Ci zidentyfikować wagę błędu, jego kod, tabelę, która jest powiązana z błędem itp.

Pełną listę identyfikatorów pól psql można znaleźć tutaj w

Pola komunikatów o błędach i powiadomieniach

https://www.postgresql.org/docs/current/protocol-error-fields.html

Aby rozwiązać problem jako opcję, możemy użyć pola

Code

Który jest ciągową reprezentacją kodu błędu. Ale najpierw musimy rzucić błąd i sprawdzić typ rzutowania powiodło się. Tak, tak

err := GetDB().Create(user).Error
if err != nil {
    pqErr, ok := err.(pq.Error)
    if !ok {
        log.Fatal(err)
    }

    // code to handle specific error code
}

Listę kodów błędów można znaleźć zarówno w oficjalnych dokumentach postgresql https://www.postgresql.org/docs/9.3/errcodes-appendix.html

I rzeczywiste mapowania go pq do błędu w github.com/lib/pq/error.go jak dla biblioteki pq

I wreszcie możemy traktować błąd jako duplikat kodu

err := GetDB().Create(user).Error
if err != nil {
    pqErr, ok := err.(pq.Error)
    if !ok {
        log.Fatal(err)
    }

    // note that type casting here is redundant and used for showing specific 
    // string type from pq library
    if pqErr.Code == pq.ErrorCode("23505") { // 23505 is unique_violation error code for psql
        // now you can create error and write it to a message to return it for 
        // a client
    }
}
1 Brits Dec 24 2020 at 02:59

Zgodnie z komentarzem gorm zapewnia dostęp do błędów bazy danych z funkcji Utwórz rekord w następujący sposób:

result := GetDB().Create(user)
if result.Error != nil {
   // Do something with the error
}

Zwróć uwagę, że sprawdzenie ciągu błędu może sprawić, że Twoja baza danych aplikacji będzie specyficzna (ale może to nie stanowić problemu). Odpowiedzi na to pytanie mogą stanowić dalszą pomoc.