开源云 IDE 产品新宠儿,如何使用 Gitpod 开发 API 网关 Apache APISIX?

钱勇

更新时间 3/3/2022

随着云原生浪潮的来临,软件开发流程中的各个环节都在发生变革,其中有一个非常热门的方向就是“云 IDE”。所谓“云 IDE”就是使用云端的计算资源作为开发环境,进行软件项目的开发。

这种开发模式对于开发者来说有很多好处,例如:

  • 计算资源予取予求,不会因为硬件限制影响开发效率;
  • 开发环境标准化,每个项目的开发环境可能有很多软件依赖,这些依赖可以通过 Docker 镜像的形式进行标准化;
  • 快速为每个项目启动或摧毁一个开发环境,避免多个项目并行开发时存在依赖冲突等问题;
  • 纯粹的 Linux 环境。对于服务端开发同学来说,MacOS 和 Windows 的依赖问题往往比开发项目代码还要困难;

目前最流行的两种 IDE,非 JetBrains 系和 VSCode 莫属,而这两种广受欢迎的开发工具都有相关的云产品面世,可见很多开发者看好“云 IDE”这个方向。

Apache APISIX 是一个动态、实时、高性能的 API 网关,提供负载均衡、动态上游、灰度发布、服务熔断、身份认证、可观测性等丰富的流量管理功能。

Apache APISIX 作为开源的云原生 API 网关,如何快速的部署 APISIX 的开发环境对于开发者是比较重要的。本文将为大家介绍如何使用 Gitpod 对 Apache APISIX 进行相关开发。

安装 Gitpod Chrome 插件

Gitpod 为三个主流代码托管服务 GitLab、GitHub 和 Bitbucket 提供了一键启动功能,您只需要安装 Chrome 插件即可进行后续使用。

安装完成后,这个插件会在代码仓库页面注入一个启动按钮,以 GitHub 为例。安装插件后打开 APISIX 项目地址,可以看到相关按钮:

error/github example.png

单击 Gitpod 按钮会跳转到 Gitpod 的页面,完成 GitHub 应用授权后,进入以下界面:

erro/gitpod UI.png

是不是非常熟悉? 对,这就是时下最流行的代码编辑器 VSCode。

为了实现 VSCode 客户端与服务端分离的架构,Gitpod 维护一个 VSCode 的分支。作为一个云上的 VSCode ,它与桌面版的功能一致。我们在本地开发时常用的插件一样可以在云上使用,与本地不同的是,云上的 VSCode 有着服务器级别的计算资源和网络环境。

使用 Gitpod 搭建 APISIX 开发环境

步骤一:执行测试用例

相信很多刚接触开源的同学,都为如何搭建开源项目的开发环境感到过困扰,因为开源项目往往都会存在大量自动化执行的测试用例来保证整个项目的质量,所以如何在开发者在本地运行这些测试用例,可能是我们遇到的第一个问题,这一点和企业内的开发可能有比较大的差异。

下面我们尝试在 Gitpod 中运行 APISIX 的测试用例,这里可以参考 APISIX 仓库中的 github workflow 配置依赖。在 Gitpod 的终端中执行如下步骤:

1# 启动CI依赖的组件
2make ci-env-up project_compose_ci=ci/pod/docker-compose.common.yml
3
4# 安装编译依赖
5sudo apt install -y cpanminus build-essential libncurses5-dev libreadline-dev libssl-dev perl libpcre3 libpcre3-dev libldap2-dev
6
7# 进行编译和执行测试用例
8sudo OPENRESTY_VERSION=default ./ci/linux_openresty_1_17_runner.sh do_install
9sudo ./ci/linux_openresty_1_17_runner.sh script

整个过程会非常流畅,因为这里有一个隐藏的优势:Gitpod 运行环境是在国外的,所以下载各种依赖的速度会非常的快,不会遇到网络问题。

步骤二:访问 HTTP 服务

那么对于项目中启动的 HTTP 服务(例如 APISIX)我们要如何访问呢?

通过终端访问自然是可以的,但如果你想要通过页面访问,也可以通过 Remote Explorer 将打开的端口暴露到公网上, 如下图所示:

error/access page example.png

然后再通过单击端口右侧的浏览器图标,Gitpod 会自动打开一个链接,就可以访问到这个端口对应的服务了。

常见问题汇总

浏览器端体验

在浏览器中使用 Gitpod 有一个很大的问题是,很多 VSCode 的快捷键会被浏览器捕获,导致无法执行对应的操作,这时我们就可以使用 VSCode 的 Gitpod 插件来实现更加原生的编码体验。

具体方法如下:

  1. 在 VSCode 的插件市场,安装 Gitpod 插件。

error/install gitpod plugin.png

  1. 在浏览器的 Gitpod 页面单击 Gitpod: Open in VS Code 就可以实现拉起本地的 VSCode 作为客户端连接到云端的 Gitpod ,达到与桌面版相同效果的编码体验。

error/open in vs code.png

私有化部署

前面我们提到 Gitpod 是一款开源产品,所以是完全可以在组织内部进行私有化部署服务的,这样就可以在私有代码仓库中使用上这款优秀的开发工具。具体部署方式可以参考 Gitpod 的官方文档和仓库

总结

Gitpod 的优点是可以让开发者快速上手一个项目,这一点非常符合开源社区的需求。因为开源项目往往会给刚刚接触开源的开发者一种神秘莫测的感觉,让人望而却步,但真正接触后你会发现并不如此。

希望通过本文的介绍和描述,可以让每一个对开源项目感兴趣的开发者借助开源工具加持下,都能更加轻松得加入到开源社区中去,让开源的生态持续繁荣。