[init] first commit

Author: Bingmang

.gitignore

@@ -0,0 +1 @@
+.idea

README.md

@@ -0,0 +1,85 @@
+# gin-restful-best-practice
+该项目以最简单易懂的框架向大家展示了我在开发gin web服务的过程中的一些最佳实践。
+
+数据实体：用户（user）、深度学习模型（model）
+场景：用户可以上传深度学习模型、下载深度学习模型。
+
+涉及到的技术有：
+- [x] GIN
+- [x] GORM & PostgreSQL
+- [x] JWT
+- [x] gRPC （与python机器学习服务通过rpc通信）
+- [ ] Travis-ci
+- [ ] and more…
+
+## server.go
+## conf
+### config.go
+存放所有服务器配置，环境分为`dev, test, prod`，根据环境变量`ENV`的不同会调用不同的函数来初始化配置，部分配置也可以从环境变量中读取。
+
+由loadConfig函数载入配置，配置由`conf.Conf()`读取，使用了`sync.Once`保证配置只被初始化一次。
+
+## controllers
+存放各接口的逻辑以及单元测试（注意，该路径下的单元测试会绕过中间件，这其实是正确的，中间件的测试就应该放在所属文件夹下测试）。
+### common.go
+一些controller中通用的函数，例如对错误的返回`ErrorResponse`、方便单元测试发送JSON网络请求的`testRequest`（参数通过`gin.H`类型传入，该函数会自动把参数转换为Body或Query）。
+### models.go
+
+## middleware
+## models
+## photos
+## routes
+## services
+## utils
+
+## Build Setup
+
+```shell script
+# clone the project
+git clone https://github.com/Bingmang/gin-restful-best-practice.git
+
+# enter the project directory
+cd gin-restful-best-practice
+
+# install dependency
+go run server.go
+```
+
+This will automatically open http://localhost:8000
+
+## Build
+
+```shell script
+go build server.go
+```
+
+## gRPC
+
+如果修改了proto文件需要重新编译pb文件，输入以下命令（要先安装protoc）：
+https://github.com/protocolbuffers/protobuf/releases/tag/v3.12.3
+
+```shell script
+export PATH="$PATH:$(go env GOPATH)/bin"
+protoc --go_out=plugins=grpc:. -I./protos ./protos/ml_service.proto
+```
+
+## PostgreSQL initialization
+
+```shell script
+docker run -d --name isp_test -p 5432:5432 postgres
+docker exec -it isp_test /bin/bash
+su postgres
+create user dev_user with password 'dev_password';
+create database dev_database owner dev_user;
+grant all on database dev_database to dev_user;
+```
+
+## Deploy
+
+```shell script
+go build server.go
+ENV=dev ./server
+ENV=test ./server
+ENV=prod ./server
+...
+```

conf/config.go

@@ -0,0 +1,103 @@
+package conf
+
+import (
+	"fmt"
+	"github.com/gin-gonic/gin"
+	"log"
+	"os"
+	"strconv"
+	"sync"
+)
+
+var ENV = os.Getenv("ENV")
+var loadConfigOnce sync.Once
+
+type Config struct {
+	ENV string
+
+	// server
+	HOST string
+	PORT int
+	URL  string
+
+	// jwt
+	JWT_ISSUER string
+	JWT_SECRET string
+
+	// db
+	DB_HOST     string
+	DB_PORT     int
+	DB_USER     string
+	DB_PASSWORD string
+	DB_DATABASE string
+	DB_CONN_STR string
+
+	// service
+	ISP_ML_SERVICE_HOST string
+	ISP_ML_SERVICE_PORT int
+	ISP_ML_SERVICE_URL  string
+}
+
+var config Config
+
+func Conf() Config {
+	loadConfigOnce.Do(loadConfig)
+	return config
+}
+
+func dev(config *Config) {
+	log.Println("Using dev environment, loading config...")
+	config.DB_HOST = "localhost"
+	config.DB_PORT = 5432
+	config.DB_USER = "dev_user"
+	config.DB_PASSWORD = "dev_password"
+	config.DB_DATABASE = "dev_database"
+
+	config.JWT_ISSUER = "dev_issuer"
+	config.JWT_SECRET = "dev_secret"
+
+	config.ISP_ML_SERVICE_HOST = "localhost"
+	config.ISP_ML_SERVICE_PORT = 50051
+}
+
+func test(config *Config) {
+	log.Println("Using test environment, loading config...")
+	panic("config: not implemented")
+}
+
+func prod(config *Config) {
+	log.Println("Using prod environment, loading config...")
+	gin.SetMode(gin.ReleaseMode)
+	panic("config: not implemented")
+}
+
+func loadConfig() {
+	config = Config{
+		ENV:  ENV,
+		HOST: "localhost",
+		PORT: 8000,
+	}
+
+	switch ENV {
+	case "test":
+		test(&config)
+	case "prod":
+		prod(&config)
+	default:
+		config.ENV = "dev"
+		dev(&config)
+	}
+
+	if os.Getenv("HOST") != "" {
+		config.HOST = os.Getenv("HOST")
+	}
+	if os.Getenv("PORT") != "" {
+		config.PORT, _ = strconv.Atoi(os.Getenv("PORT"))
+	}
+
+	config.URL = fmt.Sprintf("%s:%d", config.HOST, config.PORT)
+	config.DB_CONN_STR = fmt.Sprintf(
+		"host=%s port=%d user=%s password=%s dbname=%s sslmode=disable TimeZone=Asia/Shanghai",
+		config.DB_HOST, config.DB_PORT, config.DB_USER, config.DB_PASSWORD, config.DB_DATABASE)
+	config.ISP_ML_SERVICE_URL = fmt.Sprintf("%s:%d", config.ISP_ML_SERVICE_HOST, config.ISP_ML_SERVICE_PORT)
+}

controllers/common.go

@@ -0,0 +1,50 @@
+package controllers
+
+import (
+	"bytes"
+	"encoding/json"
+	"fmt"
+	"github.com/gin-gonic/gin"
+	"net/http"
+	"net/http/httptest"
+)
+
+type testResponse struct {
+	*httptest.ResponseRecorder
+	Data gin.H
+}
+
+func testRequest(controller func(*gin.Context), method, url string, params gin.H) *testResponse {
+	response := httptest.NewRecorder()
+	c, _ := gin.CreateTestContext(response)
+	if method == "GET" {
+		query := "?"
+		first := true
+		for k, v := range params {
+			if first {
+				first = false
+			} else {
+				query += "&"
+			}
+			query += fmt.Sprintf("%s=%v", k, v)
+		}
+		c.Request, _ = http.NewRequest(method, url+query, nil)
+	} else {
+		jsonBytes, _ := json.Marshal(params)
+		c.Request, _ = http.NewRequest(method, url, bytes.NewBuffer(jsonBytes))
+	}
+	c.Request.Header.Set("Content-Type", "application/json")
+	controller(c)
+	var data gin.H
+	_ = json.Unmarshal(response.Body.Bytes(), &data)
+	return &testResponse{
+		ResponseRecorder: response,
+		Data:             data,
+	}
+}
+
+func ErrorResponse(ctx *gin.Context, statusCode int, message string) {
+	ctx.JSON(statusCode, gin.H{
+		"error": message,
+	})
+}

controllers/login.go

@@ -0,0 +1,41 @@
+package controllers
+
+import (
+	"github.com/gin-gonic/gin"
+	"github.com/jinzhu/gorm"
+	"gin-restful-best-practice/middlewares"
+	"gin-restful-best-practice/models"
+	"net/http"
+)
+
+type LoginForm struct {
+	Username string `json:"username" binding:"required,gte=2,lte=20"`
+	Password string `json:"password" binding:"required"`
+}
+
+func Login(ctx *gin.Context) {
+	var form LoginForm
+	if err := ctx.ShouldBindJSON(&form); err != nil {
+		ErrorResponse(ctx, http.StatusBadRequest, err.Error())
+		return
+	}
+	user, err := models.GetUserByUsername(form.Username)
+	// invalid username or password
+	if err == gorm.ErrRecordNotFound || user.Password != form.Password {
+		ErrorResponse(ctx, http.StatusForbidden, "invalid username or password")
+		return
+	}
+	// sql error
+	if err != nil {
+		ErrorResponse(ctx, http.StatusInternalServerError, err.Error())
+		return
+	}
+	token, err := middlewares.CreateJWT(user)
+	if err != nil {
+		ErrorResponse(ctx, http.StatusInternalServerError, err.Error())
+		return
+	}
+	ctx.JSON(http.StatusOK, gin.H{
+		"token": "Bearer " + token,
+	})
+}

controllers/models.go

@@ -0,0 +1,82 @@
+package controllers
+
+import (
+	"github.com/gin-gonic/gin"
+	"gin-restful-best-practice/models"
+	"gin-restful-best-practice/services"
+	"net/http"
+)
+
+type FetchModelListForm struct {
+	Offset int `form:"offset" binding:"number"`
+	Limit  int `form:"limit" binding:"required,number"`
+	UserID int `form:"user_id" binding:"number"`
+}
+
+func FetchModelList(ctx *gin.Context) {
+	var form FetchModelListForm
+	if err := ctx.ShouldBindQuery(&form); err != nil {
+		ErrorResponse(ctx, http.StatusBadRequest, err.Error())
+		return
+	}
+	modelList, err := models.GetModelList(map[string]interface{}{
+		"yn": true,
+	}, form.Offset, form.Limit)
+	if err != nil {
+		ErrorResponse(ctx, http.StatusInternalServerError, err.Error())
+		return
+	}
+	ctx.JSON(http.StatusOK, gin.H{
+		"data":   modelList,
+		"total":  len(modelList),
+		"offset": form.Offset,
+		"limit":  form.Limit,
+	})
+	return
+}
+
+type CreateModelForm struct {
+	Name         string `json:"name" binding:"required,gte=2,lte=20"`
+	Type         uint   `json:"type" binding:"required,number"`
+	URL          string `json:"url"`
+	Desc         string `json:"desc"`
+	PriceMonthly uint   `json:"price_monthly" binding:"number"`
+	PriceYearly  uint   `json:"price_yearly" binding:"number"`
+	PriceTotal   uint   `json:"price_total" binding:"number"`
+	UserID       uint   `json:"user_id" binding:"required,number"`
+}
+
+func CreateModel(ctx *gin.Context) {
+	var form CreateModelForm
+	if err := ctx.ShouldBindJSON(&form); err != nil {
+		ErrorResponse(ctx, http.StatusBadRequest, err.Error())
+		return
+	}
+	model := models.Model{
+		Name:         form.Name,
+		Type:         form.Type,
+		URL:          form.URL,
+		Desc:         form.Desc,
+		PriceMonthly: form.PriceMonthly,
+		PriceYearly:  form.PriceYearly,
+		PriceTotal:   form.PriceTotal,
+		UserID:       form.UserID,
+	}
+	if err := model.Insert(); err != nil {
+		ErrorResponse(ctx, http.StatusInternalServerError, err.Error())
+		return
+	}
+	ctx.JSON(http.StatusOK, model)
+}
+
+func GetModelFile(ctx *gin.Context) {
+	model, err := services.DownloadModel("name")
+	if err != nil {
+		ctx.JSON(http.StatusInternalServerError, gin.H{
+			"error": err,
+		})
+	}
+	ctx.JSON(http.StatusOK, gin.H{
+		"model": model,
+	})
+}