3 Star 8 Fork 1

DT研究院/deploy-helper

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

deploy-helper

介绍

deploy-helper是一個Spring Boot & Spring Cloud项目自动远程部署轻量级Maven插件.

通常情况下,我们将开发好的Spring Boot程序部署到服务器上时,会经历以下流程:

1、maven项目打包

2、通过sftp、scp软件将jar包拷贝到目标服务器上

3、通过ps命令查找pid进程号,使用kill命令杀进程

4、通过java命令启动jar包

如果需求更改后,我们需要重复以上流程,对于开发者来说,是一件很无聊的事情,特别是需要发布到测试服务器等进行测试的情况下,非常耗时间。

deploy-helper解决的就是步骤2、步骤3、步骤4,项目打包好后,执行插件完成自动化部署,整个过程耗时10s左右

软件架构

软件架构说明

安装教程

在maven項目的pom.xml中直接引入

<plugin>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>deploy-helper-maven-plugin</artifactId>
    <!--请在maven中央仓库搜索最新版本-->
    <version>1.2</version>
    <configuration>
        <!--配置文件路径,由于密码是明文模式,该配置文件可以不配置在项目中,防止服务器密码泄漏,同时建议部署程序使用非root用户-->
        <configurationFile>/mnt/home/deployHelperConfig.xml</configurationFile>
    </configuration>
</plugin>

deployHelperConfig.xml配置文件在项目的src/main/resources目录下时,可以不用在pom.xml里面进行配置

引入后,在项目中可以看到我们引入的插件

使用说明

### 配置文件

deploy-helper在执行时,需要传递一个xml文件作为初始化文件,xml代表了所需要进行自动化部署的配置信息,XML模板如下:

<?xml version="1.0" encoding="UTF-8"?>
<deployHelperConfiguration>
    <!--指定deployHelper自动上传时所连接的服务器以及要使用的deploy配置-->
    <profile server="dev" deploy="dev"></profile>
    <servers>
        <!--可以配置多个server节点,代表的是目标服务器-->
        <server profile="dev" host="192.168.0.223" port="22" username="root" password="123456"></server>
    </servers>
    <deploys>
        <!--目标服务器存在启动&停止脚本-->
        <deploy profile="dev"
                source="target/demo-http-1.0.jar"
                target="/home/xiaoymin/test/test1/demo-http-1.0.jar"
                processName="demo-http-1.0.jar"
                activeDefaultStart="true"
                backup="true"
                startShell="/home/xiaoymin/test/test1/startup.sh"
                stopShell="/home/xiaoymin/test/test1/stop.sh">
        </deploy>
        <!--不存在启动脚本,使用deploy-helper默认的脚本-->
        <deploy profile="test"
                source="target/demo-http-1.0.jar"
                target="/home/xiaoymin/test/test5/demo-http-1.0.jar"
                processName="demo-http-1.0.jar"
                activeDefaultStart="true">
        </deploy>
    </deploys>
</deployHelperConfiguration>

在上面的XML模板中,主要包含三个节点

  • profile:profile节点代表的是在插件执行时具体引用那个serverdeploy
  • servers:Linux服务器节点配置,主要包含的属性:profile(名称)、host(主机号)、port(端口号)、username(登陆用户名)、password(登陆密码)
  • deploy:该节点是最终做自动化部署时的配置,可以配置多个,在profile节点时可以自动指定,区分开发环境&生成环境,属性如下:
    • profile:名称
    • source:需要上传的jar文件,可以是相对目录下的文件,也可以使用绝对路径
    • target:目标服务器路径,需要注意的时该属性必须配置完整的路径+文件名,不能只包含目录,上传是覆盖策略
    • processName:该参数主要用于在服务上用于查询进程号的名称,越完整越好,通过该名称通过ps命令查找时可以精准定位到程序的pid,如果stopShell停止脚本存在的话则该参数可以不传
    • backup: 由于插件目前的策略是直接覆盖服务器上文件,有时候我们希望保留上一个版本,此时可以设置该参数为true,帮助我们进行备份,该参数为true时,会在目标目录创建一个backup的文件夹,将服务器的文件进行备份(自1.1版本开始)
    • activeDefaultStart:是否自动生成启动jar包的启动命令,该参数的优先级低于startShell
    • startShell:启动脚本,必须配置完整路径
    • stopShell:停止脚本,必须配置完整路径

脚本参考

目标服务器上配置的启动脚本和停止脚本参考如下:

启动脚本(startup.sh):

nohup java -jar demo-http-1.0.jar &

停止脚本(stop.sh):

#!/bin/bash
echo "Stop Procedure : demo-http-1.0.jar"
pid=`ps -ef |grep java|grep demo-http-1.0.jar|awk '{print $2}'`
echo 'old Procedure pid:'$pid
if [ -n "$pid" ]
then
kill $pid
fi

使用场景

目前使用deploy-helper插件主要区分2种场景

目标服务器存在启动&停止脚本

我们可以通过在部署服务器上线创建2个脚本,分别是启动脚本停止脚本,此时,我们需要在deployHelperConfig.xml配置文件中配置deploy节点,示例如下:

<deploy profile="dev"
        source="target/demo-http-1.0.jar"
        target="/home/xiaoymin/test/test1/demo-http-1.0.jar"
        startShell="/home/xiaoymin/test/test1/startup.sh"
        stopShell="/home/xiaoymin/test/test1/stop.sh">
</deploy>

通过上面的配置文件,我们可以知道

部署目录:/home/xiaoymin/test/test1,如果该目录不存在,则会自动创建该目录

启动脚本:/home/xiaoymin/test/test1/startup.sh

停止脚本:/home/xiaoymin/test/test1/stop.sh

需要注意的是,如果使用这种场景,那么目标服务器的启动脚本和停止脚本文件必须存在,并且必须是可执行的,需要有Linux的x权限

使用deploy-helper提供的默认脚本

如果你嫌弃写shell脚本麻烦,那么deploy-helper默认提供了启动和停止的脚本,此时,配置deploy的节点时如下:

<deploy profile="test"
        source="target/demo-http-1.0.jar"
        target="/home/xiaoymin/test/test5/demo-http-1.0.jar"
        processName="demo-http-1.0.jar"
        backup="true"
        activeDefaultStart="true">
</deploy>

通过上面的配置:

部署目录:/home/xiaoymin/test/test5/,如果该目录不存在,则会自动创建该目录

进程名称:processName在这种模式下必须设置该参数,并且最好是通过ps命令能查找到pid进程号的,所以需要提供完整的名称最好

启动自动启动:activeDefaultStart命令优先级低于startShell,如果startShell启动命令不为空,程序会使用startShell中的命令进行启动程序,否则activeDefaultStart参数必须设置为true,此时,使用deploy-helper默认会生成jar项目的启动命令进行启动

备份策略:backup参数为true时,会对目标文件进行备份

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

Spring Boot & Spring Cloud项目自动远程部署Maven插件 展开 收起
Java
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
Java
1
https://gitee.com/dt_research_institute/deploy-helper.git
git@gitee.com:dt_research_institute/deploy-helper.git
dt_research_institute
deploy-helper
deploy-helper
master

搜索帮助