-
Notifications
You must be signed in to change notification settings - Fork 0
/
generator.go
317 lines (280 loc) · 9.33 KB
/
generator.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
package generator
import (
"bufio"
"bytes"
"fmt"
"go/parser"
"go/printer"
"go/token"
"path"
"strconv"
"strings"
"github.com/HuJingwei/go-zero/tool/protobuf/pkg/gen"
"github.com/HuJingwei/go-zero/tool/protobuf/pkg/naming"
"github.com/HuJingwei/go-zero/tool/protobuf/pkg/typemap"
"github.com/HuJingwei/go-zero/tool/protobuf/pkg/utils"
"github.com/golang/protobuf/protoc-gen-go/descriptor"
plugin "github.com/golang/protobuf/protoc-gen-go/plugin"
"github.com/pkg/errors"
)
const Version = "v0.1"
var GoModuleImportPath = "github.com/HuJingwei/go-zero"
var GoModuleDirName = "github.com/HuJingwei/go-zero"
type Base struct {
Reg *typemap.Registry
// Map to record whether we've built each package
// pkgName => alias name
pkgs map[string]string
pkgNamesInUse map[string]bool
ImportPrefix string // String to prefix to imported package file names.
importMap map[string]string // Mapping from .proto file name to import path.
// Package naming:
GenPkgName string // Name of the package that we're generating
PackageName string // Name of the proto file package
fileToGoPackageName map[*descriptor.FileDescriptorProto]string
// List of files that were inputs to the generator. We need to hold this in
// the struct so we can write a header for the file that lists its inputs.
GenFiles []*descriptor.FileDescriptorProto
// Output buffer that holds the bytes we want to write out for a single file.
// Gets reset after working on a file.
Output *bytes.Buffer
// key: pkgName
// value: importPath
Deps map[string]string
Params *ParamsBase
httpInfoCache map[string]*HTTPInfo
}
// RegisterPackageName name is the go package name or proto pkg name
// return go pkg alias
func (t *Base) RegisterPackageName(name string) (alias string) {
alias = name
i := 1
for t.pkgNamesInUse[alias] {
alias = name + strconv.Itoa(i)
i++
}
t.pkgNamesInUse[alias] = true
t.pkgs[name] = alias
return alias
}
func (t *Base) Setup(in *plugin.CodeGeneratorRequest, paramsOpt ...GeneratorParamsInterface) {
t.httpInfoCache = make(map[string]*HTTPInfo)
t.pkgs = make(map[string]string)
t.pkgNamesInUse = make(map[string]bool)
t.importMap = make(map[string]string)
t.Deps = make(map[string]string)
t.fileToGoPackageName = make(map[*descriptor.FileDescriptorProto]string)
t.Output = bytes.NewBuffer(nil)
var params GeneratorParamsInterface
if len(paramsOpt) > 0 {
params = paramsOpt[0]
} else {
params = &BasicParam{}
}
err := ParseGeneratorParams(in.GetParameter(), params)
if err != nil {
gen.Fail("could not parse parameters", err.Error())
}
t.Params = params.GetBase()
t.ImportPrefix = params.GetBase().ImportPrefix
t.importMap = params.GetBase().ImportMap
t.GenFiles = gen.FilesToGenerate(in)
// Collect information on types.
t.Reg = typemap.New(in.ProtoFile)
t.RegisterPackageName("context")
t.RegisterPackageName("ioutil")
t.RegisterPackageName("proto")
// Time to figure out package names of objects defined in protobuf. First,
// we'll figure out the name for the package we're generating.
genPkgName, err := DeduceGenPkgName(t.GenFiles)
if err != nil {
gen.Fail(err.Error())
}
t.GenPkgName = genPkgName
// Next, we need to pick names for all the files that are dependencies.
if len(in.ProtoFile) > 0 {
t.PackageName = t.GenFiles[0].GetPackage()
}
for _, f := range in.ProtoFile {
if fileDescSliceContains(t.GenFiles, f) {
// This is a file we are generating. It gets the shared package name.
t.fileToGoPackageName[f] = t.GenPkgName
} else {
// This is a dependency. Use its package name.
name := f.GetPackage()
if name == "" {
name = utils.BaseName(f.GetName())
}
name = utils.CleanIdentifier(name)
alias := t.RegisterPackageName(name)
t.fileToGoPackageName[f] = alias
}
}
for _, f := range t.GenFiles {
deps := t.DeduceDeps(f)
for k, v := range deps {
t.Deps[k] = v
}
}
}
func (t *Base) DeduceDeps(file *descriptor.FileDescriptorProto) map[string]string {
deps := make(map[string]string) // Map of package name to quoted import path.
ourImportPath := path.Dir(naming.GoFileName(file, ""))
for _, s := range file.Service {
for _, m := range s.Method {
defs := []*typemap.MessageDefinition{
t.Reg.MethodInputDefinition(m),
t.Reg.MethodOutputDefinition(m),
}
for _, def := range defs {
if def.File.GetPackage() == t.PackageName {
continue
}
// By default, import path is the dirname of the Go filename.
importPath := path.Dir(naming.GoFileName(def.File, ""))
if importPath == ourImportPath {
continue
}
importPath = t.SubstituteImportPath(importPath, def.File.GetName())
importPath = t.ImportPrefix + importPath
pkg := t.GoPackageNameForProtoFile(def.File)
deps[pkg] = strconv.Quote(importPath)
}
}
}
return deps
}
// DeduceGenPkgName figures out the go package name to use for generated code.
// Will try to use the explicit go_package setting in a file (if set, must be
// consistent in all files). If no files have go_package set, then use the
// protobuf package name (must be consistent in all files)
func DeduceGenPkgName(genFiles []*descriptor.FileDescriptorProto) (string, error) {
var genPkgName string
for _, f := range genFiles {
name, explicit := naming.GoPackageName(f)
if explicit {
name = utils.CleanIdentifier(name)
if genPkgName != "" && genPkgName != name {
// Make sure they're all set consistently.
return "", errors.Errorf("files have conflicting go_package settings, must be the same: %q and %q", genPkgName, name)
}
genPkgName = name
}
}
if genPkgName != "" {
return genPkgName, nil
}
// If there is no explicit setting, then check the implicit package name
// (derived from the protobuf package name) of the files and make sure it's
// consistent.
for _, f := range genFiles {
name, _ := naming.GoPackageName(f)
name = utils.CleanIdentifier(name)
if genPkgName != "" && genPkgName != name {
return "", errors.Errorf("files have conflicting package names, must be the same or overridden with go_package: %q and %q", genPkgName, name)
}
genPkgName = name
}
// All the files have the same name, so we're good.
return genPkgName, nil
}
func (t *Base) GoPackageNameForProtoFile(file *descriptor.FileDescriptorProto) string {
return t.fileToGoPackageName[file]
}
func fileDescSliceContains(slice []*descriptor.FileDescriptorProto, f *descriptor.FileDescriptorProto) bool {
for _, sf := range slice {
if f == sf {
return true
}
}
return false
}
// P forwards to g.gen.P, which prints output.
func (t *Base) P(args ...string) {
for _, v := range args {
t.Output.WriteString(v)
}
t.Output.WriteByte('\n')
}
func (t *Base) FormattedOutput() string {
// Reformat generated code.
fset := token.NewFileSet()
raw := t.Output.Bytes()
ast, err := parser.ParseFile(fset, "", raw, parser.ParseComments)
if err != nil {
// Print out the bad code with line numbers.
// This should never happen in practice, but it can while changing generated code,
// so consider this a debugging aid.
var src bytes.Buffer
s := bufio.NewScanner(bytes.NewReader(raw))
for line := 1; s.Scan(); line++ {
fmt.Fprintf(&src, "%5d\t%s\n", line, s.Bytes())
}
gen.Fail("bad Go source code was generated:", err.Error(), "\n"+src.String())
}
out := bytes.NewBuffer(nil)
err = (&printer.Config{Mode: printer.TabIndent | printer.UseSpaces, Tabwidth: 8}).Fprint(out, fset, ast)
if err != nil {
gen.Fail("generated Go source code could not be reformatted:", err.Error())
}
return out.String()
}
func (t *Base) PrintComments(comments typemap.DefinitionComments) bool {
text := strings.TrimSuffix(comments.Leading, "\n")
if len(strings.TrimSpace(text)) == 0 {
return false
}
split := strings.Split(text, "\n")
for _, line := range split {
t.P("// ", strings.TrimPrefix(line, " "))
}
return len(split) > 0
}
// IsOwnPackage ...
// protoName is fully qualified name of a type
func (t *Base) IsOwnPackage(protoName string) bool {
def := t.Reg.MessageDefinition(protoName)
if def == nil {
gen.Fail("could not find message for", protoName)
}
return def.File.GetPackage() == t.PackageName
}
// Given a protobuf name for a Message, return the Go name we will use for that
// type, including its package prefix.
func (t *Base) GoTypeName(protoName string) string {
def := t.Reg.MessageDefinition(protoName)
if def == nil {
gen.Fail("could not find message for", protoName)
}
var prefix string
if def.File.GetPackage() != t.PackageName {
prefix = t.GoPackageNameForProtoFile(def.File) + "."
}
var name string
for _, parent := range def.Lineage() {
name += parent.Descriptor.GetName() + "_"
}
name += def.Descriptor.GetName()
return prefix + name
}
func streamingMethod(method *descriptor.MethodDescriptorProto) bool {
return (method.ServerStreaming != nil && *method.ServerStreaming) || (method.ClientStreaming != nil && *method.ClientStreaming)
}
func (t *Base) ShouldGenForMethod(file *descriptor.FileDescriptorProto,
service *descriptor.ServiceDescriptorProto,
method *descriptor.MethodDescriptorProto) bool {
if streamingMethod(method) {
return false
}
if !t.Params.ExplicitHTTP {
return true
}
httpInfo := t.GetHttpInfoCached(file, service, method)
return httpInfo.HasExplicitHTTPPath
}
func (t *Base) SubstituteImportPath(importPath string, importFile string) string {
if substitution, ok := t.importMap[importFile]; ok {
importPath = substitution
}
return importPath
}