maven 中profile作用 maven的profile属性

转载

mob64ca13f2b62d 2024-03-17 11:33:32

文章标签 maven 中profile作用 Maven css 资源文件 bc 文章分类 架构后端开发

Maven属性

（1）内置属性：主要有两个常用内置属性

${basedir}：表示项目根目录，即包含pom.xml文件的目录
${version}：表示项目版本

（2）POM属性：用户可以使用该类属性引用POM文件中对应元素的值。常用的POM属性：

${project.build.sourceDirectory}：项目的主源码目录，默认为src/main/java/
${project.build.testSourceDirectory}：项目的测试源码目录，默认为src/test/java/
${project.build.directory}：项目构建输出目录，默认为target/
${project.outputDirectory}：项目主代码编译输出目录，默认为target/classes/
${project.testOutputDirectory}：项目测试代码编译输出目录，默认为target/test/classes/
${project.groupId}：项目的groupId
${project.artifactId}：项目的artifactId
${project.version}：项目版本
${project.build.finalName}：项目打包输出文件名称，默认为${project.artifactId}-${project.version}

（3）自定义属性：用户可以在POM的<properties>元素下自定义Maven属性

<project>
<!-- 省略多余代码 -->
    <properties>
        <spring.version>1.4.3</spring.version>
    </properties>
<!-- 省略多余代码 -->
</project>

然后在POM中其它地方使用${spring.version}的时候会被替换成1.4.3

（4）Settings属性：与POM原理相同，用户使用以setting. 开头的属性引用settings.xml文件中XML元素的值。常用配置：

${settings.localRepository}：指向用户本地仓库地址

（5）Java系统属性：所有Java系统属性都可以使用Maven属性引用，例如${user.home}指向用户的目录。用户可以使用mvn help:system查看所有的系统属性

（6）环境变量属性：所有环境变量都可以使用以env. 开头的Maven属性引用。例如${env.JAVA_HOME}指代了JAVA_HOME环境变量的值。用户可以使用mvn help:system查看所有的环境变量

资源过滤

把不同环境需要变化的部分提取出来，如下面数据库配置文件：

database.jdbc.driverClass=${db.driver}
database.jdbc.connectionURL=${db.url}
database.jdbc.username=${db.username}
database.jdbc.password=${db.password}

这里的命名都是任意的。既然这里使用了Maven属性，就应该在某个地方定义它们。这里使用的是一个额外的profile将其包裹，如下：

<profiles>
    <profile>
        <id>dev</id>
        <properties>
            <db.driver>com.mysql.jdbc.Driver</db.driver>
            <db.url>jdbc:mysql://127.0.0.1:3306/mysql</db.url>
            <db.username>dev</db.username>
            <db.password>dwvpass</db.password>
        </properties>
    </profile>
</profiles>

上面的Maven属性定义与直接在POM的properties元素下定义并没有什么区别，这里只是使用了一个id为dev的profile，其目的是将开发环境下的配置与其他环境的配置区别开。

现在配置文件还不能使用里面的变量，因为Maven属性默认只有在POM中才会被解析。也就是说，${db.username}放到POM中会变成dev，但是如果放到src/main/resources/目录下的文件中，构建的时候它仍然还是${da.username}。因此，需要让Maven解析资源文件中的Maven属性

资源文件的处理其实是maven-resources-plugin做的事情，它默认的行为只是将项目主资源文件复制到主代码编译输出目录中，将测试资源文件复制到测试代码编译输出目录中。不过只要通过一些简单的POM配置，该插件就能解析资源文件中的Maven属性，即开启资源过滤。

Maven默认的主资源目录和测试资源目录就定义在超级POM中。要为资源目录开启过滤，只要在此基础上添加一行filtering配置即可。

<resources>
    <resource>
        <directory>${project.basedir}/src/main/resources</directory>
        <filtering>true</filtering>
    </resource>
</resources>

Maven允许配置多个资源目录，并且为每个资源目录提供不同的过滤配置。

一切配置完毕，我们只需要在构建的时候运行如下指令：

$mvn clean install -P dev

-P参数表示激活一个profile，这里的dev为配置profile的id

Maven Profile

为了能够让构建在各个环境下方便地移植，Maven引入了Profile概念。用户可以使用很多种方式期货profile，以实现构建在不同环境下的移植。

激活profile

（1）命令行激活：用户可以使用 mvn命令行参数-P加上profile的id来激活profile，多个id之间用逗号分隔，例如我们要同时激活dev1和dev2

$mvn clean install -P dev1,dev2

（2）setting文件显式激活：如果用户想让某个profile默认一直处于激活状态，就可以配置setting.xml文件中的active-Profiles元素，表示其配置的profile对于所有项目都处于激活状态，如下：

<settings>
<!--省略多余代码-->
    <activeProfiles>
        <activeProfile>dev</activeProfile>
    </activeProfiles>
<!--省略多余代码-->
</settings>

（3）系统属性激活：用户可以配置当某系统属性存在的时候，自动激活profile。

<profiles>
    <profile>
        <activation>
            <property>
               <name>test</name> 
            </property>
        </activation>
        <!-- 属性配置省略 -->
    </profile>
</profiles>

（4）操作系统环境激活：Profile还可以自动根据操作系统环境激活，如果构建在不同的操作系统有差异，用户完全可以将这些差异写进profile，然后配置他们自动基于操作系统环境激活。

<profiles>
    <profile>
        <os>
            <name>Windows XP</name>
            <family>Windows</family>
            <arch>x86</arch>
            <version>5.2.120000</version>
        </os>
        <!-- 属性配置省略 -->
    </profile>
</profiles>

（5）文件存在与否激活：根据项目中某个文件存在与否来决定是否激活profile。

<profiles>
    <profile>
        <activation>
            <file>
                <missing>a.properties</missing>
                <exists>b.properties</exists>
            </file>
        </activation>
        <!-- 省略属性配置 -->
    </profile>
</profiles>

（6）默认激活：可以在定义profile的时候指定其默认激活

<profiles>
    <profile>
        <id>dev</id>
        <activation>
            <activeByDefault>true</activeByDefault>
        </activation>
        <!-- 省略属性配置 -->
    </profile>
</profiles>

使用activeByDefault元素用户可以指定profile自动激活。不过需要注意，如果POM中有任何一个profile通过以上其它任意一种方式被激活了，所有的默认激活都会失效。

查看当前被激活的profile：mvn help:active-profiles

列出所有profile：mvn help:all-profiles

WEB资源过滤

在web项目中，资源文件同样位于src/mian/resources/目录下，他们经处理后会位于WAR包的WEB-INF/classes目录下，这也是java代码编译打包后的目录。也就是说，这类资源打包后会位于应用程序的classpath中。

web项目中还有另外一类资源，默认他们的源码位于src/main/webapp/目录，经打包后位于WAR包的根目录。例如，一个web项目的css源码文件在/src/main/webapp/css/目录，项目打包后可以在WAR包的css/目录下找到对应的css文件。这一类资源文件称作web资源文件，它们在打包后不位于应用程序的classpath中。

与一般资源文件一样，web资源默认不会被过滤。开启一般资源文件的过滤也不会影响到web文件。

有时候，我们可能希望在构建项目的时候，为不同的客户使用不一样的资源文件（例如客户的logo图片不同，或者css主题不同）。这是可以在web资源文件中使用Maven属性，例如${client.logo}表示用户的logo。然后使用profile分别定义这些Maven属性的值，如下：

<profiles>
    <profile>
        <id>client-a</id>
        <properties>
            <client.logo>a.jpg</client.logo>
            <client.css>a.css</clicent.css>
        </properties>
    </profile>
    <profile>
        <id>client-b</id>
        <properties>
            <client.logo>b.jpg</client.logo>
            <client.css>b.css</clicent.css>
        </properties>
    </profile>
</profiles>

最后配置maven-war-plugin对src/main/wabapp/这一web资源目录开启过滤，如下：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-war-plugin</artifactId>
    <version>2.1-beta-1</version>
    <configuration>
        <webResources>
            <resource>
                <filtering>true</filtering>
                <directory>src/main/webapp</directory>
                <includes>
                    <include>**/*.jpg</include>
                    <include>**/*.css</include>
                </includes>
            </resource>
        </webResources>
    </configuration>
</plugin>

本文章为转载内容，我们尊重原作者对文章享有的著作权。如有内容错误或侵权问题，欢迎原作者联系我们进行内容更正或删除文章。