ライフサイクル

この章では、Go-Sail の動作原理とライフサイクルについて説明します。

どのように機能しますか?

Go-Sail の開始と停止は特定の順序で行われ、異なる段階で特定のタスクが実行されます。

Go-Sailのライフサイクル

初期設定

まず、Go-Sail は、後で使用するために必要な構成をプログラムスタックに挿入します。

main.go
import (
    "github.com/keepchen/go-sail/v3/sail/config"
)

var conf = &config.Config{}

config.Config{} 構成には、Go-Sail に必要な完全な構成項目が含まれています。ニーズに応じてコンテンツを設定できます。
例として、http サービスの構成を見てみましょう。サービスがリッスンするポート、サービスをデバッグモードで実行するかどうか、Swagger ドキュメントを有効にするかどうかなどを設定できます。

main.go
import (
    "github.com/keepchen/go-sail/v3/sail/config"
)

var (
    conf = &config.Config{
        HttpServer: config.HttpServerConf{
            Debug: true,
            Addr:  ":8000",
        },
    }
)

func main() {
    sail.
        WakeupHttp("go-sail", conf).
        Hook(registerRoutes, nil, nil).
        Launch()
}

スタートアップ項目の設定

次に、Go-Sail の特定の機能の動作を決定する、必要な起動項目を設定する必要があります。

API オプション (オプション)

main.go
import (
    "github.com/keepchen/go-sail/v3/constants"
    "github.com/keepchen/go-sail/v3/http/api"
    "github.com/keepchen/go-sail/v3/sail/config"
)

var (
    conf = &config.Config{
        HttpServer: config.HttpServerConf{
            Debug: true,
            Addr:  ":8000",
        },
    }
)

func main() {
    sail.
        WakeupHttp("go-sail", conf).
        SetupApiOption(&api.Option{
                Timezone:         constants.DefaultTimeZone,
                ErrNoneCode:      constants.ErrNone,
                ErrNoneCodeMsg:   "SUCCESS",
                ForceHttpCode200: true,
            }).
        Hook(registerRoutes, nil, nil).
        Launch()
}

Websocketを有効にする（オプション）

main.go
import (
    "github.com/keepchen/go-sail/v3/sail/config"
)

var (
    conf = &config.Config{
        HttpServer: config.HttpServerConf{
            Debug: true,
            Addr:  ":8000",
        },
    }
)

func main() {
    sail.
        WakeupHttp("go-sail", conf).
        EnableWebsocket(nil, nil, nil).
        Hook(registerRoutes, nil, nil).
        Launch()
}

フック関数を設定する（オプション）

main.go
import (
    "github.com/gin-gonic/gin"
    "github.com/keepchen/go-sail/v3/sail"
    "github.com/keepchen/go-sail/v3/sail/config"
)

var (
    conf = &config.Config{
        LoggerConf: logger.Conf{
            Filename: "logs/running.log",
        },
        HttpServer: config.HttpServerConf{
            Debug: true,
            Addr:  ":8000",
        },
    }
    registerRoutes = func(ginEngine *gin.Engine) {
        ginEngine.GET("/hello", func(c *gin.Context){
            c.String(http.StatusOK, "%s", "hello, world!")
        })
    }
    beforeFunc = func() {
        fmt.Println("call user function [before] to do something...")
    }
    afterFunc = func() {
        fmt.Println("call user function [after] to do something...")
    }
)

func main() {
    sail.WakeupHttp("go-sail", conf).
        Hook(registerRoutes, beforeFunc, afterFunc).
        Launch()
}

起動する

Launch() 関数が呼び出されると、Go-Sail は起動コマンドを実行し、サービスを開始します。
Go-Sail は次の手順をこの順序で実行します：

beforeFunc 関数を実行する (オプション)
この機能では特定のアクションを実行できます。この関数は、サービスが開始される前に呼び出されます。

警告
この段階では、コンポーネントはまだ初期化されていないため、この関数でコンポーネントインスタンスを呼び出すことはできません。呼び出すと、panicが発生します。
スタートアップコンポーネント
この段階で、Go-Sail はユーザーが指定した構成ファイルの内容に従って、対応するコンポーネントまたはサービスを起動します。たとえば、ログライブラリの初期化、データベース接続の初期化、Redis 接続の初期化などです。
ルーティングエンジン（gin）を初期化する
この段階で、Go-Sail はジンエンジンを初期化し、後続のルート登録の準備をします。
Websocket サービスの登録
この段階で、Go-Sail は Websocket 接続を開始し、ルーティングエンジンに登録します。もちろん、この段階は必須ではありません。
启动pprof
構成ファイルで指定された場合にのみ有効になります。
Prometheusインジケーターの収集を開始する
構成ファイルで指定された場合にのみ有効になります。
Swaggerドキュメントサービスを開始する
構成ファイルで指定された場合にのみ有効になります。
ルーティングサービスを開始し、httpリクエストをリッスンします
要約情報を端末に印刷する

screenshot おそらく次のようになります:

afterFunc 関数を実行する (オプション)

ヒント
この段階では、関連するコンポーネントが初期化されています。この関数では、データベーステーブル構造、テーブルデータ、スケジュールされたタスクなどの初期化など、必要な機能を実行できます。
システム信号を監視する
このフェーズでは、Go-Sail はシステム信号を監視し続け、終了信号を受信するまで終了操作を実行しません。
コンポーネントを閉じる
Go-Sail は終了信号を受信すると、以前に起動したコンポーネントまたはサービスを 1 つずつシャットダウンします。
プロセス全体が終了する

リクエストライフサイクル

リクエストライフサイクルは、サービスノードへの到着から中間処理、そして最終的な応答の返送までの HTTP リクエストのプロセス全体を表します。全体のプロセスと発生したイベントについて説明します。

ルーティングミドルウェア

リクエストがサービスノードに到着すると、まず一連のルーティングミドルウェアを通過し、これらのミドルウェアでリクエストのコンテキストが処理されます。

リンクログ追跡

まず、リクエストがサービスノードに到着すると、gin エンジンによって監視され、キャプチャされます。 Go-Sail は、リクエストを LogTrace と呼ばれるルーティングミドルウェアに渡します。このミドルウェアでは、いくつかの必要なリンクログ追跡情報が挿入されます。後続のアクセス要求のコンテキストを入力します。

github.com/keepchen/go-sail/sail/httpserver/gin.go
import (
    "github.com/keepchen/go-sail/v3/http/middleware"
    "github.com/gin-gonic/gin"
)

func InitGinEngine(conf config.HttpServerConf) *gin.Engine {
    var r *gin.Engine

    ...

    r.Use(middleware.LogTrace())

    ...
}

Prometheus輸出業者

Prometheus エクスポータミドルウェアは、リクエスト応答に関するいくつかの数値インジケーターをリクエストコンテキストに挿入します。このミドルウェアは Prometheus サービスと組み合わせて使用されます。

ヒント

このミドルウェアはオプションであり、必要に応じて構成ファイルを指定することで有効化または無効化できます。

github.com/keepchen/go-sail/sail/httpserver/gin.go
import (
    "github.com/keepchen/go-sail/v3/http/middleware"
    "github.com/gin-gonic/gin"
)

func InitGinEngine(conf config.HttpServerConf) *gin.Engine {
    var r *gin.Engine

    ...

    if conf.Prometheus.Enable {
        r.Use(middleware.PrometheusExporter())
    }

    ...
}

ヒント

ミドルウェアは、CPU 使用率、メモリ使用量、ネットワーク転送、ディスク負荷などのシステムメトリックのサンプリングをサポートします。必要に応じて構成ファイルを指定して、これを有効または無効にすることができます。

その他のミドルウェア

さらに、リクエストは Cors、Gzip など、開発者が指定した他のミドルウェアも通過します。もちろん、これらのミドルウェアもオプションであり、開発者によって完全に指定されます。

処理機能

リクエストが一連のルーティングミドルウェアを通過した後、ルーティング処理機能に到達します。これは通常、特定のビジネス処理コードです。

具体的な処理ロジックと手順は開発者自身によって決定されます。

一般的に、処理にはいくつかのステップがあります：

パラメータバインディング

リクエストパラメータを Go コードにバインドします。

パラメータ検証

リクエストパラメータが条件を満たしていることを確認します。

ビジネス処理

リクエストパラメータに基づいて条件を満たすレコードをデータベースに照会するなどのビジネスロジックを処理します。

応答を返す

ビジネスロジックを処理した後、処理結果がクライアント（リクエストを開始した側）に応答されます。

やっと

この時点で、サービスノードへのリクエストの到着から処理、そして最終的な応答までのプロセス全体が完了します。

どのように機能しますか?​

Go-Sailのライフサイクル​

初期設定​

スタートアップ項目の設定​

API オプション (オプション)​

Websocketを有効にする（オプション）​

フック関数を設定する（オプション）​

起動する​

リクエストライフサイクル​

ルーティングミドルウェア​

リンクログ追跡​

Prometheus輸出業者​

その他のミドルウェア​

処理機能​

パラメータバインディング​

パラメータ検証​

ビジネス処理​

応答を返す​

やっと​