upgrade

Author: xinliangnote

README.md

@@ -35,13 +35,15 @@
 ```cassandraql
 ├── main.go                      # 项目入口文件
 ├── configs                      # 配置文件统一存放目录
-├── docs                         # Swagger 文档，执行 swag init 生成的
-├── init                         # 项目初始脚本，比如初始化 SQL 语句
+├── docs                         # Swagger 文档
+├── init                         # 项目初始配置，比如初始化 SQL 语句
 ├── internal                     # 业务目录
 │   ├── api                      # 业务代码
+│   ├── graph                    # GraphQL 代码
 │   ├── pkg                      # 内部使用的 package
-├── logs                         # 存放日志的目录
-└── pkg                          # 一些封装好的 package
+├── logs                         # 日志目录
+├── pkg                          # 外部使用的 package
+└── scripts                      # 操作脚本
 ```
 ## Features
 

configs/configs.go

@@ -68,7 +68,6 @@ func init() {
 	viper.SetConfigName(env.Active().Value() + "_configs")
 	viper.SetConfigType("toml")
 	viper.AddConfigPath("./configs")
-	viper.AddConfigPath("../../configs") // 兼容 cmd/cron/main.go 引用配置文件
 
 	if err := viper.ReadInConfig(); err != nil {
 		panic(err)

docs/docs.go

@@ -351,11 +351,11 @@ type swaggerInfo struct {
 
 // SwaggerInfo holds exported Swagger Info so clients can modify it
 var SwaggerInfo = swaggerInfo{
-	Version:     "",
+	Version:     "2.0",
 	Host:        "127.0.0.1:9999",
 	BasePath:    "",
 	Schemes:     []string{},
-	Title:       "go-gin-api docs api",
+	Title:       "swagger 接口文档",
 	Description: "",
 }
 

docs/swagger.json

@@ -1,12 +1,13 @@
 {
     "swagger": "2.0",
     "info": {
-        "title": "go-gin-api docs api",
+        "title": "swagger 接口文档",
         "contact": {},
         "license": {
             "name": "MIT",
             "url": "https://github.com/xinliangnote/go-gin-api/blob/master/LICENSE"
-        }
+        },
+        "version": "2.0"
     },
     "host": "127.0.0.1:9999",
     "paths": {

docs/swagger.yaml

@@ -62,7 +62,8 @@ info:
   license:
     name: MIT
     url: https://github.com/xinliangnote/go-gin-api/blob/master/LICENSE
-  title: go-gin-api docs api
+  title: swagger 接口文档
+  version: "2.0"
 paths:
   /auth/get:
     post:

go.mod

@@ -3,6 +3,7 @@ module github.com/xinliangnote/go-gin-api
 go 1.15
 
 require (
+	github.com/99designs/gqlgen v0.13.0
 	github.com/alecthomas/template v0.0.0-20190718012654-fb15b899a751
 	github.com/dgrijalva/jwt-go v3.2.0+incompatible
 	github.com/gin-contrib/pprof v1.2.1
@@ -19,6 +20,7 @@ require (
 	github.com/spf13/viper v1.7.1
 	github.com/swaggo/gin-swagger v1.3.0
 	github.com/swaggo/swag v1.7.0
+	github.com/vektah/gqlparser/v2 v2.1.0
 	go.uber.org/multierr v1.5.0
 	go.uber.org/zap v1.16.0
 	golang.org/x/mod v0.4.0 // indirect

go.sum

@@ -0,0 +1,56 @@
+# Where are all the schema files located? globs are supported eg  src/**/*.graphqls
+schema:
+  - internal/graph/schemas/*.graphql
+
+# Where should the generated server code go?
+exec:
+  filename: internal/graph/generated/generated.go
+  package: generated
+
+# Uncomment to enable federation
+# federation:
+#   filename: graph/generated/federation.go
+#   package: generated
+
+# Where should any generated models go?
+model:
+  filename: internal/graph/model/generated.go
+  package: model
+
+# Where should the resolver implementations go?
+resolver:
+  filename: internal/graph/resolvers/generated/generated.go
+  type: Resolver
+  package: resolvers
+
+# Optional: turn on use `gqlgen:"fieldName"` tags in your models
+# struct_tag: json
+
+# Optional: turn on to use []Thing instead of []*Thing
+# omit_slice_element_pointers: false
+
+# Optional: set to speed up generation time by not performing a final validation pass.
+# skip_validation: true
+
+# gqlgen will search for any type names in the schema in these go packages
+# if they match it will use them, otherwise it will generate them.
+autobind:
+   - "github.com/xinliangnote/go-gin-api/internal/graph/model"
+
+# This section declares type mapping between the GraphQL and go type systems
+#
+# The first line in each type will be used as defaults for resolver arguments and
+# modelgen, the others will be allowed when binding to fields. Configure them to
+# your liking
+models:
+  ID:
+    model:
+      - github.com/99designs/gqlgen/graphql.ID
+      - github.com/99designs/gqlgen/graphql.Int
+      - github.com/99designs/gqlgen/graphql.Int64
+      - github.com/99designs/gqlgen/graphql.Int32
+  Int:
+    model:
+      - github.com/99designs/gqlgen/graphql.Int
+      - github.com/99designs/gqlgen/graphql.Int64
+      - github.com/99designs/gqlgen/graphql.Int32

gqlgen.yml

@@ -171,7 +171,10 @@ func (d *Demo) Trace() core.HandlerFunc {
 		}
 
 		// 调试信息
-		p.Println("res2.Data.Name", res2.Data.Name, p.WithTrace(c.Trace()))
+		p.Println("res2.Data.Name",
+			res2.Data.Name,
+			p.WithTrace(c.Trace()),
+		)
 
 		// 执行 SQL 信息
 		d.userService.GetUserByUserName(c, "test_user")

internal/api/controller/demo/demo.go

@@ -6,6 +6,7 @@ import (
 	"github.com/xinliangnote/go-gin-api/internal/pkg/db"
 
 	"github.com/pkg/errors"
+	"gorm.io/gorm"
 )
 
 var _ UserRepo = (*userRepo)(nil)
@@ -42,8 +43,9 @@ func (u *userRepo) Create(ctx core.Context, user user_model.UserDemo) (id uint,
 
 func (u *userRepo) getUserByID(ctx core.Context, id uint) (*user_model.UserDemo, error) {
 	data := new(user_model.UserDemo)
-	err := u.db.GetDbR().WithContext(ctx.RequestContext()).First(data, id).Where("is_deleted = ?", -1).Error
-	if err != nil {
+	err := u.db.GetDbR().
+		WithContext(ctx.RequestContext()).First(data, id).Where("is_deleted = ?", -1).Error
+	if err != nil && err != gorm.ErrRecordNotFound {
 		return nil, errors.Wrap(err, "[user_demo] get user data err")
 	}
 	return data, nil
@@ -52,15 +54,15 @@ func (u *userRepo) getUserByID(ctx core.Context, id uint) (*user_model.UserDemo,
 func (u *userRepo) UpdateNickNameByID(ctx core.Context, id uint, nickname string) (err error) {
 	user, err := u.getUserByID(ctx, id)
 	if err != nil {
-		return errors.Wrap(err, "[user_demo] update user data err")
+		return errors.Wrap(err, "[user_demo] get user data err")
 	}
 	return u.db.GetDbW().WithContext(ctx.RequestContext()).Model(user).Update("nick_name", nickname).Error
 }
 
 func (u *userRepo) Delete(ctx core.Context, id uint) (err error) {
 	user, err := u.getUserByID(ctx, id)
 	if err != nil {
-		return errors.Wrap(err, "[user_demo] update user data err")
+		return errors.Wrap(err, "[user_demo] get user data err")
 	}
 	return u.db.GetDbW().WithContext(ctx.RequestContext()).Model(user).Update("is_deleted", 1).Error
 }
@@ -72,7 +74,7 @@ func (u *userRepo) GetUserByUserName(ctx core.Context, username string) (*user_m
 		Select([]string{"id", "user_name", "nick_name", "mobile"}).
 		Where("user_name = ? and is_deleted = ?", username, -1).
 		First(data).Error
-	if err != nil {
+	if err != nil && err != gorm.ErrRecordNotFound {
 		return nil, errors.Wrap(err, "[user_demo] get user data err")
 	}
 	return data, nil

internal/api/repository/db_repo/user_demo_repo/user_demo.go

@@ -4,6 +4,7 @@ import (
 	"github.com/xinliangnote/go-gin-api/internal/api/controller/demo"
 	"github.com/xinliangnote/go-gin-api/internal/api/controller/user_handler"
 	"github.com/xinliangnote/go-gin-api/internal/api/router/middleware/auth"
+	"github.com/xinliangnote/go-gin-api/internal/graph/handler"
 	"github.com/xinliangnote/go-gin-api/internal/pkg/cache"
 	"github.com/xinliangnote/go-gin-api/internal/pkg/core"
 	"github.com/xinliangnote/go-gin-api/internal/pkg/db"
@@ -33,6 +34,13 @@ func NewHTTPMux(logger *zap.Logger, db db.Repo, cache cache.Repo) (core.Mux, err
 
 	demoHandler := demo.NewDemo(logger, db, cache)
 	userHandler := user_handler.NewUserDemo(logger, db, cache)
+	gqlHandler := handler.New(logger, db, cache)
+
+	gql := mux.Group("/graphql")
+	{
+		gql.GET("", gqlHandler.Playground())
+		gql.POST("/query", gqlHandler.Query())
+	}
 
 	// user_demo CURD
 	user := mux.Group("/user", core.WrapAuthHandler(auth.AuthHandler))

internal/api/router/router.go

@@ -0,0 +1,24 @@
+## example
+
+```cassandraql
+1.
+query {
+  bySex(sex: "男") {
+    id
+    name
+    sex
+    mobile
+  }
+}
+
+2.
+mutation {
+  updateUserMobile(data: {id: "1", mobile: "13299999999"}) {
+    id
+    name
+    sex
+    mobile
+  }
+}
+
+```