使用maven profile实现多环境配置

在开发过程中，我们的软件会面对不同的运行环境，比如开发环境、测试环境、生产环境，而我们的软件在不同的环境中，有的配置可能会不一样，比如数据源配置、日志文件配置、以及一些软件运行过程中的基本配置，那每次我们将软件部署到不同的环境时，都需要修改相应的配置文件,下面介绍一种maven profile实现多环境的配置。

项目目录结构

filters目录下的.properties 文件中存储环境中需要的变量,且文件的名称按照以下规则，后面会介绍到用处。打包之后,filters目录不会被打包,而该目录下对应的数据会被注入在resources目录下的文件中。

.
├──src
|   ├──mian
|   |   ├──filters
|   |   |     ├──dev-filter.properties  //本地环境需要的环境变量配置
|   |   |     ├──ci-filter.properties   //测试的环境需要的环境变量配置
|   |   |     ├──uat-filter.properties  //测试人员测试系统时需要的环境变量配置
|   |   |     └──prd-filter.properties  //生产环境需要的环境变量配置
|   |   ├──java
|   |   ├──resources   //sources模块
|   |   |     ├──sqlmap //持久层映射
|   |   |     ├──applicationContext.xml //spring配置
|   |   |     ├──jobConfig.properties   //需要的配置
|   |   |     └──datasource.xml      //数据库链接参数配置
|   |   └───webapp   //页面目录
|   └───test  //测试目录
└───pom.xml  //maven包管理配置
.

配置文件中的数据格式书写

1. dev-filter.properties文件书写的变量。

jdbc.url = jdbc:mysql:****?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&failOverReadOnly=false
jdbc.username = root
jdbc.password = 123456
jdbc.driver = com.mysql.jdbc.Driver

2. datasource.xml 文件中的变量映射

变量的写法是 ${jdbc.url} 进行填写。

 <bean id="masterdataSource" class="org.apache.commons.dbcp.BasicDataSource"
          destroy-method="close">
        <property name="driverClassName" value="${jdbc.driver}"/>
        <property name="url" value="${jdbc.url}"/>
        <property name="username" value="${jdbc.username}"/>
        <property name="password" value="${jdbc.password}"/>
  </bean>

3. jobConfig.properties 文件中的变量映射

写法与xml的资源文件的写法类似

jdbc.url = ${jdbc.url}
jdbc.username = ${jdbc.username}
jdbc.password = ${jdbc.password}
jdbc.driver = ${jdbc.driver}

4. 如果需要, yml文件中的变量映射

yml文件中的变量写法是@符号开始,@符号结束

jdbc:
    url: @jdbc.url@
    username: @jdbc.username@
    password: @jdbc.password@
    driver: @jdbc.driver@

pom 文件中的配置

该文件中需要的一下配置如下,主要配置都加有注释

  <!--配置目录变量 -->
    <properties>
        <filters.base.path.test>src/test/filters</filters.base.path.test>
        <filters.base.path.main>src/main/filters</filters.base.path.main>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

  <!--下面配置了四个环境,其中dev环境为默认环境 -->
    <profiles>
        <profile>
            <id>dev</id>
            <properties>
                <env>dev</env>
            </properties>
            <activation>
                <activeByDefault>true</activeByDefault>
            </activation>
        </profile>
        <profile>
            <id>prd</id>
            <properties>
                <env>prd</env>
            </properties>
        </profile>
        <profile>
            <id>ci</id>
            <properties>
                <env>ci</env>
            </properties>
        </profile>
        <profile>
            <id>uat</id>
            <properties>
                <env>uat</env>
            </properties>
        </profile>
    </profiles>

   <!-- 当编译的时候maven　获取到环境变量env，
　　　　从而在相应的目录中查找到对应的环境文件 -->
    <build>
        <filters>
            <filter>${filters.base.path.main}/${env}-filter.properties</filter>
        </filters>
        <finalName>demon</finalName>
        <!-- default:src/main/java -->
        <sourceDirectory>src/main/java</sourceDirectory>
        <resources>
            <resource>
                <!-- 目标资源文件的路径 -->
                <!-- default:src/main/resources -->
                <directory>src/main/resources</directory>
                <filtering>true</filtering>
            </resource>
        </resources>
        <!--<scriptSourceDirectory>src/main/scripts</scriptSourceDirectory> -->
        <!-- default:src/test/java -->
        <testSourceDirectory>src/test/java</testSourceDirectory>
        <testResources>
            <testResource>
                <!-- default:src/main/resources -->
                <directory>src/test/resources</directory>
                <filtering>true</filtering>
            </testResource>
        </testResources>
        <!-- default:target/classes -->
        <outputDirectory>target/classes</outputDirectory>
        <!-- default:target/test-classes -->
        <testOutputDirectory>target/test-classes</testOutputDirectory>

 <!-- 编译的时候需要的maven 插件-->
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.1</version>
                <configuration>
                    <source>1.7</source>
                    <target>1.7</target>
                    <encoding>UTF-8</encoding>
                </configuration>
            </plugin>
    
        </plugins>
    </build>
</project>

构建和发布

所有需要的配置就完成了,下面通过在运行maven命令时指定不同的profile即可构建不同环境需要的war或者jar包或发布到不同的环境了 。如：

mvn clean package -P prd  //即构建出生产环境需要的war或者jar包,其它环境配置类似