使用Jrebel+Docker+Idea远程热部署SpringBoot2.x项目并远程调试

忘是亡心i 2023-06-12 04:19 1阅读 0赞

### 目录 ###

*   *  所需工具
     *  配置Jrebel 开启热部署
     *   *  准备jrebel服务端所需的\`jrebel.jar\`和\`libjrebel64.so\`/\`libjrebel64.dylib\`文件
     *  在idea中配置Docker（使用idea操作docker）
     *  撰写和配置Dockerfile发布镜像并运行容器
     *  开启远程Debug，使用Idea链接远程服务debug端口进行调试
     *  使用idea开发代码并随时热部署到容器中
     *   *   *   *  \`PS:在这儿为了操作简单，因此我把mvn打包项目添加到了Before Launch中，同时我也建议您这么做，毕竟很简单嘛！\`
     *  测试
     *   *  测试jrebel的热部署
     *  如果有错误或不足的地方，请你多多留言指正。

## 所需工具 ##

1.  安装有Idea和Jrebel plugin的PC
2.  安装有Docker的机器

`PS: 经本人测试在MacOs 10.13、Idea 2019.2、Centos7、Jrebel 2019.2 、Docker18.06.3 上运行成功`

## 配置Jrebel 开启热部署 ##

1.  选择需要部署的项目类型，这里我选择了SpringBoot2.x。你也可以选择使用外置Tomcat容器之类的项目  
    ![选择部署项目类型][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4OTM2MzIw_size_16_color_FFFFFF_t_70]
2.  选择后如下图所示  
    ![选择SpringBoot2.x为例][SpringBoot2.x]

> `ps:以上两步操作的目的是为了可以明确看到不同方式部署项目所需要的额外命令行参数`

### 准备jrebel服务端所需的`jrebel.jar`和`libjrebel64.so`/`libjrebel64.dylib`文件 ###

1.  准备jrebel.jar  
    这个jar包是jrebel server端运行所需的，我这里为了简单起见，就直接使用idea 的jrebel plugin的了。这个jar的路径可以从idea的Preferences中查看，具体如下图：  
    ![jrebel.jar路径][jrebel.jar]
2.  拷贝这个jar到项目资源路径下并在.gitignore文件中添加\*\*/jrebel.jar  
    使用以上方式当然可行，但是我的做法是直接把它放到了远程静态资源中方便以后使用时通过网络直接获取。  
    `我这样做的目的是为了避免在接下来Docker为每个springCloud子工程打镜像时每次都需要复制这个jar到相应的目录`  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4OTM2MzIw_size_16_color_FFFFFF_t_70 1]
3.  拷贝libjrebel64.so到项目资源路径下并在.gitignore文件中添加\*\*/libjrebel64.so  
    这一步需要根据操作系统选择相应的文件，64位操作系统就选择*64结尾的，32位操作系统就选择*32结尾的；Linux选择.so后缀的，Mac选择.dylib结尾的，windows选择.dll结尾的  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4OTM2MzIw_size_16_color_FFFFFF_t_70 2]  
    同样地我也将libjrebel64.so放置到了服务器上。

--------------------

附上本人的地址：  
[jrebel.jar][jrebel.jar 1] *https://ali.scyuan.xyz/other/jrebel.jar*  
[libjrebel64.so][] *https://ali.scyuan.xyz/other/libjrebel64.so*

## 在idea中配置Docker（使用idea操作docker） ##

关于这一步的操作参见[CentOS7开启docker远程访问并在idea中连接使用][CentOS7_docker_idea]  
如果还没有安装docker可以参考[安装Docker和docker-compose的脚本][Docker_docker-compose]  
如果有问题请留言联系我，以便及时解决。

## 撰写和配置Dockerfile发布镜像并运行容器 ##

在这儿我选择了使用docker运行项目

1.  idea中配置如下  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4OTM2MzIw_size_16_color_FFFFFF_t_70 3]
2.  Dockerfile文件![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4OTM2MzIw_size_16_color_FFFFFF_t_70 4]

FROM openjdk:8-jre
    ENV SERVER_PORT=80
    ENV SPRING_CLOUD_CONFIG_LABEL=d2
    ENV SPRING_CLOUD_CONFIG_PROFILE=d2
    ENV EUREKA_URLS="eureka集群地址"
    VOLUME /logs/
    ADD target/app.jar /app.jar
    ADD https://ali.scyuan.xyz/other/libjrebel64.so  /libjrebel64.so
    ADD https://ali.scyuan.xyz/other/jrebel.jar  /jrebel.jar
    EXPOSE $SERVER_PORT
    ENTRYPOINT ["java",  "-jar", "-Xdebug", "-Xrunjdwp:server=y,transport=dt_socket,address=81,suspend=n","-agentpath:/libjrebel64.so","-Drebel.remoting_plugin=true", "-Djava.security.egd=file:/dev/./urandom", "/app.jar","--spring.cloud.config.label=${SPRING_CLOUD_CONFIG_LABEL}", 
    "--spring.cloud.config.profile=${SPRING_CLOUD_CONFIG_PROFILE}", "--server.port=${SERVER_PORT}",
     "--eureka.client.serviceUrl.defaultZone=${EUREKA_URLS}"]

*  `在这儿或许你会有疑问，为何我不将这两个文件打包为一个包，然后一起下载呢？`
 *  `原因是因为ADD命令从网络下载文件时并不会自动解包，然而可能某些container中并没有解包指令，我也懒得安装了，所以就直接分开为两个文件了。毕竟为了简单嘛！`

## 开启远程Debug，使用Idea链接远程服务debug端口进行调试 ##

只要在命令行中增加如下命令

-Xdebug -Xrunjdwp:server=y,transport=dt_socket,address=远程调试端口,suspend=n

`java -jar -Xdebug -Xrunjdwp:server=y,transport=dt_socket,address=远程调试端口,suspend=n app.jar`

## 使用idea开发代码并随时热部署到容器中 ##

1.  允许指定项目使用热部署，操作如图所示 ![标题][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4OTM2MzIw_size_16_color_FFFFFF_t_70 5]
2.  编写简单demo测试热部署，简简单单就好  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4OTM2MzIw_size_16_color_FFFFFF_t_70 6]
3.  在idea中配置docker打包并发布项目到容器中

##### `PS:在这儿为了操作简单，因此我把mvn打包项目添加到了Before Launch中，同时我也建议您这么做，毕竟很简单嘛！` #####

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4OTM2MzIw_size_16_color_FFFFFF_t_70 7]

1.  构建镜像并运行  
    ![构建镜像并运行容器][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4OTM2MzIw_size_16_color_FFFFFF_t_70 8]
2.  确保容器启动，项目启动成功如图

*  日志可以在docker容器的log选项中看到，也可以使用下列命令行查看日志

docker logs -f -t --tail 日志显示行数 container_name  # 滚动查看尾部n行日志
    docker logs -f container_name  # 滚动查看所有日志

*  如果container启动失败，可以进入容器内查看所需文件是否正确被打包：

docker run -it --rm [--name container_name] imgge[:tag] bash  # 交互模式进入容器
    ……  # 更多命令请自行查阅文档

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4OTM2MzIw_size_16_color_FFFFFF_t_70 9]  
6. 服务启动后需要配置jrebel客户端连接到jrebel server，保证可以向server端通信

*  添加server，并确保连接成功，即出现图中的 `Connection Successful.`  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4OTM2MzIw_size_16_color_FFFFFF_t_70 10]
 *  将项目与remote server绑定  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4OTM2MzIw_size_16_color_FFFFFF_t_70 11]

## 测试 ##

### 测试jrebel的热部署 ###

1.  首先确保服务的debug端口和服务端口处于被防火墙放行的状态
2.  访问服务接口确保正常访问  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4OTM2MzIw_size_16_color_FFFFFF_t_70 12]
3.  修改代码，并热部署  
    这一步操作中，一般在修改代码后，隔一段时间后jrebel就会自动检测到target下某些文件的修改并及时更新值远程项目中。  
    或者手动编译下项目，command+F9+fn/command+shift+F9+fn/ctrl+F9/ctrl+shift+F9+fn.  
    更新成功后jrebel console中会出现如下所示提示同步成功。再次访问时就已经变为最新内容了。  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4OTM2MzIw_size_16_color_FFFFFF_t_70 13]  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4OTM2MzIw_size_16_color_FFFFFF_t_70 14]
4.  测试远程调试

*  查看自己的dubug端口，区别于服务端口  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4OTM2MzIw_size_16_color_FFFFFF_t_70 15]
 *  在项目的Edit configurations中增加remote debug配置  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4OTM2MzIw_size_16_color_FFFFFF_t_70 16]
 *  与服务的debug建立连接  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4OTM2MzIw_size_16_color_FFFFFF_t_70 17]
 *  访问服务并打断点调试，具体怎么debug就不说了  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4OTM2MzIw_size_16_color_FFFFFF_t_70 18]

> 至此为止，恭喜已经成功地完成了所有步骤

## 如果有错误或不足的地方，请你多多留言指正。 ##

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4OTM2MzIw_size_16_color_FFFFFF_t_70]: /images/20230531/903f83871ea44d26ac1b2bbbece47449.png
[SpringBoot2.x]: /images/20230531/fbb46e43efd6418da00fb9b2ed3ca809.png
[jrebel.jar]: /images/20230531/13859ee40a4a41b99af63190e2af6422.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4OTM2MzIw_size_16_color_FFFFFF_t_70 1]: /images/20230531/743d1f15d3db4c888c8183df076320bc.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4OTM2MzIw_size_16_color_FFFFFF_t_70 2]: /images/20230531/164f422c6c2145ce818893f5fd44bef2.png
[jrebel.jar 1]: https://ali.scyuan.xyz/other/jrebel.jar
[libjrebel64.so]: https://ali.scyuan.xyz/other/libjrebel64.so
[CentOS7_docker_idea]: https://blog.csdn.net/qq_38936320/article/details/82932303
[Docker_docker-compose]: https://blog.csdn.net/qq_38936320/article/details/84478777
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4OTM2MzIw_size_16_color_FFFFFF_t_70 3]: /images/20230531/991f977531a749c39b988be5673b9fff.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4OTM2MzIw_size_16_color_FFFFFF_t_70 4]: /images/20230531/0820202272f2471cbe260850634f51f6.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4OTM2MzIw_size_16_color_FFFFFF_t_70 5]: /images/20230531/9015c132062c41d8ab85aacf02ef1e4e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4OTM2MzIw_size_16_color_FFFFFF_t_70 6]: /images/20230531/87d2f896d47d491e9add6218e4c3f988.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4OTM2MzIw_size_16_color_FFFFFF_t_70 7]: /images/20230531/632d867be7d34dfa9e93030533b88f33.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4OTM2MzIw_size_16_color_FFFFFF_t_70 8]: /images/20230531/882a2413aecf4bc183ca26433f6c62c4.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4OTM2MzIw_size_16_color_FFFFFF_t_70 9]: /images/20230531/b9669ef21bfa41b5a67506c89416fcc1.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4OTM2MzIw_size_16_color_FFFFFF_t_70 10]: /images/20230531/9f3630d686694f89ae56853a1c754d10.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4OTM2MzIw_size_16_color_FFFFFF_t_70 11]: /images/20230531/d994c53e5fde44c4996ad51ae97e81d0.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4OTM2MzIw_size_16_color_FFFFFF_t_70 12]: /images/20230531/04871e5148964b4fa5219f492d0717b2.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4OTM2MzIw_size_16_color_FFFFFF_t_70 13]: /images/20230531/d52ce99df4b94876b0b4850bfa317adc.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4OTM2MzIw_size_16_color_FFFFFF_t_70 14]: /images/20230531/1bd8181352fa43a6a1c0fb8898781ede.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4OTM2MzIw_size_16_color_FFFFFF_t_70 15]: /images/20230531/693c1c004caf4fe499eaf84820c00bbc.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4OTM2MzIw_size_16_color_FFFFFF_t_70 16]: /images/20230531/bd98a75f1bdf40a8bf4381d7f5c3256d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4OTM2MzIw_size_16_color_FFFFFF_t_70 17]: /images/20230531/31b605f859d247ba96537c70eb9d62b1.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4OTM2MzIw_size_16_color_FFFFFF_t_70 18]: /images/20230531/888043d1dd7b4a21850da5d03c703351.png