Documentation
¶
Index ¶
- func Category() string
- func Clean() error
- func GenTemplates() error
- func ProtoTmpl(out string) error
- func RevertTemplate(name string) error
- func Update() error
- type Dir
- type DirContext
- type Generator
- func (g *Generator) GenCall(ctx DirContext, proto parser.Proto, cfg *conf.Config) error
- func (g *Generator) GenConfig(ctx DirContext, _ parser.Proto, cfg *conf.Config) error
- func (g *Generator) GenEtc(ctx DirContext, _ parser.Proto, cfg *conf.Config) error
- func (g *Generator) GenLogic(ctx DirContext, proto parser.Proto, cfg *conf.Config) error
- func (g *Generator) GenMain(ctx DirContext, proto parser.Proto, cfg *conf.Config) error
- func (g *Generator) GenPb(ctx DirContext, c *ZRpcContext) error
- func (g *Generator) GenServer(ctx DirContext, proto parser.Proto, cfg *conf.Config) error
- func (g *Generator) GenSvc(ctx DirContext, _ parser.Proto, cfg *conf.Config) error
- func (g *Generator) Generate(zctx *ZRpcContext) error
- func (g *Generator) Prepare() error
- type ZRpcContext
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Category ¶
func Category() string
Category returns a const string value for rpc template category
func GenTemplates ¶
func GenTemplates() error
GenTemplates is the entry for command goctl template, it will create the specified category
func RevertTemplate ¶
RevertTemplate restores the deleted template files
Types ¶
type DirContext ¶
type DirContext interface {
GetCall() Dir
GetEtc() Dir
GetInternal() Dir
GetConfig() Dir
GetLogic() Dir
GetServer() Dir
GetSvc() Dir
GetPb() Dir
GetProtoGo() Dir
GetMain() Dir
GetServiceName() stringx.String
SetPbDir(pbDir, grpcDir string)
}
DirContext defines a rpc service directories context
type Generator ¶
type Generator struct {
// contains filtered or unexported fields
}
Generator defines the environment needs of rpc service generation
func NewGenerator ¶
NewGenerator returns an instance of Generator
func (*Generator) GenCall ¶
GenCall generates the rpc client code, which is the entry point for the rpc service call. It is a layer of encapsulation for the rpc client and shields the details in the pb.
func (*Generator) GenConfig ¶
GenConfig generates the configuration structure definition file of the rpc service, which contains the zrpc.RpcServerConf configuration item by default. You can specify the naming style of the target file name through config.Config. For details, see https://github.com/xiaoshouchen/go-zero/tree/master/tools/goctl/config/config.go
func (*Generator) GenEtc ¶
GenEtc generates the yaml configuration file of the rpc service, including host, port monitoring configuration items and etcd configuration
func (*Generator) GenLogic ¶
GenLogic generates the logic file of the rpc service, which corresponds to the RPC definition items in proto.
func (*Generator) GenMain ¶
GenMain generates the main file of the rpc service, which is an rpc service program call entry
func (*Generator) GenPb ¶
func (g *Generator) GenPb(ctx DirContext, c *ZRpcContext) error
GenPb generates the pb.go file, which is a layer of packaging for protoc to generate gprc, but the commands and flags in protoc are not completely joined in goctl. At present, proto_path(-I) is introduced
func (*Generator) GenServer ¶
GenServer generates rpc server file, which is an implementation of rpc server
func (*Generator) GenSvc ¶
GenSvc generates the servicecontext.go file, which is the resource dependency of a service, such as rpc dependency, model dependency, etc.
func (*Generator) Generate ¶
func (g *Generator) Generate(zctx *ZRpcContext) error
Generate generates an rpc service, through the proto file, code storage directory, and proto import parameters to control the source file and target location of the rpc service that needs to be generated
Source Files