Use Nocalhost to debug the application

之前的文章中我们介绍了如何通过 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 对应的组件。

Use Nocalhost to debug the application - 图1

Nocalhost 对接 Rainbond

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

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

  3. pig 命名空间下,找到工作负载 pig-auth 右击并选择 Dev Config (开发配置)

Use Nocalhost to debug the application - 图2

  1. 将以下配置文件复制到 Dev Config 中。
  1. # Deployment Name
  2. name: pig-auth
  3. serviceType: deployment
  4. containers:
  5. # Deployment 主容器名称
  6. - name: auth
  7. dev:
  8. # 开发镜像,该镜像包含了 Java Maven 环境
  9. image: registry.cn-hangzhou.aliyuncs.com/zqqq/maven:3.8.6-openjdk-8
  10. # 默认终端为 bash
  11. shell: bash
  12. # Rainbond 提供的 StorageClass Name
  13. storageClass: rainbondvolumerwx
  14. # 配置开发容器资源
  15. resources:
  16. limits:
  17. memory: 4096Mi
  18. cpu: "2"
  19. requests:
  20. memory: 2048Mi
  21. cpu: "1"
  22. persistentVolumeDirs:
  23. # Maven 依赖包缓存路径,配合 storageClass 一起食用
  24. - path: /root/.m2/repository
  25. capacity: 10Gi
  26. command:
  27. # 一键启动命令,安装依赖包和启动 pig-auth 子模块
  28. run:
  29. - mvn
  30. - install
  31. - '&&'
  32. - mvn
  33. - spring-boot:run
  34. - -pl
  35. # 指定子模块启动
  36. - pig-auth
  37. # 一键 Debug 命令,安装依赖包和 Debug pig-auth 子模块
  38. debug:
  39. - mvn
  40. - install
  41. - '&&'
  42. - mvn
  43. - spring-boot:run
  44. - -pl
  45. # 指定子模块启动
  46. - pig-auth
  47. # Java Debug 命令
  48. - -Dspring-boot.run.jvmArguments=-agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5005
  49. debug:
  50. # 远程端口,对应Debug命令中的 address=5005
  51. remoteDebugPort: 5005
  52. # 选择 Java 语言
  53. language: java
  54. # 热加载
  55. hotReload: true
  56. # 文件同步
  57. sync:
  58. type: send
  59. mode: gitIgnore
  60. deleteProtection: true
  61. # 端口转发,转发容器内的3000端口到本地3999
  62. portForward:
  63. - 3999:3000

一键 Run

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

Use Nocalhost to debug the application - 图3

一键 Debug

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

Use Nocalhost to debug the application - 图4

持久化配置

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

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

  1. storageClass: rainbondvolumerwx
  2. persistentVolumeDirs:
  3. - path: /root/.m2/repository
  4. capacity: 10Gi

Use Nocalhost to debug the application - 图5

容器资源限制

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

  1. resources:
  2. limits:
  3. memory: 4096Mi
  4. cpu: "2"
  5. requests:
  6. memory: 2048Mi
  7. cpu: "1"

端口转发

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

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

最后

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

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

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