オライリー出版のGo言語によるWebアプリケーション開発を読んだ感想 チャット部分編
オライリーから出版されているGo言語によるWebアプリケーション開発
を読みました。1章から3章までがWebsocketを使用したチャットアプリケーション開発となるのですが、その部分を読んだまとめ・感想を書いていきます。
www.oreilly.co.jp
github.com
webサーバ公開の基本
アクセスパスと処理を結びつけます。
パスは完全一致ではなく前方一致となるため、注意が必要となります。/
を登録した場合は/app
とアクセスしても関連付けた処理が実行されます。
結びつけたあとに、ListenAndServeメソッドを使ってWebサーバを開始します。
http.HundleFuncでパスと関数を紐づける
この後に挙げるhttp.Handleとは違い、Handlerのインターフェースを実装した構造体を用意する必要がありません。
その代わり、状態などを持たせることが出来ないため注意です。
http.HandleFunc("/auth/", loginHandler)
http.HandleでパスとHandlerを紐づける
Handlerのインターフェースを実装した構造体を用意した上で、http.Handle関数の第二引数に渡してあげる。Handler(https://golang.org/pkg/net/http/#Handler)は、ServeHTTP(w http.ResponseWriter, r *http.Request)
メソッドのみを持つインターフェースになっている。http.Handle関数にて指定したリクエストパスにマッチするリクエストが来た場合に、ServeHTTPメソッドの中に書いた処理が実行される。
下の例は、返却するhtmlファイルに埋め込むデータオブジェクトを作成し、そのデータオブジェクトをコンパイル済のHtmlテンプレートにapplyする処理。ただし、初回リクエストが来たときにテンプレートファイルをコンパイルする。初回だけの実行を保証するための実装としては、sync.Once
を使用している。起動時にコンパイルしないこの方法を、遅延初期化として本では取り上げられており、セットアップ処理に時間がかかる場合や利用頻度の低い機能では効果的と説明されています。ただファイルが無いなどの状態を検知できないため、template.Must
を使用してグルーバル変数にセットする方法が好まれることもあるとのこと。
http.Handle("/login", &templateHandler{filename: "login.html"})
type templateHandler struct {
once sync.Once
filename string
temp1 *template.Template
}
func (t *templateHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
t.once.Do(func() {
t.temp1 =
template.Must(template.ParseFiles(filepath.Join("templates", t.filename)))
})
data := map[string]interface{}{
"Host": r.Host,
}
if authCookie, err := r.Cookie("auth"); err == nil {
data["UserData"] = objx.MustFromBase64(authCookie.Value)
}
t.temp1.Execute(w, data)
}
template.Must
を使用してグルーバル変数にセットする方法は以下。この方法使用すると、もしエラーがある場合にはpanicを起こし起動しなくなるため、エラーに気づかない事象を避けることができる。
var temp1 = template.Must(template.ParseFiles(filepath.Join("templates", "login.html")))
以下のコマンドでWebサーバを開始する。
if err := http.ListenAndServe(*addr, nil); err != nil {
log.Fatal("ListenAndServe:", err)
}
HTTP2をつかった通信をしたいのであれば、以下のようになる。
certFile, _ := filepath.Abs("server.crt")
keyFile, _ := filepath.Abs("server.key")
if err := http.ListenAndServeTLS(*addr, certFile, keyFile, nil); err != nil {
log.Fatal("ListenAndServe:", err)
}
実装としては割れるのは、http.HandleFuncを使うかhttp.Handleを使うかというところだと思うが、遅延初期化を使わない場合には、http.HandleFuncで事足りるのではと私は感じている。
チャットアプリケーションのモデル化
ここでのチャットアプリケーションの要件は、一つの公開されたチャットルームにクライアントは自動的にログインして会話をするというもの。クライアントとの通信を管理するclientとという構造体とクライアントの入退出の管理やメッセージをブロードキャストする役割を持つroomという構造体で構成する。
client
Client構造体は、各クライアントごとに必要となるwebsocketのコネクションと他クライアントからのメッセージを格納するチャネルを持つ。また、ブラウザから送信されるメッセージをRoomに送るためにRoomへの参照を持っている。
clientのメソッドは各クライアントに対応するため、ServeHTTPメソッドの中で実行される。他クライアントからのメッセージを格納するチャネルをクライアント側で持つのは、言わずもがなWebsocketに書き出すWriteメソッドをクライアント側で持つため(おそらくsocketのコネクションを他ソースコードに使わせずチャネルでやり取りしたかった)。
type client struct {
socket *websocket.Conn
send chan []byte
room *room
}
func (c *client) read() {
for {
if _, msg, err := c.socket.ReadMessage(); err == nil {
c.room.forward <- msg
} else {
break
}
}
c.socket.Close()
}
func (c *client) write() {
for msg := range c.send {
if err := c.socket.WriteMessage(websocket.TextMessage, msg); err != nil {
break
}
}
c.socket.Close()
}
room
room構造体は他のクライアントに転送するためのメッセージを保持するチャネルと入退出を受け取るチャネル、クライアント全体のデータを持つ。
外部から利用しやすいように、newRoom()という関数を作る。run()メソッドはgoルーチンでWEBサーバと並列で実行される。チャネルへのメッセージの処理には、selectを使用している。
type room struct {
forward chan []byte
join chan *client
leave chan *client
clients map[*client]bool
tracer trace.Tracer
}
func newRoom() *room {
return &room{
forward: make(chan []byte),
join: make(chan *client),
leave: make(chan *client),
clients: make(map[*client]bool),
}
}
func (r *room) run() {
for {
select {
case client := <-r.join:
r.clients[client] = true
case client := <-r.leave:
delete(r.clients, client)
close(client.send)
case msg := <-r.forward:
for client := range r.clients {
select {
case client.send <- msg:
r.tracer.Trace(" -- クライアントに送信されました")
default:
delete(r.clients, client)
close(client.send)
}
}
}
}
}
Roomでの処理をHTTPハンドラ化
HTTPハンドラ化するにあたり、room構造体はServeHTTPメソッドを実装する必要がある。
Upgraderメソッドによりhttp通信はWebsocket通信へアップグレードされます。そして変数socketにwebcsocket通信のコネクションが入ってきます。
func (r *room) ServeHTTP(w http.ResponseWriter, req *http.Request) {
socket, err := upgrader.Upgrade(w, req, nil)
if err != nil {
log.Fatal("ServeHTTP:", err)
return
}
client := &client{
socket: socket,
send: make(chan []byte, messageBufferSize),
room: r,
}
r.join <- client
defer func() { r.leave <- client }()
go client.write()
client.read()
}
main関数の流れは以下のようになります。
http.Handle("/room", r)
http.Handle("/chat", &templateHandler{filename: "chat.html"})
go r.run()
認証機能
HTTPハンドラのdecoratorパターン
認証機能を作るにあたり、/roomにアクセスした際の処理を認証用のHTTPハンドラを用意しラップします。次に実行する処理を持つハンドラを認証ハンドラの構造体にフィールドに登録できるようにしておきます。認証用のハンドラは、認証が正常に完了したら、認証用ハンドラの次に実行するハンドラのServeHTTP()メソッドを実行することで処理を渡します。
http.Handle("/chat", MustAuth(&templateHandler{filename: "chat.html"}))
func MustAuth(handler http.Handler) http.Handler {
return &authHandler{next: handler}
}
func (h *authHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
if _, err := r.Cookie("auth"); err == http.ErrNoCookie {
w.Header().Set("Location", "/login")
w.WriteHeader(http.StatusTemporaryRedirect)
} else if err != nil {
panic(err.Error())
} else {
h.next.ServeHTTP(w, r)
}
}
このWrapするパターンですが、以下のようにWrapperをhttp.HandleFuncを使って記述することも可能です。
(参考元->https://medium.com/@matryer/the-http-handler-wrapper-technique-in-golang-updated-bc7fbcffa702)
http.Handle("/chat", MustAuth(&templateHandler{filename: "chat.html"}))
func MustAuth(h http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r
*http.Request) {
if _, err := r.Cookie("auth"); err == http.ErrNoCookie {
w.Header().Set("Location", "/login")
w.WriteHeader(http.StatusTemporaryRedirect)
} else if err != nil {
panic(err.Error())
} else {
h.ServeHTTP(w, r)
}
})
}
wrapする側もされる側もHandleFuncにするなら以下のような形です。
(参考元->https://twinbird-htn.hatenablog.com/entry/2016/06/06/001704)
http.HandleFunc("/chat", MustAuth(templateHandleFunc("chat.html")))
func MustAuth(fn http.HandlerFunc) http.HandlerFunc {
return func(w http.ResponseWriter, r *http.Request) {
if _, err := r.Cookie("auth"); err == http.ErrNoCookie {
w.Header().Set("Location", "/login")
w.WriteHeader(http.StatusTemporaryRedirect)
} else if err != nil {
panic(err.Error())
} else {
fn(w, r)
}
}
}
OAuth2
この本ではgomniauthというOSSが利用されていたが、gomniauthを使うと何故かobjx: JSON encode failed with: json: unsupported type: func() string
というgomiauthの中で使用されているライブラリの中で落ちるという現象にあい、ここで時間をとるのも…と思い、golang.org/x/oauth2
というパッケージを利用しました。
処理の流れとしては、以下の記事を参考にいたしました。
dev.to
var googleOauthConfig = &oauth2.Config{
RedirectURL: "http://localhost:8080/auth/callback/google",
ClientID: os.Getenv("OAUTH_ID_GOOGLE"),
ClientSecret: os.Getenv("OAUTH_KEY_GOOGLE"),
Scopes: []string{"https://www.googleapis.com/auth/userinfo.profile"},
Endpoint: google.Endpoint,
}
func loginHandler(w http.ResponseWriter, r *http.Request) {
segs := strings.Split(r.URL.Path, "/")
action := segs[2]
switch action {
case "login":
state, expiration := generateStateOauthCookie(w)
u := googleOauthConfig.AuthCodeURL(state)
cookie := http.Cookie{Name: "oauthstate", Value: state, Expires: expiration, Path: "/"}
http.SetCookie(w, &cookie)
http.Redirect(w, r, u, http.StatusTemporaryRedirect)
case "callback":
oauthState, _ := r.Cookie("oauthstate")
fmt.Println(r.FormValue("state"))
fmt.Println(oauthState.Value)
if r.FormValue("state") != oauthState.Value {
log.Fatalln("invalid oauth google state")
return
}
data, err := getUserDataFromGoogle(r.FormValue("code"))
if err != nil {
log.Println(err.Error())
http.Redirect(w, r, "/", http.StatusTemporaryRedirect)
return
}
var profile Profile
if err := json.Unmarshal(data, &profile); err != nil {
fmt.Println("error:", err)
}
authCookieValue := objx.New(map[string]interface{}{
"name": profile.Name,
}).MustBase64()
http.SetCookie(w, &http.Cookie{
Name: "auth",
Value: authCookieValue,
Path: "/"})
w.Header()["Location"] = []string{"/chat"}
w.WriteHeader(http.StatusTemporaryRedirect)
default:
w.WriteHeader(http.StatusNotFound)
fmt.Fprintf(w, "アクション%sには非対応です", action)
}
}
SNSから取得するパターン、Gravatarから取得するパターン、画像のアップロードしてもらうパターンの3種ありましたが、前の2つは実装自体は難しくなかったため3つ目の画像のアップロード・提供について書いていきます。
具体的な処理から抽象化していく工程も書いていきたかったのですが、言語化するのが難しかった…。
画像のアップロード
http.HandleFunc("/uploader", uploaderHandler)
func uploaderHandler(w http.ResponseWriter, req *http.Request) {
userId := req.FormValue("userid")
file, header, err := req.FormFile("avatarFile")
if err != nil {
fmt.Fprintln(w, err.Error())
return
}
defer file.Close()
data, err := ioutil.ReadAll(file)
if err != nil {
fmt.Fprintln(w, err.Error())
return
}
filename := filepath.Join("avatars", userId+filepath.Ext(header.Filename))
err = ioutil.WriteFile(filename, data, 0644)
if err != nil {
fmt.Fprintln(w, err.Error())
return
}
fmt.Fprintln(w, "success!!")
}
提供するときには組み込みのファイルサーバ機能を使います。
http.Handle("/avatars/",
http.StripPrefix("/avatars/",
http.FileServer(http.Dir("./avatars"))))
まとめ
本自体は原本が2014年の出版でかなり古いので、新しい情報とかも見つつ整理していくのが大事だなと思いました。
普通WEBアプリケーションを作成するときは標準パッケージではなくGinとか使われていくのだろうなとは思っているのですが…。
ただメルカリさんのAPIサーバのように、net/http
パッケージだけを見て作成されるパターンもあるので、実際は用途によっての使い分けなんですかね。
メルカリさんのAPIサーバの実装に関する記事↓
tech.mercari.com