环境:
IntelliJ IDEA 2018.3.6 x64;
apache-maven-3.6.1;
apache-tomcat-8.5.47 (Windows);
说明:本文仅介绍无子模块的项目打包(war);
引用外部配置文件(application.yml,application.properties):
方式一:会跳过包内的配置文件,且缺失外部配置文件,项目不可启动;
方式二:根据配置文件加载优先级,后加载的相同配置项覆盖先加载的配置;
外部tomcat部署。
1、修改pom.xml文件
<!-- 1.打包方式修改为 war -->
<packaging>war</packaging>
<!-- 2.springboot内嵌tomcat,外部部署,需将内嵌服务器移除-->
<!-- 2.1 方式一: (官方文档使用此方式)-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-tomcat</artifactId>
<scope>provided</scope>
</dependency>
<!-- 2.2 方式二: (网上看到的,作为备用吧)-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<!-- 移除嵌入式tomcat插件 -->
<exclusions>
<exclusion>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-tomcat</artifactId>
</exclusion>
</exclusions>
</dependency>
<!--添加servlet-api的依赖-->
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>javax.servlet-api</artifactId>
<version>3.1.0</version>
<scope>provided</scope>
</dependency>
<build>
<finalName>xxx</finalName> <!-- war包文件名 -->
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<!-- 指定启动的主类,若未指定插件会自动搜索 public static void main(String[] args);因此可不配置 -->
<configuration>
<mainClass>com.example.app.Main</mainClass>
</configuration>
</plugin>
<!--忽略test打包-->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<configuration>
<skip>true</skip>
</configuration>
</plugin>
</plugins>
<!-- 打包时移除,war包中将移除的文件,此处 移除了application.yml、logback.xml -->
<!-- 如果你使用方式二,这些文件不能移除哦!-->
<resources>
<resource>
<directory>src/main/resources</directory>
<excludes>
<exclude>*.yml</exclude>
<exclude>*.xml</exclude>
</excludes>
</resource>
</resources>
</build>
2、修改启动类
继承SpringBootServletInitializer ,重写configure
public class Application extends SpringBootServletInitializer {
@Override
protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) {
return builder.sources(Application.class); //启动类
}
public static void main(String[] args) throws Exception {
SpringApplication.run(Application.class, args);
}
}
3、新增配置类(方式一按此添加,方式二不需要)
我是将配置类放在了与启动类同级的config文件夹下;
部署时要引用的配置文件放在了/tomca/conf 下;
请根据自己的情况灵活修改
public class EnvironmentPostProcessorConfig implements EnvironmentPostProcessor {
@Override
public void postProcessEnvironment(ConfigurableEnvironment configurableEnvironment, SpringApplication springApplication) {
// 我是将配置文件放于/tomca/conf 文件夹下,根据自己放置位置修改
String property = System.getProperty("catalina.home"); //也可以写成 “D:\\apache-tomcat\\apache-tomcat-8.5.47”,tomcat所在的绝对路径
// .yml配置文件
String path = property + File.separator + "conf" + File.separator + "application.yml"; // D:\\apache-tomcat\\apache-tomcat-8.5.47\\conf\\application.yml
YamlPropertiesFactoryBean yaml = new YamlPropertiesFactoryBean();
yaml.setResources(new FileSystemResource(path));
MutablePropertySources propertySources = configurableEnvironment.getPropertySources();
propertySources.addFirst(new PropertiesPropertySource("config", yaml.getObject()));
}
}
4、新建spring.factories(方式一按此添加,方式二不需要)
放置于src/main/resources/META-INF下,META-INF需新建
# 实现新建的配置类
org.springframework.boot.env.EnvironmentPostProcessor = com.boot.config.EnvironmentPostProcessorConfig
5、application.yml
由于将logback.xml文件移除了war包,因此需要在配置文件中添加文件加载路径
# 绝对路径
logging:
config: D:\apache-tomcat\apache-tomcat-8.5.47\conf\logback.xml
方式二:
需指定激活的配置文件:application-dev、application-prod、...
spring:
profiles:
active: prod #指定激活的配置文件,若配置文件为自定义name请自行灵活修改
6、打包
打包可以使用命令,但是既然使用了IDEA,所以这里就不用命令了:
clean: (target文件会被删除重新编译,等待重新编译完成再执行下一项)
package:
install:(该项会将项目的war包或jar包保存到maven仓库,不需要可以不点);
注意:点击每一项都需要时间等待执行完成,所以不要着急点下一项。
5、本地Tomcat部署
方式一:由于配置类中指定加载路径,因此按下图放置配置文件
方式二:
这种方式就很简单了,既不需要EnvironmentPostProcessorConfig配置类也不需要spring.factories文件,
只要把application-prod.yml丢在tomcat的lib目录活lib/config下就可与啦!
如果你想问我为什么可以这么做,我也想知道哦,如果你有好的见解记得告诉我一下啊!
启动tomcat相信大家都知道怎么操作,就不赘述了,项目启动完成后,通过访问127.0.0.1:[端口]/[war包名称]/
访问项目就可以啦!
文章内容为本人亲测使用通过的,如有错误或遗漏请指正;
另,对于聚合项目(父工程<packaging>pom</packaging>,子模块以war、jar打包,且包含多个war模块)的打包及部署仍有疑惑,若有好的见解或文章请推荐!
参考博文:
https://www.jianshu.com/p/4f700110725e (引用外部application.properties配置文件);
https://blog.csdn.net/hzy522104212/article/details/97241374