Golang での Web サーバー開発 - 単純なものから複雑なものまで

XNUMX年前に始めました ゴフィッシュを開発する、これは Golang を学ぶ機会を提供しました。 Go は強力な言語であり、多くのライブラリによって補完されていることに気づきました。 Go は多用途です。特に、サーバー側アプリケーションの開発に問題なく使用できます。

この記事は Go でのサーバーの作成に関する記事です。 「Hello world!」のような単純なものから始めて、次の機能を持つアプリケーションで終わりましょう。

- HTTPS で Let's Encrypt を使用する。
— API ルーターとして機能します。
— ミドルウェアの操作。
— 静的ファイルの処理。
— 正しいシャットダウン。

スキルボックスは次のことを推奨します。 実践コース 「ゼロからのPython開発者」.

リマインダー： 「Habr」のすべての読者が対象 - 「Habr」プロモーション コードを使用してスキルボックス コースに登録すると 10 ルーブルの割引。

こんにちは、世界！

Go では Web サーバーを非常に迅速に作成できます。 以下は、上で約束した「Hello, world!」を返すハンドラーの使用例です。

package main
 
import (
"fmt"
"net/http"
)
 
func main() {
http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
fmt.Fprintf(w, "Hello World!")
})
http.ListenAndServe(":80", nil)
}

この後、アプリケーションを実行してページを開くと、 ローカルホスト, するとすぐに「Hello, world!」というテキストが表示されます。 (もちろん、すべてが正しく動作する場合)。

後でハンドラーを複数回使用しますが、最初にすべてがどのように機能するかを理解しましょう。

ネット/http

例ではパッケージを使用しました net/http、これはサーバーと HTTP クライアントの両方を開発するための Go の主要なツールです。 コードを理解するために、http.Handler、http.ServeMux、http.Server という XNUMX つの重要な要素の意味を理解しましょう。

HTTPハンドラー

リクエストを受信すると、ハンドラーはそれを分析し、応答を生成します。 Go のハンドラーは次のように実装されます。

type Handler interface {
        ServeHTTP(ResponseWriter, *Request)
}

最初の例では、http.HandleFunc ヘルパー関数を使用します。 これは別の関数をラップし、次に http.ResponseWriter と http.Request を ServeHTTP に取り込みます。

言い換えれば、Golang のハンドラーは単一のインターフェースで表示され、プログラマーに多くのオプションを提供します。 したがって、たとえば、ミドルウェアはハンドラーを使用して実装されます。このハンドラーでは、ServeHTTP が最初に何かを実行してから、別のハンドラーの ServeHTTP メソッドを呼び出します。

前述したように、ハンドラーはリクエストに対する応答を生成するだけです。 しかし、特定の時点でどの特定のハンドラーを使用する必要があるのでしょうか?

リクエストルーティング

正しい選択をするには、HTTP マルチプレクサーを使用してください。 多くのライブラリではマルチプレクサーまたはルーターと呼ばれていますが、それらはすべて同じものです。 マルチプレクサの機能は、リクエスト パスを分析し、適切なハンドラを選択することです。

複雑なルーティングのサポートが必要な場合は、サードパーティのライブラリを使用することをお勧めします。 最も先進的なもののいくつか - ゴリラ/マックス и ゴチ/チ, これらのライブラリを利用することで中間処理を問題なく実装することができます。 彼らの助けを借りて、ワイルドカード ルーティングを構成し、他の多くのタスクを実行できます。 それらの利点は、標準の HTTP ハンドラーとの互換性です。 その結果、将来変更できる単純なコードを作成できます。

通常の状況で複雑なフレームワークを使用するには、非標準のソリューションが必要となり、これによりデフォルトのハンドラーの使用が大幅に複雑になります。 大部分のアプリケーションを作成するには、デフォルトのライブラリと単純なルーターの組み合わせで十分です。

クエリ処理

さらに、受信接続を「リッスン」し、すべてのリクエストを正しいハンドラーにリダイレクトするコンポーネントが必要です。 http.Server はこのタスクを簡単に処理できます。

以下は、サーバーが接続処理に関連するすべてのタスクを担当することを示しています。 たとえば、これは TLS プロトコルを使用して機能します。 http.ListenAndServer 呼び出しを実装するには、標準の HTTP サーバーが使用されます。

次に、より複雑な例を見てみましょう。

Let's Encrypt の追加

デフォルトでは、アプリケーションは HTTP プロトコル上で実行されますが、HTTPS プロトコルを使用することをお勧めします。 これは Go では問題なく実行できます。 証明書と秘密キーを受け取った場合は、正しい証明書とキー ファイルを使用して ListenAndServeTLS を登録するだけで十分です。

http.ListenAndServeTLS(":443", "cert.pem", "key.pem", nil)

いつでもより良いものを作ることができます。

暗号化しよう 自動更新付きの無料証明書を提供します。 サービスを利用するにはパッケージが必要です autocert.

これを構成する最も簡単な方法は、autocert.NewListener メソッドを http.Serve と組み合わせて使用​​することです。 このメソッドを使用すると、HTTP サーバーがリクエストを処理している間に TLS 証明書を取得および更新できます。

http.Serve(autocert.NewListener("example.com"), nil)

ブラウザで開くと example.com、「Hello, world!」という HTTPS 応答を受け取ります。

より詳細な構成が必要な場合は、autocert.Manager マネージャーを使用する必要があります。 次に、独自の http.Server インスタンスを作成し (これまではデフォルトで使用していました)、マネージャーを TLSConfig サーバーに追加します。

m := &autocert.Manager{
Cache:      autocert.DirCache("golang-autocert"),
Prompt:     autocert.AcceptTOS,
HostPolicy: autocert.HostWhitelist("example.org", "www.example.org"),
}
server := &http.Server{
    Addr:      ":443",
    TLSConfig: m.TLSConfig(),
}
server.ListenAndServeTLS("", "")

これは、証明書の自動更新による完全な HTTPS サポートを実装する簡単な方法です。

カスタムルートの追加

標準ライブラリに含まれているデフォルトのルーターは優れていますが、非常に基本的なものです。 ほとんどのアプリケーションでは、ネストされたルートやワイルドカード ルート、またはパス パターンとパラメータを設定する手順など、より複雑なルーティングが必要です。

この場合、パッケージを使用する価値があります ゴリラ/マックス и ゴチ/チ。 後者の操作方法を学習します。例を以下に示します。

API のルートを含むファイル api/v1/api.go を示します。

/ HelloResponse is the JSON representation for a customized message
type HelloResponse struct {
Message string `json:"message"`
}
 
// HelloName returns a personalized JSON message
func HelloName(w http.ResponseWriter, r *http.Request) {
name := chi.URLParam(r, "name")
response := HelloResponse{
Message: fmt.Sprintf("Hello %s!", name),
}
jsonResponse(w, response, http.StatusOK)
}
 
// NewRouter returns an HTTP handler that implements the routes for the API
func NewRouter() http.Handler {
r := chi.NewRouter()
r.Get("/{name}", HelloName)
return r
}

メインファイルのルートに api/vq プレフィックスを設定します。

次に、これをメイン アプリケーションの api/v1/ プレフィックスの下にあるメイン ルーターにマウントします。

// NewRouter returns a new HTTP handler that implements the main server routes
func NewRouter() http.Handler {
router := chi.NewRouter()
    router.Mount("/api/v1/", v1.NewRouter())
    return router
}
http.Serve(autocert.NewListener("example.com"), NewRouter())

Go は複雑なルートを扱いやすいため、大規模で複雑なアプリケーションの構造とメンテナンスを簡素化できます。

ミドルウェアの操作

ステージングには、ある HTTP ハンドラーを別の HTTP ハンドラーでラップすることが含まれ、認証、圧縮、ロギング、およびその他のいくつかの機能を迅速に実行できるようになります。

例として、http.Handler インターフェイスを見て、これを使用してサービス ユーザーを認証するハンドラーを作成します。

func RequireAuthentication(next http.Handler) http.Handler {
    return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
        if !isAuthenticated(r) {
            http.Redirect(w, r, "/login", http.StatusTemporaryRedirect)
            return
        }
        // Assuming authentication passed, run the original handler
        next.ServeHTTP(w, r)
    })
}

ミドルウェア機能を拡張できる、chi などのサードパーティ製ルーターがあります。

静的ファイルの操作

Go 標準ライブラリには、画像、JavaScript、CSS ファイルなどの静的コンテンツを操作する機能が含まれています。 これらには、http.FileServer 関数を通じてアクセスできます。 特定のディレクトリからファイルを提供するハンドラーを返します。

func NewRouter() http.Handler {
    router := chi.NewRouter()
    r.Get("/{name}", HelloName)
 
// Настройка раздачи статических файлов
staticPath, _ := filepath.Abs("../../static/")
fs := http.FileServer(http.Dir(staticPath))
    router.Handle("/*", fs)
    
    return r

http.Dir は、ディレクトリにメインのindex.html ファイルが含まれていない場合、ディレクトリの内容を表示することを覚えておく価値があります。 この場合、ディレクトリが侵害されるのを防ぐために、パッケージを使用する必要があります。 unindexed.

正しいシャットダウン

Go には、HTTP サーバーの正常なシャットダウンと呼ばれる機能もあります。 これは Shutdown() メソッドを使用して実行できます。 サーバーはゴルーチンで起動され、チャネルがリッスンされて割り込み信号を受信します。 信号を受信するとすぐにサーバーの電源がオフになりますが、すぐにはオフになり、数秒後にオフになります。

handler := server.NewRouter()
srv := &http.Server{
    Handler: handler,
}
 
go func() {
srv.Serve(autocert.NewListener(domains...))
}()
 
// Wait for an interrupt
c := make(chan os.Signal, 1)
signal.Notify(c, os.Interrupt)
<-c
 
// Attempt a graceful shutdown
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
srv.Shutdown(ctx)

結論として

Go は、ほぼ普遍的な標準ライブラリを備えた強力な言語です。 そのデフォルトの機能は非常に幅広く、インターフェイスを使用して拡張できます。これにより、真に信頼性の高い HTTP サーバーを開発できます。

スキルボックスは次のことを推奨します。

• XNUMX年間の実践コース 「私はプロのウェブ開発者です」.
• 教育オンラインコース 「職業 Java 開発者」.
• 実践一年コース 「0からPROまでのPHP開発者」.

出所： habr.com