Springboot项目使用外部配置文件(排除打包内部yml文件,使用jar包外配置yml文件)

本文介绍了如何在Springboot项目中避免在打包时包含特定配置文件,通过在Maven的资源配置中排除文件并在线上环境放置生产配置文件,实现项目运行时动态加载外部配置。同时强调了常见误解和替代解决方案。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

Springboot项目使用外部配置文件(排除打包内部yml文件,使用jar包外配置yml文件)

在项目中不同的环境可能会有不同的配置文件,比如项目中 redis 地址在本地的环境和在线上生产环境的地址密码是可能会不同,那么每次打包构建项目的时候去更改配置文件,十分可能会忘记或者改错。

为了解决上述情况,在打包的时候排除配置文件,然后在线上环境 jar 包同级放上配置 yml 文件,这样每次只需要上次 jar 包即可。

一、排除配置文件

在项目父 pom.xml 文件中:

 <build>
<!-- 如果你想在构建过程中排除某些文件,你应该在Maven的<resources>部分中配置,而不是在Spring Boot Maven插件中。-->
        <resources>
            <resource>
       			<!--  排除的文件的路径 -->
                <directory>src/main/resources</directory>
                <excludes>
                	<!--  排除的文件的名称 -->
                    <exclude>application.properties</exclude>
                    <exclude>application-dev.yml</exclude>
                    <exclude>application-prod.yml</exclude>
                    <exclude>logback.xml</exclude>
                </excludes>
            </resource>
        </resources>
  </build>

加上上面配置后,打包的 jar 包中,便不会有这些文件。

二、在线上环境 jar 包同级放入生产配置文件 application.yml

在这里插入图片描述

通过以上两步,便可以实现 jar 包运行时会默认读取外部配置文件,这样即使临时更改一些配置,直接更改外部配置文件然后重启项目即可。

注意:

  • 一、网上一堆转载文章说通过以下配置排除文件:
    在这里插入图片描述
    这种造成误解,这样是不对的,因为 maven-plugin 中的 excludes 是只能排除不需要的 jar 包的,不能排除 文件的。

  • 二、除了上述解决办法,我们还可以在启动脚本中配置指定使用外部配置文件。

<think>好的,我现在需要帮助用户了解如何将Spring Boot应用打包成WAR文件,并在引入外部配置文件后部署到Tomcat服务器。首先,我得回忆一下相关的步骤,确保每个环节都正确无误。 首先,用户的问题涉及几个关键点:打包成WAR、引入外部配置文件、部署到Tomcat。我需要按照这些点逐一解答。根据之前的引用内容,用户可能遇到404错误,可能是因为没有正确配置启动类或依赖项。 第一步,修改启动类。记得Spring Boot应用默认打包JAR,如果要改成WAR,需要继承SpringBootServletInitializer并重写configure方法。引用[1]、[2]、[4]都提到了这一点,必须确保用户正确修改启动类,否则部署时可能无法正确初始化应用。 接下来是pom.xml的配置。需要将打包方式改为war,添加servlet-api依赖,并排除内嵌的Tomcat。这里需要注意,有时候用户可能会忘记排除内嵌的Tomcat,导致冲突。引用[1]、[3]提到要排除内嵌Tomcat,并将其作用域设为provided,这样打包时就不会含它了。不过引用[3]的注释说可能不需要排除,但根据其他引用,最好还是排除,避免潜在问题。 然后是外部配置文件。用户可能需要将application.properties或application.yml放在外部,比如Tomcat的conf目录下,或者通过JVM参数指定路径。引用[5]提到将配置文件放在WAR面,这样可以方便修改而不需要重新打包。需要告诉用户如何配置spring.config.location,使用环境变量或启动参数来指定外部文件的位置。 在部署到Tomcat时,可能需要将WAR文件放在webapps目录下,并确保Tomcat版本兼容。还要提醒用户注意可能遇到的常见问题,比如访问404,这时候要检查启动类是否正确,依赖是否排除干净,以及配置文件路径是否正确。 最后,生成相关问题,帮助用户进一步深入。例如如何指定不同环境的配置文件,或者如何处理多模块项目打包问题。这些都是用户可能遇到的后续问题。 现在需要把这些步骤整理成一个清晰的教程,确保用户能够一步步操作,并避免常见的错误点。同时,引用相关的引用来源,增强可信度。例如,在修改启动类的时候引用[1]和[4],在配置pom.xml时引用[3],在外部配置文件部分引用[5]。 需要检查是否有遗漏的步骤,比如测试是否成功,或者是否需要配置Tomcat的其他参数。确保每个步骤都有对应的解决方案,并给出示例代码,比如启动类的代码和pom.xml的依赖配置,这样用户可以直接复制粘贴,减少出错的可能。 另,可能还需要提醒用户关于Tomcat的版本兼容性问题,比如Spring Boot 2.x可能需要Tomcat 8.5或更高版本。还有,如果使用Java 11,需要注意Tomcat的兼容性。不过用户的问题中没有提到版本,可能需要保持通用性,只讲一般步骤,不涉及具体版本。 总结一下,整个流程应该是:修改启动类 → 配置pom.xml → 打包WAR → 处理外部配置文件 → 部署到Tomcat → 验证和测试。每个步骤都需要详细说明,并附上示例代码和配置,确保用户能顺利操作。</think>### 如何将Spring Boot应用打包成WAR文件并引入外部配置文件部署到Tomcat? 以下是分步操作指南,结合代码示例和配置文件调整: --- #### **一、修改启动类** Spring Boot默认生成可执行JAR,需通过以下改造支持WAR部署: ```java @SpringBootApplication public class Application extends SpringBootServletInitializer { // 继承SpringBootServletInitializer @Override protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) { return builder.sources(Application.class); // 指定启动类[^1][^2][^4] } public static void main(String[] args) { SpringApplication.run(Application.class, args); } } ``` --- #### **二、配置pom.xml** 1. **修改打包格式**: ```xml <packaging>war</packaging> <!-- 指定打包为WAR --> ``` 2. **排除内嵌Tomcat并添加依赖**: ```xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-tomcat</artifactId> <scope>provided</scope> <!-- 依赖由外部Tomcat提供[^3] --> </dependency> <dependency> <groupId>javax.servlet</groupId> <artifactId>javax.servlet-api</artifactId> <scope>provided</scope> </dependency> ``` --- #### **三、打包生成WAR文件** 在项目根目录执行Maven命令: ```bash mvn clean package ``` 生成的WAR文件位于`target`目录下,文件名为`项目名-版本.war`。 --- #### **四、引入外部配置文件** **方法1:通过环境变量指定外部路径** 启动时添加参数: ```bash java -jar your-app.war --spring.config.location=/path/to/external/config/ ``` **方法2:配置文件优先级** Spring Boot默认按以下顺序加载配置文件[^5]: 1. `./config/`(项目根目录下的`config`文件夹) 2. `./`(项目根目录) 3. `classpath:/config/` 4. `classpath:/` 将`application.properties`或`application.yml`放在Tomcat的`conf`目录或WAR同级`config`目录即可。 --- #### **五、部署到Tomcat** 1. 将WAR文件复制到Tomcat的`webapps`目录。 2. 启动Tomcat(执行`bin/startup.sh`或`bin/startup.bat`)。 3. 访问路径:`http://localhost:8080/your-war-name/`。 --- #### **常见问题排查** - **404错误**:检查启动类是否继承`SpringBootServletInitializer`[^2]。 - **依赖冲突**:确认已排除内嵌Tomcat(`<scope>provided</scope>`)[^3]。 - **配置未生效**:检查外部配置文件路径是否正确。 ---
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值