{"id":42500802,"url":"https://github.com/melf-xyzh/gin-start","last_synced_at":"2026-01-28T13:06:03.123Z","repository":{"id":61210654,"uuid":"426078471","full_name":"melf-xyzh/gin-start","owner":"melf-xyzh","description":"一个包含golang常用功能模块工具库（单例gorm连接池、基于雪花算法的分布式ID、常用的gin中间件、RBAC模块等）","archived":false,"fork":false,"pushed_at":"2022-06-24T01:11:17.000Z","size":457,"stargazers_count":27,"open_issues_count":0,"forks_count":6,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-06-20T02:03:40.371Z","etag":null,"topics":["casbin","cors","database","datatype","functions","gin","go","golang","gorm","method","mysql","rate","rate-limit","redis","snowflake"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/melf-xyzh.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-11-09T03:29:18.000Z","updated_at":"2024-05-15T15:59:19.000Z","dependencies_parsed_at":"2022-10-12T20:29:31.667Z","dependency_job_id":null,"html_url":"https://github.com/melf-xyzh/gin-start","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/melf-xyzh/gin-start","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/melf-xyzh%2Fgin-start","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/melf-xyzh%2Fgin-start/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/melf-xyzh%2Fgin-start/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/melf-xyzh%2Fgin-start/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/melf-xyzh","download_url":"https://codeload.github.com/melf-xyzh/gin-start/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/melf-xyzh%2Fgin-start/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28845816,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-28T13:02:32.985Z","status":"ssl_error","status_checked_at":"2026-01-28T13:02:04.945Z","response_time":57,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["casbin","cors","database","datatype","functions","gin","go","golang","gorm","method","mysql","rate","rate-limit","redis","snowflake"],"created_at":"2026-01-28T13:06:02.204Z","updated_at":"2026-01-28T13:06:03.115Z","avatar_url":"https://github.com/melf-xyzh.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# gin-start\n\n### 介绍\n\n一个Gin框架的项目公共基础库，避免进行基础模块的重复开发。\n\n- 实现高并发可用的分布式雪花ID\n- 封装跨域、限流等常用中间件\n- 封装类型转换等常用函数\n- 封装`Casbin`的常用方法\n- 封装请求统一返回格式\n\n### 安装\n\n```\ngo get github.com/melf-xyzh/gin-start\n```\n\n### 例子\n\n```go\npackage main\n\nimport (\n\t\"github.com/gin-gonic/gin\"\n\t\"github.com/melf-xyzh/gin-start/config\"\n\t\"github.com/melf-xyzh/gin-start/global\"\n\t\"github.com/melf-xyzh/gin-start/global/check\"\n\t\"github.com/melf-xyzh/gin-start/middleware\"\n\t\"github.com/melf-xyzh/gin-start/user/model\"\n\t\"github.com/melf-xyzh/gin-start/utils/result\"\n\t\"go-guide/guide/api/v1\"\n\t\"go-guide/guide/model\"\n)\n\n//go:generate go env -w GO111MODULE=on\n//go:generate go env -w GOPROXY=https://goproxy.cn,direct\n//go:generate go mod tidy\n//go:generate go mod download\n\nfunc main() {\n\tinit := conf.Init{}\n\t// 初始化环境变量\n\tglobal.E = init.Env(global.ENV_DEV)\n\t// 初始化Viper（读取配置文件）\n\tglobal.V = init.Viper()\n\t// 初始化数据库连接池\n\tglobal.DB = init.Database()\n\t// 初始化雪花ID节点\n\tglobal.Node = init.Node()\n\t// 初始化Redis连接池\n\tglobal.RDB = init.Redis()\n\t// 初始化参数校验器\n\tglobal.Validate = init.Validate()\n\t// 初始化Casbin\n\tglobal.Enforcer = init.Casbin()\n\n\tr := gin.New()\n\tr.Use(middleware.Cors())\n\n\terr := global.DB.AutoMigrate(\n\t\tusermod.User{},\n\t\tguidemod.Index{},\n\t\tguidemod.WebSite{},\n\t\tguidemod.WebsiteGroup{},\n\t)\n\tif err != nil {\n\t\tpanic(\"数据迁移失败\")\n\t}\n\n\tr.GET(\"/\", func(c *gin.Context) {\n\n\t\tuser := usermod.User{\n\t\t\tModel: global.Model{\n\t\t\t\tID:         global.CreateId(),\n\t\t\t\tCreateTime: global.CreateTime(),\n\t\t\t},\n\t\t\tName:        \"MELF\",\n\t\t\tEmail:       \"123456789@99.com\",\n\t\t\tLastLoginIp: \"8.8.8.8\",\n\t\t}\n\t\terr = check.Check(user, usermod.CreateUserCheck)\n\t\tif err != nil {\n\t\t\treturn\n\t\t}\n\t\t//err = global.DB.Create(\u0026user).Error\n\n\t\tvar userFind usermod.User\n\t\tglobal.DB.First(\u0026userFind)\n\t\tuserFind.LastLoginIp = \"192.168.1.11\"\n\t\tglobal.DB.Updates(\u0026userFind)\n\t\tresult.OkDataMsg(c, userFind, \"创建成功\")\n\t})\n\n\tr.GET(\"/index\", guideapi.IndexAPI.GetIndex)\n\n\tr.GET(\"/aaa/\", middleware.Rate0(\"4-H\"), func(c *gin.Context) {\n\t\tvar userFind usermod.User\n\t\tglobal.DB.First(\u0026userFind)\n\t\tresult.OkDataMsg(c, userFind, \"创建成功\")\n\t})\n\n\t// 启动服务\n\tinit.Run(r)\n}\n```\n\n### 类型转换封装\n\n```go\nfunc main(){\n    // var x interface{}\n    \n    // 将任意类型转换为string\n\tstr := data.ToString(x)\n\t// 将任意类型转换为float32\n\tf32, err := data.ToFloat32(x)\n\tif err != nil {\n\t\treturn\n\t}\n\t// 将任意类型转换为float64\n\tf64, err := data.ToFloat64(x)\n\tif err != nil {\n\t\treturn\n\t}\n\t// 将任意类型转换为int\n\ti, err := data.ToInt(x)\n\tif err != nil {\n\t\treturn\n\t}\n\t// 将任意类型转换为int32\n\ti32, err := data.ToInt32(x)\n\tif err != nil {\n\t\treturn\n\t}\n\t// 将任意类型转换为int64\n\ti64, err := data.ToInt64(x)\n\tif err != nil {\n\t\treturn\n\t}\n}\n```\n\n### 中间件封装\n\n```go\n// 允许跨域\nr.Use(middleware.Cors())\n\n// 限流中间件\n *  5 reqs/second: \"5-S\"\n *  10 reqs/minute: \"10-M\"\n *  1000 reqs/hour: \"1000-H\"\n *  2000 reqs/day: \"2000-D\"\n// 限流每个ip的访问频率\nr.Use(middleware.Rate(\"4-H\"))\n// 限制该接口的总访问频率\nr.Use(middleware.Rate0(\"4-H\"))\n```\n\n### 非侵入式校验器\n\n模型定义\n\n```go\ntype User struct {\n\tglobal.Model\n\tAccount       string     `json:\"account\"           gorm:\"column:account;comment:账号;type:varchar(30)\"`\n\tPassword      string     `json:\"-\"                 gorm:\"column:password;comment:密码;type:varchar(255)\"`\n\tName          string     `json:\"name\"              gorm:\"column:name;comment:姓名;type:varchar(10)\"`\n\tAvatar        string     `json:\"avatar\"            gorm:\"column:avatar;comment:头像;type:varchar(255)\"`\n\tNickname      string     `json:\"nickname\"          gorm:\"column:nickname;comment:昵称;type:varchar(20)\"`\n\tStatus        string     `json:\"status\"            gorm:\"column:status;comment:状态;default:enable;type:varchar(10)\"`\n\tUserType      string     `json:\"userType\"          gorm:\"column:user_type;comment:用户类型;default:common;type:varchar(20)\"`\n\tPhone         string     `json:\"phone\"             gorm:\"column:phone;comment:手机号;type:varchar(255)\"`\n\tEmail         string     `json:\"email\"             gorm:\"column:email;comment:邮箱;type:varchar(255)\"`\n\tLoginCount    uint64     `json:\"loginCount\"        gorm:\"column:login_count;comment:登录次数;default:0\"`\n\tLastLoginTime *time.Time `json:\"lastLoginTime\"     gorm:\"column:last_login_time;comment:上传登录时间;\"`\n\tLastLoginIp   string     `json:\"lastLoginIp\"       gorm:\"column:last_login_ip;comment:上次登录IP;type:varchar(100)\"`\n}\n```\n\n校验规则定义\n\n```go\nvar (\n\t// CreateUserCheck 创建用户校验\n\tCreateUserCheck = check.Rules{\n        // 键名为结构体字段名，规则请参考\n        // https://github.com/go-playground/validator/blob/master/README.md\n        \"Name\": \"required\",\n\t}\n)\n```\n\n在这里向`https://github.com/go-playground/validator`致敬！\n\n校验\n\n```go\n// 创建一个实例\nuser := usermod.User{\n    Model: global.Model{\n        ID:         global.CreateId(),\n        CreateTime: global.CreateTime(),\n    },\n    Name:        \"MELF\",\n    Email:       \"123456789@99.com\",\n    LastLoginIp: \"8.8.8.8\",\n}\n// 校验该实例是否符合规则\nerr = check.Check(user, usermod.CreateUserCheck)\nif err != nil {\n    return\n}\n```\n\n### 第三方接口请求（GET / POST方式）\n\n```go\nfunc main(){\n\tdata, err := httpapi.Get.Get(\"https://api.uomg.com/api/comments.163\")\n\tif err != nil {\n\t\tlog.Println(err.Error())\n\t}\n\tlog.Println(data)\n\n\n\tdata, err = httpapi.Get.GetWithParams(\"https://api.uomg.com/api/comments.163\", map[string]interface{}{\"format\":\"text\"})\n\tif err != nil {\n\t\tlog.Println(err.Error())\n\t}\n\tlog.Println(data)\n\n\tdata,err = httpapi.Post.PostJson(\"需要请求的url\",map[string]interface{}{\"format\":\"text\"})\n\tif err != nil {\n\t\tlog.Println(err.Error())\n\t}\n\tlog.Println(data)\n\n\tdata,err = httpapi.Post.PostFormData(\"需要请求的url\",map[string]interface{}{\"format\":\"text\"})\n\tif err != nil {\n\t\tlog.Println(err.Error())\n\t}\n\tlog.Println(data)\n\n\tdata,err = httpapi.Post.PostUrlencoded(\"需要请求的url\",map[string]interface{}{\"format\":\"text\"})\n\tif err != nil {\n\t\tlog.Println(err.Error())\n\t}\n\tlog.Println(data)\n}\n```\n\n### 项目目录\n\n```bash\n├─config            #配置相关\n├─global            #全局变量（或单例连接池）、全局常量\n├─resource          #资源文件夹\n├─router            #路由文件夹\n├─user              #用户模块\n└─utils             #工具类\n    ├─data          #数据格式相关\n    ├─distributed #分布式相关\n    └─result#返回消息封装\n```\n\n### 功能目标\n\n- [x] Viper配置文件解析\n- [x] 集成ORM（Gorm）\n- [x] 跨域\n- [ ] 身份认证（登录）\n  - [ ] 基于Session\n  - [ ] 基于Jwt\n- [ ] 权限控制\n  - [ ] 集成csabin\n- [ ] SSE（服务端消息推送）\n- [ ] gRPC\n- [x] 分布式ID\n  - [x] snowflow\n- [ ] Websocket\n- [x] 接口限流\n\n### 备注\n\n\u003e codechina：https://codechina.csdn.net/qq_29537269/gin-start\n\u003e\n\u003e gitee：https://gitee.com/melf-xyzh/gin-start\n\u003e\n\u003e github：https://github.com/melf-xyzh/gin-start\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmelf-xyzh%2Fgin-start","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmelf-xyzh%2Fgin-start","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmelf-xyzh%2Fgin-start/lists"}