go的 kratos的http自定义(响应)信息

  • /internal/server/http.go

自定义:响应格式、错误

go 复制代码
opts = append(opts, http.ResponseEncoder(responseEncoder))
opts = append(opts, http.ErrorEncoder(errorEncoder))
  • /internal/server/httpencoder.go

上面的:自定义内容,写在下面

go 复制代码
package server

import (
	"net/http"

	kratoshttp "github.com/go-kratos/kratos/v2/transport/http"
	karatosstatus "github.com/go-kratos/kratos/v2/transport/http/status"
	"google.golang.org/grpc/status"
)

type httpResponse struct {
	Code int `json:"code"`
	Msg string `json:"msg"`
	Data any `json:"data"`
}

func responseEncoder(w http.ResponseWriter, r *http.Request, v interface{}) error {
	if v == nil {
		return nil
	}
	if rd, ok := v.(kratoshttp.Redirector); ok {
		url, code := rd.Redirect()
		http.Redirect(w, r, url, code)
		return nil
	}
	codec, _ := kratoshttp.CodecForRequest(r, "Accept")

	res := &httpResponse{
		Code: http.StatusOK,
		Msg: "success",
		Data: v,
	}

	data, err := codec.Marshal(res)
	if err != nil {
		return err
	}
	w.Header().Set("Content-Type", "application/" + codec.Name())
	_, err = w.Write(data)
	if err != nil {
		return err
	}
	return nil
}


// ⾃自定义的错误响应编码器器
func errorEncoder(w http.ResponseWriter, r *http.Request, err error) {
	if err == nil {
		return
	}
	resp := new(httpResponse)
	// 能从err⾥里里⾯面解析出错误码的
	if gs, ok := status.FromError(err); ok {
		resp = &httpResponse{
			Code: karatosstatus.FromGRPCCode(gs.Code()),
			Msg: gs.Message(),
			Data: nil,
		}
	} else {
		resp = &httpResponse{
			Code: http.StatusInternalServerError, // 500
			Msg: "内部错误",
		}
	}
	codec, _ := kratoshttp.CodecForRequest(r, "Accept")
	body, err := codec.Marshal(resp)
	if err != nil {
		w.WriteHeader(http.StatusInternalServerError)
		return
	}
	w.Header().Set("Content-Type", "application/"+codec.Name())
	w.WriteHeader(resp.Code)
	_, _ = w.Write(body)
}
  • /api/bubble/v1/todo_error.proto

自定义状态码

①、安装依赖:go install github.com/go-kratos/kratos/cmd/protoc-gen-go-errors/v2@latest

②、定义好proto后,windows执行生成命令

protoc --proto_path=. --proto_path=./third_party --go_out=paths=source_relative:. --go-errors_out=paths=source_relative:. api/bubble/v1/todo_error.proto

go 复制代码
syntax = "proto3";
package api.bubble.v1;
import "errors/errors.proto";

option go_package = "bubble/api/bubble/v1;v1";
option java_multiple_files = true;
option java_package = "api.bubble.v1";

enum ErrorReason {
  // 设置缺省错误码
  option (errors.default_code) = 500;
  // 为某个枚举单独设置错误码
  TODO_NOT_FOUND = 0 [(errors.code) = 404];
  INVALID_PARAM = 1 [(errors.code) = 400];
}
相关推荐
Wang's Blog2 小时前
Go-Zero 项目开发19:基于 Kafka 的异步消息存储与转发实战
golang·kafka
小莫分享3 小时前
sshw:用交互搜索和 Web 配置高效管理 SSH Server
linux·运维·golang·开源·ssh
名字还没想好☜3 小时前
Go 结构体内存对齐:调整字段顺序,同样的字段省下 40% 内存
开发语言·后端·golang·go·内存对齐
FfHUCisI3 小时前
sync.Mutex 互斥锁
golang
牛奔12 小时前
Go 如何打印调试深层或嵌套的结构体
开发语言·后端·golang
geovindu13 小时前
go: Iterative Algorithms
开发语言·后端·算法·golang·迭代算法
kite012114 小时前
Go语言Map深度解析与最佳实践
开发语言·后端·golang
Wang's Blog1 天前
Go-Zero 项目开发21: 实现离线消息拉取与会话管理
开发语言·后端·golang
FfHUCisI1 天前
Golang学习-约瑟夫环问题(Josephus Problem)
开发语言·学习·golang
会编程的土豆1 天前
结构体 struct:用代码描述用户、订单、座位
数据库·mysql·golang