1. 安らぎ
1.1 RestFul の概要
RESTFUL (Representational State Transfer) は、HTTP または HTTPS に基づくWeb アプリケーションの設計スタイルおよび開発方法であり、XML 形式または JSON 形式で定義できます。RESTFUL は、モバイル インターネット メーカーがビジネス インターフェイスとして機能するシナリオに適しており、サードパーティの OTT がモバイル ネットワーク リソースを呼び出す機能を実現します。アクション タイプは、呼び出し先リソースの追加、変更、削除です。
REST は、よりシンプルで軽量な方法で設計および実装される傾向があります。REST には明確な標準がなく、むしろ設計スタイルに近いものであることに注意してください。
1.2 原則と条件
-
REST は、一連のアーキテクチャ上の制約と原則を指します。これらの制約と原則を満たすアプリケーションまたは設計は RESTful です。
-
Web アプリケーションにとって最も重要な REST 原則は、クライアントとサーバー間の対話がリクエスト間でステートレスであることです。つまり、 1)
クライアントからサーバーへのすべてのリクエストには、リクエストを理解するために必要な情報が含まれている必要があります2
) サーバーはいつでも再起動されます。クライアントには通知されません。
3) ステートレスなリクエストには、利用可能な任意のサーバーが応答できます。 -
サーバー側では、アプリケーションの状態と機能をさまざまなリソースにグループ化できます。
1.3 特徴
- 各 URI はリソースを表します
- クライアントは、GET、POST、PUT、および DELETE を使用してサーバー リソースを操作します。GET はリソースの取得に使用され、POST は新しいリソースの作成に使用され (リソースの更新にも使用できます)、PUT はリソースの更新に使用され、 DELETE リソースを削除するために使用されます。
- クライアントとサーバー間の対話はリクエスト間でステートレスです。クライアントからサーバーへのすべてのリクエストには、リクエストを理解するために必要な情報が含まれている必要があります。
2. go のジンパッケージ
Gin は Go 言語で書かれた Web フレームワークで、高速な実行速度、グループ化されたルーター、優れたクラッシュ キャプチャとエラー処理、およびミドルウェアと JSON の非常に優れたサポートを備えています。つまり、Go 言語開発の分野において、研究する価値のある Web フレームワークです オープンソース URL: https://github.com/gin-gonic/gin
2.1 gin パッケージをダウンロードしてロードします。
go get "https://github.com/gin-gonic/gin"
import "https://github.com/gin-gonic/gin"
2.2 HTTPベースのginパッケージの簡単な使い方
package main
import(
"fmt"
"https://github.com/gin-gonic/gin"
)
func main(){
router := gin.Default()
router.GET("/getConfig",func (context *gin.Context){
context.JSON(http.StatusOK, gin.H{
"code": http.StatusOK,
"data": "message"
})
})
router.Run(":8080")
}
2.3 HTTPS ベースの gin パッケージの簡単な使用
package main
import(
"fmt"
"https://github.com/gin-gonic/gin"
)
func LoadTls(port int) gin.HandlerFunc {
return func(c *gin.Context) {
middleware := secure.New(secure.Options{
SSLRedirect: true,
SSLHost: "localhost:" + strconv.Itoa(port),
})
err := middleware.Process(c.Writer, c.Request)
if err != nil {
//如果出现错误，请不要继续。
fmt.Println(err)
return
}
// 继续往下处理
c.Next()
}
}
func main(){
router := gin.Default()
router.Use(LoadTls(8000))
router.GET("/getConfig",func (context *gin.Context){
context.JSON(http.StatusOK, gin.H{
"code": http.StatusOK,
"data": "message"
})
})
router.RunTLS(":8080", "server.crt","server.key")
}
3. config.json ファイルサーバーを解析します。
3.1 インターフェースとプロトコルの設定
type ConfigParseServer struct {
}
func LoadTls(port int) gin.HandlerFunc {
return func(c *gin.Context) {
middleware := secure.New(secure.Options{
SSLRedirect: true,
SSLHost: "localhost:" + strconv.Itoa(port),
})
err := middleware.Process(c.Writer, c.Request)
if err != nil {
//如果出现错误，请不要继续。
fmt.Println(err)
return
}
// 继续往下处理
c.Next()
}
}
func (*ConfigParseServer) GinHttps(isHttps bool) error {
router := gin.Default()
router.GET("/getConfigs/config", hello.GetAllConfigData)
router.GET("/getConfig/server", hello.GetServerInfo)
router.GET("/getConfig/client", hello.GetClientInfo)
router.POST("/setServerInfo/", hello.SetServerInfo)
router.POST("/setClientInfo/", hello.SetClientInfo)
if isHttps {
router.Use(LoadTls(8000))
return router.RunTLS(":8000", "server.crt", "server.key")
}
return router.Run(":8080")
}
func main() {
var configParseServer ConfigParseServer
fmt.Printf("请输入0/1来确定是否使用https: ")
var valve bool
fmt.Scan(&valve)
configParseServer.GinHttps(valve)
}
3.2 インターフェースの実装
func GetJsonData() []byte {
data, err := os.ReadFile("./hello/config.json")
if err != nil {
fmt.Println("readfile error")
}
return data
}
func ParseJson2Struct() *AutoGenerated {
datafig, err := os.ReadFile("./hello/config.json")
if err != nil {
fmt.Println("ParseJson: os.ReadFile.....")
}
cfg := new(AutoGenerated)
err = json.Unmarshal(datafig, cfg)
if err != nil {
fmt.Println("ParseJson: json.Unmarshal.....")
}
return cfg
}
func SetConfigInfo(context *gin.Context, modle string) (int, string) {
var code int = -1
var errorMessage string
raw := GetJsonData()
var configStruct AutoGenerated
err := json.Unmarshal(raw, &configStruct)
if err != nil {
fmt.Println("SetConfigInfo: json.Unmarshal failed")
}
data, _ := io.ReadAll(context.Request.Body)
var res map[string]interface{
}
err = json.Unmarshal(data, &res)
if err != nil {
fmt.Println("GetConfigInfo: json.Unmarshal failed...")
}
for k := range res {
if k != modle {
errorMessage = "Only the config of " + modle + " can be modified here"
return code, errorMessage
}
}
err = json.Unmarshal(data, &configStruct)
if err != nil {
Logger("Error", "json Unmarshal failed")
errorMessage = "type of value is wrong"
return code, errorMessage
}
Indata, err := json.MarshalIndent(configStruct, "", " ")
if err != nil {
fmt.Println("json.MarshalIndent failed")
}
fp, err := os.Create("./newConfig.json")
if err != nil {
fmt.Println("os.Create fail...")
}
defer fp.Close()
fp.Write(Indata)
code = 0
errorMessage = "modify success!!!"
return code, errorMessage
}
func SetServerInfo(context *gin.Context) {
code, reason := SetConfigInfo(context, "server")
var newConfig AutoGenerated
data, err := os.ReadFile("./newConfig.json")
if err != nil {
Logger("Error", "SetServerVersionInfo: ReadFile failed")
}
err = json.Unmarshal(data, &newConfig)
if err != nil {
Logger("Error", "SetServerVersionInfo: json Unmarshal failed")
}
var param interface{
}
if reason == "modify success!!!" {
param = newConfig.Server
} else {
param = nil
}
context.JSON(http.StatusOK, gin.H{
"code": code,
"reason": reason,
"params": param,
})
}
func SetClientInfo(context *gin.Context) {
code, reason := SetConfigInfo(context, "client")
var newConfig AutoGenerated
data, err := os.ReadFile("./newConfig.json")
if err != nil {
Logger("Error", "SetServerVersionInfo: ReadFile failed")
}
err = json.Unmarshal(data, &newConfig)
if err != nil {
Logger("Error", "SetServerVersionInfo: json Unmarshal failed")
}
var param interface{
}
if reason == "modify success!!!" {
param = newConfig.Client
} else {
param = nil
}
context.JSON(http.StatusOK, gin.H{
"code": code,
"reason": reason,
"params": param,
})
}
func GetConfigStruct() *AutoGenerated {
//fmt.Println(*ParseJson2Struct())
return ParseJson2Struct()
}
func GetServerInfo(context *gin.Context) {
context.JSON(http.StatusOK, gin.H{
"code": http.StatusOK,
//"reason": "get data success",
"data": GetConfigStruct().Server,
})
}
func GetClientInfo(context *gin.Context) {
context.JSON(http.StatusOK, gin.H{
"code": http.StatusOK,
//"reason": "get data success",
"data": GetConfigStruct().Client,
})
}
サーバーをデプロイした後、コード内でキーを取得するために json 情報をネストするのは面倒なので、次のコードを記述します
3.3 jsonフェッチキー
func getKeys(data map[string]interface{
}) string {
var j int
var flag int
var keyList []string
//fmt.Println(len(data))
for j = 0; j < 20; j++ {
flag = 0
for k, v := range data {
keyList = append(keyList, k)
switch value := v.(type) {
case string, int, float64, uint:
flag = -1
case map[string]interface{
}:
data = value
fmt.Println(data)
}
}
if flag == -1 {
break
}
}
queryString := keyList[0]
var i int
if len(keyList) > 1 {
queryString += "."
for i = 1; i < len(keyList)-1; i++ {
queryString += keyList[i]
queryString += "."
}
queryString += keyList[i]
}
return queryString //key的格式为key1.key2.key3...
}
//如上取到的key的格式，可以通过jmespath.Search去json中取相应的value
func getOneClassInfo(context *gin.Context, postJsondata []byte) {
jsonData := GetJsonData()
var totalData interface{
}
err := json.Unmarshal(jsonData, &totalData)
if err != nil {
fmt.Println("getServerInfo:111json.Unmarshal")
}
var jsonMap map[string]interface{
}
err = json.Unmarshal(postJsondata, &jsonMap)
if err != nil {
fmt.Println("getServerInfo:222json.Unmarshal")
}
path := getKeys(jsonMap)
res, err := jmespath.Search(path, totalData)
if err != nil {
fmt.Println("jmespath Search failed....")
}
context.JSON(http.StatusOK, res)
}