프로그래밍 언어 & 프레임워크/Golang

Go: 싱글 바이너리로 웹 서비스 제공하기 (go-bindata)

Go 를 사용하여 얻을 수 있는 이점 중 하나는, 빌드의 결과로 싱글 바이너리가 나와 간단하게 배포하고 사용자에게 제공할 수 있다는 점이다. 그런데, 이러한 Go 로 작성한 웹 서비스를 제공하려고 하다보면 각종 리소스 파일이 많아지는 것으로 인해 문제가 될 수 있다. 기껏 싱글 바이너리로 어플리케이션을 배포할 수 있는데 리소스 파일로 인해 배포할 파일이 늘어난다면 그건 이점을 살리지 못한 것이 될 지도 모른다.

리소스를 바이너리에 포함시키기

리소스를 별도의 파일로 분리시키지 않고 소스코드에 포함시켜 최종적으로는 바이너리에 포함될 수 있도록 만들 수 있는데, 바로 go-bindata 를 사용하면 그런 행위가 가능하다. go-bindata 를 사용하면 실제 파일시스템 경로와 유사한 사용방법으로 API 를 사용하여 논리적으로 접근할 수 있다.

 

https://github.com/go-bindata/go-bindata

 

go-bindata/go-bindata

Turn data file into go code. Contribute to go-bindata/go-bindata development by creating an account on GitHub.

github.com

먼저 우리는 data 라는 폴더에 txt, image, html 등 여러 리소스 파일이 있다고 가정해보자. go-bindata 를 설치했다면 go-bindata 바이너리가 설치되어 해당 커맨드를 사용할 수 있게된다.

go-bindata ./data

위와 같이 실행하고나면 bindata.go 라는 파일이 생겨나고 되고 디폴트로 main 패키지에 포함될 것이다. 만약 data 폴더 아래에 hello.txt 파일이 존재한다면 다음과 같이 접근할 수 있다.

b, err := Asset("data/hello.txt")
if err != nil {
	log.Fatal(err)
}

io.Copy(os.Stdout, bytes.NewReader(b))

go-bindata 를 사용하여 bindata.go 를 만들고 나면 해당 파일에는 파일이 바이트 배열로 바뀌어있는 모습을 볼 수 있다. 따라서 새롭게 리소스를 추가하거나 삭제하지 않는 한, 다시 go-bindata 를 실행할 필요는 없어진다.

var _dataHelloTxt = []byte("\x1f\x8b\x08\x00\x00\x00\x00\x00\x00\xff\xf2\x48\xcd\xc9\xc9\xd7\x51\x70\xcf\x57\x04\x04\x00\x00\xff\xff\x6b\x54\x39\x35\x0a\x00\x00\x00")

웹 서버에 정적파일 제공하기

이것을 사용하면 실제 파일시스템에 접근하는 것보다도 안전하게 사용자에게 정적파일 컨텐츠를 제공할 수 있다. 예를 들어 사용자가 /hello.txt 경로에 접근했다면, 소스코드에서는 hello.txt 에 접근하도록 만들면 된다. 리소스 파일은 data 폴더에 있도록 하되 미리 접두사를 만들어 놓고 data/hello.txt 가 아닌 hello.txt 만으로도 접근이 가능하도록 만들자.

go-bindata -prefix data ./data

이제 아래와 같이 웹 서버를 작성하고나면 정적파일에 접근할 수 있다. r.URL.Path 의 경우 요청 URL 이 담기게 될 텐데, http.StripPrefix() 에 의해 / 문자는 제외하고 오게된다.

package main

import (
	"log"
	"mime"
	"net/http"
	"path"
	"strconv"
)

func main() {
	http.Handle("/", http.StripPrefix("/", http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		p := r.URL.Path
		if r.URL.Path == "" {
			p = "index.html"
		}

		b, err := Asset(p)
		if err != nil {
			http.Error(w, http.StatusText(http.StatusNotFound), http.StatusNotFound)
		}

		if ctype := mime.TypeByExtension(path.Ext(r.URL.Path)); ctype != "" {
			w.Header().Set("Content-Type", ctype)
		}
		w.Header().Set("Content-Length", strconv.Itoa(len(b)))

		w.Write(b)
	})))

	err := http.ListenAndServe(":8080", nil)
	if err != nil {
		log.Fatal(err)
	}
}

본래라면 사용자에게 파일시스템에 접근할 수 있도록 하였을 때, filepath.Base() 와 같은 함수를 사용하여 보안을 신경써야 할 필요가 있었으나, 이와 같이 구성하면 필요한 리소스 파일에 대해서만 접근을 허용하기 때문에 더욱 안전하다고 볼 수 있다.