[系列] Go gRPC 调试工具
<p></p><div class="toc"><div class="toc-container-header">目录</div><ul><li>概述</li><li>写一个 gRPC API<ul><li><ul><li>启动服务</li></ul></li></ul></li><li>grpcui 使用<ul><li><ul><li>安装</li><li>运行</li></ul></li></ul></li><li>go-gin-api 系列文章</li></ul></div><p></p><h2 id="概述">概述</h2>
<p>最近这段时间工作挺忙的，发现已经 3 周没更文了...</p>
<p>感谢你们还在，今天给大家分享一款 gRPC 的调试工具。</p>
<p>进入正题。</p>
<p>当我们在写 HTTP 接口的时候，使用的是 Postman 进行接口调试，那么在写 gRPC 接口的时候，有没有类似于 Postman 的调试工具呢？</p>
<p><img src="https://img2018.cnblogs.com/blog/389840/201911/389840-20191109143303140-1026193203.png"></p>
<p>这是有的。</p>
<p>咱们一起看下 <code>grpcui</code>，源码地址：</p>
<p>https://github.com/fullstorydev/grpcui</p>
<p>看下官方描述：</p>
<blockquote>
<p>grpcui is a command-line tool that lets you interact with gRPC servers via a browser. It's sort of like Postman, but for gRPC APIs instead of REST.</p>
</blockquote>
<h2 id="写一个-grpc-api">写一个 gRPC API</h2>
<p>我原来写过 Demo，可以直接用原来写的 listen 项目。</p>
<p>端口：9901</p>
<p><code>.proto</code> 文件：</p>
<pre><code>syntax = "proto3"; // 指定 proto 版本
package listen; // 指定包名
// 定义服务
service Listen {
// 定义方法
rpc ListenData(Request) returns (Response) {}
}
// Request 请求结构
message Request {
string name = 1;
}
// Response 响应结构
message Response {
string message = 1;
}
</code></pre>
<p>很简单，这个大家一看就知道了。</p>
<ul>
<li>Service name 为 listen.Listen</li>
<li>Method name 为 ListenData</li>
</ul>
<p>再看下 ListenData 方法：</p>
<pre><code>func (l *ListenController) ListenData(ctx context.Context, in *listen.Request) (*listen.Response, error) {
return &listen.Response{Message : fmt.Sprintf("[%s]", in.Name)}, nil
}
</code></pre>
<p>这表示，将 <code>Name</code> 直接返回。</p>
<p>源码地址：</p>
<p>https://github.com/xinliangnote/go-jaeger-demo/tree/master/listen</p>
<h4 id="启动服务">启动服务</h4>
<pre><code>cd listen && go run main.go
</code></pre>
<p>服务启动成功后，等待使用。</p>
<h2 id="grpcui-使用">grpcui 使用</h2>
<h4 id="安装">安装</h4>
<p>根据官方 <code>README.md</code> 文档安装即可。</p>
<pre><code>go get github.com/fullstorydev/grpcui
go install github.com/fullstorydev/grpcui/cmd/grpcui
</code></pre>
<p>这时，在 <code>$GOPATH/bin</code> 目录下，生成一个 <code>grpcui</code> 可执行文件。</p>
<p>执行个命令，验证下：</p>
<pre><code>grpcui -help
</code></pre>
<p>输出：</p>
<pre><code>Usage:
grpcui
......
</code></pre>
<p>表示安装成功了。</p>
<h4 id="运行">运行</h4>
<pre><code>grpcui -plaintext 127.0.0.1:9901
Failed to compute set of methods to expose: server does not support the reflection API
</code></pre>
<p>这种情况下，加个反射就可以了，在 listen 的 main.go 新增如下代码即可：</p>
<pre><code>reflection.Register(s)
</code></pre>
<p>在运行一次试试：</p>
<pre><code>grpcui -plaintext 127.0.0.1:9901
gRPC Web UI available at http://127.0.0.1:63027/
</code></pre>
<p>在浏览器中访问：<code>http://127.0.0.1:63027/</code></p>
<p><img src="https://img2018.cnblogs.com/blog/389840/201911/389840-20191109143325708-1281464227.png"></p>
<p>到这，我们看到 Service name、Method name 都出来了，传输参数直接在页面上进行操作即可。</p>
<p>当发起 Request "Tom"，也能获得 Response “Tom”。</p>
<p>当然，如果这个服务下面有多个 Service name，多个 Method name 也都会显示出来的，去试试吧。</p>
<h2 id="go-gin-api-系列文章">go-gin-api 系列文章</h2>
<ul>
<li>7. 路由中间件 - 签名验证</li>
<li>6. 路由中间件 - Jaeger 链路追踪（实战篇）</li>
<li>5. 路由中间件 - Jaeger 链路追踪（理论篇）</li>
<li>4. 路由中间件 - 捕获异常</li>
<li>3. 路由中间件 - 日志记录</li>
<li>2. 规划项目目录和参数验证</li>
<li>1. 使用 go modules 初始化项目</li>
</ul>
</div>
<div id="MySignature" role="contentinfo">
<p style="text-align: center"><img src="https://img2020.cnblogs.com/blog/389840/202008/389840-20200822143814170-1389230174.png"></p>
<p style="border: #e7e7e7 1px solid; padding: 10px 10px; font-size: 12px; background-color: whitesmoke"><span style="margin-left: -14px">作者：新亮笔记（关注公众号，可申请添加微信好友）</span>
<br>
<span style="margin-left: 10px">出处：https://www.cnblogs.com/xinliangcoder</span>
<br>
<span style="margin-left: 10px; color: black">本文版权归作者和博客园共有，欢迎转载，但未经作者同意必须保留此段声明，且在文章页面明显位置给出原文连接，否则保留追究法律责任的权利。</span>
</p><br><br>
来源：https://www.cnblogs.com/xinliangcoder/p/11825748.html
頁:
[1]