update gen go api code

Author: xnzone

README.md

@@ -0,0 +1,39 @@
+# protoc-gen-go_api
+一款用protobuf文件生成go的http调用代码。
+
+## 安装
+
+```bash
+go install github.com/dev-openapi/protoc-gen-go_api@latest
+```
+
+## 使用
+
+依赖googleapis的http.proto和annotations.proto。并且需要放到google/api/目录下
+
+如果google/api是在工程文件目录下，执行以下脚本
+
+```bash
+protoc --go_api_out=out={dir}:. *.proto
+```
+
+如果google/api在其他文件目录下，执行以下脚本
+
+```bash
+protoc --proto_path={yourpath}:. --go_api_out=:. *.proto
+```
+
+## 注意
+
+最新版本的protoc-gen-go要求go_package必须含有/，且会生成到$GOPATH/src目录下，所以建议把工程文件放到$GOPATH/src/git域名/git_group/目录下。
+
+如 https://github.com/dev-openapi/wxmp 则该工程文件为 $GOPATH/src/github.com/dev-openapi/wxmp
+
+另外，也可以指定protoc-gen-go的生成目录和设置source_relative相关配置，也可以生成到指定目录
+
+如
+```shell
+protoc --go_out=.. --go_opt=paths=source_relative --go_api_out=out=..:. *.proto
+```
+
+这样会生成到上一层目录

go.sum

@@ -0,0 +1,47 @@
+package genapi
+
+import (
+	plugin "github.com/golang/protobuf/protoc-gen-go/plugin"
+	"google.golang.org/protobuf/runtime/protoiface"
+)
+
+var (
+	comments = make(map[protoiface.MessageV1]string)
+)
+
+func initComment(req *plugin.CodeGeneratorRequest) {
+	for _, f := range req.GetProtoFile() {
+		for _, loc := range f.GetSourceCodeInfo().GetLocation() {
+			if loc.LeadingComments == nil {
+				continue
+			}
+
+			// p is an array with format [f1, i1, f2, i2, ...]
+			// - f1 refers to the protobuf field tag
+			// - if field refer to by f1 is a slice, i1 refers to an element in that slice
+			// - f2 and i2 works recursively.
+			// So, [6, x] refers to the xth service defined in the file,
+			// since the field tag of Service is 6.
+			// [6, x, 2, y] refers to the yth method in that service,
+			// since the field tag of Method is 2.
+			p := loc.Path
+			switch {
+			case len(p) == 2 && p[0] == 6:
+				comments[f.Service[p[1]]] = *loc.LeadingComments
+			case len(p) == 4 && p[0] == 6 && p[2] == 2:
+				comments[f.Service[p[1]].Method[p[3]]] = *loc.LeadingComments
+			}
+		}
+	}
+}
+
+func getComment(m protoiface.MessageV1) string {
+	c, ok := comments[m]
+	if !ok {
+		return ""
+	}
+	if c[len(c)-1] == '\n' {
+		return c[:len(c)-1]
+	}
+	return c
+}

internal/genapi/comment.go

@@ -0,0 +1,54 @@
+package genapi
+
+import (
+	"regexp"
+
+	"github.com/golang/protobuf/protoc-gen-go/descriptor"
+)
+
+type restInfo struct {
+	verb, route, body, typ string
+}
+
+const (
+	BODY_JSON  = "json"
+	BODY_FORM  = "form"
+	BODY_MULTI = "multi"
+)
+
+const (
+	emptyValue = "google.protobuf.Empty"
+	// protoc puts a dot in front of name, signaling that the name is fully qualified.
+	emptyType               = "." + emptyValue
+	lroType                 = ".google.longrunning.Operation"
+	httpBodyType            = ".google.api.HttpBody"
+	alpha                   = "alpha"
+	beta                    = "beta"
+	disableDeadlinesVar     = "GOOGLE_API_GO_EXPERIMENTAL_DISABLE_DEFAULT_DEADLINE"
+	fieldTypeBool           = descriptor.FieldDescriptorProto_TYPE_BOOL
+	fieldTypeString         = descriptor.FieldDescriptorProto_TYPE_STRING
+	fieldTypeBytes          = descriptor.FieldDescriptorProto_TYPE_BYTES
+	fieldTypeMessage        = descriptor.FieldDescriptorProto_TYPE_MESSAGE
+	fieldLabelRepeated      = descriptor.FieldDescriptorProto_LABEL_REPEATED
+	defaultPollInitialDelay = "time.Second" // 1 second
+	defaultPollMaxDelay     = "time.Minute" // 1 minute
+)
+
+var wellKnownTypes = []string{
+	".google.protobuf.FieldMask",
+	".google.protobuf.Timestamp",
+	".google.protobuf.Duration",
+	".google.protobuf.DoubleValue",
+	".google.protobuf.FloatValue",
+	".google.protobuf.Int64Value",
+	".google.protobuf.UInt64Value",
+	".google.protobuf.Int32Value",
+	".google.protobuf.UInt32Value",
+	".google.protobuf.BoolValue",
+	".google.protobuf.StringValue",
+	".google.protobuf.BytesValue",
+	".google.protobuf.Value",
+	".google.protobuf.ListValue",
+}
+
+var httpPatternVarRegex = regexp.MustCompile(`{([a-zA-Z0-9_.]+?)(=[^{}]+)?}`)

internal/genapi/const.go

@@ -0,0 +1,61 @@
+package genapi
+
+import "strings"
+
+var (
+	fn = map[string]interface{}{
+		"unexport": unexport,
+		"html":     html,
+	}
+)
+
+var (
+	noClientStream = `return nil, fmt.Errorf("%s not yet supported for REST clients")`
+	noServerStream = `return nil, fmt.Errorf("%s not yet supported for REST servers")`
+	noRestyOptions = `return nil, fmt.Errorf("%s has no resty options")`
+)
+
+type FileData struct {
+	Version   string         // 版本号
+	Source    string         // 源文件
+	GoPackage string         // Go包名
+	Services  []*ServiceData // 服务数据
+}
+
+type ServiceData struct {
+	PkgName  string        // package name
+	ServName string        // 服务名，不带Service的
+	Methods  []*MethodData // 方法数据
+}
+
+type MethodData struct {
+	ServName string // 所属服务名
+	MethName string // 方法名
+	Comment  string // 注释。只取头注释
+	ReqTyp   string // 请求类型名
+	ResTyp   string // 返回类型名
+	ReqCode  string // 请求代码
+}
+
+type CodeData struct {
+	Verb      string
+	RouteCode string
+	BodyCode  string
+	QueryCode string
+}
+
+type OptionData struct {
+	GoPackage string
+}
+
+// unexport 把首字母转小写
+func unexport(s string) string {
+	if len(s) == 0 {
+		return ""
+	}
+	return strings.ToLower(s[:1]) + s[1:]
+}
+
+func html(s string) string {
+	return s
+}

internal/genapi/data.go

@@ -0,0 +1,118 @@
+package genapi
+
+import (
+	"fmt"
+	"path"
+	"strings"
+
+	"github.com/golang/protobuf/protoc-gen-go/descriptor"
+	plugin "github.com/golang/protobuf/protoc-gen-go/plugin"
+	"google.golang.org/protobuf/proto"
+)
+
+func Gen(req *plugin.CodeGeneratorRequest) (*plugin.CodeGeneratorResponse, error) {
+	initDescInfo(req)
+	initComment(req)
+	opts, err := parseOptions(req.Parameter)
+	if err != nil {
+		return nil, err
+	}
+	var resp plugin.CodeGeneratorResponse
+	optdata := &OptionData{}
+	for _, f := range req.GetProtoFile() {
+		if !strContains(req.GetFileToGenerate(), f.GetName()) {
+			continue
+		}
+		data, err := parseRestFile(f)
+		if err != nil {
+			return nil, err
+		}
+		if len(optdata.GoPackage) == 0 {
+			optdata.GoPackage = data.GoPackage
+		}
+		bs, err := buildFrame(data)
+		if err != nil {
+			return nil, err
+		}
+		name := fmt.Sprintf("%s.api.go", strings.ReplaceAll(f.GetName(), ".proto", ""))
+		if len(opts.out) > 0 {
+			name = path.Join(opts.out, name)
+		}
+		resp.File = append(resp.File, &plugin.CodeGeneratorResponse_File{
+			Name:    proto.String(name),
+			Content: proto.String(bs),
+		})
+	}
+	bs, err := buildOptionsCode(optdata)
+	if err != nil {
+		return nil, err
+	}
+	resp.File = append(resp.File, &plugin.CodeGeneratorResponse_File{
+		Name:    proto.String("option.go"),
+		Content: proto.String(bs),
+	})
+	return &resp, nil
+}
+
+func parseRestFile(fd *descriptor.FileDescriptorProto) (*FileData, error) {
+	pkg := fd.Options.GetGoPackage()
+	ps := strings.Split(pkg, "/")
+	data := &FileData{
+		Version:   Version,
+		Source:    fd.GetName(),
+		GoPackage: strings.ReplaceAll(ps[len(ps)-1], "-", "_"),
+	}
+	servs := fd.GetService()
+
+	for _, serv := range servs {
+		srv, err := parseRestService(fd, serv)
+		if err != nil {
+			return nil, err
+		}
+		data.Services = append(data.Services, srv)
+	}
+
+	return data, nil
+}
+
+func parseRestService(fd *descriptor.FileDescriptorProto, serv *descriptor.ServiceDescriptorProto) (*ServiceData, error) {
+	data := &ServiceData{
+		PkgName:  fd.GetPackage(),
+		ServName: strings.ReplaceAll(serv.GetName(), "Service", ""),
+	}
+
+	meths := serv.GetMethod()
+	for _, meth := range meths {
+		mth, err := parseRestMethod(fd, serv, meth)
+		if err != nil {
+			return nil, err
+		}
+		data.Methods = append(data.Methods, mth)
+	}
+
+	return data, nil
+}
+
+func parseRestMethod(fd *descriptor.FileDescriptorProto, serv *descriptor.ServiceDescriptorProto, meth *descriptor.MethodDescriptorProto) (*MethodData, error) {
+	data := &MethodData{
+		ServName: strings.ReplaceAll(serv.GetName(), "Service", ""),
+		MethName: meth.GetName(),
+		Comment:  getComment(meth),
+		ReqTyp:   typeName(meth.GetInputType()),
+		ResTyp:   typeName(meth.GetOutputType()),
+	}
+	switch {
+	case meth.GetClientStreaming():
+		data.ReqCode = fmt.Sprintf(noClientStream, meth.GetName())
+	case meth.GetServerStreaming():
+		data.ReqCode = fmt.Sprintf(noServerStream, meth.GetName())
+	default:
+		code, err := genRestMethodCode(fd, serv, meth)
+		if err != nil {
+			return nil, err
+		}
+		data.ReqCode = code
+	}
+
+	return data, nil
+}