Introduction
인턴의 업무(?) 중에서 가장 어렵고 복잡하면서 (사실 조금)지루한 일은 소스코드 분석 이었다. 특히 Node Exporter 라는 구조화된 프로그램을 분석하면서 http server-client 패턴을 접할 기회가 많았는데, 이번 기회에 제대로 정리해보려고 한다.
Web Server
웹 서버는 web browser와 같은 클라이언트로부터 http 프로토콜 요청을 받아 html 문서 등과 같은 정적 웹 페이지를 응답해주는 소프트웨어이다.
위 그림에서처럼, 브라우저가 웹 서버의 파일을 필요로 할 때, HTTP Request를 통해 파일을 요청하고, Web Server에서 HTTP Response를 통해 요청된 문서를 보내준다.
golang 에서는 Go의 표준 패키지인 net/http 패키지를 통해 웹 관련 서버(및 클라이언트) 기능을 제공한다. 주요 http 패키지 메서드로 ListenAndServe(), Handle(), HandleFunc() 등을 들 수 있다.
Handle과 HandleFunc()
Handle()과 HandleFunc() 메서드는 요청된 request path에 어떤 request 핸들러를 사용할 지를 지정하는 라우팅 역할을 한다.
http.HandleFunc()
http.HandleFunc("/hello", func(w http.ResponseWriter, req *http.Request) {
w.Write([]byte("Hello World"))
})
http.Handle()
http.Hanlde()는 첫번째 파라미터로 url 을 받아들이고, 두번째 파라미터는 handler 인스턴스를 new() 함수로 생성하여 전달한다.
package main
import (
"net/http"
)
func main() {
http.Handle("/", new(testHandler))
http.ListenAndServe(":5000", nil)
}
type testHandler struct {
http.Handler
}
//testHandler 객체의 method
func (h *testHandler) ServeHTTP(w http.ResponseWriter, req *http.Request) {
str := "Your Request Path is " + req.URL.Path
w.Write([]byte(str))
}
ListenAndServe()
ListenAndServe() 메서드는 지정된 포트에 웹 서버를 열고 클라이언트 Request를 받아들여 새 go 루틴에 작업을 할당하는 일을 한다. 첫번째 파라미터로는 해당 경로에서 Request를 Listen 할 것인지를 정하고, 두번째는 어떤 ServeMux(또는 ServeHTTP)를 사용할 지를 지정하는데 nil의 경우 DefaultServeMux를 사용한다.
ServeMux는 기본적으로 HTTP Request Router(혹은 Multiplexor)인데, 일반적으로 내장된 DefaultServeMux을 사용하지만, 개발자가 별도로 ServeMux를 만들어 Routing 부분을 세밀하게 제어할 수도 있다).
http.ListenAndServe(":5000", nil) //DefaultServeMux 사용
http.ListenAndServe("localhost:8080", db) //ServeHTTP 메서드를 가진 handler 구조체
http.ListenAndServe("localhost:8000", mux) //ServeMux 메서드를 가진 handler 구조체
보충설명
func ListenAndServe(addr string, handler Handler) error
위와같이 ListenAndServer는 두번째 인자로 (ServeHTTP를 메서드로 가진 인터페이스인) handler를 받는다.
즉 Handler 타입을 확인해보면,
type Handler interface {
ServeHTTP(ResponseWriter, *Request)
}
Handler는 interface이며 ServeHTTP를 가지고 있음을 확인할 수 있다.
예제
다음은 가장 기본적인 Go based web server 이다.
package main
import (
"fmt"
"net/http"
)
func handler(w http.ResponseWriter, r *http.Request) {
fmt.Fprintf(w, "Hello %s", r.URL.Path[1:])
}
func main() {
http.HandleFunc("/World", handler)
http.ListenAndServe(":8080", nil)
}
이 간단한 web server 구현을 4가지 방법으로 해볼 수 있다. 사실 3가지인데, 1,2번은 결국 같은 방법이기 때문이다.
- No request parsing
- Manual request parsing
- Multiplexer
- Global multiplexer
No request parsing
package main
import (
"fmt"
"log"
"net/http"
)
type pounds float32
func (p pounds) String() string {
return fmt.Sprintf("£%.2f", p)
}
type database map[string]pounds
func (d database) ServeHTTP(w http.ResponseWriter, r *http.Request) {
for item, price := range d {
fmt.Fprintf(w, "%s: %s\n", item, price)
}
}
func main() {
db := database{
"foo": 1,
"bar": 2,
}
log.Fatal(http.ListenAndServe("localhost:8000", db))
}
가장 raw 한 예시이다. ListenAndServe의 두번째 argument로 db를 전달한다.
참고: argument는 전달 인자, 인자를 의미한다. 함수 혹은 메서드를 호출 할때 전달 혹은 입력되는 실제값이다. 반면 parameter는 함수 혹은 메서드 정의에서 나열되는 변수 명이다.
위 코드를 보면 db는 database type의 인스턴스 이고, 이 database type은 keys 값으로 strings, values 값으로 pounds값을 가진다. 또한 이 database type은 ServeHTTP 메서드를 가지기 때문에 ListenAndServe 메서드의 두번째 인자값은 (ServeHTTP 메서드를 가진 인터페이스인) Handler 타입이어야 한다는 조건을 만족한다.
위 web server는 URL값에 관계없이 동일한 요청을 처리하는 것이다. 예를들어
http://localhost:8000/
http://localhost:8000/abc
http://localhost:8000/xyz
세가지 결과 모두
foo: £1.00
bar: £2.00
라는 결과값을 리턴한다.
Manual request parsing
위 코드에 ServeHTTP 메서드에 switch문을 추가하여 다양한 routes를 다룰 수 있는 기능을 추가해보자.
package main
import (
"fmt"
"log"
"net/http"
)
type pounds float32
func (p pounds) String() string{
return fmt.Sprintf("£%.2f", p)
}
type database map[string]pounds
func (d database) ServeHTTP(w http.ResponseWriter, r *http.Request) {
switch r.URL.Path {
case "/foo":
fmt.Fprintf(w, "foo: %s\n", d["foo"])
case "/bar":
fmt.Fprintf(w, "bar: %s\n", d["bar"])
default:
w.WriteHeader(http.StatusNotFound)
fmt.Fprintf(w, "No page found for: %s\n", r.URL)
}
}
func main() {
db := databse{
"foo": 1,
"bar": 2,
}
log.Fatal(http.ListenAndServe("localhost:8080", db))
}
Multiplexer
위 코드는 각 case별로 나누어 처리할 수 있게되었다. 그러나 여전히, switch 문을 통해 조건을 처리하는 것에 제한되어있다.
위 코드에서 switch 로 분기된 부분을 함수로 만들어 준다. 그리고 이번에는 ServeHTTP 대신 ServeMux를 사용해보자. ServeMux 인스턴스는 Multiplexer 이며 ListenAndServe의 두번째 인자로 들어갈 수 있다. ServeMux를 사용하려면 http.NewServeMux를 선언해야한다.
package main
import(
)
type pounds float32
func (p pounds) String() string {
return fmt.Sprintf("£%.2f", p)
}
type database map[string]pounds
func (d database) foo(w http.ResponseWriter, r *http.Request) {
fmt.Fprintf(w, "foo: %s\n", d["foo"])
}
func (d database) bar(w http.ResponseWriter, r *http.Request) {
fmt.Fprintf(w, "bar: %s\n", d["bar"])
}
func (d database) baz(w http.ResponseWriter, r *http.Request) {
fmt.Fprintf(w, "baz: %s\n", d["baz"])
}
func main() {
db := database{
"foo": 1,
"bar": 2,
"baz": 3,
}
mux := http.NewServerMux()
mux.Handle("/foo", http.HandleFunc(db.foo))
mux.Handle("/bar", http.HandleFunc(db.bar))
mux.HandleFunc("/baz", db.baz)
log.Fatal(http.ListenAndServe("localhost:8000", mux))
}
Global Multiplexer
Web server를 만들다 보면 기능별로 여러개의 package를 만들어 사용하게 된다. ServeMux를 각 package별로 만들어야 되는데 그 대신에 Go의 DefaultServeMux를 사용하는 방법이 있다. DefaultServeMux를 사용하면 ListenAndServe의 두 번째 인자에 nil이 들어가게 된다
package main
import (
"fmt"
"log"
"net/http"
)
type pounds float32
func (p pounds) String() string {
return fmt.Sprintf("£%.2f", p)
}
type database map[string]pounds
func (d database) foo(w http.ResponseWriter, r *http.Request) {
fmt.Fprintf(w, "foo: %s\n", d["foo"])
}
func (d database) bar(w http.ResponseWriter, r *http.Request) {
fmt.Fprintf(w, "bar: %s\n", d["bar"])
}
func (d database) baz(w http.ResponseWriter, r *http.Request) {
fmt.Fprintf(w, "baz: %s\n", d["baz"])
}
func main() {
db := database{
"foo": 1,
"bar": 2,
"baz": 3,
}
http.HandleFunc("/foo", db.foo)
http.HandleFunc("/bar", db.bar)
http.HandleFunc("/baz", db.baz)
log.Fatal(http.ListenAndServe("localhost:8000", nil))
}