跳转至主要内容

All our posts

一篇博文 含有标签「rainbond」

查看所有标签

微服务远程Debug，Nocalhost + Rainbond微服务开发第二弹

Qi Zhang

Qi Zhang

Cloud Native Enthusiasts

之前的文章中我们介绍了如何通过 Nocalhost 快速开发 Rainbond 上的微服务，介绍了基本的开发流程。

本文将续接上文继续介绍，使用 Nocalhost 开发配置文件 实现以下内容：

  • 一键 Run 和 远程Debug
  • 持久化配置
  • 开发容器资源限制
  • 端口转发

什么是开发配置？

开发配置是围绕 开发模式 来进行的，例如使用什么镜像来进入 开发模式，是否需要开启持久化来保存开发容器的内容，将哪些文件同步到开发容器中，如何一键调试、一键运行容器内的服务等。 配置了正确且合适的开发配置后，可以在使用 Nocalhost 开发模式 时更加得心应手。

部署 Rainbond + SpringCloud#

接下来继续以上文中的 SpringCloud Pig 为例，调试 Java Maven 服务的 Pig-auth 模块。

项目 Gitee 地址：https://gitee.com/zhangbigqi/pig

部署 Rainbond#

这里就不详细介绍 Rainbond 的安装，请参阅 基于Linux安装Rainbond。

部署 SpringCloud#

我们在 Rainbond 内对接了开源应用商店后，在开源应用商店内搜索 Spring Cloud Pig 安装 3.5.0版本。

来自应用商店安装应用组件的英文名称是自动生成的字符串，需要我们设置一下组件的英文名称（Deployment Name），通过 Nocalhost 连接到集群时可以很直观的分清楚 Deployment 对应的组件。

Nocalhost 对接 Rainbond#

  1. 安装 Nocalhost JetBrains Plugin 插件，请参阅文档 安装Nocalhost JetBrains Plugin 插件。

  2. 获取 K8s Kubeconfig，请参阅文档 获取 Kubeconfig 文件。

  3. 在 pig 命名空间下，找到工作负载 pig-auth 右击并选择 Dev Config （开发配置）

  4. 将以下配置文件复制到 Dev Config 中。

# Deployment Name
name: pig-auth
serviceType: deployment
containers:
# Deployment 主容器名称
- name: auth
dev:
# 开发镜像，该镜像包含了 Java Maven 环境
image: registry.cn-hangzhou.aliyuncs.com/zqqq/maven:3.8.6-openjdk-8
# 默认终端为 bash
shell: bash
# Rainbond 提供的 StorageClass Name
storageClass: rainbondvolumerwx
# 配置开发容器资源
resources:
limits:
memory: 4096Mi
cpu: "2"
requests:
memory: 2048Mi
cpu: "1"
persistentVolumeDirs:
# Maven 依赖包缓存路径，配合 storageClass 一起食用
- path: /root/.m2/repository
capacity: 10Gi
command:
# 一键启动命令，安装依赖包和启动 pig-auth 子模块
run:
- mvn
- install
- '&&'
- mvn
- spring-boot:run
- -pl
# 指定子模块启动
- pig-auth
# 一键 Debug 命令，安装依赖包和 Debug pig-auth 子模块
debug:
- mvn
- install
- '&&'
- mvn
- spring-boot:run
- -pl
# 指定子模块启动
- pig-auth
# Java Debug 命令
- -Dspring-boot.run.jvmArguments=-agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5005
debug:
# 远程端口，对应Debug命令中的 address=5005
remoteDebugPort: 5005
# 选择 Java 语言
language: java
# 热加载
hotReload: true
# 文件同步
sync:
type: send
mode: gitIgnore
deleteProtection: true
# 端口转发，转发容器内的3000端口到本地3999
portForward:
- 3999:3000

一键 Run#

  1. 右击工作负载 pig-auth 。
  2. 选择 Remote Run。
  3. Nocalhost 会自动进入 DevMode 并执行 Remote Run。

一键 Debug#

  1. 右击工作负载 pig-auth 。
  2. 选择 Remote Debug。
  3. Nocalhost 会自动进入 DevMode 并执行 Remote Debug。
  4. 在代码中打上断点，发起请求，进入 IDE Debug 模式。

持久化配置#

在开发时，我们希望持久化的文件大多数都是 依赖包 日志，本篇文章中也是缓存了 Java 的依赖包。

rainbondvolumerwx 是 Rainbond 默认提供的存储类，填写以下配置后会在当前命名空间下自动创建 PVC，如下：

storageClass: rainbondvolumerwx
persistentVolumeDirs:
- path: /root/.m2/repository
capacity: 10Gi

容器资源限制#

限制开发容器的资源，限额能让服务器的资源利用最大化，可以通过以下开发配置修改：

resources:
limits:
memory: 4096Mi
cpu: "2"
requests:
memory: 2048Mi
cpu: "1"

端口转发#

转发容器端口到本地，可以通过以下开发配置修改：

portForward:
- 3999:3000 # 转发容器 3000 端口到本地 3999 端口

最后#

当然 Nocalhost 可以同时调试多个微服务，同样的方式只需修改配置文件中的 Deployment Name 和 Containers Name 以及微服务的子模块。

Nocalhost 还有一些开发配置文中没讲到的，比如：开发环境变量、文件同步的两种模式 pattern gitignore 等等，并且 Nocalhost 支持多种语言，Java 只是其中一种，小伙伴们可以自行探索。

Nocalhost + Rainbond 让开发、部署更加高效、便捷。

使用 Nocalhost 开发 Rainbond 上的微服务应用

Qi Zhang

Qi Zhang

Cloud Native Enthusiasts

本文将介绍如何使用 Nocalhost 快速开发 Rainbond 上的微服务应用的开发流程以及实践操作步骤。

Nocalhost 可以直接在 Kubernetes 中开发应用，Rainbond 可以快速部署微服务项目，无需编写Yaml，Nocalhost 结合 Rainbond 加速我们的微服务开发效率。

一. 简介#

Nocalhost 是一款开源的基于 IDE 的云原生应用开发工具：

  • 直接在 Kubernetes 集群中构建、测试和调试应用程序
  • 提供易于使用的 IDE 插件（支持 VS Code 和 JetBrains），即使在 Kubernetes 集群中进行开发和调试，使用 Nocalhost 之后也能够获得和本地开发一样的开发体验
  • 使用即时文件同步进行开发： 即时将您的代码更改同步到远端容器，而无需重建镜像或重新启动容器。

Rainbond 是一款云原生应用管理平台：

  • 使用简单，不需要懂容器、Kubernetes和底层复杂技术，支持管理多个Kubernetes集群，和管理企业应用全生命周期。主要功能包括应用开发环境、应用市场、微服务架构、应用交付、应用运维、应用级多云管理等。

二. 本地 + Rainbond 开发微服务#

在以往的开发模式中，我们在本地 + Rainbond 开发微服务时，要开发的模块我们运行在本地，其他模块运行在 Rainbond 上，我们通过 Rainbond 的网关与本地进行通信、联调。

这种场景下，我们有以下问题急需解决：

  • 多人协作开发联调困难
  • 本地环境差异化
  • 无法通过注册中心(Nacos)调用其他微服务
  • 远程Debug较难
  • 受限于本地资源

三. 使用 Nocalhost + Rainbond 开发微服务#

现在我们通过 Nocalhost + Rainbond 开发微服务时，所有服务都运行在 Rainbond 上，在开发过程中可以使用 VSCode 插件 Nocalhost 连接进入到 Rainbond 组件中，并将本地代码实时同步到 Rainbond 组件中。多人开发联调时，可通过 Rainbond 内置的 Service Mesh 进行服务之间调用。

使用 Nocalhost 开发，可以解决本地开发时遇到的问题：

  • 多人联调开发更便捷
  • 服务都运行在 Rainbond 上，不再受限于本地
  • 与生产环境更接近
  • 远程Debug
  • 通过注册中心(Nacos)调用其他微服务组件

四. 实践操作步骤#

Nocalhost 目前支持两种开发模式：

  • Replace DevMode
  • Duplicate DevMode

本篇将主要介绍 Replace DevMode，当进入 Replace DevMode 时，Nocalhost 会对 组件 执行以下操作:

  1. 将副本数缩减为 1
  2. 替换容器的镜像为开发镜像
  3. 增加一个 sidecar 容器。
  4. 转发一个本地端口到文件同步服务器。
  5. 启动本地文件同步客户端。
  6. 打开远程终端。

4.1 安装 Nocalhost 插件#

Nocalhost IDE 插件支持 VSCode JetBrains，这里我们主要介绍 VSCode 插件安装参考官网文档。

  1. 打开 VSCode，点击左侧的 Extension 按钮 img 图标
  2. 在搜索框中输入 Nocalhost 选择 Nocalhost 插件，并点击 Install 按钮

4.2 安装 Rainbond#

我们选择 基于主机安装 Rainbond

4.3 Nocalhost 对接 Rainbond 集群#

  1. 获取 kubeconfig 文件，进入 Rainbond 集群视图 -> 点击节点配置 -> kubeconfig

  1. 我们将 kubeconfig 文件复制到本地并保存为 yaml 文件。

  2. 打开 VSCode，点击按钮 ，打开 Nocalhost 插件，选择 Connect to Cluster，选择我们 kubeconfig 文件的路径，点击 Add Cluster，添加集群。

  3. 添加完成后，如下图：

4.4 在 Rainbond 上部署 Spring Cloud 应用#

  1. 这里选择从开源应用商店安装 Spring Cloud Pig 微服务组件，在应用商店中搜索 Pig 进行安装。

  2. 部署完成后，效果如下：

4.5 进入 Nocalhost 开发模式#

上面我们已经在本地 VSCode 中对接好了集群，并且也已经在 Rainbond 中安装了 Spring Cloud Pig 微服务，那么接下来我们在本地 VSCode 中选择其中一个组件进行开发，这里为了效果更明显，选择开发 pig-ui 组件。

Spring Cloud Pig 后端

Spring Cloud Pig 前端

4.5.1 克隆 Pig-ui 代码到本地#

git clone https://gitee.com/zhangbigqi/pig-ui

4.5.2 启动本地开发#

打开 VSCode，点击按钮 ，找到我们的 Pig-ui 组件，由于该应用是从开源应用商店中安装，Deployment名称是自动生成的字符串，我们需要在组件中查询下。

我们点击旁边的🔨进入开发模式，

  1. 提示选择容器，我们选择 gred5f1c 这个容器。 > 另外一个容器是 Rainbond 默认注入的 sidecar 容器，用于组件之间的内部通信。
  2. 提示指定源代码目录，选择我们刚刚克隆下来的代码目录。
  3. 等待片刻后，会默认打开远端容器的终端界面并且将本地项目的文件同步至容器内，如下：

4.5.3 启动项目#

  1. 安装项目依赖，执行
npm install
  1. 运行项目
npm run dev

启动后效果如下，容器内端口为 80

  1. 开启端口转发，点击按钮 ，找到我们的 Deployment，右键选择 Port Forward，Add Port Forward，输入 38000:80 将容器的80端口转发到本地的38000端口。
  1. 通过 http://localhost:38000 可以访问到页面，并且也可以正常登录。

4.5.4 修改代码查看效果#

上面已经演示了如果通过本地访问到远端容器内的服务，接下来我们修改代码看下效果。

修改 src/page/wel.vue，新增一段代码，保存。可以发现，当我们保存的时候，终端中就自动重启了，与本地开发效果一致。

文件的修改会实时同步到容器中。

刷新页面http://localhost:38000，可以看到修改的内容已生效。

写在最后#

通过以上的实践步骤，我们已经可以通过 Nocalhost 开发 Rainbond 上的微服务应用，进入云原生快速开发，提升我们的开发效率。

本文仅介绍了基本的开发，还可以为项目配置 Nocalhost开发配置 等等，小伙伴们可以自行探索。