生成客户端 SDK

自动生成 http sdk 参数

$ jzero gen sdk -h                   
Generate sdk client by api file and proto file

Usage:
  jzero gen sdk [flags]

Flags:
      --api-dir string     set input api dir (default "desc/api")
      --goModule string    set go module name
      --goPackage string   set package name
      --goVersion string   set go version, only effect when having goModule flag
  -h, --help               help for sdk
  -l, --language string    set language (default "go")
  -o, --output string      set output dir
      --proto-dir string   set input proto dir (default "desc/proto")
      --scope string       set scope name
      --wrap-response      warp response: code, data, message (default true)

Global Flags:
  -f, --config string   set config file (default ".jzero.yaml")
      --debug           debug mode
      --home string     set template home (default "/Users/jaronnie/Desktop/jaronnie/github/jzero-io/jzero/.template")
      --style string    The file naming format, see [https://github.com/zeromicro/go-zero/blob/master/tools/goctl/config/readme.md] (default "gozero")

自动生成 go http sdk

• kubernetes client-go style
• 根据 api 文件中的 group name 和 proto 文件中的 service name 进行业务分组
• 链式调用, 调用逻辑清晰
• 可自定义接口进行扩展

jzero

cd your_project
jzero gen sdk
cd your_project_go
go mod tidy

Docker

cd your_project
docker run --rm -v ${PWD}:/app ghcr.io/jzero-io/jzero:latest gen sdk

cd your_project-go
go mod tidy

GitHub Action

name: jzero-action-test

on:
  push:
    branches:

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
        with:
          fetch-depth: 0

      - uses: jzero-io/jzero-action@v1
        with:
          args: gen sdk
          version: latest

使用实例

package main

import (
	"context"
	"github.com/jzero-io/restc"
	your_project_go "your_project/your_project-go"
	"your_project/your_project-go/model/your_project/pb/hellopb"
)

func main() {
	headers := make(map[string][]string)
	headers["Content-Type"] = []string{"application/json"}
	clientset, err := your_project.NewClientWithOptions(
		restc.WithAddr("127.0.0.1"),
		restc.WithPort("8001"),
		restc.WithProtocol("http")),
		restc.WithHeaders(headers),
	if err != nil {
		panic(err)
	}

	result, err := clientset.Hello().SayHello(context.Background(), &types.SayHelloRequest{
		Message: "jzero",
	})
	if err != nil {
		panic(err)
	}
	fmt.Println(result.Message)
}

自动生成 ts http sdk

working...

自动生成 zrpc client

jzero gen zrpcclient

使用实例一: 直连 rpc 服务

package main

import (
	"context"
	"fmt"
	"github.com/zeromicro/go-zero/zrpc"
	your_project "your_project/zrpcclient-go"
	"your_project/zrpcclient-go/model/your_project/pb/hellopb"
)

func main() {
	target, err := zrpc.NewClientWithTarget("localhost:8000")
	if err != nil {
		panic(err)
	}
	var cs your_project.Interface

	cs = your_project.NewClientset(your_project.WithYour_projectClient(target))

	hello, err := cs.Your_project().Hello().SayHello(context.Background(), &hellopb.SayHelloRequest{
		Message: "hello",
	})

	if err != nil {
		panic(err)
	}
	fmt.Println(hello)
}

使用实例二: 基于 etcd 连接

使用之前请修改服务端配置 etc/etc.yaml, 请查看 etcd 配置, 然后重启程序

package main

import (
	"context"
	"fmt"
	"github.com/zeromicro/go-zero/zrpc"
	your_project "your_project/zrpcclient-go"
	"your_project/zrpcclient-go/model/your_project/pb/hellopb"
)

func main() {
	target, err := zrpc.NewClient(zrpc.RpcClientConf{
		Etcd: discov.EtcdConf{
			Hosts: []string{"127.0.0.1:2379"},
			Key:   "your_project.rpc",
		},
	})
	var cs your_project.Interface

	cs = your_project.NewClientset(your_project.WithYour_projectClient(target))

	hello, err := cs.Your_project().Hello().SayHello(context.Background(), &hellopb.SayHelloRequest{
		Message: "hello",
	})

	if err != nil {
		panic(err)
	}
	fmt.Println(hello)
}