go/kratos
1
0
Fork 0
mirror of https://github.com/go-kratos/kratos.git synced 2025-10-30 23:47:59 +02:00
Code Issues Releases Activity

examples: update mod (#862)

Browse Source 
* fix examples errors
This commit is contained in:
Tony Chen
2021-04-25 22:26:31 +08:00
committed by GitHub
parent 9806191b7f
commit 3780f70c91
17 changed files with 71 additions and 97 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
errors/errors.go
View File

@@ -31,19 +31,22 @@ func (e *Error) WithMetadata(md map[string]string) *Error {
// Is matches each error in the chain with the target value.
func (e *Error) Is(err error) bool {
if target := new(Error); errors.As(err, &target) {
return target.Code == e.Code && target.Reason == e.Reason
return target.Code == e.Code &&
target.Domain == e.Domain &&
target.Reason == e.Reason
}
return false
}
func (e *Error) Error() string {
return fmt.Sprintf("error: code = %d domain = %s reason = %s message = %s metadata = %v", e.Code, e.Domain, e.Reason, e.Message, e.Metadata)
return fmt.Sprintf("error: code = %d domain = %s reason = %s message = %s", e.Code, e.Domain, e.Reason, e.Message)
}
// New returns an error object for the code, message and error info.
func New(code int, reason, message string) *Error {
func New(code int, domain, reason, message string) *Error {
return &Error{
Code: code,
Domain: domain,
Reason: reason,
Message: message,
}
@@ -85,5 +88,5 @@ func FromError(err error) *Error {
if target := new(Error); errors.As(err, &target) {
return target
}
return New(http.StatusInternalServerError, "", err.Error())
return New(http.StatusInternalServerError, "", "", err.Error())
}

4
errors/errors_test.go
View File

@@ -10,8 +10,8 @@ func TestError(t *testing.T) {
var (
base *Error
)
err := New(400, "reason", "message")
err2 := New(400, "reason", "message")
err := New(400, "domain", "reason", "message")
err2 := New(400, "domain", "reason", "message")
err3 := err.WithMetadata(map[string]string{
"foo": "bar",
})

28
errors/types.go
View File

@@ -3,8 +3,8 @@ package errors
import "net/http"
// BadRequest new BadRequest error that is mapped to a 400 response.
func BadRequest(reason, message string) *Error {
return New(http.StatusBadRequest, reason, message)
func BadRequest(domain, reason, message string) *Error {
return New(http.StatusBadRequest, domain, reason, message)
}
// IsBadRequest determines if err is an error which indicates a BadRequest error.
@@ -14,8 +14,8 @@ func IsBadRequest(err error) bool {
}
// Unauthorized new Unauthorized error that is mapped to a 401 response.
func Unauthorized(reason, message string) *Error {
return New(http.StatusUnauthorized, reason, message)
func Unauthorized(domain, reason, message string) *Error {
return New(http.StatusUnauthorized, domain, reason, message)
}
// IsUnauthorized determines if err is an error which indicates a Unauthorized error.
@@ -25,8 +25,8 @@ func IsUnauthorized(err error) bool {
}
// Forbidden new Forbidden error that is mapped to a 403 response.
func Forbidden(reason, message string) *Error {
return New(http.StatusForbidden, reason, message)
func Forbidden(domain, reason, message string) *Error {
return New(http.StatusForbidden, domain, reason, message)
}
// IsForbidden determines if err is an error which indicates a Forbidden error.
@@ -36,8 +36,8 @@ func IsForbidden(err error) bool {
}
// NotFound new NotFound error that is mapped to a 404 response.
func NotFound(reason, message string) *Error {
return New(http.StatusNotFound, reason, message)
func NotFound(domain, reason, message string) *Error {
return New(http.StatusNotFound, domain, reason, message)
}
// IsNotFound determines if err is an error which indicates an NotFound error.
@@ -47,8 +47,8 @@ func IsNotFound(err error) bool {
}
// Conflict new Conflict error that is mapped to a 409 response.
func Conflict(reason, message string) *Error {
return New(http.StatusConflict, reason, message)
func Conflict(domain, reason, message string) *Error {
return New(http.StatusConflict, domain, reason, message)
}
// IsConflict determines if err is an error which indicates a Conflict error.
@@ -58,8 +58,8 @@ func IsConflict(err error) bool {
}
// InternalServer new InternalServer error that is mapped to a 500 response.
func InternalServer(reason, message string) *Error {
return New(http.StatusInternalServerError, reason, message)
func InternalServer(domain, reason, message string) *Error {
return New(http.StatusInternalServerError, domain, reason, message)
}
// IsInternalServer determines if err is an error which indicates an InternalServer error.
@@ -69,8 +69,8 @@ func IsInternalServer(err error) bool {
}
// ServiceUnavailable new ServiceUnavailable error that is mapped to a HTTP 503 response.
func ServiceUnavailable(reason, message string) *Error {
return New(http.StatusServiceUnavailable, reason, message)
func ServiceUnavailable(domain, reason, message string) *Error {
return New(http.StatusServiceUnavailable, domain, reason, message)
}
// IsServiceUnavailable determines if err is an error which indicates a ServiceUnavailable error.

14
errors/types_test.go
View File

@@ -5,13 +5,13 @@ import "testing"
func TestTypes(t *testing.T) {
var (
input = []*Error{
BadRequest("reason_400", "message_400"),
Unauthorized("reason_401", "message_401"),
Forbidden("reason_403", "message_403"),
NotFound("reason_404", "message_404"),
Conflict("reason_409", "message_409"),
InternalServer("reason_500", "message_500"),
ServiceUnavailable("reason_503", "message_503"),
BadRequest("domain_400", "reason_400", "message_400"),
Unauthorized("domain_401", "reason_401", "message_401"),
Forbidden("domain_403", "reason_403", "message_403"),
NotFound("domain_404", "reason_404", "message_404"),
Conflict("domain_409", "reason_409", "message_409"),
InternalServer("domain_500", "reason_500", "message_500"),
ServiceUnavailable("domain_503", "reason_503", "message_503"),
}
output = []func(error) bool{
IsBadRequest,

5
examples/blog/internal/server/grpc.go
View File

@@ -4,6 +4,7 @@ import (
v1 "github.com/go-kratos/kratos/examples/blog/api/blog/v1"
"github.com/go-kratos/kratos/examples/blog/internal/conf"
"github.com/go-kratos/kratos/examples/blog/internal/service"
"github.com/go-kratos/kratos/v2/log"
"github.com/go-kratos/kratos/v2/middleware"
"github.com/go-kratos/kratos/v2/middleware/logging"
"github.com/go-kratos/kratos/v2/middleware/recovery"
@@ -18,10 +19,10 @@ func NewGRPCServer(c *conf.Server, tracer trace.TracerProvider, blog *service.Bl
var opts = []grpc.ServerOption{
grpc.Middleware(
middleware.Chain(
recovery.Recovery(),
status.Server(),
tracing.Server(tracing.WithTracerProvider(tracer)),
logging.Server(),
logging.Server(log.DefaultLogger),
recovery.Recovery(),
),
),
}

5
examples/blog/internal/server/http.go
View File

@@ -4,6 +4,7 @@ import (
v1 "github.com/go-kratos/kratos/examples/blog/api/blog/v1"
"github.com/go-kratos/kratos/examples/blog/internal/conf"
"github.com/go-kratos/kratos/examples/blog/internal/service"
"github.com/go-kratos/kratos/v2/log"
"github.com/go-kratos/kratos/v2/middleware"
"github.com/go-kratos/kratos/v2/middleware/logging"
"github.com/go-kratos/kratos/v2/middleware/recovery"
@@ -26,9 +27,9 @@ func NewHTTPServer(c *conf.Server, tracer trace.TracerProvider, blog *service.Bl
}
m := http.Middleware(
middleware.Chain(
recovery.Recovery(),
tracing.Server(tracing.WithTracerProvider(tracer)),
logging.Server(),
logging.Server(log.DefaultLogger),
recovery.Recovery(),
),
)
srv := http.NewServer(opts...)

6
examples/go.mod
View File

@@ -5,9 +5,9 @@ go 1.16
require (
entgo.io/ent v0.6.0
github.com/gin-gonic/gin v1.6.3
github.com/go-kratos/consul v0.0.0-20210311161349-cfb0345e820d
github.com/go-kratos/consul v0.0.0-20210425141546-e047a9f6ec87
github.com/go-kratos/etcd v0.0.0-20210311162832-e0fdc8177742
github.com/go-kratos/kratos/v2 v2.0.0-20210415063033-9007abfd2888
github.com/go-kratos/kratos/v2 v2.0.0-20210425121923-9806191b7f32
github.com/go-kratos/nacos v0.0.0-20210415082641-f1b756c16257
github.com/go-playground/validator/v10 v10.4.1 // indirect
github.com/go-redis/redis/extra/redisotel v0.3.0
@@ -40,3 +40,5 @@ require (
gopkg.in/yaml.v2 v2.4.0
gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b // indirect
)
replace github.com/go-kratos/kratos/v2 => ../

8
examples/go.sum
View File

@@ -125,13 +125,10 @@ github.com/go-gl/glfw/v3.3/glfw v0.0.0-20191125211704-12ad95a8df72/go.mod h1:tQ2
github.com/go-gl/glfw/v3.3/glfw v0.0.0-20200222043503-6f7a984d4dc4/go.mod h1:tQ2UAYgL5IevRw8kRxooKSPJfGvJ9fJQFa0TUsXzTg8=
github.com/go-kit/kit v0.8.0/go.mod h1:xBxKIO96dXMWWy0MnWVtmwkA9/13aqxPnvrjFYMA2as=
github.com/go-kit/kit v0.9.0/go.mod h1:xBxKIO96dXMWWy0MnWVtmwkA9/13aqxPnvrjFYMA2as=
github.com/go-kratos/consul v0.0.0-20210311161349-cfb0345e820d h1:px9mGqOsFmcXYsidSYATFoDK/R7x43WnUqiE/9Pu8x8=
github.com/go-kratos/consul v0.0.0-20210311161349-cfb0345e820d/go.mod h1:i/8iM3Xm0YwSmiCdFFZ611y+6rk5Bi1G5UZtBG3t9rg=
github.com/go-kratos/consul v0.0.0-20210425141546-e047a9f6ec87 h1:YKG1fpsSZivsGzeD31Mb91hsmouDFCPq8LR6Uz8SjTg=
github.com/go-kratos/consul v0.0.0-20210425141546-e047a9f6ec87/go.mod h1:O21CidethNnnpWtHS7XcisEKl3P+f9sTZACoIyuvq4Y=
github.com/go-kratos/etcd v0.0.0-20210311162832-e0fdc8177742 h1:gEjXnGJ30PVLE3AMgh1z48PmHgVC4E1q8ZvkdkyJyt8=
github.com/go-kratos/etcd v0.0.0-20210311162832-e0fdc8177742/go.mod h1:+1nilFyiWLlYpAWliKnbFhIax79n4l0mOTJhyNw5EEw=
github.com/go-kratos/kratos/v2 v2.0.0-20210311152607-a4409adf164e/go.mod h1:oLvFyDBJkkWN8TPqb+NmpvRrSy9uM/K+XQubVRc11a8=
github.com/go-kratos/kratos/v2 v2.0.0-20210415063033-9007abfd2888 h1:GmcG4UBf9ome4mJMltFSqxRdQssIRgGBAhIvHJA9MVU=
github.com/go-kratos/kratos/v2 v2.0.0-20210415063033-9007abfd2888/go.mod h1:hwEYWw8GFuJ8IoNt3T/3k+7kUfYt+h2fHDcyFlR1jBA=
github.com/go-kratos/nacos v0.0.0-20210415082641-f1b756c16257 h1:mJdO5lD+C1UsxJ5NC0rQ2hPx1dA0tdXLp/3UFNWRaFc=
github.com/go-kratos/nacos v0.0.0-20210415082641-f1b756c16257/go.mod h1:GP7wV0ohYEG+x1P/qdNCJGb7K2jtbsMop+5BDaSqBlA=
github.com/go-logfmt/logfmt v0.3.0/go.mod h1:Qt1PoO58o5twSAckw1HlFXLmHsOX5/0LbT9GBnD5lWE=
@@ -389,7 +386,6 @@ github.com/onsi/gomega v1.10.1/go.mod h1:iN09h71vgCQne3DLsj+A5owkum+a2tYe+TOCB1y
github.com/onsi/gomega v1.10.3/go.mod h1:V9xEwhxec5O8UDM77eCW8vLymOMltsqPVYWrpDsH8xc=
github.com/onsi/gomega v1.10.5 h1:7n6FEkpFmfCoo2t+YYqXH0evK+a9ICQz0xcAy9dYcaQ=
github.com/onsi/gomega v1.10.5/go.mod h1:gza4q3jKQJijlu05nKWRCW/GavJumGt8aNRxWg7mt48=
github.com/opentracing/opentracing-go v1.2.0/go.mod h1:GxEUsuufX4nBwe+T+Wl9TAgYrxe9dPLANfrWvHYVTgc=
github.com/pascaldekloe/goe v0.0.0-20180627143212-57f6aae5913c/go.mod h1:lzWF7FIEvWOWxwDKqyGYQf6ZUaNfKdP144TG7ZOy1lc=
github.com/pascaldekloe/goe v0.1.0 h1:cBOtyMzM9HTpWjXfbbunk26uA6nG3a8n06Wieeh0MwY=
github.com/pascaldekloe/goe v0.1.0/go.mod h1:lzWF7FIEvWOWxwDKqyGYQf6ZUaNfKdP144TG7ZOy1lc=

11
examples/helloworld/client/main.go
View File

@@ -20,7 +20,14 @@ func main() {
}
func callHTTP() {
client, err := transhttp.NewClient(context.Background())
client, err := transhttp.NewClient(
context.Background(),
transhttp.WithMiddleware(
middleware.Chain(
recovery.Recovery(),
),
),
)
if err != nil {
log.Fatal(err)
}
@@ -71,7 +78,7 @@ func callGRPC() {
if err != nil {
log.Printf("[grpc] SayHello error: %v\n", err)
}
if errors.IsInvalidArgument(err) {
if errors.IsBadRequest(err) {
log.Printf("[grpc] SayHello error is invalid argument: %v\n", err)
}
}

16
examples/helloworld/server/main.go
View File

@@ -17,6 +17,14 @@ import (
"github.com/go-kratos/kratos/v2/transport/http"
)
// go build -ldflags "-X main.Version=x.y.z"
var (
// Name is the name of the compiled software.
Name = "helloworld"
// Version is the version of the compiled software.
Version = "v1.0.0"
)
// server is used to implement helloworld.GreeterServer.
type server struct {
pb.UnimplementedGreeterServer
@@ -25,7 +33,7 @@ type server struct {
// SayHello implements helloworld.GreeterServer
func (s *server) SayHello(ctx context.Context, in *pb.HelloRequest) (*pb.HelloReply, error) {
if in.Name == "error" {
return nil, errors.InvalidArgument("BadRequest", "invalid argument %s", in.Name)
return nil, errors.BadRequest(Name, "custom_error", fmt.Sprintf("invalid argument %s", in.Name))
}
if in.Name == "panic" {
panic("grpc panic")
@@ -42,8 +50,8 @@ func main() {
grpc.Address(":9000"),
grpc.Middleware(
middleware.Chain(
logging.Server(logging.WithLogger(logger)),
status.Server(),
logging.Server(logger),
recovery.Recovery(),
),
))
@@ -55,14 +63,14 @@ func main() {
httpSrv.HandlePrefix("/", pb.NewGreeterHandler(s,
http.Middleware(
middleware.Chain(
logging.Server(logging.WithLogger(logger)),
logging.Server(logger),
recovery.Recovery(),
),
)),
)
app := kratos.New(
kratos.Name("helloworld"),
kratos.Name(Name),
kratos.Server(
httpSrv,
grpcSrv,

34
middleware/logging/logging.go
View File

@@ -11,29 +11,9 @@ import (
"github.com/go-kratos/kratos/v2/transport/http"
)
// Option is HTTP logging option.
type Option func(*options)
type options struct {
logger log.Logger
}
// WithLogger with middleware logger.
func WithLogger(logger log.Logger) Option {
return func(o *options) {
o.logger = logger
}
}
// Server is an server logging middleware.
func Server(opts ...Option) middleware.Middleware {
options := options{
logger: log.DefaultLogger,
}
for _, o := range opts {
o(&options)
}
logger := log.NewHelper("middleware/logging", options.logger)
func Server(l log.Logger) middleware.Middleware {
logger := log.NewHelper("middleware/logging", l)
return func(handler middleware.Handler) middleware.Handler {
return func(ctx context.Context, req interface{}) (interface{}, error) {
var (
@@ -80,14 +60,8 @@ func Server(opts ...Option) middleware.Middleware {
}
// Client is an client logging middleware.
func Client(opts ...Option) middleware.Middleware {
options := options{
logger: log.DefaultLogger,
}
for _, o := range opts {
o(&options)
}
logger := log.NewHelper("middleware/logging", options.logger)
func Client(l log.Logger) middleware.Middleware {
logger := log.NewHelper("middleware/logging", l)
return func(handler middleware.Handler) middleware.Handler {
return func(ctx context.Context, req interface{}) (interface{}, error) {
var (

2
middleware/recovery/recovery.go
View File

@@ -40,7 +40,7 @@ func Recovery(opts ...Option) middleware.Middleware {
options := options{
logger: log.DefaultLogger,
handler: func(ctx context.Context, req, err interface{}) error {
return errors.InternalServer("recovery", fmt.Sprintf("panic triggered: %v", err))
return errors.InternalServer("", "recovery", fmt.Sprintf("panic triggered: %v", err))
},
}
for _, o := range opts {

14
middleware/status/status.go
View File

@@ -14,8 +14,6 @@ import (
"google.golang.org/grpc/status"
)
type domainKey struct{}
// HandlerFunc is middleware error handler.
type HandlerFunc func(context.Context, error) error
@@ -23,17 +21,9 @@ type HandlerFunc func(context.Context, error) error
type Option func(*options)
type options struct {
domain string
handler HandlerFunc
}
// WithDomain with service domain.
func WithDomain(domain string) Option {
return func(o *options) {
o.domain = domain
}
}
// WithHandler with status handler.
func WithHandler(h HandlerFunc) Option {
return func(o *options) {
@@ -53,7 +43,6 @@ func Server(opts ...Option) middleware.Middleware {
return func(ctx context.Context, req interface{}) (interface{}, error) {
reply, err := handler(ctx, req)
if err != nil {
ctx = context.WithValue(ctx, domainKey{}, options.domain)
return nil, options.handler(ctx, err)
}
return reply, nil
@@ -82,9 +71,6 @@ func Client(opts ...Option) middleware.Middleware {
func encodeErr(ctx context.Context, err error) error {
se := errors.FromError(err)
if se.Domain == "" {
se.Domain, _ = ctx.Value(domainKey{}).(string)
}
gs := status.Newf(httpToGRPCCode(se.Code), "%s: %s", se.Reason, se.Message)
details := []proto.Message{
&errdetails.ErrorInfo{

2
middleware/status/status_test.go
View File

@@ -10,7 +10,7 @@ import (
)
func TestErrEncoder(t *testing.T) {
err := errors.BadRequest("InvalidArgument", "format")
err := errors.BadRequest("test", "invalid_argument", "format")
en := encodeErr(context.Background(), err)
if code := status.Code(en); code != codes.InvalidArgument {
t.Errorf("expected %d got %d", codes.InvalidArgument, code)

4
middleware/validate/validate.go
View File

@@ -12,12 +12,12 @@ type validator interface {
}
// Validator is a validator middleware.
func Validator() middleware.Middleware {
func Validator(domain string) middleware.Middleware {
return func(handler middleware.Handler) middleware.Handler {
return func(ctx context.Context, req interface{}) (reply interface{}, err error) {
if v, ok := req.(validator); ok {
if err := v.Validate(); err != nil {
return nil, errors.BadRequest("validator", err.Error())
return nil, errors.BadRequest(domain, "validator", err.Error())
}
}
return handler(ctx, req)

2
transport/grpc/client.go
View File

@@ -6,7 +6,6 @@ import (
"github.com/go-kratos/kratos/v2/middleware"
"github.com/go-kratos/kratos/v2/middleware/recovery"
"github.com/go-kratos/kratos/v2/middleware/status"
"github.com/go-kratos/kratos/v2/registry"
"github.com/go-kratos/kratos/v2/transport"
"github.com/go-kratos/kratos/v2/transport/grpc/resolver/discovery"
@@ -77,7 +76,6 @@ func dial(ctx context.Context, insecure bool, opts ...ClientOption) (*grpc.Clien
timeout: 500 * time.Millisecond,
middleware: middleware.Chain(
recovery.Recovery(),
status.Client(),
),
}
for _, o := range opts {

2
transport/grpc/server.go
View File

@@ -10,7 +10,6 @@ import (
"github.com/go-kratos/kratos/v2/log"
"github.com/go-kratos/kratos/v2/middleware"
"github.com/go-kratos/kratos/v2/middleware/recovery"
"github.com/go-kratos/kratos/v2/middleware/status"
"github.com/go-kratos/kratos/v2/transport"
"google.golang.org/grpc"
@@ -86,7 +85,6 @@ func NewServer(opts ...ServerOption) *Server {
log: log.NewHelper(loggerName, log.DefaultLogger),
middleware: middleware.Chain(
recovery.Recovery(),
status.Server(),
),
}
for _, o := range opts {