https://github.com/zeromicro/go-zero Skip to content Sign up * Why GitHub? Features - + Mobile - + Actions - + Codespaces - + Packages - + Security - + Code review - + Issues - + Integrations - + GitHub Sponsors - + Customer stories- * Team * Enterprise * Explore + Explore GitHub - Learn and contribute + Topics - + Collections - + Trending - + Learning Lab - + Open source guides - Connect with others + The ReadME Project - + Events - + Community forum - + GitHub Education - + GitHub Stars program - * Marketplace * Pricing Plans - + Compare plans - + Contact Sales - + Education - [ ] * # In this repository All GitHub | Jump to | * No suggested jump to results * # In this repository All GitHub | Jump to | * # In this organization All GitHub | Jump to | * # In this repository All GitHub | Jump to | Sign in Sign up {{ message }} zeromicro / go-zero Public * Notifications * Star 11.1k * Fork 1.4k go-zero is a web and rpc framework written in Go. It's born to ensure the stability of the busy sites with resilient design. Builtin goctl greatly improves the development productivity. go-zero.dev MIT License 11.1k stars 1.4k forks Star Notifications * Code * Issues 29 * Pull requests 8 * Discussions * Actions * Projects 0 * Security * Insights More * Code * Issues * Pull requests * Discussions * Actions * Projects * Security * Insights master Switch branches/tags [ ] Branches Tags Could not load branches Nothing to show {{ refName }} default View all branches Could not load tags Nothing to show {{ refName }} default View all tags 1 branch 45 tags Code Latest commit @kevwan kevwan fix jwt security issue by using golang-jwt package (#1066) ... 30e49f2 Sep 19, 2021 fix jwt security issue by using golang-jwt package (#1066) 30e49f2 Git stats * 932 commits Files Permalink Failed to load latest commit information. Type Name Latest commit message Commit time .github/workflows reorg imports, format code (#1000) Sep 6, 2021 core chore: fix comment issues (#1056) Sep 17, 2021 rest fix jwt security issue by using golang-jwt package (#1066) Sep 19, 2021 tools/goctl fix #1058 (#1064) Sep 19, 2021 zrpc upgrade grpc version & replace github.com/golang/protobuf/ protoc-gen-... Sep 19, 2021 .codecov.yml update codecov settings (#1010) Sep 7, 2021 .dockerignore initial import Jul 26, 2020 .gitattributes initial import Jul 26, 2020 .gitignore implement k8s service discovery (#988) Sep 4, 2021 CONTRIBUTING.md httpx.Error response without body (#982) Sep 1, 2021 LICENSE Add LICENSE Jul 30, 2020 ROADMAP.md add roadmap (#764) Jun 13, 2021 code-of-conduct.md add code of conduct (#760) Jun 12, 2021 go.mod fix jwt security issue by using golang-jwt package (#1066) Sep 19, 2021 go.sum fix jwt security issue by using golang-jwt package (#1066) Sep 19, 2021 readme-cn.md add repo moving notice (#1062) Sep 18, 2021 readme.md add repo moving notice (#1062) Sep 18, 2021 View code [ ] go-zero 0. what is go-zero 1. Backgrounds of go-zero 2. Design considerations on go-zero 3. The implementation and features of go-zero 4. Future development plans of go-zero 5. Installation 6. Quick Start 7. Benchmark 8. Documents (adding) 9. Chat group Give a Star! readme.md [go-zero] go-zero English | Jian Ti Zhong Wen Go codecov Go Report Card Release License: MIT Note: To meet the requirements of Open Source Foundation, we moved go-zero from tal-tech to zeromicro (a neutral GitHub organization). 0. what is go-zero go-zero (listed in CNCF Landscape: https://landscape.cncf.io/? selected=go-zero) is a web and rpc framework with lots of builtin engineering practices. It's born to ensure the stability of the busy services with resilience design, and has been serving sites with tens of millions users for years. go-zero contains simple API description syntax and code generation tool called goctl. You can generate Go, iOS, Android, Kotlin, Dart, TypeScript, JavaScript from .api files with goctl. Advantages of go-zero: * improve the stability of the services with tens of millions of daily active users * builtin chained timeout control, concurrency control, rate limit, adaptive circuit breaker, adaptive load shedding, even no configuration needed * builtin middlewares also can be integrated into your frameworks * simple API syntax, one command to generate couple of different languages * auto validate the request parameters from clients * plenty of builtin microservice management and concurrent toolkits Architecture 1. Backgrounds of go-zero At the beginning of 2018, we decided to re-design our system, from monolithic architecture with Java+MongoDB to microservice architecture. After researches and comparison, we chose to: * Golang based + great performance + simple syntax + proven engineering efficiency + extreme deployment experience + less server resource consumption * Self-designed microservice architecture + I have rich experience on designing microservice architectures + easy to location the problems + easy to extend the features 2. Design considerations on go-zero By designing the microservice architecture, we expected to ensure the stability, as well as the productivity. And from just the beginning, we have the following design principles: * keep it simple * high availability * stable on high concurrency * easy to extend * resilience design, failure-oriented programming * try best to be friendly to the business logic development, encapsulate the complexity * one thing, one way After almost half a year, we finished the transfer from monolithic system to microservice system, and deployed on August 2018. The new system guaranteed the business growth, and the system stability. 3. The implementation and features of go-zero go-zero is a web and rpc framework that integrates lots of engineering practices. The features are mainly listed below: * powerful tool included, less code to write * simple interfaces * fully compatible with net/http * middlewares are supported, easy to extend * high performance * failure-oriented programming, resilience design * builtin service discovery, load balancing * builtin concurrency control, adaptive circuit breaker, adaptive load shedding, auto trigger, auto recover * auto validation of API request parameters * chained timeout control * auto management of data caching * call tracing, metrics and monitoring * high concurrency protected As below, go-zero protects the system with couple layers and mechanisms: Resilience 4. Future development plans of go-zero * auto generate API mock server, make the client debugging easier * auto generate the simple integration test for the server side just from the .api files 5. Installation Run the following command under your project: go get -u github.com/tal-tech/go-zero 6. Quick Start 0. full examples can be checked out from below: Rapid development of microservice systems Rapid development of microservice systems - multiple RPCs 1. install goctl goctlcan be read as go control. goctl means not to be controlled by code, instead, we control it. The inside go is not golang. At the very beginning, I was expecting it to help us improve the productivity, and make our lives easier. # for Go 1.15 and earlier GO111MODULE=on go get -u github.com/tal-tech/go-zero/tools/goctl # for Go 1.16 and later go install github.com/tal-tech/go-zero/tools/goctl@latest make sure goctl is executable. 2. create the API file, like greet.api, you can install the plugin of goctl in vs code, api syntax is supported. type ( Request { Name string `path:"name,options=you|me"` // parameters are auto validated } Response { Message string `json:"message"` } ) service greet-api { @handler GreetHandler get /greet/from/:name(Request) returns (Response) } the .api files also can be generate by goctl, like below: goctl api -o greet.api 3. generate the go server side code goctl api go -api greet.api -dir greet the generated files look like: +-- greet | +-- etc | | +-- greet-api.yaml // configuration file | +-- greet.go // main file | +-- internal | +-- config | | +-- config.go // configuration definition | +-- handler | | +-- greethandler.go // get/put/post/delete routes are defined here | | +-- routes.go // routes list | +-- logic | | +-- greetlogic.go // request logic can be written here | +-- svc | | +-- servicecontext.go // service context, mysql/redis can be passed in here | +-- types | +-- types.go // request/response defined here +-- greet.api // api description file the generated code can be run directly: cd greet go mod init go mod tidy go run greet.go -f etc/greet-api.yaml by default, it's listening on port 8888, while it can be changed in configuration file. you can check it by curl: curl -i http://localhost:8888/greet/from/you the response looks like: HTTP/1.1 200 OK Date: Sun, 30 Aug 2020 15:32:35 GMT Content-Length: 0 4. Write the business logic code + the dependencies can be passed into the logic within servicecontext.go, like mysql, reds etc. + add the logic code in logic package according to .api file 5. Generate code like Java, TypeScript, Dart, JavaScript etc. just from the api file goctl api java -api greet.api -dir greet goctl api dart -api greet.api -dir greet ... 7. Benchmark benchmark Checkout the test code 8. Documents (adding) * Documents * Rapid development of microservice systems * Rapid development of microservice systems - multiple RPCs * Examples 9. Chat group Join the chat via https://join.slack.com/t/go-zero/shared_invite/ zt-ulzixfgi-NAkZjq856TewLY2KQSxHCw Give a Star! If you like or are using this project to learn or start your solution, please give it a star. Thanks! About go-zero is a web and rpc framework written in Go. It's born to ensure the stability of the busy sites with resilient design. Builtin goctl greatly improves the development productivity. go-zero.dev Topics go golang microservices microservice architecture restful web-framework rpc code-generation restful-api rpc-framework gozero goctl go-zero Resources Readme License MIT License Releases 45 Release v1.2.1 Latest Sep 14, 2021 + 44 releases Used by 328 * @1278651995 * @1278651995 * @achilsh * @HCY2315 * @leolongpy * @SaneHe * @1005281342 * @Jourmey + 320 Contributors 81 * @kevwan * @anqiansong * @kingxt * @bittoy * @StevenZack * @miaogaolin * @chenquan * @zhoushuguang * @heyanfu * @szpnygo * @sjatsh + 70 contributors Languages * Go 99.7% * Other 0.3% * (c) 2021 GitHub, Inc. * Terms * Privacy * Security * Status * Docs * Contact GitHub * Pricing * API * Training * Blog * About You can't perform that action at this time. You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.