【实践】 基于proto生成对应http的client和server代码， 类似grpc的代码生成功能

背景

当你开发grpc服务久了， 再去开发http服务的时候， 你会明显发现， 开发http的时候没有那么方便？

你需要注册http路由，编写对应的handler来处理， 也最多就基于某个web框架，比如： gin， 来写一大堆web服务的初始代码，很难受！！！

而且，一般情况， 接口的req和resp也是通过proto来定义的，到那时使用proto的功能也仅限于.pb.go文件生成的功能， 完全没有像使用grpc那么方便和强大。

想想写grpc的时候， 这些初始化代码是自动生成的（包括： server端和client端代码），你只需要定义对应的proto文件即可， 然后，client引用对应生成的client端代码就能很方便的创建一个client出来。

执行的命令如下：

API_PROTO_FILES=$(find ./api -name *.proto)


go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
go install github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc@latest

mkdir -p ./api/docs && protoc --proto_path=./api \
	       --proto_path=./third_party \
 	       --go_out=paths=source_relative:./api \
		   --go-grpc_out=paths=source_relative:./api \
		   --doc_out=./api/docs \
		   --doc_opt=html,api.html,source_relative \
	       ${API_PROTO_FILES}

那有没有一个类似的工具，在写http服务的时候，也能通过代码生成的方式获得对应的server和client呢？

之前在B站，就有类似的工具， 当时没太注意，现在回过头来仔细思考一番，这个工具应该挺常用的，为啥不用？

此工具传送门： protoc-gen-go-http，

这个工具最大的问题在于， 如果要比较好的用起来， 那推荐你的服务都用这个微服务框架 kratos 来创建， 要多方便有多方便。该工具不依赖外部web服务框架，代码都集成到了一起，功能全由自己维护了， 重新复制了一份，与原开源版本完全隔离开了。

但是，相信很多现有的项目不太会轻易重新更换项目结构， 嫌麻烦呗！！

问题来了： 我能不能只用http那部分代码生成功能呢？

我简单试了一下，应该是可以。 我把这个功能依赖的部分代码单独抽取出来了

生成http代码的protoc插件代码如下： protoc-gen-go-http-gin

这是一个基于gin的web服务代码生成工具

生成的http的server和client的代码：greeter_http.pb.go， 该代码类似grpc插件生成的代码： greeter_grpc.pb.go。

添加http代码生成插件，执行的命令如下：

API_PROTO_FILES=$(find ./api -name *.proto)


go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
go install github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc@latest

mkdir -p ./api/docs && protoc --proto_path=./api \
	       --proto_path=./third_party \
 	       --go_out=paths=source_relative:./api \
		   --go-grpc_out=paths=source_relative:./api \
           --go-http_out=paths=source_relative:./api \
		   --doc_out=./api/docs \
		   --doc_opt=html,api.html,source_relative \
	       ${API_PROTO_FILES}

再进一步，可以写个 makefile 来管理上面的命令，后续开发中，就只管在 proto 中写接口的定义，以及实现对应接口功能的 service 就好了

最后： make 一下，HTTP 接口路由就注册了，对应生成的 client 代码也就有了新接口的调用方式，是不是和 grpc 的使用体验一样（这个应该就是参考 grpc 的思路来的），参考不可怕，可怕的是没这个想法😱 

凭什么 grpc 可以，HTTP 不行，不都是基于 proto 吗

Enjoy ~