Java擴展Nginx之四:遠程調試

程序員欣宸 發佈 2024-03-29T14:11:44.376366+00:00

歡迎訪問我的GitHub這裡分類和匯總了欣宸的全部原創(含配套源碼):https://github.

歡迎訪問我的GitHub

  • 這裡分類和匯總了欣宸的全部原創(含配套源碼):https://github.com/zq2599/blog_demos

本篇概覽

  • 本文是《java擴展nginx》系列的第四篇,一起來體驗個實用的功能,此能力定會讓愛學習的您大呼過癮,它就是廣大java程式設計師在日常開發和定位問題過程中常用的神技:遠程調試;
  • 看變量、看堆棧,不論閱讀代碼還是定位問題,打斷點都是我們最值得信賴的手段,當您的代碼運行在nginx-clojure模塊中的時候,如果能像tomcat那樣遠程打斷點,單步調試,會大幅度提高工作效率
  • 遠程斷點的效果如下圖所示,通過IDEA的Remote JVM Debug功能遠程連接到nginx-clojure監聽的遠程debug埠,當瀏覽器請求觸發了java代碼的執行時,就會進入斷點狀態,停留在斷點位置,可以看到堆棧和內存中的變量情況,以及單步執行:

關於工具

  • 本篇使用的編碼工具是IntelliJ IDEA 2021.3.2 (Ultimate Edition)
  • 關於代碼
    • 本篇直接使用《Java擴展Nginx之一:你好,nginx-clojure》中的工程和代碼,這裡簡單回顧如下,只有一個類:
package com.bolingcavalry.simplehello;

import nginx.clojure.java.ArrayMap;
import nginx.clojure.java.NginxJavaRingHandler;
import java.time.LocalDateTime;
import java.util.Map;
import static nginx.clojure.MiniConstants.CONTENT_TYPE;
import static nginx.clojure.MiniConstants.NGX_HTTP_OK;

public class HelloHandler implements NginxJavaRingHandler {

    @Override
    public Object[] invoke(Map<String, Object> request) {
        return new Object[] {
                NGX_HTTP_OK, //http status 200
                ArrayMap.create(CONTENT_TYPE, "text/plain"), //headers map
                "Hello, Nginx clojure! " + LocalDateTime.now()  //response body can be string, File or Array/Collection of them
        };
    }
}
  • 在nginx.conf中,配置了一個location,path是/java
location /java {
        content_handler_type 'java';
        content_handler_name 'com.bolingcavalry.simplehello.HelloHandler';
}
  • 以上就是今天要打斷點調試的代碼和配置了

nginx-clojure的遠程調試配置

  • 打開nginx.conf文件,在http的配置中增加以下兩行,即可開啟nginx-clojure的遠程調試:
jvm_options "-Xdebug";
jvm_options "-Xrunjdwp:server=y,transport=dt_socket,address=840#{pno},suspend=n";
  • 上述配置中,address=840#{pno}的含義要注意:
  1. 如果worker_processes配置的值等於1,address=840#{pno}表示遠程調試的埠是8401
  2. 如果worker_processes配置的值大於1,例如等於3,此時有3個java進程,每個進程都有一個埠被用於遠程調試,這三個埠分別是address=840#{pno}表示遠程調試的埠是840184028403
  • 要注意的是,請確保這些埠沒有被占用
  • 今天的實戰為了簡單省事兒,worker_processes的值等於1,所以只有一個java進程,它的遠程調試埠是8401
  • 配置完成後,啟動nginx
  • 用postman訪問/java,確認可以響應成功,證明nginx和nginx-clojure是正常的:

IDEA上的遠程調試操作

  • 用IDEA打開工程,點擊下圖紅框中的按鈕:
  • 操作如下圖,新增一個Remote JVM Debug配置:
  • Remote JVM Debug的設置如下,紅框1是nginx的ip地址,我這裡IDEA和nginx在同一台電腦上,所以用localhost即可,紅框2是埠號,對應nginx配置的jvm_options中的address=840#{pno}
  • 配置完成後,按照下圖紅框數字的順序操作,先在代碼上打斷點,然後執行遠程連接,順利的話會看到紅框3中的連接成功提示:
  • 至此,遠程調試功能已經準備好,可以使用了

驗證

  • 在postman上再發一次請求,IDEA上立即進入斷點狀態,如下圖:
  • 如果想看堆棧中的代碼,可以操作如下圖:
  • 此刻,NginxClojureRT.java已經被下載下來,可以更仔細的閱讀和研究nginx-clojure了:
  • 至此,nginx-clojure的遠程調試功能演示完畢,各位java同僚們,如虎添翼的感覺有沒有?學習和使用nginx-clojure的信心是否更強了呢?

歡迎關注頭條號:程式設計師欣宸

  • 學習路上,你不孤單,欣宸原創一路相伴...
關鍵字: