IDEA使用docker進行調試

背景

手頭有個任務，需要用java通過jni調用一個開源算法庫gmssl的功能，但是gmssl只提供了源碼，需要編譯后才能使用。按照通常的做法，我們會部署好centos的虛擬機和開發環境，安裝好gmssl的依賴環境，然后再基於這個部署好的開發環境進行開發和調試。

這樣的做法，會在開發和部署過程中會出現一些問題：

• 對虛擬機做的改動，沒有效記錄
• 虛擬機的體積過大，保存麻煩
• 在生成環境中，需要重新編譯部署，比較麻煩

為了解決上面提到的問題，通過引入docker，並支持快速調試。主要思路如下：

• 使用Dockerfile部署開發環境
• 在進程的啟動腳本中，加入遠程調試的指令
• IDEA配置遠程調試的環境
• IDEA在執行遠程調試前，通過maven對Dockerfile生成docker鏡像並進行部署
• docker鏡像部署完成后，IDEA能夠連接到鏡像中，進行調試

操作步驟

Dockerfile內容

#build docker build -t 10.10.8.166:5000/gmssl .

FROM 10.10.8.166:5000/centos-java:latest

RUN yum -y update
RUN yum install -y unzip
RUN yum install -y gcc
RUN yum install -y openssl-devel
RUN yum install -y perl

RUN wget https://codeload.github.com/guanzhi/GmSSL/zip/2.0
RUN unzip 2.0
RUN rm -rf 2.0

WORKDIR "/GmSSL-2.0"
RUN ./config
RUN make && make install

ADD maven/test-1.0-SNAPSHOT.jar /opt/test.jar
ADD maven/startup.sh /opt/startup.sh
RUN chmod +x /opt/startup.sh

WORKDIR "/opt"
EXPOSE "5005"
ENTRYPOINT ["/opt/startup.sh"]    

Pom配置

使用docker-maven-plugin，對docker文件進行打包、發布處理

<plugin>
    <groupId>io.fabric8</groupId>
    <artifactId>docker-maven-plugin</artifactId>
    <version>0.15.16</version>
    <executions>
        <execution>
            <id>package</id>
            <phase>package</phase>
            <goals>
                <goal>build</goal>
            </goals>
        </execution>
        <execution>
            <id>deploy</id>
            <phase>deploy</phase>
            <goals>
                <goal>build</goal>
                <goal>push</goal>
            </goals>
        </execution>
    </executions>
    <configuration>
        <verbose>true</verbose>
        <machine>
            <name>default</name>
            <autoCreate>true</autoCreate>
            <createOptions>
                <driver>virtualbox</driver>
            </createOptions>
        </machine>
        <images>
            <image>
                <!-- Artifact Image-->
                <name>10.10.8.166:5000/gmssl:${project.version}</name>
                <run>
                    <ports>
                        <port>5005:5005</port>
                    </ports>
                </run>
                <build>
                    <dockerFileDir>${project.basedir}/docker</dockerFileDir>
                    <assembly>
                        <mode>dir</mode>
                        <inline>
                            <id>gmssl-it</id>
                            <fileSets>
                                <fileSet>
                                    <includes>
                                        <include>*.jar</include>
                                    </includes>
                                    <directory>${project.build.directory}</directory>
                                    <outputDirectory>/</outputDirectory>
                                </fileSet>
                                <fileSet>
                                    <includes>
                                        <include>*.sh</include>
                                    </includes>
                                    <directory>${project.build.directory}/classes</directory>
                                    <outputDirectory>/</outputDirectory>
                                </fileSet>
                            </fileSets>
                        </inline>
                    </assembly>
                </build>
            </image>
        </images>
    </configuration>
</plugin>

遠程調試配置

為了保證鏡像保持最新，需要將before launch設置為：

• mvn package
• mvn docker:stop
• mvn docker:start

執行mvn docker:stop的目的是為了能夠在啟動前，將之前運行的鏡像刪除。

startup腳本配置

在startup腳本中，加入遠程調試的腳本

#!/bin/bash
java -agentlib:jdwp=transport=dt_socket,address=5005,suspend=y,server=y -cp /opt/*:/opt Main

改進

• 遠程調試的配置修改為mvn package docker:stop docker:start進行加速
• 遠程調試結束后，停止運行鏡像