add test (#95)

* rebase upstream

* rebase

* trim no need line

* trim no need line

* trim no need line

* update doc

* remove update

* remove no need

* remove no need

* goctl add jwt support

* goctl add jwt support

* goctl add jwt support

* goctl support import

* goctl support import

Co-authored-by: kingxt <dream4kingxt@163.com>

core/bloom/bloom.go

@@ -13,15 +13,13 @@ const (
 	// maps as k in the error rate table
 	maps      = 14
 	setScript = `
-local key = KEYS[1]
 for _, offset in ipairs(ARGV) do
-	redis.call("setbit", key, offset, 1)
+	redis.call("setbit", KEYS[1], offset, 1)
 end
 `
 	testScript = `
-local key = KEYS[1]
 for _, offset in ipairs(ARGV) do
-	if tonumber(redis.call("getbit", key, offset)) == 0 then
+	if tonumber(redis.call("getbit", KEYS[1], offset)) == 0 then
 		return false
 	end
 end

core/errorx/atomicerror.go

@@ -1,21 +1,18 @@
 package errorx
 
-import "sync"
+import "sync/atomic"
 
 type AtomicError struct {
-	err  error
-	lock sync.Mutex
+	err atomic.Value // error
 }
 
 func (ae *AtomicError) Set(err error) {
-	ae.lock.Lock()
-	ae.err = err
-	ae.lock.Unlock()
+	ae.err.Store(err)
 }
 
 func (ae *AtomicError) Load() error {
-	ae.lock.Lock()
-	err := ae.err
-	ae.lock.Unlock()
-	return err
+	if v := ae.err.Load(); v != nil {
+		return v.(error)
+	}
+	return nil
 }

core/errorx/atomicerror_test.go

@@ -2,6 +2,8 @@ package errorx
 
 import (
 	"errors"
+	"sync"
+	"sync/atomic"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
@@ -19,3 +21,53 @@ func TestAtomicErrorNil(t *testing.T) {
 	var err AtomicError
 	assert.Nil(t, err.Load())
 }
+
+func BenchmarkAtomicError(b *testing.B) {
+	var aerr AtomicError
+	wg := sync.WaitGroup{}
+
+	b.Run("Load", func(b *testing.B) {
+		var done uint32
+		go func() {
+			for {
+				if atomic.LoadUint32(&done) != 0 {
+					break
+				}
+				wg.Add(1)
+				go func() {
+					aerr.Set(errDummy)
+					wg.Done()
+				}()
+			}
+		}()
+		b.ResetTimer()
+		for i := 0; i < b.N; i++ {
+			_ = aerr.Load()
+		}
+		b.StopTimer()
+		atomic.StoreUint32(&done, 1)
+		wg.Wait()
+	})
+	b.Run("Set", func(b *testing.B) {
+		var done uint32
+		go func() {
+			for {
+				if atomic.LoadUint32(&done) != 0 {
+					break
+				}
+				wg.Add(1)
+				go func() {
+					_ = aerr.Load()
+					wg.Done()
+				}()
+			}
+		}()
+		b.ResetTimer()
+		for i := 0; i < b.N; i++ {
+			aerr.Set(errDummy)
+		}
+		b.StopTimer()
+		atomic.StoreUint32(&done, 1)
+		wg.Wait()
+	})
+}

core/logx/durationlogger.go

@@ -8,55 +8,60 @@ import (
 	"github.com/tal-tech/go-zero/core/timex"
 )
 
-const customCallerDepth = 3
+const durationCallerDepth = 3
 
-type customLog logEntry
+type durationLogger logEntry
 
 func WithDuration(d time.Duration) Logger {
-	return customLog{
+	return &durationLogger{
 		Duration: timex.ReprOfDuration(d),
 	}
 }
 
-func (l customLog) Error(v ...interface{}) {
+func (l *durationLogger) Error(v ...interface{}) {
 	if shouldLog(ErrorLevel) {
-		l.write(errorLog, levelError, formatWithCaller(fmt.Sprint(v...), customCallerDepth))
+		l.write(errorLog, levelError, formatWithCaller(fmt.Sprint(v...), durationCallerDepth))
 	}
 }
 
-func (l customLog) Errorf(format string, v ...interface{}) {
+func (l *durationLogger) Errorf(format string, v ...interface{}) {
 	if shouldLog(ErrorLevel) {
-		l.write(errorLog, levelError, formatWithCaller(fmt.Sprintf(format, v...), customCallerDepth))
+		l.write(errorLog, levelError, formatWithCaller(fmt.Sprintf(format, v...), durationCallerDepth))
 	}
 }
 
-func (l customLog) Info(v ...interface{}) {
+func (l *durationLogger) Info(v ...interface{}) {
 	if shouldLog(InfoLevel) {
 		l.write(infoLog, levelInfo, fmt.Sprint(v...))
 	}
 }
 
-func (l customLog) Infof(format string, v ...interface{}) {
+func (l *durationLogger) Infof(format string, v ...interface{}) {
 	if shouldLog(InfoLevel) {
 		l.write(infoLog, levelInfo, fmt.Sprintf(format, v...))
 	}
 }
 
-func (l customLog) Slow(v ...interface{}) {
+func (l *durationLogger) Slow(v ...interface{}) {
 	if shouldLog(ErrorLevel) {
 		l.write(slowLog, levelSlow, fmt.Sprint(v...))
 	}
 }
 
-func (l customLog) Slowf(format string, v ...interface{}) {
+func (l *durationLogger) Slowf(format string, v ...interface{}) {
 	if shouldLog(ErrorLevel) {
 		l.write(slowLog, levelSlow, fmt.Sprintf(format, v...))
 	}
 }
 
-func (l customLog) write(writer io.Writer, level, content string) {
+func (l *durationLogger) WithDuration(duration time.Duration) Logger {
+	l.Duration = timex.ReprOfDuration(duration)
+	return l
+}
+
+func (l *durationLogger) write(writer io.Writer, level, content string) {
 	l.Timestamp = getTimestamp()
 	l.Level = level
 	l.Content = content
-	outputJson(writer, logEntry(l))
+	outputJson(writer, logEntry(*l))
 }

core/logx/durationlogger_test.go

@@ -0,0 +1,52 @@
+package logx
+
+import (
+	"log"
+	"strings"
+	"testing"
+	"time"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestWithDurationError(t *testing.T) {
+	var builder strings.Builder
+	log.SetOutput(&builder)
+	WithDuration(time.Second).Error("foo")
+	assert.True(t, strings.Contains(builder.String(), "duration"), builder.String())
+}
+
+func TestWithDurationErrorf(t *testing.T) {
+	var builder strings.Builder
+	log.SetOutput(&builder)
+	WithDuration(time.Second).Errorf("foo")
+	assert.True(t, strings.Contains(builder.String(), "duration"), builder.String())
+}
+
+func TestWithDurationInfo(t *testing.T) {
+	var builder strings.Builder
+	log.SetOutput(&builder)
+	WithDuration(time.Second).Info("foo")
+	assert.True(t, strings.Contains(builder.String(), "duration"), builder.String())
+}
+
+func TestWithDurationInfof(t *testing.T) {
+	var builder strings.Builder
+	log.SetOutput(&builder)
+	WithDuration(time.Second).Infof("foo")
+	assert.True(t, strings.Contains(builder.String(), "duration"), builder.String())
+}
+
+func TestWithDurationSlow(t *testing.T) {
+	var builder strings.Builder
+	log.SetOutput(&builder)
+	WithDuration(time.Second).Slow("foo")
+	assert.True(t, strings.Contains(builder.String(), "duration"), builder.String())
+}
+
+func TestWithDurationSlowf(t *testing.T) {
+	var builder strings.Builder
+	log.SetOutput(&builder)
+	WithDuration(time.Second).WithDuration(time.Hour).Slowf("foo")
+	assert.True(t, strings.Contains(builder.String(), "duration"), builder.String())
+}

core/logx/logs.go

@@ -15,6 +15,7 @@ import (
 	"strings"
 	"sync"
 	"sync/atomic"
+	"time"
 
 	"github.com/tal-tech/go-zero/core/iox"
 	"github.com/tal-tech/go-zero/core/sysx"
@@ -96,6 +97,7 @@ type (
 		Infof(string, ...interface{})
 		Slow(...interface{})
 		Slowf(string, ...interface{})
+		WithDuration(time.Duration) Logger
 	}
 )
 

core/logx/tracelogger.go

@@ -4,54 +4,61 @@ import (
 	"context"
 	"fmt"
 	"io"
+	"time"
 
+	"github.com/tal-tech/go-zero/core/timex"
 	"github.com/tal-tech/go-zero/core/trace/tracespec"
 )
 
-type tracingEntry struct {
+type traceLogger struct {
 	logEntry
-	Trace string          `json:"trace,omitempty"`
-	Span  string          `json:"span,omitempty"`
-	ctx   context.Context `json:"-"`
+	Trace string `json:"trace,omitempty"`
+	Span  string `json:"span,omitempty"`
+	ctx   context.Context
 }
 
-func (l tracingEntry) Error(v ...interface{}) {
+func (l *traceLogger) Error(v ...interface{}) {
 	if shouldLog(ErrorLevel) {
-		l.write(errorLog, levelError, formatWithCaller(fmt.Sprint(v...), customCallerDepth))
+		l.write(errorLog, levelError, formatWithCaller(fmt.Sprint(v...), durationCallerDepth))
 	}
 }
 
-func (l tracingEntry) Errorf(format string, v ...interface{}) {
+func (l *traceLogger) Errorf(format string, v ...interface{}) {
 	if shouldLog(ErrorLevel) {
-		l.write(errorLog, levelError, formatWithCaller(fmt.Sprintf(format, v...), customCallerDepth))
+		l.write(errorLog, levelError, formatWithCaller(fmt.Sprintf(format, v...), durationCallerDepth))
 	}
 }
 
-func (l tracingEntry) Info(v ...interface{}) {
+func (l *traceLogger) Info(v ...interface{}) {
 	if shouldLog(InfoLevel) {
 		l.write(infoLog, levelInfo, fmt.Sprint(v...))
 	}
 }
 
-func (l tracingEntry) Infof(format string, v ...interface{}) {
+func (l *traceLogger) Infof(format string, v ...interface{}) {
 	if shouldLog(InfoLevel) {
 		l.write(infoLog, levelInfo, fmt.Sprintf(format, v...))
 	}
 }
 
-func (l tracingEntry) Slow(v ...interface{}) {
+func (l *traceLogger) Slow(v ...interface{}) {
 	if shouldLog(ErrorLevel) {
 		l.write(slowLog, levelSlow, fmt.Sprint(v...))
 	}
 }
 
-func (l tracingEntry) Slowf(format string, v ...interface{}) {
+func (l *traceLogger) Slowf(format string, v ...interface{}) {
 	if shouldLog(ErrorLevel) {
 		l.write(slowLog, levelSlow, fmt.Sprintf(format, v...))
 	}
 }
 
-func (l tracingEntry) write(writer io.Writer, level, content string) {
+func (l *traceLogger) WithDuration(duration time.Duration) Logger {
+	l.Duration = timex.ReprOfDuration(duration)
+	return l
+}
+
+func (l *traceLogger) write(writer io.Writer, level, content string) {
 	l.Timestamp = getTimestamp()
 	l.Level = level
 	l.Content = content
@@ -61,7 +68,7 @@ func (l tracingEntry) write(writer io.Writer, level, content string) {
 }
 
 func WithContext(ctx context.Context) Logger {
-	return tracingEntry{
+	return &traceLogger{
 		ctx: ctx,
 	}
 }

core/logx/tracelogger_test.go

@@ -19,7 +19,7 @@ var mock tracespec.Trace = new(mockTrace)
 func TestTraceLog(t *testing.T) {
 	var buf strings.Builder
 	ctx := context.WithValue(context.Background(), tracespec.TracingKey, mock)
-	WithContext(ctx).(tracingEntry).write(&buf, levelInfo, testlog)
+	WithContext(ctx).(*traceLogger).write(&buf, levelInfo, testlog)
 	assert.True(t, strings.Contains(buf.String(), mockTraceId))
 	assert.True(t, strings.Contains(buf.String(), mockSpanId))
 }

core/mapping/unmarshaler.go

@@ -345,7 +345,7 @@ func (u *Unmarshaler) processNamedFieldWithValue(field reflect.StructField, valu
 			options := opts.options()
 			if len(options) > 0 {
 				if !stringx.Contains(options, mapValue.(string)) {
-					return fmt.Errorf(`error: value "%s" for field "%s" is not defined in opts "%v"`,
+					return fmt.Errorf(`error: value "%s" for field "%s" is not defined in options "%v"`,
 						mapValue, key, options)
 				}
 			}

core/syncx/sharedcalls_test.go

@@ -68,6 +68,38 @@ func TestExclusiveCallDoDupSuppress(t *testing.T) {
 	}
 }
 
+func TestExclusiveCallDoDiffDupSuppress(t *testing.T) {
+	g := NewSharedCalls()
+	broadcast := make(chan struct{})
+	var calls int32
+	tests := []string{"e", "a", "e", "a", "b", "c", "b", "a", "c", "d", "b", "c", "d"}
+
+	var wg sync.WaitGroup
+	for _, key := range tests {
+		wg.Add(1)
+		go func(k string) {
+			<-broadcast // get all goroutines ready
+			_, err := g.Do(k, func() (interface{}, error) {
+				atomic.AddInt32(&calls, 1)
+				time.Sleep(10 * time.Millisecond)
+				return nil, nil
+			})
+			if err != nil {
+				t.Errorf("Do error: %v", err)
+			}
+			wg.Done()
+		}(key)
+	}
+
+	time.Sleep(100 * time.Millisecond) // let goroutines above block
+	close(broadcast)
+	wg.Wait()
+
+	if got := atomic.LoadInt32(&calls); got != 5 {	// five letters
+		t.Errorf("number of calls = %d; want 5", got)
+	}
+}
+
 func TestExclusiveCallDoExDupSuppress(t *testing.T) {
 	g := NewSharedCalls()
 	c := make(chan string)

core/trace/tracespec/keys.go

@@ -0,0 +1,12 @@
+package tracespec
+
+// TracingKey is tracing key for context
+var TracingKey = contextKey("X-Trace")
+
+// contextKey a type for context key
+type contextKey string
+
+// Printing a context will reveal a fair amount of information about it.
+func (c contextKey) String() string {
+	return "trace/tracespec context key " + string(c)
+}

core/trace/tracespec/vars.go

@@ -1,3 +0,0 @@
-package tracespec
-
-const TracingKey = "X-Trace"

doc/bookstore-en.md

@@ -57,6 +57,12 @@ And now, let’s walk through the complete flow of quickly create a microservice
 
 * install etcd, mysql, redis
 
+* install protoc-gen-go
+
+  ```shell
+  go get -u github.com/golang/protobuf/protoc-gen-go
+  ```
+
 * install goctl
 
   ```shell
@@ -347,8 +353,8 @@ you can change the listening port in file `etc/add.yaml`.
   ```go
   type Config struct {
       rest.RestConf
-      Add   rpcx.RpcClientConf     // manual code
-      Check rpcx.RpcClientConf     // manual code
+      Add   zrpc.RpcClientConf     // manual code
+      Check zrpc.RpcClientConf     // manual code
   }
   ```
 
@@ -364,8 +370,8 @@ you can change the listening port in file `etc/add.yaml`.
   func NewServiceContext(c config.Config) *ServiceContext {
       return &ServiceContext{
           Config:  c,
-          Adder:   adder.NewAdder(rpcx.MustNewClient(c.Add)),         // manual code
-          Checker: checker.NewChecker(rpcx.MustNewClient(c.Check)),   // manual code
+          Adder:   adder.NewAdder(zrpc.MustNewClient(c.Add)),         // manual code
+          Checker: checker.NewChecker(zrpc.MustNewClient(c.Check)),   // manual code
       }
   }
   ```
@@ -477,7 +483,7 @@ Till now, we’ve done the modification of API Gateway. All the manually added c
 
   ```go
   type Config struct {
-      rpcx.RpcServerConf
+      zrpc.RpcServerConf
       DataSource string             // manual code
       Table      string             // manual code
       Cache      cache.CacheConf    // manual code

doc/bookstore.md

@@ -57,6 +57,12 @@
 
 * 安装etcd, mysql, redis
 
+* 安装`protoc-gen-go`
+
+  ```shell
+  go get -u github.com/golang/protobuf/protoc-gen-go
+  ```
+
 * 安装goctl工具
 
   ```shell
@@ -349,8 +355,8 @@
   ```go
   type Config struct {
       rest.RestConf
-      Add   rpcx.RpcClientConf     // 手动代码
-      Check rpcx.RpcClientConf     // 手动代码
+      Add   zrpc.RpcClientConf     // 手动代码
+      Check zrpc.RpcClientConf     // 手动代码
   }
   ```
 
@@ -366,8 +372,8 @@
   func NewServiceContext(c config.Config) *ServiceContext {
       return &ServiceContext{
           Config:  c,
-          Adder:   adder.NewAdder(rpcx.MustNewClient(c.Add)),         // 手动代码
-          Checker: checker.NewChecker(rpcx.MustNewClient(c.Check)),   // 手动代码
+          Adder:   adder.NewAdder(zrpc.MustNewClient(c.Add)),         // 手动代码
+          Checker: checker.NewChecker(zrpc.MustNewClient(c.Check)),   // 手动代码
       }
   }
   ```
@@ -477,7 +483,7 @@
 
   ```go
   type Config struct {
-      rpcx.RpcServerConf
+      zrpc.RpcServerConf
       DataSource string             // 手动代码
       Table      string             // 手动代码
       Cache      cache.CacheConf    // 手动代码

doc/goctl-rpc.md

@@ -221,11 +221,11 @@ OPTIONS:
     *rrBalanced does not implement Picker (wrong type for Pick method)
 		have Pick(context.Context, balancer.PickInfo) (balancer.SubConn, func(balancer.DoneInfo), error)
     want Pick(balancer.PickInfo) (balancer.PickResult, error)
-    #github.com/tal-tech/go-zero/rpcx/internal/balancer/p2c
-    ../../../go/pkg/mod/github.com/tal-tech/go-zero@v1.0.12/rpcx/internal/balancer/p2c/p2c.go:41:32: not enough arguments in call to base.NewBalancerBuilder
+    #github.com/tal-tech/go-zero/zrpc/internal/balancer/p2c
+    ../../../go/pkg/mod/github.com/tal-tech/go-zero@v1.0.12/zrpc/internal/balancer/p2c/p2c.go:41:32: not enough arguments in call to base.NewBalancerBuilder
 	have (string, *p2cPickerBuilder)
   want (string, base.PickerBuilder, base.Config)
-  ../../../go/pkg/mod/github.com/tal-tech/go-zero@v1.0.12/rpcx/internal/balancer/p2c/p2c.go:58:9: cannot use &p2cPicker literal (type *p2cPicker) as type balancer.Picker in return argument:
+  ../../../go/pkg/mod/github.com/tal-tech/go-zero@v1.0.12/zrpc/internal/balancer/p2c/p2c.go:58:9: cannot use &p2cPicker literal (type *p2cPicker) as type balancer.Picker in return argument:
 	*p2cPicker does not implement balancer.Picker (wrong type for Pick method)
 		have Pick(context.Context, balancer.PickInfo) (balancer.SubConn, func(balancer.DoneInfo), error)
 		want Pick(balancer.PickInfo) (balancer.PickResult, error)

doc/jwt.md

@@ -0,0 +1,140 @@
+# 基于go-zero实现JWT认证
+
+关于JWT是什么，大家可以看看[官网](https://jwt.io/)，一句话介绍下：是可以实现服务器无状态的鉴权认证方案，也是目前最流行的跨域认证解决方案。
+
+要实现JWT认证，我们需要分成如下两个步骤
+
+* 客户端获取JWT token。
+* 服务器对客户端带来的JWT token认证。
+
+## 1.  客户端获取JWT Token
+
+我们定义一个协议供客户端调用获取JWT token，我们新建一个目录jwt然后在目录中执行 `goctl api -o jwt.api`，将生成的jwt.api改成如下：
+
+````go
+type JwtTokenRequest struct {
+}
+
+type JwtTokenResponse struct {
+  AccessToken  string `json:"access_token"`
+  AccessExpire int64  `json:"access_expire"`
+  RefreshAfter int64  `json:"refresh_after"` // 建议客户端刷新token的绝对时间
+}
+
+type GetUserRequest struct { 
+  UserId string `json:"userId"`
+}
+
+type GetUserResponse struct {
+  Name string `json:"name"`
+}
+
+service jwt-api {
+  @server(
+    handler: JwtHandler
+  )
+  post /user/token(JwtTokenRequest) returns (JwtTokenResponse)
+}
+
+@server(
+  jwt: JwtAuth
+)
+service jwt-api {
+  @server(
+    handler: GetUserHandler
+  )
+  post /user/info(GetUserRequest) returns (GetUserResponse)
+}
+````
+
+在服务jwt目录中执行：`goctl api go -api jwt.api -dir .`
+打开jwtlogic.go文件，修改 `func (l *JwtLogic) Jwt(req types.JwtTokenRequest) (*types.JwtTokenResponse, error) {` 方法如下：
+
+```go
+
+func (l *JwtLogic) Jwt(req types.JwtTokenRequest) (*types.JwtTokenResponse, error) {
+	var accessExpire = l.svcCtx.Config.JwtAuth.AccessExpire
+
+	now := time.Now().Unix()
+	accessToken, err := l.GenToken(now, l.svcCtx.Config.JwtAuth.AccessSecret, nil, accessExpire)
+	if err != nil {
+		return nil, err
+	}
+
+	return &types.JwtTokenResponse{
+    AccessToken:  accessToken,
+    AccessExpire: now + accessExpire,
+    RefreshAfter: now + accessExpire/2,
+  }, nil
+}
+
+func (l *JwtLogic) GenToken(iat int64, secretKey string, payloads map[string]interface{}, seconds int64) (string, error) {
+	claims := make(jwt.MapClaims)
+	claims["exp"] = iat + seconds
+	claims["iat"] = iat
+	for k, v := range payloads {
+		claims[k] = v
+	}
+
+	token := jwt.New(jwt.SigningMethodHS256)
+	token.Claims = claims
+
+	return token.SignedString([]byte(secretKey))
+}
+```
+
+在启动服务之前，我们需要修改etc/jwt-api.yaml文件如下：
+```yaml
+Name: jwt-api
+Host: 0.0.0.0
+Port: 8888
+JwtAuth:
+  AccessSecret: xxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+  AccessExpire: 604800
+```
+启动服务器，然后测试下获取到的token。
+
+```sh
+➜ curl --location --request POST '127.0.0.1:8888/user/token'
+{"access_token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2MDEyNjE0MjksImlhdCI6MTYwMDY1NjYyOX0.6u_hpE_4m5gcI90taJLZtvfekwUmjrbNJ-5saaDGeQc","access_expire":1601261429,"refresh_after":1600959029}
+```
+
+## 2. 服务器验证JWT token
+
+1. 在api文件中通过`jwt: JwtAuth`标记的service表示激活了jwt认证。
+2. 可以阅读rest/handler/authhandler.go文件了解服务器jwt实现。
+3. 修改getuserlogic.go如下：
+
+```go
+func (l *GetUserLogic) GetUser(req types.GetUserRequest) (*types.GetUserResponse, error) {
+	return &types.GetUserResponse{Name: "kim"}, nil
+}
+```
+
+* 我们先不带JWT Authorization header请求头测试下，返回http status code是401，符合预期。
+
+```sh
+➜ curl -w  "\nhttp: %{http_code} \n" --location --request POST '127.0.0.1:8888/user/info' \
+--header 'Content-Type: application/json' \
+--data-raw '{
+    "userId": "a"
+}'
+
+http: 401
+```
+
+* 加上Authorization header请求头测试。
+
+```sh
+➜ curl -w  "\nhttp: %{http_code} \n" --location --request POST '127.0.0.1:8888/user/info' \
+--header 'Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2MDEyNjE0MjksImlhdCI6MTYwMDY1NjYyOX0.6u_hpE_4m5gcI90taJLZtvfekwUmjrbNJ-5saaDGeQc' \
+--header 'Content-Type: application/json' \
+--data-raw '{
+    "userId": "a"
+}'
+{"name":"kim"}
+http: 200
+```
+
+综上所述：基于go-zero的JWT认证完成，在真实生产环境部署时候，AccessSecret, AccessExpire, RefreshAfter根据业务场景通过配置文件配置，RefreshAfter 是告诉客户端什么时候该刷新JWT token了，一般都需要设置过期时间前几天。
+

doc/shorturl-en.md

@@ -60,6 +60,12 @@ And now, let’s walk through the complete flow of quickly create a microservice
 
 * install etcd, mysql, redis
 
+* install protoc-gen-go
+
+  ```
+  go get -u github.com/golang/protobuf/protoc-gen-go
+  ```
+
 * install goctl
 
   ```shell
@@ -284,7 +290,7 @@ And now, let’s walk through the complete flow of quickly create a microservice
   ```go
   type Config struct {
   	rest.RestConf
-  	Transform rpcx.RpcClientConf     // manual code
+  	Transform zrpc.RpcClientConf     // manual code
   }
   ```
 
@@ -299,7 +305,7 @@ And now, let’s walk through the complete flow of quickly create a microservice
   func NewServiceContext(c config.Config) *ServiceContext {
   	return &ServiceContext{
   		Config:    c,
-      Transformer: transformer.NewTransformer(rpcx.MustNewClient(c.Transform)), // manual code
+      Transformer: transformer.NewTransformer(zrpc.MustNewClient(c.Transform)), // manual code
   	}
   }
   ```
@@ -409,7 +415,7 @@ Till now, we’ve done the modification of API Gateway. All the manually added c
 
   ```go
   type Config struct {
-  	rpcx.RpcServerConf
+  	zrpc.RpcServerConf
   	DataSource string             // manual code
   	Table      string             // manual code
   	Cache      cache.CacheConf    // manual code

doc/shorturl.md

@@ -60,6 +60,12 @@
 
 * 安装etcd, mysql, redis
 
+* 安装`protoc-gen-go`
+
+  ```shell
+  go get -u github.com/golang/protobuf/protoc-gen-go
+  ```
+
 * 安装goctl工具
 
   ```shell
@@ -280,7 +286,7 @@
   ```go
   type Config struct {
   	rest.RestConf
-  	Transform rpcx.RpcClientConf     // 手动代码
+  	Transform zrpc.RpcClientConf     // 手动代码
   }
   ```
 
@@ -295,7 +301,7 @@
   func NewServiceContext(c config.Config) *ServiceContext {
   	return &ServiceContext{
   		Config:    c,
-      Transformer: transformer.NewTransformer(rpcx.MustNewClient(c.Transform)),  // 手动代码
+      Transformer: transformer.NewTransformer(zrpc.MustNewClient(c.Transform)),  // 手动代码
   	}
   }
   ```
@@ -405,7 +411,7 @@
 
   ```go
   type Config struct {
-  	rpcx.RpcServerConf
+  	zrpc.RpcServerConf
   	DataSource string             // 手动代码
   	Table      string             // 手动代码
   	Cache      cache.CacheConf    // 手动代码

example/bookstore/api/internal/config/config.go

@@ -2,11 +2,11 @@ package config
 
 import (
 	"github.com/tal-tech/go-zero/rest"
-	"github.com/tal-tech/go-zero/rpcx"
+	"github.com/tal-tech/go-zero/zrpc"
 )
 
 type Config struct {
 	rest.RestConf
-	Add   rpcx.RpcClientConf
-	Check rpcx.RpcClientConf
-}
+	Add   zrpc.RpcClientConf
+	Check zrpc.RpcClientConf
+}

example/bookstore/api/internal/handler/routes.go

@@ -1,4 +1,4 @@
-// DO NOT EDIT, generated by goctl
+// Code generated by goctl. DO NOT EDIT.
 package handler
 
 import (

example/bookstore/api/internal/svc/servicecontext.go

@@ -5,7 +5,7 @@ import (
 	"bookstore/rpc/add/adder"
 	"bookstore/rpc/check/checker"
 
-	"github.com/tal-tech/go-zero/rpcx"
+	"github.com/tal-tech/go-zero/zrpc"
 )
 
 type ServiceContext struct {
@@ -17,7 +17,7 @@ type ServiceContext struct {
 func NewServiceContext(c config.Config) *ServiceContext {
 	return &ServiceContext{
 		Config:  c,
-		Adder:   adder.NewAdder(rpcx.MustNewClient(c.Add)),
-		Checker: checker.NewChecker(rpcx.MustNewClient(c.Check)),
+		Adder:   adder.NewAdder(zrpc.MustNewClient(c.Add)),
+		Checker: checker.NewChecker(zrpc.MustNewClient(c.Check)),
 	}
-}
+}

example/bookstore/api/internal/types/types.go

@@ -1,4 +1,4 @@
-// DO NOT EDIT, generated by goctl
+// Code generated by goctl. DO NOT EDIT.
 package types
 
 type AddReq struct {

example/bookstore/rpc/add/add.go

@@ -14,7 +14,7 @@ import (
 
 	"github.com/tal-tech/go-zero/core/conf"
 	"github.com/tal-tech/go-zero/core/logx"
-	"github.com/tal-tech/go-zero/rpcx"
+	"github.com/tal-tech/go-zero/zrpc"
 	"google.golang.org/grpc"
 )
 
@@ -28,7 +28,7 @@ func main() {
 	ctx := svc.NewServiceContext(c)
 	adderSrv := server.NewAdderServer(ctx)
 
-	s, err := rpcx.NewServer(c.RpcServerConf, func(grpcServer *grpc.Server) {
+	s, err := zrpc.NewServer(c.RpcServerConf, func(grpcServer *grpc.Server) {
 		add.RegisterAdderServer(grpcServer, adderSrv)
 	})
 	logx.Must(err)

example/bookstore/rpc/add/adder/adder.go

@@ -10,7 +10,7 @@ import (
 	"context"
 
 	"github.com/tal-tech/go-zero/core/jsonx"
-	"github.com/tal-tech/go-zero/rpcx"
+	"github.com/tal-tech/go-zero/zrpc"
 )
 
 type (
@@ -19,11 +19,11 @@ type (
 	}
 
 	defaultAdder struct {
-		cli rpcx.Client
+		cli zrpc.Client
 	}
 )
 
-func NewAdder(cli rpcx.Client) Adder {
+func NewAdder(cli zrpc.Client) Adder {
 	return &defaultAdder{
 		cli: cli,
 	}

example/bookstore/rpc/add/internal/config/config.go

@@ -2,12 +2,12 @@ package config
 
 import (
 	"github.com/tal-tech/go-zero/core/stores/cache"
-	"github.com/tal-tech/go-zero/rpcx"
+	"github.com/tal-tech/go-zero/zrpc"
 )
 
 type Config struct {
-	rpcx.RpcServerConf
+	zrpc.RpcServerConf
 	DataSource string
 	Table      string
 	Cache      cache.CacheConf
-}
+}

example/bookstore/rpc/check/check.go

@@ -14,7 +14,7 @@ import (
 
 	"github.com/tal-tech/go-zero/core/conf"
 	"github.com/tal-tech/go-zero/core/logx"
-	"github.com/tal-tech/go-zero/rpcx"
+	"github.com/tal-tech/go-zero/zrpc"
 	"google.golang.org/grpc"
 )
 
@@ -28,7 +28,7 @@ func main() {
 	ctx := svc.NewServiceContext(c)
 	checkerSrv := server.NewCheckerServer(ctx)
 
-	s, err := rpcx.NewServer(c.RpcServerConf, func(grpcServer *grpc.Server) {
+	s, err := zrpc.NewServer(c.RpcServerConf, func(grpcServer *grpc.Server) {
 		check.RegisterCheckerServer(grpcServer, checkerSrv)
 	})
 	logx.Must(err)

example/bookstore/rpc/check/checker/checker.go

@@ -10,7 +10,7 @@ import (
 	"context"
 
 	"github.com/tal-tech/go-zero/core/jsonx"
-	"github.com/tal-tech/go-zero/rpcx"
+	"github.com/tal-tech/go-zero/zrpc"
 )
 
 type (
@@ -19,11 +19,11 @@ type (
 	}
 
 	defaultChecker struct {
-		cli rpcx.Client
+		cli zrpc.Client
 	}
 )
 
-func NewChecker(cli rpcx.Client) Checker {
+func NewChecker(cli zrpc.Client) Checker {
 	return &defaultChecker{
 		cli: cli,
 	}

example/bookstore/rpc/check/internal/config/config.go

@@ -2,12 +2,12 @@ package config
 
 import (
 	"github.com/tal-tech/go-zero/core/stores/cache"
-	"github.com/tal-tech/go-zero/rpcx"
+	"github.com/tal-tech/go-zero/zrpc"
 )
 
 type Config struct {
-	rpcx.RpcServerConf
+	zrpc.RpcServerConf
 	DataSource string
 	Table      string
 	Cache      cache.CacheConf
-}
+}

example/graceful/dns/api/config/config.go

@@ -2,10 +2,10 @@ package config
 
 import (
 	"github.com/tal-tech/go-zero/rest"
-	"github.com/tal-tech/go-zero/rpcx"
+	"github.com/tal-tech/go-zero/zrpc"
 )
 
 type Config struct {
 	rest.RestConf
-	Rpc rpcx.RpcClientConf
+	Rpc zrpc.RpcClientConf
 }

example/graceful/dns/api/graceful.go

@@ -8,7 +8,7 @@ import (
 	"github.com/tal-tech/go-zero/example/graceful/dns/api/handler"
 	"github.com/tal-tech/go-zero/example/graceful/dns/api/svc"
 	"github.com/tal-tech/go-zero/rest"
-	"github.com/tal-tech/go-zero/rpcx"
+	"github.com/tal-tech/go-zero/zrpc"
 )
 
 var configFile = flag.String("f", "etc/graceful-api.json", "the config file")
@@ -19,7 +19,7 @@ func main() {
 	var c config.Config
 	conf.MustLoad(*configFile, &c)
 
-	client := rpcx.MustNewClient(c.Rpc)
+	client := zrpc.MustNewClient(c.Rpc)
 	ctx := &svc.ServiceContext{
 		Client: client,
 	}

example/graceful/dns/api/handler/routes.go

@@ -1,4 +1,4 @@
-// DO NOT EDIT, generated by goctl
+// Code generated by goctl. DO NOT EDIT.
 package handler
 
 import (

example/graceful/dns/api/svc/servicecontext.go

@@ -1,7 +1,7 @@
 package svc
 
-import "github.com/tal-tech/go-zero/rpcx"
+import "github.com/tal-tech/go-zero/zrpc"
 
 type ServiceContext struct {
-	Client rpcx.Client
+	Client zrpc.Client
 }

example/graceful/dns/api/types/types.go

@@ -1,4 +1,4 @@
-// DO NOT EDIT, generated by goctl
+// Code generated by goctl. DO NOT EDIT.
 package types
 
 type Response struct {

example/graceful/dns/rpc/gracefulrpc.go

@@ -9,7 +9,7 @@ import (
 
 	"github.com/tal-tech/go-zero/core/conf"
 	"github.com/tal-tech/go-zero/example/graceful/dns/rpc/graceful"
-	"github.com/tal-tech/go-zero/rpcx"
+	"github.com/tal-tech/go-zero/zrpc"
 	"google.golang.org/grpc"
 )
 
@@ -39,10 +39,10 @@ func (gs *GracefulServer) Grace(ctx context.Context, req *graceful.Request) (*gr
 func main() {
 	flag.Parse()
 
-	var c rpcx.RpcServerConf
+	var c zrpc.RpcServerConf
 	conf.MustLoad(*configFile, &c)
 
-	server := rpcx.MustNewServer(c, func(grpcServer *grpc.Server) {
+	server := zrpc.MustNewServer(c, func(grpcServer *grpc.Server) {
 		graceful.RegisterGraceServiceServer(grpcServer, NewGracefulServer())
 	})
 	defer server.Stop()

example/graceful/etcd/api/config/config.go

@@ -2,10 +2,10 @@ package config
 
 import (
 	"github.com/tal-tech/go-zero/rest"
-	"github.com/tal-tech/go-zero/rpcx"
+	"github.com/tal-tech/go-zero/zrpc"
 )
 
 type Config struct {
 	rest.RestConf
-	Rpc rpcx.RpcClientConf
+	Rpc zrpc.RpcClientConf
 }

example/graceful/etcd/api/etc/graceful-api.json

@@ -6,7 +6,7 @@
     "Rpc": {
         "Etcd": {
             "Hosts": ["etcd.discov:2379"],
-            "Key": "rpcx"
+            "Key": "zrpc"
         }
     }
-}
+}

example/graceful/etcd/api/graceful.go

@@ -8,7 +8,7 @@ import (
 	"github.com/tal-tech/go-zero/example/graceful/etcd/api/handler"
 	"github.com/tal-tech/go-zero/example/graceful/etcd/api/svc"
 	"github.com/tal-tech/go-zero/rest"
-	"github.com/tal-tech/go-zero/rpcx"
+	"github.com/tal-tech/go-zero/zrpc"
 )
 
 var configFile = flag.String("f", "etc/graceful-api.json", "the config file")
@@ -19,7 +19,7 @@ func main() {
 	var c config.Config
 	conf.MustLoad(*configFile, &c)
 
-	client := rpcx.MustNewClient(c.Rpc)
+	client := zrpc.MustNewClient(c.Rpc)
 	ctx := &svc.ServiceContext{
 		Client: client,
 	}

example/graceful/etcd/api/handler/routes.go

@@ -1,4 +1,4 @@
-// DO NOT EDIT, generated by goctl
+// Code generated by goctl. DO NOT EDIT.
 package handler
 
 import (

example/graceful/etcd/api/svc/servicecontext.go

@@ -1,7 +1,7 @@
 package svc
 
-import "github.com/tal-tech/go-zero/rpcx"
+import "github.com/tal-tech/go-zero/zrpc"
 
 type ServiceContext struct {
-	Client rpcx.Client
+	Client zrpc.Client
 }

example/graceful/etcd/api/types/types.go

@@ -1,4 +1,4 @@
-// DO NOT EDIT, generated by goctl
+// Code generated by goctl. DO NOT EDIT.
 package types
 
 type Response struct {

example/graceful/etcd/rpc/etc/graceful-rpc.json

@@ -3,6 +3,6 @@
     "ListenOn": "0.0.0.0:3456",
     "Etcd": {
         "Hosts": ["etcd.discov:2379"],
-        "Key": "rpcx"
+        "Key": "zrpc"
     }
 }

example/graceful/etcd/rpc/gracefulrpc.go

@@ -9,7 +9,7 @@ import (
 
 	"github.com/tal-tech/go-zero/core/conf"
 	"github.com/tal-tech/go-zero/example/graceful/etcd/rpc/graceful"
-	"github.com/tal-tech/go-zero/rpcx"
+	"github.com/tal-tech/go-zero/zrpc"
 	"google.golang.org/grpc"
 )
 
@@ -39,10 +39,10 @@ func (gs *GracefulServer) Grace(ctx context.Context, req *graceful.Request) (*gr
 func main() {
 	flag.Parse()
 
-	var c rpcx.RpcServerConf
+	var c zrpc.RpcServerConf
 	conf.MustLoad(*configFile, &c)
 
-	server := rpcx.MustNewServer(c, func(grpcServer *grpc.Server) {
+	server := zrpc.MustNewServer(c, func(grpcServer *grpc.Server) {
 		graceful.RegisterGraceServiceServer(grpcServer, NewGracefulServer())
 	})
 	defer server.Stop()

example/rpc/client/direct/client.go

@@ -8,7 +8,7 @@ import (
 
 	"github.com/tal-tech/go-zero/core/discov"
 	"github.com/tal-tech/go-zero/example/rpc/remote/unary"
-	"github.com/tal-tech/go-zero/rpcx"
+	"github.com/tal-tech/go-zero/zrpc"
 )
 
 const timeFormat = "15:04:05"
@@ -16,10 +16,10 @@ const timeFormat = "15:04:05"
 func main() {
 	flag.Parse()
 
-	client := rpcx.MustNewClient(rpcx.RpcClientConf{
+	client := zrpc.MustNewClient(zrpc.RpcClientConf{
 		Etcd: discov.EtcdConf{
 			Hosts: []string{"localhost:2379"},
-			Key:   "rpcx",
+			Key:   "zrpc",
 		},
 	})
 

example/rpc/client/lb/main.go

@@ -9,7 +9,7 @@ import (
 
 	"github.com/tal-tech/go-zero/core/discov"
 	"github.com/tal-tech/go-zero/example/rpc/remote/unary"
-	"github.com/tal-tech/go-zero/rpcx"
+	"github.com/tal-tech/go-zero/zrpc"
 )
 
 var lb = flag.String("t", "direct", "the load balancer type")
@@ -17,20 +17,20 @@ var lb = flag.String("t", "direct", "the load balancer type")
 func main() {
 	flag.Parse()
 
-	var cli rpcx.Client
+	var cli zrpc.Client
 	switch *lb {
 	case "direct":
-		cli = rpcx.MustNewClient(rpcx.RpcClientConf{
+		cli = zrpc.MustNewClient(zrpc.RpcClientConf{
 			Endpoints: []string{
 				"localhost:3456",
 				"localhost:3457",
 			},
 		})
 	case "discov":
-		cli = rpcx.MustNewClient(rpcx.RpcClientConf{
+		cli = zrpc.MustNewClient(zrpc.RpcClientConf{
 			Etcd: discov.EtcdConf{
 				Hosts: []string{"localhost:2379"},
-				Key:   "rpcx",
+				Key:   "zrpc",
 			},
 		})
 	default:

example/rpc/client/stream/client.go

@@ -5,20 +5,21 @@ import (
 	"flag"
 	"fmt"
 	"log"
+	"sync"
 
 	"github.com/tal-tech/go-zero/core/discov"
 	"github.com/tal-tech/go-zero/example/rpc/remote/stream"
-	"github.com/tal-tech/go-zero/rpcx"
+	"github.com/tal-tech/go-zero/zrpc"
 )
 
 const name = "kevin"
 
-var key = flag.String("key", "rpcx", "the key on etcd")
+var key = flag.String("key", "zrpc", "the key on etcd")
 
 func main() {
 	flag.Parse()
 
-	client, err := rpcx.NewClientNoAuth(discov.EtcdConf{
+	client, err := zrpc.NewClientNoAuth(discov.EtcdConf{
 		Hosts: []string{"localhost:2379"},
 		Key:   *key,
 	})
@@ -33,6 +34,7 @@ func main() {
 		log.Fatal(err)
 	}
 
+	var wg sync.WaitGroup
 	go func() {
 		for {
 			resp, err := stm.Recv()
@@ -41,10 +43,12 @@ func main() {
 			}
 
 			fmt.Println("=>", resp.Greet)
+			wg.Done()
 		}
 	}()
 
 	for i := 0; i < 3; i++ {
+		wg.Add(1)
 		fmt.Println("<=", name)
 		if err = stm.Send(&stream.StreamReq{
 			Name: name,
@@ -52,4 +56,6 @@ func main() {
 			log.Fatal(err)
 		}
 	}
+
+	wg.Wait()
 }

example/rpc/client/unary/client.go

@@ -8,7 +8,7 @@ import (
 
 	"github.com/tal-tech/go-zero/core/conf"
 	"github.com/tal-tech/go-zero/example/rpc/remote/unary"
-	"github.com/tal-tech/go-zero/rpcx"
+	"github.com/tal-tech/go-zero/zrpc"
 )
 
 var configFile = flag.String("f", "config.json", "the config file")
@@ -16,9 +16,9 @@ var configFile = flag.String("f", "config.json", "the config file")
 func main() {
 	flag.Parse()
 
-	var c rpcx.RpcClientConf
+	var c zrpc.RpcClientConf
 	conf.MustLoad(*configFile, &c)
-	client := rpcx.MustNewClient(c)
+	client := zrpc.MustNewClient(c)
 	ticker := time.NewTicker(time.Millisecond * 500)
 	defer ticker.Stop()
 	for {

example/rpc/proxy/proxy.go

@@ -7,7 +7,7 @@ import (
 	"github.com/tal-tech/go-zero/core/logx"
 	"github.com/tal-tech/go-zero/core/service"
 	"github.com/tal-tech/go-zero/example/rpc/remote/unary"
-	"github.com/tal-tech/go-zero/rpcx"
+	"github.com/tal-tech/go-zero/zrpc"
 	"google.golang.org/grpc"
 )
 
@@ -17,7 +17,7 @@ var (
 )
 
 type GreetServer struct {
-	*rpcx.RpcProxy
+	*zrpc.RpcProxy
 }
 
 func (s *GreetServer) Greet(ctx context.Context, req *unary.Request) (*unary.Response, error) {
@@ -33,7 +33,7 @@ func (s *GreetServer) Greet(ctx context.Context, req *unary.Request) (*unary.Res
 func main() {
 	flag.Parse()
 
-	proxy := rpcx.MustNewServer(rpcx.RpcServerConf{
+	proxy := zrpc.MustNewServer(zrpc.RpcServerConf{
 		ServiceConf: service.ServiceConf{
 			Log: logx.LogConf{
 				Mode: "console",
@@ -42,7 +42,7 @@ func main() {
 		ListenOn: *listen,
 	}, func(grpcServer *grpc.Server) {
 		unary.RegisterGreeterServer(grpcServer, &GreetServer{
-			RpcProxy: rpcx.NewProxy(*server),
+			RpcProxy: zrpc.NewProxy(*server),
 		})
 	})
 	proxy.Start()

example/rpc/server/stream/etc/config.json

@@ -6,7 +6,7 @@
         "Hosts": [
             "localhost:2379"
         ],
-        "Key": "rpcx"
+        "Key": "zrpc"
     },
     "Redis": {
         "Host": "localhost:6379",

example/rpc/server/stream/server.go

@@ -6,7 +6,7 @@ import (
 
 	"github.com/tal-tech/go-zero/core/conf"
 	"github.com/tal-tech/go-zero/example/rpc/remote/stream"
-	"github.com/tal-tech/go-zero/rpcx"
+	"github.com/tal-tech/go-zero/zrpc"
 	"google.golang.org/grpc"
 )
 
@@ -39,10 +39,10 @@ func (gs StreamGreetServer) Greet(s stream.StreamGreeter_GreetServer) error {
 }
 
 func main() {
-	var c rpcx.RpcServerConf
+	var c zrpc.RpcServerConf
 	conf.MustLoad("etc/config.json", &c)
 
-	server := rpcx.MustNewServer(c, func(grpcServer *grpc.Server) {
+	server := zrpc.MustNewServer(c, func(grpcServer *grpc.Server) {
 		stream.RegisterStreamGreeterServer(grpcServer, StreamGreetServer(0))
 	})
 	server.Start()

example/rpc/server/unary/etc/config.json

@@ -8,6 +8,6 @@
         "Hosts": [
             "localhost:2379"
         ],
-        "Key": "rpcx"
+        "Key": "zrpc"
     }
 }

example/rpc/server/unary/etc/config1.json

@@ -8,6 +8,6 @@
         "Hosts": [
             "localhost:2379"
         ],
-        "Key": "rpcx"
+        "Key": "zrpc"
     }
 }

example/rpc/server/unary/etc/k8s.json

@@ -6,7 +6,7 @@
         "Hosts": [
             "etcd.discov:2379"
         ],
-        "Key": "rpcx"
+        "Key": "zrpc"
     },
     "Timeout": 500
 }

example/rpc/server/unary/server.go

@@ -10,7 +10,7 @@ import (
 
 	"github.com/tal-tech/go-zero/core/conf"
 	"github.com/tal-tech/go-zero/example/rpc/remote/unary"
-	"github.com/tal-tech/go-zero/rpcx"
+	"github.com/tal-tech/go-zero/zrpc"
 	"google.golang.org/grpc"
 )
 
@@ -44,10 +44,10 @@ func (gs *GreetServer) Greet(ctx context.Context, req *unary.Request) (*unary.Re
 func main() {
 	flag.Parse()
 
-	var c rpcx.RpcServerConf
+	var c zrpc.RpcServerConf
 	conf.MustLoad(*configFile, &c)
 
-	server := rpcx.MustNewServer(c, func(grpcServer *grpc.Server) {
+	server := zrpc.MustNewServer(c, func(grpcServer *grpc.Server) {
 		unary.RegisterGreeterServer(grpcServer, NewGreetServer())
 	})
 	server.Start()

example/shorturl/api/internal/config/config.go

@@ -2,10 +2,10 @@ package config
 
 import (
 	"github.com/tal-tech/go-zero/rest"
-	"github.com/tal-tech/go-zero/rpcx"
+	"github.com/tal-tech/go-zero/zrpc"
 )
 
 type Config struct {
 	rest.RestConf
-	Transform rpcx.RpcClientConf
+	Transform zrpc.RpcClientConf
 }

example/shorturl/api/internal/handler/routes.go

@@ -1,4 +1,4 @@
-// DO NOT EDIT, generated by goctl
+// Code generated by goctl. DO NOT EDIT.
 package handler
 
 import (

example/shorturl/api/internal/svc/servicecontext.go

@@ -4,7 +4,7 @@ import (
 	"shorturl/api/internal/config"
 	"shorturl/rpc/transform/transformer"
 
-	"github.com/tal-tech/go-zero/rpcx"
+	"github.com/tal-tech/go-zero/zrpc"
 )
 
 type ServiceContext struct {
@@ -15,6 +15,6 @@ type ServiceContext struct {
 func NewServiceContext(c config.Config) *ServiceContext {
 	return &ServiceContext{
 		Config:      c,
-		Transformer: transformer.NewTransformer(rpcx.MustNewClient(c.Transform)),
+		Transformer: transformer.NewTransformer(zrpc.MustNewClient(c.Transform)),
 	}
 }

example/shorturl/api/internal/types/types.go

@@ -1,4 +1,4 @@
-// DO NOT EDIT, generated by goctl
+// Code generated by goctl. DO NOT EDIT.
 package types
 
 type ExpandReq struct {

example/shorturl/rpc/transform/internal/config/config.go

@@ -2,11 +2,11 @@ package config
 
 import (
 	"github.com/tal-tech/go-zero/core/stores/cache"
-	"github.com/tal-tech/go-zero/rpcx"
+	"github.com/tal-tech/go-zero/zrpc"
 )
 
 type Config struct {
-	rpcx.RpcServerConf
+	zrpc.RpcServerConf
 	DataSource string
 	Table      string
 	Cache      cache.CacheConf

example/shorturl/rpc/transform/transform.go

@@ -14,7 +14,7 @@ import (
 	transform "shorturl/rpc/transform/pb"
 
 	"github.com/tal-tech/go-zero/core/conf"
-	"github.com/tal-tech/go-zero/rpcx"
+	"github.com/tal-tech/go-zero/zrpc"
 	"google.golang.org/grpc"
 )
 
@@ -28,7 +28,7 @@ func main() {
 	ctx := svc.NewServiceContext(c)
 	transformerSrv := server.NewTransformerServer(ctx)
 
-	s, err := rpcx.NewServer(c.RpcServerConf, func(grpcServer *grpc.Server) {
+	s, err := zrpc.NewServer(c.RpcServerConf, func(grpcServer *grpc.Server) {
 		transform.RegisterTransformerServer(grpcServer, transformerSrv)
 	})
 	if err != nil {

example/shorturl/rpc/transform/transformer/transformer.go

@@ -11,7 +11,7 @@ import (
 	transform "shorturl/rpc/transform/pb"
 
 	"github.com/tal-tech/go-zero/core/jsonx"
-	"github.com/tal-tech/go-zero/rpcx"
+	"github.com/tal-tech/go-zero/zrpc"
 )
 
 type (
@@ -21,11 +21,11 @@ type (
 	}
 
 	defaultTransformer struct {
-		cli rpcx.Client
+		cli zrpc.Client
 	}
 )
 
-func NewTransformer(cli rpcx.Client) Transformer {
+func NewTransformer(cli zrpc.Client) Transformer {
 	return &defaultTransformer{
 		cli: cli,
 	}

example/tracing/edge/config.json

@@ -1,3 +1,13 @@
 {
-    "Server": "localhost:3456"
+  "Name": "edge-api",
+  "Host": "0.0.0.0",
+  "Port": 3456,
+  "Portal": {
+    "Etcd": {
+      "Hosts": [
+        "localhost:2379"
+      ],
+      "Key": "portal"
+    }
+  }
 }

example/tracing/edge/main.go

@@ -10,14 +10,19 @@ import (
 	"github.com/tal-tech/go-zero/example/tracing/remote/portal"
 	"github.com/tal-tech/go-zero/rest"
 	"github.com/tal-tech/go-zero/rest/httpx"
-	"github.com/tal-tech/go-zero/rpcx"
+	"github.com/tal-tech/go-zero/zrpc"
 )
 
 var (
 	configFile = flag.String("f", "config.json", "the config file")
-	client     rpcx.Client
+	client     zrpc.Client
 )
 
+type Config struct {
+	rest.RestConf
+	Portal zrpc.RpcClientConf
+}
+
 func handle(w http.ResponseWriter, r *http.Request) {
 	conn := client.Conn()
 	greet := portal.NewPortalClient(conn)
@@ -34,16 +39,16 @@ func handle(w http.ResponseWriter, r *http.Request) {
 func main() {
 	flag.Parse()
 
-	var c rpcx.RpcClientConf
+	var c Config
 	conf.MustLoad(*configFile, &c)
-	client = rpcx.MustNewClient(c)
+	client = zrpc.MustNewClient(c.Portal)
 	engine := rest.MustNewServer(rest.RestConf{
 		ServiceConf: service.ServiceConf{
 			Log: logx.LogConf{
 				Mode: "console",
 			},
 		},
-		Port: 3333,
+		Port: c.Port,
 	})
 	defer engine.Stop()
 

example/tracing/portal/server.go

@@ -7,7 +7,7 @@ import (
 	"github.com/tal-tech/go-zero/core/conf"
 	"github.com/tal-tech/go-zero/example/tracing/remote/portal"
 	"github.com/tal-tech/go-zero/example/tracing/remote/user"
-	"github.com/tal-tech/go-zero/rpcx"
+	"github.com/tal-tech/go-zero/zrpc"
 	"google.golang.org/grpc"
 )
 
@@ -15,16 +15,16 @@ var configFile = flag.String("f", "etc/config.json", "the config file")
 
 type (
 	Config struct {
-		rpcx.RpcServerConf
-		UserRpc rpcx.RpcClientConf
+		zrpc.RpcServerConf
+		UserRpc zrpc.RpcClientConf
 	}
 
 	PortalServer struct {
-		userRpc rpcx.Client
+		userRpc zrpc.Client
 	}
 )
 
-func NewPortalServer(client rpcx.Client) *PortalServer {
+func NewPortalServer(client zrpc.Client) *PortalServer {
 	return &PortalServer{
 		userRpc: client,
 	}
@@ -53,8 +53,8 @@ func main() {
 	var c Config
 	conf.MustLoad(*configFile, &c)
 
-	client := rpcx.MustNewClient(c.UserRpc)
-	server := rpcx.MustNewServer(c.RpcServerConf, func(grpcServer *grpc.Server) {
+	client := zrpc.MustNewClient(c.UserRpc)
+	server := zrpc.MustNewServer(c.RpcServerConf, func(grpcServer *grpc.Server) {
 		portal.RegisterPortalServer(grpcServer, NewPortalServer(client))
 	})
 	server.Start()

example/tracing/user/server.go

@@ -10,7 +10,7 @@ import (
 
 	"github.com/tal-tech/go-zero/core/conf"
 	"github.com/tal-tech/go-zero/example/tracing/remote/user"
-	"github.com/tal-tech/go-zero/rpcx"
+	"github.com/tal-tech/go-zero/zrpc"
 	"google.golang.org/grpc"
 )
 
@@ -44,10 +44,10 @@ func (gs *UserServer) GetGrade(ctx context.Context, req *user.UserRequest) (*use
 func main() {
 	flag.Parse()
 
-	var c rpcx.RpcServerConf
+	var c zrpc.RpcServerConf
 	conf.MustLoad(*configFile, &c)
 
-	server := rpcx.MustNewServer(c, func(grpcServer *grpc.Server) {
+	server := zrpc.MustNewServer(c, func(grpcServer *grpc.Server) {
 		user.RegisterUserServer(grpcServer, NewUserServer())
 	})
 	server.Start()

readme-en.md

@@ -19,7 +19,7 @@ Advantages of go-zero:
 * improve the stability of the services with tens of millions of daily active users
 * builtin chained timeout control, concurrency control, rate limit, adaptive circuit breaker, adaptive load shedding, even no configuration needed
 * builtin middlewares also can be integrated into your frameworks
-* simple API syntax, one command to generate couple different languages
+* simple API syntax, one command to generate couple of different languages
 * auto validate the request parameters from clients
 * plenty of builtin microservice management and concurrent toolkits
 
@@ -78,7 +78,7 @@ As below, go-zero protects the system with couple layers and mechanisms:
 
 ## 4. Future development plans of go-zero
 
-* auto generate API mock server, make the client debugging eaisier
+* auto generate API mock server, make the client debugging easier
 * auto generate the simple integration test for the server side just from the .api files
 
 ## 5. Installation

readme.md

@@ -160,6 +160,7 @@ go get -u github.com/tal-tech/go-zero
 * [防止缓存击穿之进程内共享调用](doc/sharedcalls.md)
 * [基于prometheus的微服务指标监控](doc/metric.md)
 * [文本序列化和反序列化](doc/mapping.md)
+* [快速构建jwt鉴权认证](doc/jwt.md)
 
 ## 9. 微信交流群
 

rest/config.go

@@ -20,7 +20,7 @@ type (
 
 	// why not name it as Conf, because we need to consider usage like:
 	// type Config struct {
-	//     rpcx.RpcConf
+	//     zrpc.RpcConf
 	//     rest.RestConf
 	// }
 	// if with the name Conf, there will be two Conf inside Config.

rest/handler/loghandler.go

@@ -115,7 +115,7 @@ func logBrief(r *http.Request, code int, timer *utils.ElapsedTimer, logs *intern
 	buf.WriteString(fmt.Sprintf("%d - %s - %s - %s - %s",
 		code, r.RequestURI, httpx.GetRemoteAddr(r), r.UserAgent(), timex.ReprOfDuration(duration)))
 	if duration > slowThreshold {
-		logx.Slowf("[HTTP] %d - %s - %s - %s - slowcall(%s)",
+		logx.WithContext(r.Context()).Slowf("[HTTP] %d - %s - %s - %s - slowcall(%s)",
 			code, r.RequestURI, httpx.GetRemoteAddr(r), r.UserAgent(), timex.ReprOfDuration(duration))
 	}
 
@@ -130,9 +130,9 @@ func logBrief(r *http.Request, code int, timer *utils.ElapsedTimer, logs *intern
 	}
 
 	if ok {
-		logx.Info(buf.String())
+		logx.WithContext(r.Context()).Info(buf.String())
 	} else {
-		logx.Error(buf.String())
+		logx.WithContext(r.Context()).Error(buf.String())
 	}
 }
 
@@ -143,7 +143,7 @@ func logDetails(r *http.Request, response *DetailLoggedResponseWriter, timer *ut
 	buf.WriteString(fmt.Sprintf("%d - %s - %s\n=> %s\n",
 		response.writer.code, r.RemoteAddr, timex.ReprOfDuration(duration), dumpRequest(r)))
 	if duration > slowThreshold {
-		logx.Slowf("[HTTP] %d - %s - slowcall(%s)\n=> %s\n",
+		logx.WithContext(r.Context()).Slowf("[HTTP] %d - %s - slowcall(%s)\n=> %s\n",
 			response.writer.code, r.RemoteAddr, timex.ReprOfDuration(duration), dumpRequest(r))
 	}
 
@@ -157,7 +157,7 @@ func logDetails(r *http.Request, response *DetailLoggedResponseWriter, timer *ut
 		buf.WriteString(fmt.Sprintf("<= %s", respBuf))
 	}
 
-	logx.Info(buf.String())
+	logx.WithContext(r.Context()).Info(buf.String())
 }
 
 func isOkResponse(code int) bool {

rest/httpx/requests_test.go

@@ -109,6 +109,18 @@ func TestParseRequired(t *testing.T) {
 	assert.NotNil(t, err)
 }
 
+func TestParseOptions(t *testing.T) {
+	v := struct {
+		Position int8 `form:"pos,options=1|2"`
+	}{}
+
+	r, err := http.NewRequest(http.MethodGet, "http://hello.com/a?pos=4", nil)
+	assert.Nil(t, err)
+
+	err = Parse(r, &v)
+	assert.NotNil(t, err)
+}
+
 func BenchmarkParseRaw(b *testing.B) {
 	r, err := http.NewRequest(http.MethodGet, "http://hello.com/a?name=hello&age=18&percent=3.4", nil)
 	if err != nil {

rest/internal/context/params.go

@@ -5,7 +5,7 @@ import (
 	"net/http"
 )
 
-const pathVars = "pathVars"
+var pathVars = contextKey("pathVars")
 
 func Vars(r *http.Request) map[string]string {
 	vars, ok := r.Context().Value(pathVars).(map[string]string)
@@ -19,3 +19,9 @@ func Vars(r *http.Request) map[string]string {
 func WithPathVars(r *http.Request, params map[string]string) *http.Request {
 	return r.WithContext(context.WithValue(r.Context(), pathVars, params))
 }
+
+type contextKey string
+
+func (c contextKey) String() string {
+	return "rest/internal/context context key" + string(c)
+}

rest/internal/log.go

@@ -10,7 +10,7 @@ import (
 	"github.com/tal-tech/go-zero/rest/httpx"
 )
 
-const LogContext = "request_logs"
+var LogContext = contextKey("request_logs")
 
 type LogCollector struct {
 	Messages []string
@@ -82,3 +82,9 @@ func formatf(r *http.Request, format string, v ...interface{}) string {
 func formatWithReq(r *http.Request, v string) string {
 	return fmt.Sprintf("(%s - %s) %s", r.RequestURI, httpx.GetRemoteAddr(r), v)
 }
+
+type contextKey string
+
+func (c contextKey) String() string {
+	return "rest/internal context key " + string(c)
+}

tools/goctl/api/format/format.go

@@ -65,16 +65,16 @@ func ApiFormat(path string, printToConsole bool) error {
 		return m
 	})
 
-	info, st, service, err := parser.MatchStruct(r)
+	apiStruct, err := parser.MatchStruct(r)
 	if err != nil {
 		return err
 	}
-	info = strings.TrimSpace(info)
-	if len(service) == 0 || len(st) == 0 {
+	info := strings.TrimSpace(apiStruct.Info)
+	if len(apiStruct.Service) == 0 {
 		return nil
 	}
 
-	fs, err := format.Source([]byte(strings.TrimSpace(st)))
+	fs, err := format.Source([]byte(strings.TrimSpace(apiStruct.StructBody)))
 	if err != nil {
 		str := err.Error()
 		lineNumber := strings.Index(str, ":")
@@ -93,12 +93,24 @@ func ApiFormat(path string, printToConsole bool) error {
 		return err
 	}
 
-	result := strings.Join([]string{info, string(fs), service}, "\n\n")
+	var result string
+	if len(strings.TrimSpace(info)) > 0 {
+		result += strings.TrimSpace(info) + "\n\n"
+	}
+	if len(strings.TrimSpace(apiStruct.Imports)) > 0 {
+		result += strings.TrimSpace(apiStruct.Imports) + "\n\n"
+	}
+	if len(strings.TrimSpace(string(fs))) > 0 {
+		result += strings.TrimSpace(string(fs)) + "\n\n"
+	}
+	if len(strings.TrimSpace(apiStruct.Service)) > 0 {
+		result += strings.TrimSpace(apiStruct.Service) + "\n\n"
+	}
+
 	if printToConsole {
 		_, err := fmt.Print(result)
 		return err
 	}
-	result = strings.TrimSpace(result)
 	return ioutil.WriteFile(path, []byte(result), os.ModePerm)
 }
 

tools/goctl/api/gogen/gen.go

@@ -53,15 +53,13 @@ func DoGenProject(apiFile, dir string, force bool) error {
 
 	logx.Must(util.MkdirIfNotExist(dir))
 	logx.Must(genEtc(dir, api))
-	logx.Must(genConfig(dir))
+	logx.Must(genConfig(dir, api))
 	logx.Must(genMain(dir, api))
 	logx.Must(genServiceContext(dir, api))
 	logx.Must(genTypes(dir, api, force))
 	logx.Must(genHandlers(dir, api))
 	logx.Must(genRoutes(dir, api, force))
 	logx.Must(genLogic(dir, api))
-	// it does not work
-	format(dir)
 	createGoModFileIfNeed(dir)
 
 	if err := backupAndSweep(apiFile); err != nil {
@@ -102,14 +100,6 @@ func backupAndSweep(apiFile string) error {
 	return err
 }
 
-func format(dir string) {
-	cmd := exec.Command("go", "fmt", "./"+dir+"...")
-	_, err := cmd.CombinedOutput()
-	if err != nil {
-		fmt.Println(err.Error())
-	}
-}
-
 func sweep() error {
 	keepTime := time.Now().AddDate(0, 0, -7)
 	return filepath.Walk(tmpDir, func(fpath string, info os.FileInfo, err error) error {

tools/goctl/api/gogen/genconfig.go

@@ -3,8 +3,10 @@ package gogen
 import (
 	"bytes"
 	"fmt"
+	"strings"
 	"text/template"
 
+	"github.com/tal-tech/go-zero/tools/goctl/api/spec"
 	"github.com/tal-tech/go-zero/tools/goctl/api/util"
 	"github.com/tal-tech/go-zero/tools/goctl/vars"
 )
@@ -17,11 +19,18 @@ import {{.authImport}}
 
 type Config struct {
 	rest.RestConf
+	{{.auth}}
 }
+`
+
+	jwtTemplate = ` struct {
+		AccessSecret string
+		AccessExpire int64
+	}
 `
 )
 
-func genConfig(dir string) error {
+func genConfig(dir string, api *spec.ApiSpec) error {
 	fp, created, err := util.MaybeCreateFile(dir, configDir, configFile)
 	if err != nil {
 		return err
@@ -31,11 +40,18 @@ func genConfig(dir string) error {
 	}
 	defer fp.Close()
 
+	var authNames = getAuths(api)
+	var auths []string
+	for _, item := range authNames {
+		auths = append(auths, fmt.Sprintf("%s %s", item, jwtTemplate))
+	}
+
 	var authImportStr = fmt.Sprintf("\"%s/rest\"", vars.ProjectOpenSourceUrl)
 	t := template.Must(template.New("configTemplate").Parse(configTemplate))
 	buffer := new(bytes.Buffer)
 	err = t.Execute(buffer, map[string]string{
 		"authImport": authImportStr,
+		"auth":       strings.Join(auths, "\n"),
 	})
 	if err != nil {
 		return nil

tools/goctl/api/gogen/genroutes.go

@@ -17,7 +17,7 @@ import (
 
 const (
 	routesFilename = "routes.go"
-	routesTemplate = `// DO NOT EDIT, generated by goctl
+	routesTemplate = `// Code generated by goctl. DO NOT EDIT.
 package handler
 
 import (
@@ -81,11 +81,11 @@ func genRoutes(dir string, api *spec.ApiSpec, force bool) error {
 		}
 		var jwt string
 		if g.jwtEnabled {
-			jwt = fmt.Sprintf(", ngin.WithJwt(serverCtx.Config.%s.AccessSecret)", g.authName)
+			jwt = fmt.Sprintf(", rest.WithJwt(serverCtx.Config.%s.AccessSecret)", g.authName)
 		}
 		var signature string
 		if g.signatureEnabled {
-			signature = fmt.Sprintf(", ngin.WithSignature(serverCtx.Config.%s.Signature)", g.authName)
+			signature = fmt.Sprintf(", rest.WithSignature(serverCtx.Config.%s.Signature)", g.authName)
 		}
 		if err := gt.Execute(&builder, map[string]string{
 			"routes":    strings.TrimSpace(gbuilder.String()),
@@ -180,6 +180,11 @@ func getRoutes(api *spec.ApiSpec) ([]group, error) {
 				handler: handler,
 			})
 		}
+
+		if value, ok := apiutil.GetAnnotationValue(g.Annotations, "server", "jwt"); ok {
+			groupedRoutes.authName = value
+			groupedRoutes.jwtEnabled = true
+		}
 		routes = append(routes, groupedRoutes)
 	}
 

tools/goctl/api/gogen/gentypes.go

@@ -16,7 +16,7 @@ import (
 
 const (
 	typesFile     = "types.go"
-	typesTemplate = `// DO NOT EDIT, generated by goctl
+	typesTemplate = `// Code generated by goctl. DO NOT EDIT.
 package types{{if .containsTime}}
 import (
 	"time"

tools/goctl/api/javagen/gencomponents.go

@@ -13,7 +13,7 @@ import (
 )
 
 const (
-	componentTemplate = `// DO NOT EDIT, generated by goctl
+	componentTemplate = `// Code generated by goctl. DO NOT EDIT.
 package com.xhb.logic.http.packet.{{.packet}}.model;
 
 import com.xhb.logic.http.DeProguardable;

tools/goctl/api/parser/parser.go

@@ -6,36 +6,61 @@ import (
 	"fmt"
 	"io"
 	"io/ioutil"
+	"path/filepath"
+	"strings"
 
 	"github.com/tal-tech/go-zero/tools/goctl/api/spec"
+	"github.com/tal-tech/go-zero/tools/goctl/util"
 )
 
 type Parser struct {
-	r  *bufio.Reader
-	st string
+	r       *bufio.Reader
+	typeDef string
 }
 
 func NewParser(filename string) (*Parser, error) {
+	apiAbsPath, err := filepath.Abs(filename)
+	if err != nil {
+		return nil, err
+	}
+
 	api, err := ioutil.ReadFile(filename)
 	if err != nil {
 		return nil, err
 	}
-	info, body, service, err := MatchStruct(string(api))
+
+	apiStruct, err := MatchStruct(string(api))
 	if err != nil {
 		return nil, err
 	}
+	for _, item := range strings.Split(apiStruct.Imports, "\n") {
+		ip := strings.TrimSpace(item)
+		if len(ip) > 0 {
+			item := strings.TrimPrefix(item, "import")
+			item = strings.TrimSpace(item)
+			var path = item
+			if !util.FileExists(item) {
+				path = filepath.Join(filepath.Dir(apiAbsPath), item)
+			}
+			content, err := ioutil.ReadFile(path)
+			if err != nil {
+				return nil, err
+			}
+			apiStruct.StructBody += "\n" + string(content)
+		}
+	}
+
 	var buffer = new(bytes.Buffer)
-	buffer.WriteString(info)
-	buffer.WriteString(service)
+	buffer.WriteString(apiStruct.Service)
 	return &Parser{
-		r:  bufio.NewReader(buffer),
-		st: body,
+		r:       bufio.NewReader(buffer),
+		typeDef: apiStruct.StructBody,
 	}, nil
 }
 
 func (p *Parser) Parse() (api *spec.ApiSpec, err error) {
 	api = new(spec.ApiSpec)
-	types, err := parseStructAst(p.st)
+	types, err := parseStructAst(p.typeDef)
 	if err != nil {
 		return nil, err
 	}

tools/goctl/api/parser/util.go

@@ -3,19 +3,19 @@ package parser
 import (
 	"bufio"
 	"errors"
-	"regexp"
 	"strings"
 
 	"github.com/tal-tech/go-zero/tools/goctl/api/spec"
 )
 
-// struct match
-const typeRegex = `(?m)(?m)(^ *type\s+[a-zA-Z][a-zA-Z0-9_-]+\s+(((struct)\s*?\{[\w\W]*?[^\{]\})|([a-zA-Z][a-zA-Z0-9_-]+)))|(^ *type\s*?\([\w\W]+\}\s*\))`
+var emptyType spec.Type
 
-var (
-	emptyStrcut = errors.New("struct body not found")
-	emptyType   spec.Type
-)
+type ApiStruct struct {
+	Info       string
+	StructBody string
+	Service    string
+	Imports    string
+}
 
 func GetType(api *spec.ApiSpec, t string) spec.Type {
 	for _, tp := range api.Types {
@@ -69,32 +69,56 @@ func unread(r *bufio.Reader) error {
 	return r.UnreadRune()
 }
 
-func MatchStruct(api string) (info, structBody, service string, err error) {
-	r := regexp.MustCompile(typeRegex)
-	indexes := r.FindAllStringIndex(api, -1)
-	if len(indexes) == 0 {
-		return "", "", "", emptyStrcut
-	}
-	startIndexes := indexes[0]
-	endIndexes := indexes[len(indexes)-1]
+func MatchStruct(api string) (*ApiStruct, error) {
+	var result ApiStruct
+	scanner := bufio.NewScanner(strings.NewReader(api))
+	var parseInfo = false
+	var parseImport = false
+	var parseType = false
+	var parseSevice = false
+	var segment string
+	for scanner.Scan() {
+		line := strings.TrimSpace(scanner.Text())
 
-	info = api[:startIndexes[0]]
-	structBody = api[startIndexes[0]:endIndexes[len(endIndexes)-1]]
-	service = api[endIndexes[len(endIndexes)-1]:]
-
-	firstIIndex := strings.Index(info, "i")
-	if firstIIndex > 0 {
-		info = info[firstIIndex:]
-	}
-
-	lastServiceRightBraceIndex := strings.LastIndex(service, "}") + 1
-	var firstServiceIndex int
-	for index, char := range service {
-		if !isSpace(char) && !isNewline(char) {
-			firstServiceIndex = index
-			break
+		if line == "@doc(" {
+			parseInfo = true
 		}
+		if line == ")" && parseInfo {
+			parseInfo = false
+			result.Info = segment + ")"
+			segment = ""
+			continue
+		}
+
+		if strings.HasPrefix(line, "import") {
+			parseImport = true
+		}
+		if parseImport && (strings.HasPrefix(line, "type") || strings.HasPrefix(line, "@server") ||
+			strings.HasPrefix(line, "service")) {
+			parseImport = false
+			result.Imports = segment
+			segment = line + "\n"
+			continue
+		}
+
+		if strings.HasPrefix(line, "type") {
+			parseType = true
+		}
+		if strings.HasPrefix(line, "@server") || strings.HasPrefix(line, "service") {
+			if parseType {
+				parseType = false
+				result.StructBody = segment
+				segment = line + "\n"
+				continue
+			}
+			parseSevice = true
+		}
+		segment += scanner.Text() + "\n"
 	}
-	service = service[firstServiceIndex:lastServiceRightBraceIndex]
-	return
+
+	if !parseSevice {
+		return nil, errors.New("no service defined")
+	}
+	result.Service = segment
+	return &result, nil
 }

tools/goctl/api/tsgen/gencomponents.go

@@ -12,7 +12,7 @@ import (
 )
 
 const (
-	componentsTemplate = `// DO NOT EDIT, generated by goctl
+	componentsTemplate = `// Code generated by goctl. DO NOT EDIT.
 
 {{.componentTypes}}
 `

tools/goctl/rpc/README.md

@@ -220,11 +220,11 @@ OPTIONS:
     *rrBalanced does not implement Picker (wrong type for Pick method)
 		have Pick(context.Context, balancer.PickInfo) (balancer.SubConn, func(balancer.DoneInfo), error)
     want Pick(balancer.PickInfo) (balancer.PickResult, error)
-    #github.com/tal-tech/go-zero/rpcx/internal/balancer/p2c
-    ../../../go/pkg/mod/github.com/tal-tech/go-zero@v1.0.12/rpcx/internal/balancer/p2c/p2c.go:41:32: not enough arguments in call to base.NewBalancerBuilder
+    #github.com/tal-tech/go-zero/zrpc/internal/balancer/p2c
+    ../../../go/pkg/mod/github.com/tal-tech/go-zero@v1.0.12/zrpc/internal/balancer/p2c/p2c.go:41:32: not enough arguments in call to base.NewBalancerBuilder
 	have (string, *p2cPickerBuilder)
   want (string, base.PickerBuilder, base.Config)
-  ../../../go/pkg/mod/github.com/tal-tech/go-zero@v1.0.12/rpcx/internal/balancer/p2c/p2c.go:58:9: cannot use &p2cPicker literal (type *p2cPicker) as type balancer.Picker in return argument:
+  ../../../go/pkg/mod/github.com/tal-tech/go-zero@v1.0.12/zrpc/internal/balancer/p2c/p2c.go:58:9: cannot use &p2cPicker literal (type *p2cPicker) as type balancer.Picker in return argument:
 	*p2cPicker does not implement balancer.Picker (wrong type for Pick method)
 		have Pick(context.Context, balancer.PickInfo) (balancer.SubConn, func(balancer.DoneInfo), error)
 		want Pick(balancer.PickInfo) (balancer.PickResult, error)

tools/goctl/rpc/gen/gencall.go

@@ -25,7 +25,7 @@ import (
 	{{.package}}
 
 	"github.com/tal-tech/go-zero/core/jsonx"
-	"github.com/tal-tech/go-zero/rpcx"
+	"github.com/tal-tech/go-zero/zrpc"
 )
 
 type (
@@ -34,11 +34,11 @@ type (
 	}
 
 	default{{.serviceName}} struct {
-		cli rpcx.Client
+		cli zrpc.Client
 	}
 )
 
-func New{{.serviceName}}(cli rpcx.Client) {{.serviceName}} {
+func New{{.serviceName}}(cli zrpc.Client) {{.serviceName}} {
 	return &default{{.serviceName}}{
 		cli: cli,
 	}
@@ -57,24 +57,24 @@ var errJsonConvert = errors.New("json convert error")
 {{.types}}
 `
 	callInterfaceFunctionTemplate = `{{if .hasComment}}{{.comment}}
-{{end}}{{.method}}(ctx context.Context,in *{{.pbRequest}}) {{if .hasResponse}}(*{{.pbResponse}},{{end}} error{{if .hasResponse}}){{end}}`
+{{end}}{{.method}}(ctx context.Context,in *{{.pbRequest}}) (*{{.pbResponse}},error)`
 	callFunctionTemplate = `
 {{if .hasComment}}{{.comment}}{{end}}
-func (m *default{{.rpcServiceName}}) {{.method}}(ctx context.Context,in *{{.pbRequest}}) {{if .hasResponse}}(*{{.pbResponse}},{{end}} error{{if .hasResponse}}){{end}} {
+func (m *default{{.rpcServiceName}}) {{.method}}(ctx context.Context,in *{{.pbRequest}}) (*{{.pbResponse}}, error) {
 	var request {{.package}}.{{.pbRequest}}
 	bts, err := jsonx.Marshal(in)
 	if err != nil {
-		return {{if .hasResponse}}nil, {{end}}errJsonConvert
+		return nil, errJsonConvert
 	}
 
 	err = jsonx.Unmarshal(bts, &request)
 	if err != nil {
-		return {{if .hasResponse}}nil, {{end}}errJsonConvert
+		return nil, errJsonConvert
 	}
 
 	client := {{.package}}.New{{.rpcServiceName}}Client(m.cli.Conn())
-	{{if .hasResponse}}resp, err := {{else}}_, err = {{end}}client.{{.method}}(ctx, &request)
-	{{if .hasResponse}}if err != nil{
+	resp, err :=  client.{{.method}}(ctx, &request)
+	if err != nil{
 		return nil, err
 	}
 
@@ -89,11 +89,7 @@ func (m *default{{.rpcServiceName}}) {{.method}}(ctx context.Context,in *{{.pbRe
 		return nil, errJsonConvert
 	}
 
-	return &ret, nil{{else}}if err != nil {
-		return err
-	}
-
-	return nil{{end}}
+	return &ret, nil
 }
 `
 )
@@ -177,10 +173,6 @@ func (g *defaultRpcGenerator) getFuncs(service *parser.RpcService) ([]string, er
 	pkgName := file.Package
 	functions := make([]string, 0)
 	for _, method := range service.Funcs {
-		data, found := file.Strcuts[strings.ToLower(method.OutType)]
-		if found {
-			found = len(data.Field) > 0
-		}
 		var comment string
 		if len(method.Document) > 0 {
 			comment = method.Document[0]
@@ -191,7 +183,6 @@ func (g *defaultRpcGenerator) getFuncs(service *parser.RpcService) ([]string, er
 			"package":        pkgName,
 			"pbRequest":      method.InType,
 			"pbResponse":     method.OutType,
-			"hasResponse":    found,
 			"hasComment":     len(method.Document) > 0,
 			"comment":        comment,
 		})
@@ -205,26 +196,20 @@ func (g *defaultRpcGenerator) getFuncs(service *parser.RpcService) ([]string, er
 }
 
 func (g *defaultRpcGenerator) getInterfaceFuncs(service *parser.RpcService) ([]string, error) {
-	file := g.ast
 	functions := make([]string, 0)
 
 	for _, method := range service.Funcs {
-		data, found := file.Strcuts[strings.ToLower(method.OutType)]
-		if found {
-			found = len(data.Field) > 0
-		}
 		var comment string
 		if len(method.Document) > 0 {
 			comment = method.Document[0]
 		}
 		buffer, err := util.With("interfaceFn").Parse(callInterfaceFunctionTemplate).Execute(
 			map[string]interface{}{
-				"hasComment":  len(method.Document) > 0,
-				"comment":     comment,
-				"method":      method.Name.Title(),
-				"pbRequest":   method.InType,
-				"pbResponse":  method.OutType,
-				"hasResponse": found,
+				"hasComment": len(method.Document) > 0,
+				"comment":    comment,
+				"method":     method.Name.Title(),
+				"pbRequest":  method.InType,
+				"pbResponse": method.OutType,
 			})
 		if err != nil {
 			return nil, err

tools/goctl/rpc/gen/genconfig.go

@@ -10,10 +10,10 @@ import (
 
 const configTemplate = `package config
 
-import "github.com/tal-tech/go-zero/rpcx"
+import "github.com/tal-tech/go-zero/zrpc"
 
 type Config struct {
-	rpcx.RpcServerConf
+	zrpc.RpcServerConf
 }
 `
 

tools/goctl/rpc/gen/genmain.go

@@ -21,7 +21,7 @@ import (
 
 	"github.com/tal-tech/go-zero/core/conf"
 	"github.com/tal-tech/go-zero/core/logx"
-	"github.com/tal-tech/go-zero/rpcx"
+	"github.com/tal-tech/go-zero/zrpc"
 	"google.golang.org/grpc"
 )
 
@@ -35,7 +35,7 @@ func main() {
 	ctx := svc.NewServiceContext(c)
 	{{.srv}}
 
-	s, err := rpcx.NewServer(c.RpcServerConf, func(grpcServer *grpc.Server) {
+	s, err := zrpc.NewServer(c.RpcServerConf, func(grpcServer *grpc.Server) {
 		{{.registers}}
 	})
 	logx.Must(err)

tools/goctl/rpc/parser/pbast.go

@@ -445,9 +445,6 @@ func (a *PbAst) GenTypesCode() (string, error) {
 }
 
 func (s *Struct) genCode(containsTypeStatement bool) (string, error) {
-	if len(s.Field) == 0 {
-		return "", nil
-	}
 	fields := make([]string, 0)
 	for _, f := range s.Field {
 		var comment, doc string

zrpc/client.go

@@ -1,12 +1,12 @@
-package rpcx
+package zrpc
 
 import (
 	"log"
 	"time"
 
 	"github.com/tal-tech/go-zero/core/discov"
-	"github.com/tal-tech/go-zero/rpcx/internal"
-	"github.com/tal-tech/go-zero/rpcx/internal/auth"
+	"github.com/tal-tech/go-zero/zrpc/internal"
+	"github.com/tal-tech/go-zero/zrpc/internal/auth"
 	"google.golang.org/grpc"
 )
 

zrpc/client_test.go

@@ -1,4 +1,4 @@
-package rpcx
+package zrpc
 
 import (
 	"context"
@@ -9,7 +9,7 @@ import (
 
 	"github.com/stretchr/testify/assert"
 	"github.com/tal-tech/go-zero/core/logx"
-	"github.com/tal-tech/go-zero/rpcx/internal/mock"
+	"github.com/tal-tech/go-zero/zrpc/internal/mock"
 	"google.golang.org/grpc"
 	"google.golang.org/grpc/codes"
 	"google.golang.org/grpc/status"

zrpc/config.go

@@ -1,4 +1,4 @@
-package rpcx
+package zrpc
 
 import (
 	"github.com/tal-tech/go-zero/core/discov"

zrpc/config_test.go

@@ -1,4 +1,4 @@
-package rpcx
+package zrpc
 
 import (
 	"testing"

zrpc/internal/balancer/p2c/p2c.go

@@ -13,7 +13,7 @@ import (
 	"github.com/tal-tech/go-zero/core/logx"
 	"github.com/tal-tech/go-zero/core/syncx"
 	"github.com/tal-tech/go-zero/core/timex"
-	"github.com/tal-tech/go-zero/rpcx/internal/codes"
+	"github.com/tal-tech/go-zero/zrpc/internal/codes"
 	"google.golang.org/grpc/balancer"
 	"google.golang.org/grpc/balancer/base"
 	"google.golang.org/grpc/resolver"