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 测试技术 数据库
SpringBoot:@Profile注解和Spring EL
SpringBoot:@Profile注解和Spring EL
|
1月前
|
Java Linux Maven
Linux系统Docker部署Nexus Maven并实现远程访问本地管理界面
Linux系统Docker部署Nexus Maven并实现远程访问本地管理界面
|
2月前
|
Java Linux Maven
私有仓库工具Nexus Maven如何部署并实现远程访问管理界面
私有仓库工具Nexus Maven如何部署并实现远程访问管理界面
58 0
|
3月前
|
消息中间件 Java 测试技术
Spring Cloud Alibaba环境问题之测试环境失败如何解决
Spring Cloud Alibaba提供了一套在Spring Cloud框架基础上构建的微服务解决方案,旨在简化分布式系统的开发和管理;本合集将探讨Spring Cloud Alibaba在实际应用中的部署和使用技巧,以及该框架常见问题的诊断方法和解决步骤。
|
1月前
|
Java Maven
Maven【5】在IDEA环境中配置和使用Maven
Maven【5】在IDEA环境中配置和使用Maven
65 1
|
3月前
|
Java 数据库 数据安全/隐私保护
基于SSM框架实现管科类考研自我管理系统(分前后台spring+springmvc+mybatis+maven+jsp+jquery)
基于SSM框架实现管科类考研自我管理系统(分前后台spring+springmvc+mybatis+maven+jsp+jquery)
|
2天前
|
canal 缓存 关系型数据库
Spring Boot整合canal实现数据一致性解决方案解析-部署+实战
Spring Boot整合canal实现数据一致性解决方案解析-部署+实战
|
8天前
|
存储 安全 Java
第2章 Spring Security 的环境设置与基础配置(2024 最新版)(下)
第2章 Spring Security 的环境设置与基础配置(2024 最新版)(下)
17 0
|
8天前
|
安全 Java 数据库
第2章 Spring Security 的环境设置与基础配置(2024 最新版)(上)
第2章 Spring Security 的环境设置与基础配置(2024 最新版)
35 0

热门文章

最新文章

推荐镜像

更多