go-zero는 [CNCF Landscape](https://landscape.cncf.io/?selected=go-zero)에 등재된, 다양한 엔지니어링 모범 사례가 내장된 웹 및 RPC 프레임워크입니다. 회복 탄력성 설계로 트래픽이 많은 서비스의 안정성을 보장하기 위해 만들어졌으며, 수년 동안 수천만 사용자를 보유한 사이트에서 운영되어 왔습니다.
go-zero에는 간단한 API 설명 문법과 `goctl`이라는 코드 생성 도구가 포함되어 있습니다. `goctl`을 사용하면 .api 파일에서 Go, iOS, Android, Kotlin, Dart, TypeScript, JavaScript 코드를 생성할 수 있습니다.
#### go-zero의 장점:
* 수천만 일간 활성 사용자를 처리하는 서비스의 안정성을 높입니다.
* 체인형 타임아웃 제어, 동시성 제어, 속도 제한, 적응형 서킷 브레이커, 적응형 로드 셰딩이 내장되어 있으며, 별도 설정 없이도 사용할 수 있습니다.
* 내장 미들웨어를 기존 프레임워크에 통합할 수 있습니다.
* 간단한 API 문법과 한 번의 명령으로 여러 언어 코드를 생성할 수 있습니다.
* 클라이언트 요청 파라미터를 자동으로 검증합니다.
* 다양한 내장 마이크로서비스 관리 도구와 동시성 도구를 제공합니다.
## go-zero의 배경
2018년 초, 우리는 Java+MongoDB 기반 모놀리식 아키텍처에서 마이크로서비스로 전환하면서 다음을 선택했습니다.
* **Golang** - 높은 성능, 간결한 문법, 뛰어난 배포 경험, 낮은 리소스 사용량
* **자체 설계한 마이크로서비스 프레임워크** - 더 나은 문제 격리, 더 쉬운 기능 확장, 더 빠른 이슈 해결
## go-zero의 설계 고려 사항
go-zero는 다음 핵심 설계 원칙을 따릅니다.
* **단순성** - 단순하게 유지하는 것을 제1원칙으로 삼습니다.
* **고가용성** - 높은 동시성 상황에서도 안정적으로 동작합니다.
* **회복 탄력성** - 적응형 보호를 갖춘 장애 지향 프로그래밍을 지향합니다.
* **개발자 친화성** - 복잡성을 캡슐화하고 한 가지 일을 하는 한 가지 방법을 제공합니다.
* **확장 용이성** - 성장을 위한 유연한 아키텍처를 제공합니다.
## go-zero의 구현과 기능
go-zero는 엔지니어링 모범 사례를 통합합니다.
* **코드 생성** - 보일러플레이트를 최소화하는 강력한 도구
* **간단한 API** - 깔끔한 인터페이스와 net/http 완전 호환
* **고성능** - 속도와 효율성을 위한 최적화
* **회복 탄력성** - 내장 서킷 브레이커, 속도 제한, 로드 셰딩, 타임아웃 제어
* **서비스 메시** - 서비스 디스커버리, 부하 분산, 호출 추적
* **개발자 도구** - 자동 파라미터 검증, 캐시 관리, 메트릭과 모니터링
## go-zero 아키텍처
## 설치
프로젝트에서 다음 명령을 실행하세요.
```shell
go get -u github.com/zeromicro/go-zero
```
## AI 네이티브 개발
go-zero 팀은 Claude, GitHub Copilot, Cursor가 프레임워크 규칙을 따르는 코드를 생성할 수 있도록 AI 도구를 제공합니다.
### 세 가지 핵심 프로젝트
**[ai-context](https://github.com/zeromicro/ai-context)** - AI 어시스턴트를 위한 워크플로 가이드
**[zero-skills](https://github.com/zeromicro/zero-skills)** - 예제가 포함된 패턴 라이브러리
**[mcp-zero](https://github.com/zeromicro/mcp-zero)** - Model Context Protocol을 통한 코드 생성 도구
### 빠른 설정
#### GitHub Copilot
```bash
git submodule add https://github.com/zeromicro/ai-context.git .github/ai-context
ln -s ai-context/00-instructions.md .github/copilot-instructions.md # macOS/Linux
# Windows: mklink .github\copilot-instructions.md .github\ai-context\00-instructions.md
git submodule update --remote .github/ai-context # 업데이트
```
#### Cursor
```bash
git submodule add https://github.com/zeromicro/ai-context.git .cursorrules
git submodule update --remote .cursorrules # 업데이트
```
#### Windsurf
```bash
git submodule add https://github.com/zeromicro/ai-context.git .windsurfrules
git submodule update --remote .windsurfrules # 업데이트
```
#### Claude Desktop
```bash
git clone https://github.com/zeromicro/mcp-zero.git && cd mcp-zero && go build
# 설정: ~/Library/Application Support/Claude/claude_desktop_config.json
# 또는: claude mcp add --transport stdio mcp-zero --env GOCTL_PATH=/path/to/goctl -- /path/to/mcp-zero
```
### 동작 방식
AI 어시스턴트는 다음 도구를 함께 사용합니다.
1. **ai-context** - 워크플로 안내
2. **zero-skills** - 구현 패턴
3. **mcp-zero** - 실시간 코드 생성
**예시**: REST API 생성 → AI가 **ai-context**에서 워크플로를 읽음 → **mcp-zero**를 호출해 코드 생성 → **zero-skills**에서 패턴 참조 → 프로덕션 준비가 된 코드 생성 ✅
## 빠른 시작
1. 전체 예제:
[마이크로서비스 시스템 빠른 개발](https://github.com/zeromicro/zero-doc/blob/main/doc/shorturl-en.md)
[마이크로서비스 시스템 빠른 개발 - 다중 RPC](https://github.com/zeromicro/zero-doc/blob/main/docs/zero/bookstore-en.md)
2. goctl 설치
```shell
# Go 사용
go install github.com/zeromicro/go-zero/tools/goctl@latest
# Mac 사용
brew install goctl
# 모든 플랫폼에서 docker 사용
docker pull kevinwan/goctl
# goctl 실행
docker run --rm -it -v `pwd`:/app kevinwan/goctl --help
```
goctl이 실행 가능하고 $PATH에 포함되어 있는지 확인하세요.
3. API 파일(greet.api) 생성:
```go
type (
Request {
Name string `path:"name,options=[you,me]"` // 파라미터는 자동으로 검증됩니다.
}
Response {
Message string `json:"message"`
}
)
service greet-api {
@handler GreetHandler
get /greet/from/:name(Request) returns (Response)
}
```
.api 템플릿 생성:
```shell
goctl api -o greet.api
```
4. Go 서버 코드 생성
```shell
goctl api go -api greet.api -dir greet
```
생성되는 구조:
```Plain Text
├── greet
│ ├── etc
│ │ └── greet-api.yaml // 설정 파일
│ ├── greet.go // main 파일
│ └── internal
│ ├── config
│ │ └── config.go // 설정 정의
│ ├── handler
│ │ ├── greethandler.go // get/put/post/delete 라우트가 여기에 정의됩니다.
│ │ └── routes.go // 라우트 목록
│ ├── logic
│ │ └── greetlogic.go // 요청 로직을 여기에 작성할 수 있습니다.
│ ├── svc
│ │ └── servicecontext.go // 서비스 컨텍스트, mysql/redis를 여기에 전달할 수 있습니다.
│ └── types
│ └── types.go // 요청/응답이 여기에 정의됩니다.
└── greet.api // api 설명 파일
```
서비스 실행:
```shell
cd greet
go mod tidy
go run greet.go -f etc/greet-api.yaml
```
기본 포트: 8888(etc/greet-api.yaml에서 변경 가능)
curl로 테스트:
```shell
curl -i http://localhost:8888/greet/from/you
```
응답:
```http
HTTP/1.1 200 OK
Date: Sun, 30 Aug 2020 15:32:35 GMT
Content-Length: 0
```
5. 비즈니스 로직 작성
* servicecontext.go를 통해 의존성(mysql, redis 등)을 전달합니다.
* .api 정의에 따라 logic 패키지에 로직 코드를 추가합니다.
6. 여러 언어의 클라이언트 코드 생성
```shell
goctl api java -api greet.api -dir greet
goctl api dart -api greet.api -dir greet
...
```
## 벤치마크
[테스트 코드 보기](https://github.com/smallnest/go-web-framework-benchmark)
## 문서
* [문서](https://go-zero.dev/)
* [마이크로서비스 시스템 빠른 개발](https://github.com/zeromicro/zero-doc/blob/main/doc/shorturl-en.md)
* [마이크로서비스 시스템 빠른 개발 - 다중 RPC](https://github.com/zeromicro/zero-doc/blob/main/docs/zero/bookstore-en.md)
* [예제](https://github.com/zeromicro/zero-examples)
## 채팅 그룹
다음 링크에서 채팅에 참여하세요: https://discord.gg/4JQvC5A4Fe
## Cloud Native Landscape
