B站微服务框架Kratos详细教程（2）- HTTP服务

背景在像微服务这样的分布式架构中，经常会有一些需求需要你调用多个服务，但是还需要确保服务的安全性、统一化每次的请求日志或者追踪用户完整的行为等等。你可能需要一个框架来帮助你实现这些功能。比如说帮你在一些关键路径的请求上配置必要的鉴权或超时策略。那样服务间的调用会被多层中间件所过滤并检查，确保整体服务的稳定性。设计目标性能优异，不应该掺杂太多业务逻辑的成分方便开发使用，开发对接的成本应该尽可能地

IM魂影

5720人浏览 · 2020-09-07 21:54:49

IM魂影 · 2020-09-07 21:54:49 发布

背景

在像微服务这样的分布式架构中，经常会有一些需求需要你调用多个服务，但是还需要确保服务的安全性、统一化每次的请求日志或者追踪用户完整的行为等等。
你可能需要一个框架来帮助你实现这些功能。比如说帮你在一些关键路径的请求上配置必要的鉴权或超时策略。那样服务间的调用会被多层中间件所过滤并检查，确保整体服务的稳定性。

设计目标

性能优异，不应该掺杂太多业务逻辑的成分
方便开发使用，开发对接的成本应该尽可能地小
后续鉴权、认证等业务逻辑的模块应该可以通过业务模块的开发接入该框架内
默认配置已经是 production ready 的配置，减少开发与线上环境的差异性

kratos的http服务架构-blademaster

blademaster设计的整套HTTP框架参考了gin，去除 gin 中不需要的部分逻辑。
blademaster由几个非常精简的内部模块组成。其中Router用于根据请求的路径分发请求，Context包含了一个完整的请求信息，Handler则负责处理传入的Context，Handlers为一个列表，一个串一个地执行。
所有的middlerware均以Handler的形式存在，这样可以保证blademaster自身足够精简且扩展性足够强。

bladmaster架构

blademaster处理请求的模式非常简单，大部分的逻辑都被封装在了各种Handler中。一般而言，业务逻辑作为最后一个Handler。

正常情况下每个Handler按照顺序一个一个串行地执行下去，但是Handler中也可以中断整个处理流程，直接输出Response。这种模式常被用于校验登陆的middleware中：一旦发现请求不合法，直接响应拒绝。

请求处理的流程中也可以使用Render来辅助渲染Response，比如对于不同的请求需要响应不同的数据格式JSON、XML，此时可以使用不同的Render来简化逻辑。

快速开始

创建http项目：

kratos new httpdemo --http

可以指定名字和目录：

kratos new kratos-demo -o YourName -d YourPath

创建http项目
创建项目成功后，进入 internal/server/http 目录下，默认生成的 server.go 模板：

package http

import (
	"net/http"

	pb "httpdemo/api"
	"httpdemo/internal/model"
	"github.com/go-kratos/kratos/pkg/conf/paladin"
	"github.com/go-kratos/kratos/pkg/log"
	bm "github.com/go-kratos/kratos/pkg/net/http/blademaster"
)

var svc pb.DemoServer

// New new a bm server.
func New(s pb.DemoServer) (engine *bm.Engine, err error) {
	var (
		cfg bm.ServerConfig
		ct paladin.TOML
	)
	if err = paladin.Get("http.toml").Unmarshal(&ct); err != nil {
		return
	}
	if err = ct.Get("Server").UnmarshalTOML(&cfg); err != nil {
		return
	}
	svc = s
	engine = bm.DefaultServer(&cfg)
	pb.RegisterDemoBMServer(engine, s)
	initRouter(engine)
	err = engine.Start()
	return
}
//路由
func initRouter(e *bm.Engine) {
	e.Ping(ping)  // engine自带的"/ping"接口，用于负载均衡检测服务健康状态
	g := e.Group("/httpdemo") // // e.Group 创建一组 "/httpdemo" 起始的路由组
	{
		g.GET("/start", howToStart) // // g.GET 创建一个 "httpdemo/start" 的路由，使用GET方式请求，默认处理Handle r为howToStart方法
	}
}
//engine自带Ping方法，用于设置 /ping 路由的handler，该路由统一提供于负载均衡服务做健康检测。服务是否健康，可自 定义 ping handler 进行逻辑判断，如检测DB是否正常等。
func ping(ctx *bm.Context) {
	if _, err := svc.Ping(ctx, nil); err != nil {
		log.Error("ping error(%v)", err)
		ctx.AbortWithStatus(http.StatusServiceUnavailable)
	}
}

// bm的handler方法.
func howToStart(c *bm.Context) {
	k := &model.Kratos{
		Hello: "Golang 大法好 !!!",
	}
	c.JSON(k, nil)
}

默认路由

默认路由有：

/metrics 用于prometheus信息采集
/metadata 可以查看所有注册的路由信息

打开浏览器访问：

http://localhost:8000/metadata

查看已注册路由信息

{
    "code": 0,
    "message": "0",
    "ttl": 1,
    "data": {
        "/debug/pprof/": {
            "method": "GET"
        },
        "/debug/pprof/allocs": {
            "method": "GET"
        },
        "/debug/pprof/block": {
            "method": "GET"
        },
        "/debug/pprof/cmdline": {
            "method": "GET"
        },
        "/debug/pprof/goroutine": {
            "method": "GET"
        },
        "/debug/pprof/heap": {
            "method": "GET"
        },
        "/debug/pprof/mutex": {
            "method": "GET"
        },
        "/debug/pprof/profile": {
            "method": "GET"
        },
        "/debug/pprof/symbol": {
            "method": "GET"
        },
        "/debug/pprof/threadcreate": {
            "method": "GET"
        },
        "/debug/pprof/trace": {
            "method": "GET"
        },
        "/demo.service.v1.Demo/Ping": {
            "method": "GET"
        },
        "/demo.service.v1.Demo/SayHello": {
            "method": "GET"
        },
        "/demo/say_hello": {
            "method": "GET"
        },
        "/httpdemo/param1/:name": {
            "method": "GET"
        },
        "/httpdemo/param2/:name/:gender/:say": {
            "method": "GET"
        },
        "/httpdemo/param3/:name/*action": {
            "method": "GET"
        },
        "/httpdemo/start": {
            "method": "GET"
        },
        "/metadata": {
            "method": "GET"
        },
        "/metrics": {
            "method": "GET"
        },
        "/ping": {
            "method": "GET"
        }
    }
}

路径参数

我们在路由中增加一些内容，增加一个handler方法showParam：


func initRouter(e *bm.Engine) {
	e.Ping(ping)
	g := e.Group("/httpdemo")
	{
		g.GET("/start", howToStart)

		// 路径参数有两个特殊符号":"和"*"
		// ":" 跟在"/"后面为参数的key，匹配两个/中间的值 或 一个/到结尾(其中不再包含/)的值
		// "*" 跟在"/"后面为参数的key，匹配从 /*开始到结尾的所有值，所有*必须写在最后且无法多个

		// NOTE：这是不被允许的，会和 /start 冲突
		// g.GET("/:xxx")

		// NOTE: 可以拿到一个key为name的参数。注意只能匹配到/param1/soul，无法匹配/param1/soul/hao(该路径会404)
		g.GET("/param1/:name", showParam)
		// NOTE: 可以拿到多个key参数。注意只能匹配到/param2/soul/male/hello，无法匹配/param2/soul或/param2/soul/hello
		g.GET("/param2/:name/:gender/:say", showParam)
		// NOTE: 可以拿到一个key为name的参数 和 一个key为action的路径。
		// NOTE: 如/params3/soul/hello，action的值为"/hello"
		// NOTE: 如/params3/soul/hello/hi，action的值为"/hello/hi"
		// NOTE: 如/params3/soul/hello/hi/，action的值为"/hello/hi/"
		g.GET("/param3/:name/*action", showParam)
	}
}

func showParam(c *bm.Context) {
	name, _ := c.Params.Get("name")
	gender, _ := c.Params.Get("gender")
	say, _ := c.Params.Get("say")
	action, _ := c.Params.Get("action")
	path := c.RoutePath // NOTE: 获取注册的路由原始地址，如: /httpdemo/param1/:name
	c.JSONMap(map[string]interface{}{
		"name":   name,
		"gender":  gender,
		"say":  say,
		"action": action,
		"path":   path,
	}, nil)
}

打开浏览器访问：

http://localhost:8000/httpdemo/param2/Soul/male/hello

输出内容：

{
    "action": "",
    "code": 0,
    "gender": "male",
    "message": "0",
    "name": "Soul",
    "path": "/httpdemo/param2/:name/:gender/:say",
    "say": "hello"
}

Context

以下是 blademaster 中 Context 对象结构体声明的代码片段：

// Context is the most important part. It allows us to pass variables between
// middleware, manage the flow, validate the JSON of a request and render a
// JSON response for example.
type Context struct {
    context.Context 	//嵌入一个标准库中的 Context实例，对应bm中的 Context，也是通过该实例来实现标准库中的 Context 接口
 
    Request *http.Request 	//获取当前请求信息
    Writer  http.ResponseWriter		//输出响应请求信息
 
    // flow control
    index    int8 	//标记当前正在执行的 handler 的索引位
    handlers []HandlerFunc 	//中存储了当前请求需要执行的所有 handler
 
    // Keys is a key/value pair exclusively for the context of each request.
    Keys map[string]interface{} 	//在 handler 之间传递一些额外的信息
 
    Error error 	//存储整个请求处理过程中的错误
 
    method string 	//检查当前请求的 Method 是否与预定义的相匹配
    engine *Engine 	//指向当前 blademaster 的 Engine 实例
}

首先 blademaster 的 Context 结构体中会嵌入一个标准库中的 Context 实例，bm 中的 Context 也是通过该实例来实现标准库中的 Context 接口。
blademaster 会使用配置的 server timeout (默认1s) 作为一次请求整个过程中的超时时间，使用该context调用dao做数据库、缓存操作查询时均会将该超时时间传递下去，一旦抵达deadline，后续相关操作均会返回context deadline exceeded。
Request 和 Writer 字段用于获取当前请求的与输出响应。
index 和 handlers 用于 handler 的流程控制；handlers 中存储了当前请求需要执行的所有 handler，index 用于标记当前正在执行的 handler 的索引位。
Keys 用于在 handler 之间传递一些额外的信息。
Error 用于存储整个请求处理过程中的错误。
method 用于检查当前请求的 Method 是否与预定义的相匹配。
engine 字段指向当前 blademaster 的 Engine 实例。

以下为 Context 中所有的公开的方法：

// 用于 Handler 的流程控制
func (c *Context) Abort()
func (c *Context) AbortWithStatus(code int)
func (c *Context) Bytes(code int, contentType string, data ...[]byte)
func (c *Context) IsAborted() bool
func (c *Context) Next()
 
// 用户获取或者传递请求的额外信息
func (c *Context) RemoteIP() (cip string)
func (c *Context) Set(key string, value interface{})
func (c *Context) Get(key string) (value interface{}, exists bool)
  
// 用于校验请求的 payload
func (c *Context) Bind(obj interface{}) error
func (c *Context) BindWith(obj interface{}, b binding.Binding) error
  
// 用于输出响应
func (c *Context) Render(code int, r render.Render)
func (c *Context) Redirect(code int, location string)
func (c *Context) Status(code int)
func (c *Context) String(code int, format string, values ...interface{})
func (c *Context) XML(data interface{}, err error)
func (c *Context) JSON(data interface{}, err error)
func (c *Context) JSONMap(data map[string]interface{}, err error)
func (c *Context) Protobuf(data proto.Message, err error)

所有方法基本上可以分为三类：

流程控制
额外信息传递
请求处理
响应处理

Handler

Handler处理流程
初次接触blademaster的用户可能会对其Handler的流程处理产生不小的疑惑，实际上bm对Handler对处理非常简单：

将Router模块中预先注册的middleware与其他Handler合并，放入Context的handlers字段，并将index字段置0
然后通过Next()方法一个个执行下去，部分middleware可能想要在过程中中断整个流程，此时可以使用Abort()方法提前结束处理
有些middleware还想在所有Handler执行完后再执行部分逻辑，此时可以在自身Handler中显式调用Next()方法，并将这些逻辑放在调用了Next()方法之后

性能分析

启动时默认监听了2333端口用于pprof信息采集，如：

go tool pprof http://127.0.0.1:8000/debug/pprof/profile

改变端口可以使用flag，如：-http.perf=tcp://0.0.0.0:12333

最后附上教程示例项目源码：

https://download.csdn.net/download/uisoul/12822504

向您推荐>>Eolink开发者社区

权威｜前沿｜技术｜干货｜国内首个API全生命周期开发者社区

更多推荐

ELK实现containerd的容器日志采集展示【基于logging的全栈监测】

企业级ELK Stack构建介绍

云原生

深入理解 Mocha 测试框架：从零实现一个 Mocha

前言什么是自动化测试自动化测试在很多团队中都是Devops环节中很难执行起来的一个环节，主要原因在于测试代码的编写工作很难抽象，99%的场景都需要和业务强绑定，而且写测试代码的编写工作量往往比编写实际业务代码的工作量更多。在一些很多业务场景中投入产出比很低，适合写自动化测试的应该是那些中长期业务以及一些诸如组件一样的基础库。自动化测试是个比较大的概念，其中分类也比较多，比如单元测试，端对端测试，集

云原生

(20200916 Solved)docker-compose up创建容器自动退出

问题描述如题，创建容器后自动退出了。并且docker start container无效解决方案原因是缺失了控制终端的配置，需要在docker-compose.yml中增加tty:true ，有时候这样也不行，需要再增加一个command:/bin/bash，命令不一定是这个，需要是一个不会退出的命令，然后用-d后台启动容器。Referencesdocker-compose启动容器后自动退出...

云原生

所有评论(0)

查看更多评论

IM魂影

@uisoul

已为社区贡献4条内容