SpringBoot项目打包成war包实现远程部署

SpringBoot项目打包成war包实现远程部署

---

前言

本文主要解决两个问题：

1. SpringBoot项目引入了 spring-boot-starter-web 依赖，内嵌tomcat，默认打包方式是 jar。我想要将项目部署到远程服务器上的 tomcat 里，需要打包成 war 。
2. 由于项目还在开发中，部署到服务器上是方便前端调用，后期还要持续部署。为了避免每次手动打包上传，使用 tomcat 插件实现命令行一键部署。

开发环境

• 开发工具：IDEA
• 项目格式：Maven
• Java 版本：1.8.0_191
• SpringBoot 版本： 2.1.1.RELEASE
• Tomcat 版本：8.5.35

---

SpringBoot项目打包成war

踩坑过程

网上很多教程都说要添加如下两个依赖包：tomcat-servlet-api和spring-boot-starter-tomcat 。 其中 scope = provided 表示依赖包只在编译和测试过程中有效，最后生成war包时不会加入。

<dependency>
    <groupId>org.apache.tomcat</groupId>
    <artifactId>tomcat-servlet-api</artifactId>
    <version>8.0.36</version>
    <scope>provided</scope>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-tomcat</artifactId>
    <scope>provided</scope>
</dependency>

此外还要修改启动类，重写 configure() 方法，如下：

@SpringBootApplication
public class Application extends SpringBootServletInitializer {

    @Override
    protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {
        return application.sources(Application.class);
    }
    public static void main(String[] args){
        SpringApplication.run(Application.class,args);
    }
}

最佳实践

经过笔者和小伙伴的多次测试，发现并不需要以上操作。对于 SpringBoot 2.1.1.RELEASE 来讲，要打包成war只需要：

在pom文件中修改打包方式就好了

即：在 pom 文件中 `` 标签下加上： ```xml war ``` 为了让打包的项目名称不包含版本信息，在``标签中指定war包名字： ```xml ${artifactId} ... ``` 当然引入依赖并修改启动类也能正常工作，只是稍微有点儿多余。

本地maven项目一键部署到远程tomcat服务器

1. 修改服务器 tomcat的 tomcat-user.xml 配置，添加用户 user，并赋予其管理员权限。

vi tomcat/conf/tomcat-user.xml

# 添加如下内容
<role rolename="manager-gui"/>
<role rolename="manager-script"/>
<user username="admin" password="admin" roles="manager-gui,manager-script"/>

• manager-gui
  允许访问 html 图形用户接口与状态页面 (即 URL 路径为 /manager/html/* )
  配置此权限即可以通过tomcat主页登录管理页面：
  
  
• manager-script
  允许访问纯文本接口与状态页面 (即 URL 路径为 /manager/text/* )
  实现远程部署必须配置此权限，否则会报权限不足的错。

2. 在pom文件中引入tomcat插件，并配置远程部署路径

<plugin>
    <groupId>org.apache.tomcat.maven</groupId>
    <artifactId>tomcat7-maven-plugin</artifactId>
    <version>2.2</version>
    <configuration>
        <!-- war包的名字，也是访问服务的根路径 -->
        <path>/find-friends</path>
        <url>http://远程ip:tomcat端口号/manager/text</url>
        <!-- tomcat用户账号和密码 -->
        <username>admin</username>
        <password>admin</password>
        <update>true</update>
    </configuration>
</plugin>

3. 将/webapps/manager/META-INF/context.xml的以下代码注释，会限制IP访问

<Valve className="org.apache.catalina.valves.RemoteAddrValve" allow="127\.\d+\.\d+\.\d+|::1|0:0:0:0:0:0:0:1" />

4. 现在，即可使用命令实现一键远程部署。打开IDEA 控制台（terminal），使用命令：

mvn clean tomcat7:deploy -Dskiptests

• Dskiptests 跳过测试

---