一个更好的可视化微服务架构的方式

【编者的话】如何快速地可视化一个微服务架构，本文做者有一个很酷的办法，赶忙来看看吧！

【3 天烧脑式容器存储网络训练营 | 深圳站】本次培训以容器存储和网络为主题，包括：Docker Plugin、Docker storage driver、Docker Volume Pulgin、Kubernetes Storage机制、容器网络实现原理和模型、Docker网络实现、网络插件、Calico、Contiv Netplugin、开源企业级镜像仓库Harbor原理及实现等。

我一直在用draw.io作一些和UML流程图，图表或者曲线图相关的事情。它在丰富的功能和用户的手工控制方面作出了合理的权衡。

可是，接下来我会告诉你如何自动化一些无聊的鼠标点击;）

避免从一开始就犯错

Daniel Woods的 “Microservices: The Right Way” 演讲里其中一张幻灯片

若是它不是这样的话事情也不会变得这么有趣。事实上，这里最好能有一张更清晰地展示组件之间关系和职责的图片。否则的话最终结果就是像上面看到的这样 ;)

诀窍即是在作的时候不断审视它哪一个地方不对，这样一来便不太可能作的这么糟了。

在作图的时候 —— 你也在同时给本身一个总体的感受，它们将会怎么交互，问题域是什么，上下文，边界，等等。

"光纸上谈兵是没用的，长期的战略规划才是无价的。"
― Winston Churchill

行动起来！

假设咱们有一个简单的社交应用。固然，这是一个很简单的设定，可是你能够注意到这里面存在许多的关联关系。

客户端：前端应用和浏览器扩展。
API网管：认证API和主服务API。
微服务：照片，图表还有好友这些微服务。

我花了至关长的时间来排列方块，拖放箭头还有调整。而这只是由于我想要以一个更可读的方式来对齐它们。

你能够想象排列50个这样的方块有多无聊吗？100个呢？而后我若是再删除一个？我敢打赌你会放弃这件事情，而后选择回来继续码代码。

和 Graphviz 结缘

我从Terraform得到了灵感 —— 一个建立和维护生产环境基础设施的工具。它支持配置任意和基础设施相关的服务，这里面包含了从AWS EC2的实例到来自于50个云厂商提供的集群和负载均衡。它还提供了一个有趣的terraform graph命令，能够根据现有配置生成一个可视化的图表展示。

‘terraform graph’ 命令的示例输出

所以我决定采用相同的技巧，可是针对的是一个更高层面的微服务架构。如下是一个用DOT编写的Graphviz配置。

digraph architecture {
rankdir=LR;

subgraph client_side_apps {
front_end -> {auth_api, my_app_api};
extension -> {auth_api, my_app_api};

{rank=same; front_end, extension, auth_api};复制代码

}

subgraph api_gateways {
my_app_api -> {photos_ms, chats_ms, friends_ms};
}

subgraph microservices {
photos_ms -> {database};
chats_ms -> {database, cache};
friends_ms -> {database, facebook_api};
}
}

你只须要将它渲染成一个.png文件便可。你可使用在线编辑器或者直接在机器上渲染。为了避免弄脏系统，我为此建立了一个Docker镜像：

cat file.dot | docker container run --rm -i vladgolubev/dot2png > file.png
经过执行上述这行简单代码，两分钟内你即可以获得这样一个使人惊叹的输出结果！

提示：你能够将代码复制粘贴到一个在线的编辑器： dreampuf.github.io/GraphvizOnl…

在微服务之间添加一个新的依赖的想法实现起来从未如此简单。我须要作的只是添加一行新的代码，随即 Graphviz 会很好地将它们组织在一块儿。

做为最后的点睛之笔，我喜欢添加一些颜色。所以你立马能够看到下面的效果：

• 绿色 — node.js
• 红色 — api gateway
• 黄色 — front-end
• 蓝色 — storage，database
• 灰色 — 3rd-party API

这并非最优的颜色布局，可是你已经知道能够这样作了 ;)
相信我，有大量图表的状况也很容易作到这一点。

所有代码放在： gist.github.com/vladgolubev…

小结

我在给一张微服务架构图频繁添加修改时遇到了问题。每一次变动都要用箭头手工修补。现在我能够放心实验，看看新的微服务是如何适配个人系统。固然，你还能够作的更好，将它放到版本控制系统里，这样一来即可以获得架构图的修改变动历史！

可是这取决于你。选择一款最合适的工具吧。Google搜索微服务可视化的方案，你将会被一大票商业解决方案轰炸的。

可视化的设计会使得检查和调试变得更容易。
― Unix的基本哲学

原文连接：A Better Way of Visualizing Microservice Architecture （翻译：吴佳兴）