Chapter5. HTTP Server - Basic, mux handler, Request with Context

[robert-min]

Basic HTTP server

• net/http 패키지를 통해 HTTP 서버 구축
• ListenAndServer 함수로 주어진 네트워크 주소에서 HTTP 서버 시작

[robert-min]

Basic HTTP server 구현

func main() {
    listenAddr := os.Getenv("LISTEN_ADDR")
    if len(listenAddr) == 0 {
        listenAddr = ":8080"
    }
    log.Fatal(http.ListenAndServe(listenAddr, nil))
}

[robert-min]

Handler 함수 설정

• ListenAndServer() 함수의 두번째 매개변수 nil 을 지정하면 기본 핸들러인 DefaultServerMux를 사용
• mux 를 사용해 특정 경로에 특정함수를 호출하는 핸들러 함수를 등록

[robert-min]

Handler 함수 설정 코드

func apiHandler(w http.ResponseWriter, r *http.Request) {
    fmt.Fprintf(w, "Hello, world!")
}

func healthCheckHandler(w http.ResponseWriter, r *http.Request) {
    fmt.Fprintf(w, "ok")
}

func setupHandlers(mux *http.ServeMux) {
    mux.HandleFunc("/api", apiHandler)
    mux.HandleFunc("/healthz", healthCheckHandler)
}

func main() {
    listenAddr := os.Getenv("LISTEN_ADDR")
    if len(listenAddr) == 0 {
        listenAddr = ":8080"
    }

    mux := http.NewServeMux()
    setupHandlers(mux)

    log.Fatal(http.ListenAndServe(listenAddr, mux))
}

[robert-min]

HTTP 함수 설정 테스트 코드

package main

import (
    "io"
    "log"
    "net/http"
    "net/http/httptest"
    "testing"
)

func TestServer(t *testing.T) {
    tests := []struct {
        name     string
        path     string
        expected string
    }{
        {
            name:     "index",
            path:     "/api",
            expected: "Hello, world!",
        },
        {
            name:     "healthcheck",
            path:     "/healthz",
            expected: "ok",
        },
    }
    mux := http.NewServeMux()
    setupHandlers(mux)

    ts := httptest.NewServer(mux)
    // Shut down the server before the test function exits
    defer ts.Close()

    for _, tc := range tests {
        t.Run(tc.name, func(t *testing.T) {
            resp, err := http.Get(ts.URL + tc.path)
            respBody, err := io.ReadAll(resp.Body)
            resp.Body.Close()
            if err != nil {
                log.Fatal(err)
            }
            if string(respBody) != tc.expected {
                t.Errorf(
                    "Expected: %s, Got: %s",
                    tc.expected, string(respBody),
                )
            }
        })
    }

}

[robert-min]

Request 객체에 메타데이터 부착

• 핸들러 함수가 처리하는 모든 수신 요청에는 연관된 콘텍스트가 존재
• 해당 콘텍스트에 특정 데이터를 부착함으로써 요청 생명주기 동안 데이터를 저장하는데 유용하게 숑
• 아래는 Request 요청에 고유한 아이디 값 부착

[robert-min]

Request 객체에 메타데이터(고유한 아이디 값) 부착 코드

type requestContextKey struct{} // key경우 string과 같은 기본 데이터 타입이 안되기 때문에 공백의 구조체로 정의
type requestContextValue struct {
    requestID string
}

// Add Request ID
func addRequestID(r *http.Request, requestID string) *http.Request {
    c := requestContextValue{
        requestID: requestID,
    }
    currentCtx := r.Context()
    // WithValue(저장될 값의 콘텍스트를 식별하기 위한 부모 Context 객체, 맵 자료구조에서 데이터 키값을 식별하기 위한 interface 객체,
    // 데이터 자체의 interface{} 객체)
    newCtx := context.WithValue(currentCtx, requestContextKey{}, c)
    return r.WithContext(newCtx)
}

func logRequest(r *http.Request) {
    ctx := r.Context()
    v := ctx.Value(requestContextKey{})

    if m, ok := v.(requestContextValue); ok {
        log.Printf("Processing request: %s", m.requestID)
    }
}

func processRequest(w http.ResponseWriter, r *http.Request) {
    logRequest(r)
    fmt.Fprintf(w, "Request processed")
}

func apiHandler(w http.ResponseWriter, r *http.Request) {
    requestID := "request-123-abc"
    r = addRequestID(r, requestID)
    processRequest(w, r)
}

func main() {
    listenAddr := os.Getenv("LISTEN_ADDR")
    if len(listenAddr) == 0 {
        listenAddr = ":8080"
    }

    mux := http.NewServeMux()
    mux.HandleFunc("/api", apiHandler)

    log.Fatal(http.ListenAndServe(listenAddr, mux))
}