# GopherFocus **Repository Path**: Lcoderfit/GopherFocus ## Basic Information - **Project Name**: GopherFocus - **Description**: No description available - **Primary Language**: Go - **License**: MIT - **Default Branch**: main - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2021-08-20 - **Last Updated**: 2021-10-26 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # GoFrame Project https://goframe.org # 一、模板 ```text 1.首先ParseTplContent会根据data的值将模板语法解析成对应的数据, 返回一个字符串和一个error类型 WriteTplContent, 会根据data的值将模板语法解析成对应的数据然后写入到响应体中 -首先，如果要使解析成功，则data必须为一个map[string]interface{}类型，可以根据gconv.Map()将结构体类型转换为map[string]interface类型 -可以传递多个参数，data1和data2均为map[string]interface类型 -如果是根据结构体根据gconv.Map转换为map[string]interface{}类型的，则结构体字段中只有可导出的字段能够被转换成功，因为不可导出的字段 在gconv包中是无法访问的，所以转换成的map[string]interface{}中是不包含不可导出字段对应的键值对的 -如果data的key是大写的，则模板中名称也需要大写: {{.Name}}; .表示的是当前的变量，.Name表示的是当前变量中的Name字段 -如果是嵌套结构体, 如下，则内层结构体中的字段通过gconv.Map的转换后字段都会变为最外层的key, 例如下面这个结构体，将转换为 map[string]interface{"Link": "link", conf: "conf"}; 还有一点需要注意的是：如果外层结构体与内层结构体的字段名冲突，则转换成map后只取最外层的结构体字段值作为map的value - {{dump .}} 表示将当前所有的变量（包括传入的参数和config.toml文件中的内置变量）, 序列化(格式化之后)之后的样子 - r.Response.ParseTpl和r.Response.ParseTplContent 返回两个参数，string和error - r.Response.WriteTpl和r.Response.WriteTplContent 返回一个参数，error Target{ Link: "link", Config{ conf: "conf", Server{ Link: "link", }, }, } str := `{{.Name}}` res, _ := r.Response.ParseTplContent(str, data1, data2) r.Response.WriteTplContent(`{{dump .}}`, data1, data2) type Server struct { Link string Fuck string } type Config struct { Server Fuck string } type Target struct { name string Age int Config } t := Target{ name: "coder", Age: 10, Config: Config{ Fuck: "lcoderfit", Server: Server{ Link: "link", Fuck: "link-fuck", }, }, } target := gconv.Map(t) f := func(t Target) { g.Log().Println(t.name) } f(t) g.Log().Line(true).Info(t) s := g.Server() s.Group("/", func(group *ghttp.RouterGroup) { group.ALL("/", func(r *ghttp.Request) { st := `{{.Name}}` res, _ := r.Response.ParseTplContent(st, target) g.Log().Println(res) _ = r.Response.WriteTplContent(`{{.Name}}, {{.Config.server.Address}}, {{.Config.Server.Link}}, {{.Config.Fuck}}`, target) }) }) s.Run() ``` # 二、Swagger ## 2.1 swagger参数 ```text swagger 参考文档 https://hub.fastgit.org/swaggo/swag/blob/master/README_zh-CN.md#mime-types 一般使用下面这六种选项 // @summary 接口概要简介 // @description 接口描述 // @tags 接口所属分类标签 // @param 传入接口的参数（如果没有传入参数则不写此项） // @success 成功时返回的状态码和数据信息 // @router 路由 请求方法 // @param entity body model.UserApiSignUpReq true "注册请求" // @param password fromData string true "用户密码" // @param passport query string true "用户帐号" object表示参数类型是一个对象，response.JsonResponse是项目中自定义的结构体（返回的数据类型） // @success 200 {object} response.JsonResponse "执行结果: `true/false`" // @success 200 {object} response.JsonResponse "执行结果" // @success 200 {object} model.User "执行结果" // @success 200 {string} string "执行结果" // ShowAccount godoc // @Summary Show a account // @Description get string by ID // @ID get-string-by-int // @Accept json // @Produce json // @Param id path int true "Account ID" // @Success 200 {object} model.Account // @Header 200 {string} Token "qwerty" // @Failure 400,404 {object} httputil.HTTPError // @Failure 500 {object} httputil.HTTPError // @Failure default {object} httputil.DefaultError // @Router /accounts/{id} [get] func (c *Controller) ShowAccount(ctx *gin.Context) { id := ctx.Param("id") aid, err := strconv.Atoi(id) if err != nil { httputil.NewError(ctx, http.StatusBadRequest, err) return } account, err := model.AccountOne(aid) if err != nil { httputil.NewError(ctx, http.StatusNotFound, err) return } ctx.JSON(http.StatusOK, account) } // ListAccounts godoc // @Summary List accounts // @Description get accounts // @Accept json // @Produce json // @Param q query string false "name search by q" // @Success 200 {array} model.Account // @Header 200 {string} Token "qwerty" // @Failure 400,404 {object} httputil.HTTPError // @Failure 500 {object} httputil.HTTPError // @Failure default {object} httputil.DefaultError // @Router /accounts [get] func (c *Controller) ListAccounts(ctx *gin.Context) { q := ctx.Request.URL.Query().Get("q") accounts, err := model.AccountsAll(q) if err != nil { httputil.NewError(ctx, http.StatusNotFound, err) return } ctx.JSON(http.StatusOK, accounts) } ``` ## 2.2 API操作 Example [celler/controller](https://github.com/swaggo/swag/tree/master/example/celler/controller) | 注释 | 描述 | | -------------------- | ------------------------------------------------------------------------------------------------------- | | description | 操作行为的详细说明。 | | description.markdown | 应用程序的简短描述。该描述将从名为`endpointname.md`的文件中读取。 | | id | 用于标识操作的唯一字符串。在所有API操作中必须唯一。 | | tags | 每个API操作的标签列表，以逗号分隔。 | | summary | 该操作的简短摘要。 | | accept | API可以使用的MIME类型的列表。值必须如“[Mime类型](#mime-types)”中所述。 | | produce | API可以生成的MIME类型的列表。值必须如“[Mime类型](#mime-types)”中所述。 | | param | 用空格分隔的参数。`param name`,`param type`,`data type`,`is mandatory?`,`comment` `attribute(optional)` | | security | 每个API操作的[安全性](#security)。 | | success | 以空格分隔的成功响应。`return code`,`{param type}`,`data type`,`comment` | | failure | 以空格分隔的故障响应。`return code`,`{param type}`,`data type`,`comment` | | response | 与success、failure作用相同 | | header | 以空格分隔的头字段。 `return code`,`{param type}`,`data type`,`comment` | | router | 以空格分隔的路径定义。 `path`,`[httpMethod]` | | x-name | 扩展字段必须以`x-`开头，并且只能使用json值。 | ## 2.3 Mime类型 `swag` 接受所有格式正确的MIME类型, 即使匹配 `*/*`。除此之外，`swag`还接受某些MIME类型的别名，如下所示： | Alias | MIME Type | | --------------------- | --------------------------------- | | json | application/json | | xml | text/xml | | plain | text/plain | | html | text/html | | mpfd | multipart/form-data | | x-www-form-urlencoded | application/x-www-form-urlencoded | | json-api | application/vnd.api+json | | json-stream | application/x-json-stream | | octet-stream | application/octet-stream | | png | image/png | | jpeg | image/jpeg | | gif | image/gif | ## 2.4 参数类型 - query - path - header - body - formData ## 2.5 数据类型 - string (string) - integer (int, uint, uint32, uint64) - number (float32) - boolean (bool) - user defined struct ## 2.6 boot包中需要加上 ```text import ( _ "gf-simple-im/packed" "github.com/gogf/gf/frame/g" "github.com/gogf/swagger" ) // 用于应用初始化 func init() { s := g.Server() s.Plugin(&swagger.Swagger{}) } ``` # 三、gf swagger ```text // 自动根据注解生成swagger.json文档 gf swagger ``` # 四、replace手动替换包版本-指定gf包版本为v1.15.5 ```text module gf-simple-im go 1.13 require ( github.com/cpuguy83/go-md2man/v2 v2.0.1 // indirect github.com/go-openapi/jsonreference v0.19.6 // indirect github.com/go-openapi/spec v0.20.3 // indirect github.com/go-openapi/swag v0.19.15 // indirect github.com/gogf/gf v1.16.4 github.com/gogf/swagger v1.3.0 github.com/mailru/easyjson v0.7.7 // indirect github.com/swaggo/swag v1.7.0 // indirect golang.org/x/net v0.0.0-20210716203947-853a461950ff // indirect golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c // indirect golang.org/x/tools v0.1.5 // indirect ) replace github.com/gogf/gf => github.com/gogf/gf v1.15.5 ``` # 五、 ```text Server对于客户端提交的数据是有大小限制的，主要有两个配置参数控制： MaxHeaderBytes：请求头大小限制，请求头包括客户端提交的Cookie数据，默认设置为10KB。 ClientMaxBodySize：客户端提交的Body大小限制，同时也影响文件上传大小，默认设置为8MB。 对应nginx的配置项: max_header_bytes 10k; client_max_body_size 8m; ``` # 六、配置参考项 ```text # 配置项参考：https://goframe.org/pages/viewpage.action?pageId=1115660 # https://goframe.org/pages/viewpage.action?pageId=7297542 # ServerRoot 表示静态文件存在的路径 # ServerAgent表示服务端代理名称，默认为"GF HTTP Server" # RouteOverWrite 当遇到重复路由时是否强制覆盖, 如果设置为false，则启动时候如果遇到重复路由会报错 # nameToUriType 设置路由的生成规则(0表示根据请求处理函数名大小写字母用-隔开，例如SignOut 对应路由 sign-out) # 1表示会用函数名作为路由 SignOut 对应 SignOut # 2表示用函数的全小写名作为路由 SignOut 对应 signout 注意：如果路由已经可以唯一性确定调用一个请求处理方法，则系统会用设置好的路由，而不会根据nameToUriType转换 例如： group.ALL("/chat", api.Chat) group.ALL("/user", api.User) group.Group("/", func(group *ghttp.RouterGroup) { group.Middleware(service.Middleware.Auth) group.ALL("/user/profile", api.User.Profile) }) }) /user/xxx的请求都会传递给api.User文件，所以系统会根据nameToUriType给该文件中的请求处理函数设置对应的路由 但是/user/profile 已经可以确定发送请求给Profile请求处理函数，所以不会受nameToUriType影响 ``` # 七、问题 ```text 1.前端（通过swagger可以访问到后端） 2.密码未加密 3.QPS压测 4.调用WebSocket接口发送数据时，有一个for循环，为什么当一个用户发送消息时，群发的消息不会无限发送给自己 ```