spring和maven(profile)的多环境部署

简介: spring和maven(profile)的多环境部署

在开发过程中,我们经常会根据不同的环境配置不同的参数,如数据源的ip,username,password、url、秘钥等都会不同,传统方式是在一个配置文件中通过修改properties文件中的参数值或者通过注释解注释来达到目的,这样不仅容易出错,还浪费不必要的时间,更重要的是把代码发布到测试环境或者生产环境还容易忘记改。为解决这种问题,maven提供了一种解决方案,就是profile。


下图为传统方式,需要来回的注释和解注释


profile定义的位置

  • 针对于特定项目的profile配置我们可以定义在该项目的pom.xml中。
  • 针对于特定用户的profile配置,我们可以在用户的settings.xml文件中定义profile。该文件在用户家目录下的“.m2”目录下。
  • 全局的profile配置。全局的profile是定义在Maven安装目录下的“conf/settings.xml”文件中的。

filter方式实现

  • 第一步:分别定义application-dev.properties、application-test.properties、application-pro.properties三个文件


application-dev.properties


env.jdbc.username=dev
env.jdbc.password=123456


application-test.properties


env.jdbc.username=test
env.jdbc.password=888888


application-pro.properties


env.jdbc.username=root
env.jdbc.password=666666


  • 第二步:定义总的属性文件application.properties,该文件中的值去引用application-<env>.properties中的key


application.properties


// 引用application-<env>中的key
jdbc.username=${env.jdbc.username}
jdbc.password=${env.jdbc.password}
# 公共配置
salt=123456789


  • 第三步:配置profile
<profiles>
        <profile>
            <!-- 开发环境 -->
            <id>dev</id>
            <properties>
                <envProfile>dev</envProfile>
            </properties>
            <activation>
                <!-- 设置默认激活这个配置 -->
                <activeByDefault>true</activeByDefault>
            </activation>
        </profile>
        <profile>
            <!-- 测试 -->
            <id>test</id>
            <properties>
                <envProfile>test</envProfile>
            </properties>
        </profile>
        <profile>
            <!-- 发布环境 -->
            <id>pro</id>
            <properties>
                <envProfile>pro</envProfile>
            </properties>
        </profile>
    </profiles>


  • 第四步:配置filter和resource


  • ${env}就是在mvn package -P <env>的名字,这样就告诉application.properties中应用的key是那个属性文件的key了


<build>
        <finalName>profile-app</finalName>
        <!-- 定义了变量配置文件的地址 -->
        <filters>
            <filter>src/main/resources/jdbc-${envProfile}.properties</filter>
        </filters>
        <resources>
            <resource>
                <directory>src/main/resources</directory>
                <filtering>true</filtering>
            </resource>
        </resources>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-war-plugin</artifactId>
            </plugin>
        </plugins>
    </build>


  • 打包运行
// 如果不指定环境,默认是activeByDefault=true的环境,当前是指开发环境
mvn package
// 打包指定的环境通过-P 参数,注意p是大写的
mvn package -P <env>


从mvn packege -P test运行的结果中可以看到生成的target目录下classes/application.perperties中的jdbc.username和jdbc.password 就是application-test.properties中配置的env.jdbc.username和env.jdbc.password的值。


在spring中如果要使用属性配置文件,直接引入这个总的配置文件即可,其他的环境配置文件的使命已经结束了。

<context:property-placeholder location="classpath:application.properties"/>


实现原理:

在pom.xml中为每个不同的环境定义不同的profile,每个profile都有一个环境名称,然后为不同环境定义不同的配置文件(如application-<env>.properties), 再定义一个总的属性文件(如application.properties), 然后让application.properties的value去引用application-<env>.properties中对应的key,在打包时指定要打包的环境的名称即可,这样application.properties中的key的值就是相对应环境application-<env>.properties对应的值了。


注意事项:
如果不使用maven命令去编译打包,直接用tomcat去运行,那么只会执行默认的激活的配置文件,例如:使用maven packege的命令先打包激活生产环境的配置文件,再去运行tomcat则会以生产环境去运行。如果target目录下没有编译过的class文件,那么运行tomcat将会进行编译,如果有的话,则不会进行重新编译


多resource实现方式

步骤

  • 第一步:在src/main/resource创建一个env目录,再创建各个环境的子目录,再再各个环境子目录下创建名为config.properties的文件,每个键相同,值不同。

env/dev/config.properties


·

jdbc.username=dev
jdbc.password=123456


env/test/config.properties


jdbc.username=test
jdbc.password=888888


env/pro/config.properties


jdbc.username=root
jdbc.password=666666


  • 第二步:创建一个与环境无关的application.properties

application.properties


# 公共配置
salt=123456789


  • 第三步:配置profiles


<profiles>
  <profile>
    <!-- 开发环境 -->
    <id>dev</id>
    <properties>
      <env>dev</env>
    </properties>
    <activation>
      <!-- 设置默认激活这个配置 -->
      <activeByDefault>true</activeByDefault>
    </activation>
  </profile>
  <profile>
    <!-- 测试环境 -->
    <id>test</id>
    <properties>
      <env>test</env>
    </properties>
  </profile>
  <profile>
    <!-- 发布环境 -->
    <id>pro</id>
    <properties>
      <env>pro</env>
    </properties>
  </profile>
</profiles>
  • 第四步:配置resource
<build>
 <finalName>profile-app</finalName>
  <!-- 定义了变量配置文件的地址 -->
  <resources>
    <resource>
      <directory>src/main/resources</directory>
      <excludes>
        <exclude>env/dev/*</exclude>
        <exclude>env/test/*</exclude>
        <exclude>env/pro/*</exclude>
      </excludes>
      <filtering>true</filtering>
    </resource>
    <resource>
      <directory>src/main/resources/env/${env}</directory>
      <includes>
        <include>*.*</include>
        <include>**/*.xml</include>
        <include>**/*.properties</include>
      </includes>
      <filtering>true</filtering>
    </resource>
  </resources>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-war-plugin</artifactId>
    </plugin>
  </plugins>
</build>


  • 第五步:运行 mvn package -P test



  • 如果经常使用mvn package -P <env>可以在idea中配置一些maven, 步骤为:Edit Configurations… —– + —- Maven —- 分别为每个环境添加maven 命令,以后双击Run Configureations中的任意一个就是相当于运行mvn package -P <env>命令了


两种方式比较


  • filter方式会把所有的application-dev.properties、application-test.properties、application-pro.properties文件都会打包进去,而且此种方式只能针对属性文件,如果有其他文件(如.xml)也根据不同的环境有不同的配置,这种方式是不好处理。


  • 多resource方式在打包时只打包指定环境的配置文件,可以将各种文件放到各自的环境文件夹中,在打包的时候会将整个文件夹都打包进去。推荐此种方式


目录
相关文章
|
1月前
|
Java API 数据库
JPA简介:Spring Boot环境下的实践指南
上述内容仅是JPA在Spring Boot环境下使用的冰山一角,实际的实践中你会发现更深更广的应用。总而言之,只要掌握了JPA的规则,你就可以借助Spring Boot无比丰富的功能,娴熟地驾驶这台高性能的跑车,在属于你的程序世界里驰骋。
79 15
|
2月前
|
Java 应用服务中间件 Apache
在IntelliJ IDEA中使用Maven配置Tomcat环境
此配置方法具有较高的实用性,简单易懂。遵循以上步骤,您将能顺利在IntelliJ IDEA中使用Maven配置Tomcat环境,从而进行Web项目的开发和调试。
182 18
|
2月前
|
Java 应用服务中间件 Maven
在IntelliJ IDEA中如何配置使用Maven以创建Tomcat环境
所以,别担心这些工具看起来有些吓人,实际上这些都是为了帮助你更好的完成工作的工具,就像超市里的各种烹饪工具一样,尽管它们看起来可能很复杂,但只要你学会用,它们会为你烹饪出一道道美妙的食物。这就是学习新技能的乐趣,让我们一起享受这个过程,攀登知识的高峰!
204 27
|
3月前
|
存储 Java Maven
Maven系统级别依赖:解决部署时Jar包缺失问题
以上就是关于Maven系统级别依赖解决部署时Jar包缺失问题的解答,希望对你有所帮助。在软件开发中,遇到问题并解决问题是常态,希望你能够善用这些工具,解决你遇到的问题。
132 28
|
3月前
|
前端开发 Java 物联网
智慧班牌源码,采用Java + Spring Boot后端框架,搭配Vue2前端技术,支持SaaS云部署
智慧班牌系统是一款基于信息化与物联网技术的校园管理工具,集成电子屏显示、人脸识别及数据交互功能,实现班级信息展示、智能考勤与家校互通。系统采用Java + Spring Boot后端框架,搭配Vue2前端技术,支持SaaS云部署与私有化定制。核心功能涵盖信息发布、考勤管理、教务处理及数据分析,助力校园文化建设与教学优化。其综合性和可扩展性有效打破数据孤岛,提升交互体验并降低管理成本,适用于日常教学、考试管理和应急场景,为智慧校园建设提供全面解决方案。
297 70
|
4月前
|
Java Maven 微服务
微服务——SpringBoot使用归纳——Spring Boot集成 Swagger2 展现在线接口文档——Swagger2 的 maven 依赖
在项目中使用Swagger2工具时,需导入Maven依赖。尽管官方最高版本为2.8.0,但其展示效果不够理想且稳定性欠佳。实际开发中常用2.2.2版本,因其稳定且界面友好。以下是围绕2.2.2版本的Maven依赖配置,包括`springfox-swagger2`和`springfox-swagger-ui`两个模块。
80 0
|
6月前
|
XML Java 应用服务中间件
Spring Boot 两种部署到服务器的方式
本文介绍了Spring Boot项目的两种部署方式:jar包和war包。Jar包方式使用内置Tomcat,只需配置JDK 1.8及以上环境,通过`nohup java -jar`命令后台运行,并开放服务器端口即可访问。War包则需将项目打包后放入外部Tomcat的webapps目录,修改启动类继承`SpringBootServletInitializer`并调整pom.xml中的打包类型为war,最后启动Tomcat访问应用。两者各有优劣,jar包更简单便捷,而war包适合传统部署场景。需要注意的是,war包部署时,内置Tomcat的端口配置不会生效。
1712 17
Spring Boot 两种部署到服务器的方式
|
6月前
|
Java 测试技术 应用服务中间件
Spring Boot 如何测试打包部署
本文介绍了 Spring Boot 项目的开发、调试、打包及投产上线的全流程。主要内容包括: 1. **单元测试**:通过添加 `spring-boot-starter-test` 包,使用 `@RunWith(SpringRunner.class)` 和 `@SpringBootTest` 注解进行测试类开发。 2. **集成测试**:支持热部署,通过添加 `spring-boot-devtools` 实现代码修改后自动重启。 3. **投产上线**:提供两种部署方案,一是打包成 jar 包直接运行,二是打包成 war 包部署到 Tomcat 服务器。
132 10
|
7月前
|
Java 应用服务中间件 Docker
将基于 Spring 的 WAR 应用程序部署到 Docker:详尽指南
将基于 Spring 的 WAR 应用程序部署到 Docker:详尽指南
109 2

推荐镜像

更多