微服務遠端Debug,Nocalhost + Rainbond微服務開發第二彈

2022-07-07 18:01:09

之前的文章中我們介紹瞭如何通過 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 (開發設定)

  1. 將以下組態檔複製到 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 讓開發、部署更加高效、便捷。