feature: refactor api parse to g4 (#365)

* feature: refactor api parse to g4

* new g4 parser

* add CHANGE_LOG.MD

* refactor

* fix byte bug

* refactor

* optimized

* optimized

* revert

* update readme.md

* update readme.md

* update readme.md

* update readme.md

* remove no need

* fix java gen

* add upgrade

* resolve confilits

Co-authored-by: anqiansong <anqiansong@xiaoheiban.cn>
This commit is contained in:
kingxt
2021-01-11 15:10:51 +08:00
committed by GitHub
parent b0ccfb8eb4
commit ee19fb736b
88 changed files with 13641 additions and 2458 deletions

View File

@@ -1,7 +1,6 @@
package tsgen
import (
"errors"
"fmt"
"path"
"strings"
@@ -15,8 +14,6 @@ import (
const (
handlerTemplate = `{{.imports}}
{{.types}}
{{.apis}}
`
)
@@ -35,36 +32,6 @@ func genHandler(dir, webApi, caller string, api *spec.ApiSpec, unwrapApi bool) e
}
defer fp.Close()
var localTypes []spec.Type
for _, route := range api.Service.Routes() {
rts := apiutil.GetLocalTypes(api, route)
localTypes = append(localTypes, rts...)
}
var prefixForType = func(ty string) string {
if _, pri := primitiveType(ty); pri {
return ""
}
for _, item := range localTypes {
if util.Title(item.Name) == ty {
return ""
}
}
return packagePrefix
}
types, err := genTypes(localTypes, func(name string) (*spec.Type, error) {
for _, ty := range api.Types {
if strings.ToLower(ty.Name) == strings.ToLower(name) {
return &ty, nil
}
}
return nil, errors.New("inline type " + name + " not exist, please correct api file")
}, prefixForType)
if err != nil {
return err
}
imports := ""
if len(caller) == 0 {
caller = "webapi"
@@ -76,8 +43,8 @@ func genHandler(dir, webApi, caller string, api *spec.ApiSpec, unwrapApi bool) e
if len(webApi) > 0 {
imports += `import ` + importCaller + ` from ` + "\"" + webApi + "\""
}
shardTypes := apiutil.GetSharedTypes(api)
if len(shardTypes) != 0 {
if len(api.Types) != 0 {
if len(imports) > 0 {
imports += "\n"
}
@@ -85,7 +52,7 @@ func genHandler(dir, webApi, caller string, api *spec.ApiSpec, unwrapApi bool) e
imports += fmt.Sprintf(`import * as components from "%s"`, "./"+outputFile)
}
apis, err := genApi(api, caller, prefixForType)
apis, err := genApi(api, caller)
if err != nil {
return err
}
@@ -93,54 +60,35 @@ func genHandler(dir, webApi, caller string, api *spec.ApiSpec, unwrapApi bool) e
t := template.Must(template.New("handlerTemplate").Parse(handlerTemplate))
return t.Execute(fp, map[string]string{
"webApi": webApi,
"types": strings.TrimSpace(types),
"imports": imports,
"apis": strings.TrimSpace(apis),
})
}
func genTypes(localTypes []spec.Type, inlineType func(string) (*spec.Type, error), prefixForType func(string) string) (string, error) {
var builder strings.Builder
var first bool
for _, tp := range localTypes {
if first {
first = false
} else {
fmt.Fprintln(&builder)
}
if err := writeType(&builder, tp, func(name string) (s *spec.Type, err error) {
return inlineType(name)
}, prefixForType); err != nil {
return "", err
}
}
types := builder.String()
return types, nil
}
func genApi(api *spec.ApiSpec, caller string, prefixForType func(string) string) (string, error) {
func genApi(api *spec.ApiSpec, caller string) (string, error) {
var builder strings.Builder
for _, group := range api.Service.Groups {
for _, route := range group.Routes {
handler, ok := apiutil.GetAnnotationValue(route.Annotations, "server", "handler")
if !ok {
handler := route.Handler
if len(handler) == 0 {
return "", fmt.Errorf("missing handler annotation for route %q", route.Path)
}
handler = util.Untitle(handler)
handler = strings.Replace(handler, "Handler", "", 1)
comment := commentForRoute(route)
if len(comment) > 0 {
fmt.Fprintf(&builder, "%s\n", comment)
}
fmt.Fprintf(&builder, "export function %s(%s) {\n", handler, paramsForRoute(route, prefixForType))
fmt.Fprintf(&builder, "export function %s(%s) {\n", handler, paramsForRoute(route))
writeIndent(&builder, 1)
responseGeneric := "<null>"
if len(route.ResponseType.Name) > 0 {
val, err := goTypeToTs(route.ResponseType.Name, prefixForType)
if len(route.ResponseTypeName()) > 0 {
val, err := goTypeToTs(route.ResponseType, true)
if err != nil {
return "", err
}
responseGeneric = fmt.Sprintf("<%s>", val)
}
fmt.Fprintf(&builder, `return %s.%s%s(%s)`, caller, strings.ToLower(route.Method),
@@ -153,14 +101,18 @@ func genApi(api *spec.ApiSpec, caller string, prefixForType func(string) string)
return apis, nil
}
func paramsForRoute(route spec.Route, prefixForType func(string) string) string {
func paramsForRoute(route spec.Route) string {
if route.RequestType == nil {
return ""
}
hasParams := pathHasParams(route)
hasBody := hasRequestBody(route)
rt, err := goTypeToTs(route.RequestType.Name, prefixForType)
rt, err := goTypeToTs(route.RequestType, true)
if err != nil {
fmt.Println(err.Error())
return ""
}
if hasParams && hasBody {
return fmt.Sprintf("params: %s, req: %s", rt+"Params", rt)
} else if hasParams {
@@ -173,7 +125,7 @@ func paramsForRoute(route spec.Route, prefixForType func(string) string) string
func commentForRoute(route spec.Route) string {
var builder strings.Builder
comment, _ := apiutil.GetAnnotationValue(route.Annotations, "doc", "summary")
comment := route.JoinedDoc()
builder.WriteString("/**")
builder.WriteString("\n * @description " + comment)
hasParams := pathHasParams(route)
@@ -200,24 +152,35 @@ func callParamsForRoute(route spec.Route, group spec.Group) string {
} else if hasBody {
return fmt.Sprintf("%s, %s", pathForRoute(route, group), "req")
}
return pathForRoute(route, group)
}
func pathForRoute(route spec.Route, group spec.Group) string {
value, ok := apiutil.GetAnnotationValue(group.Annotations, "server", pathPrefix)
if !ok {
prefix := group.GetAnnotation("pathPrefix")
if len(prefix) == 0 {
return "\"" + route.Path + "\""
} else {
value = strings.TrimPrefix(value, `"`)
value = strings.TrimSuffix(value, `"`)
return fmt.Sprintf(`"%s/%s"`, value, strings.TrimPrefix(route.Path, "/"))
prefix = strings.TrimPrefix(prefix, `"`)
prefix = strings.TrimSuffix(prefix, `"`)
return fmt.Sprintf(`"%s/%s"`, prefix, strings.TrimPrefix(route.Path, "/"))
}
}
func pathHasParams(route spec.Route) bool {
return len(route.RequestType.Members) != len(route.RequestType.GetBodyMembers())
ds, ok := route.RequestType.(spec.DefineStruct)
if !ok {
return false
}
return len(ds.Members) != len(ds.GetBodyMembers())
}
func hasRequestBody(route spec.Route) bool {
return len(route.RequestType.Name) > 0 && len(route.RequestType.GetBodyMembers()) > 0
ds, ok := route.RequestType.(spec.DefineStruct)
if !ok {
return false
}
return len(route.RequestTypeName()) > 0 && len(ds.GetBodyMembers()) > 0
}