--------------------20180927-----------------
.xml 和 .properties 文件都能配置属性。
.properties文件主要是key-value键值对形式,只需要简单的getProperty(key)方法或者setProperty(key,value)方法就可以读取或者写入内容,如果只是用来进行属性配置,使用.properties文件会比较方便。

参考:XML与Properties文件区别

--------------------20180524-----------------
正在我疑惑时,看到了这篇文章,写的很好,原文:https://my.oschina.net/zjllovecode/blog/1789874

问题引入:

   在学习别人的Maven项目时发现了在xxx.properties 中使用了${} 来获取具体属性值。

xxx.xml中也使用了${} 来引用相应的属性值

 

但是他却不是从xxx.properties 中扫描来的。

选中相应的${undefined****}的内容在IDEA中按住ctrl+鼠标左键。被带入到了pom文件。这是怎么回事呢?

 

已知知识回顾:

       (在xxx.xml中使用${}来引入xxx.properties中的变量)

    我们知道一般情况下在配置文件中使用${}都是在xxx.xml中 然后相应的具体属性配置在xxx.properties之中。

比如:在applicationContext.xml文件中配置数据连接池

<!-- 配置数据链接池 -->
<propertyname="dataSource">
<beanclass="com.mchange.v2.c3p0.ComboPooledDataSource">
<propertyname="jdbcUrl"value="${jdbcUrl}"></property>
<propertyname="driverClass"value="${driverClass}"></property>
<propertyname="user"value="${user}"></property>
<propertyname="password"value="${password}"></property>
<!-- 其它配置 -->

 

这个xml中就使用了${}的功能。它相当于Java中调用了变量名一样。

在本例子中,这些变量来自另外一个properties文件。该properties为: jdbc.properties(主要用来存放JDBC连接数据库的一些配置,方便下次修改,而不需要在applicationContext.xml文件中修改。

jdbc.properties:

jdbcUrl=jdbc:mysql://localhost:3306/oa
driverClass=com.mysql.jdbc.Driver
user=root
password=123456

而且还需要在xxx.xml中引入properties文件,

一般情况下,如果你只有一个applicationContext.xml配置文件而已的话,那么只需要在applicationContext.xml文件中添加一行:

<!-- 导入外部的properties文件 -->
<context:property-placeholder location="classpath:jdbc.properties"/>  

而本${}变量的读取来自pom,这是怎么回事呢?很明显这个功能是Maven提供的。

通过查阅定位到这个功能确实是maven提供的。 属于 "maven properties 资源过滤“

下面的内容参考:maven内置属性(${} properties), Maven官方文档

-----------------------------------------------------------------------------

Maven内置了三大特性:属性、Profile和资源过滤来支持构建的灵活性。

Maven属性

事实上有六种类型的Maven属性:

  • 内置属性:主要有两个常用内置属性——${basedir}表示项目根目录,即包含pom.xml文件的目录;${version}表示项目版本。
  • POM属性:pom中对应元素的值。例如${project.artifactId}对应了<project><artifactId>元素的值,常用的POM属性包括: 
    ${project.build.sourceDirectory}:项目的主源码目录,默认为src/main/java/.                              ${project.build.testSourceDirectory}:项目的测试源码目录,默认为/src/test/java/.                    ${project.build.directory}:项目构建输出目录,默认为target/.                                                      ${project.build.outputDirectory}:项目主代码编译输出目录,默认为target/classes/.                  ${project.build.testOutputDirectory}:项目测试代码编译输出目录,默认为target/testclasses/.  ${project.groupId}:项目的groupId.                                                                                              ${project.artifactId}:项目的artifactId.                                                                                          ${project.version}:项目的version,于${version}等价                                                                    ${project.build.finalName}:项目打包输出文件的名称,默认为$$,${project.artifactId}${project.version}.
  • 自定义属性:在pom中<properties>元素下自定义的Maven属性。例如
    <project>  
        <properties>  
            <my.prop>hello</my.prop>  
        </properties>  
    </project>
  • Settings属性:与POM属性同理。如${settings.localRepository}指向用户本地仓库的地址。
  • Java系统属性:所有Java系统属性都可以使用Maven属性引用,例如${user.home}指向了用户目录。可以通过命令行mvn help:system查看所有的Java系统属性
  • 环境变量属性:所有环境变量都可以使用以env.开头的Maven属性引用。例如${env.JAVA_HOME}指代了JAVA_HOME环境变量的值。也可以通过命令行mvn help:system查看所有环境变量。

资源过滤

默认情况下,Maven属性只有在POM中才会被解析。资源过滤就是指让Maven属性在资源文件(src/main/resources、src/test/resources)中也能被解析。

在POM中添加下面的配置便可以开启资源过滤

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

从上面的配置中可以看出,我们其实可以配置多个主资源目录和多个测试资源目录。

Maven除了可以对主资源目录、测试资源目录过滤外,还能对Web项目的资源目录(如css、js目录)进行过滤。这时需要对maven-war-plugin插件进行配置

<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>**/*.css</include>
					<include>**/*.js</include>
				</includes>
			</resource>
		</webResources>
	</configuration>
</plugin>

Maven Profile

每个Profile可以看作是POM的一部分配置,我们可以根据不同的环境应用不同的Profile,从而达到不同环境使用不同的POM配置的目的。

profile可以声明在以下这三个文件中:

  • pom.xml:很显然,这里声明的profile只对当前项目有效
  • 用户settings.xml:.m2/settings.xml中的profile对该用户的Maven项目有效
  • 全局settings.xml:conf/settings.xml,对本机上所有Maven项目有效

非常值得注意的一点是,profile在pom.xml中可声明的元素在settings.xml中可声明的元素是不一样的:

  • profile在pom.xml中可声明的元素:
<project>
	<repositories></repositories>
	<pluginRepositories></pluginRepositories>
	<distributionManagement></distributionManagement>
	<dependencies></dependencies>
	<dependencyManagement></dependencyManagement>
	<modules></modules>
	<properties></properties>
	<reporting></reporting>
	<build>
		<plugins></plugins>
		<defaultGoal></defaultGoal>
		<resources></resources>
		<testResources></testResources>
		<finalName></finalName>
	</build>
</project>
  • profile在settings.xml中可声明的元素:
    <project>
    	<repositories></repositories>
    	<pluginRepositories></pluginRepositories>
    	<properties></properties>
    </project>

激活Profile

有多种激活Profile的方式:

  1. 命令行方式激活,如有两个profile id为devx和devy的profile:
    mvn clean install  -Pdevx,devy
  2. settings文件显式激活
    <settings>
    	...
    	<activeProfiles>
    		<activeProfile>devx</activeProfile>
    		<activeProfile>devy</activeProfile>
    	</activeProfiles>
    	...
    </settings>

  3. 系统属性激活,用户可以配置当某系统属性存在或其值等于期望值时激活profile,如:
    <profiles>
    	<profile>
    		<activation>
    			<property>
    				<name>actProp</name>
    				<value>x</value>
    			</property>
    		</activation>
    	</profile>
    </profiles>

    不要忘了,可以在命令行声明系统属性。如:

    mvn clean install -DactProp=x

    这其实也是一种从命令行激活profile的方法,而且多个profile完全可以使用同一个系统属性来激活。别忘了,系统属性可以通过mvn help:system来查看

  4. 操作系统环境激活,如
    <profiles>
    	<profile>
    		<activation>
    			<os>
    				<name>Windows XP</name>
    				<family>Windows</family>
    				<arch>x86</arch>
    				<version>5.1.2600</version>
    			</os>
    		</activation>
    	</profile>
    </profiles>

    这里的family值包括Window、UNIX和Mac等,而其他几项对应系统属性的os.name、os.arch、os.version

  5. 文件存在与否激活,Maven能根据项目中某个文件存在与否来决定是否激活profile
    <profiles>
    	<profile>
    		<activation>
    			<file>
    				<missing>x.properties</missing>
    				<exists>y.properties</exists>
    			</file>
    		</activation>
    	</profile>
    </profiles>

    Notice:插件maven-help-plugin提供了一个目标帮助用户了解当前激活的profile:

    mvn help:active-profiles
    另外还有一个目标来列出当前所有的profile:
    mvn help:all-profiles

 

-----------------------------------------------------------------------------

问题解决阐述:

先看我们关心得问题。“为什么在xxx.properties,xxx.xml 中能使用${} 来访问pom文件的属性”

这是因为Maven 提供的资源过滤的功能

默认情况下,Maven属性只有在POM中才会被解析。资源过滤就是指让Maven属性在资源文件(src/main/resources、src/test/resources)中也能被解析。

在POM中添加下面的配置便可以开启资源过滤

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

 

从上面的配置中可以看出,我们其实可以配置多个主资源目录和多个测试资源目录。

Maven除了可以对主资源目录、测试资源目录过滤外,还能对Web项目的资源目录(如css、js目录)进行过滤。这时需要对maven-war-plugin插件进行配置

<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>**/*.css</include>  
                    <include>**/*.js</include>  
                </includes>  
            </resource>  
        </webResources>  
    </configuration>  
</plugin>  

注意这个${} 只能引用Maven中的属性

事实上有六种类型的Maven属性:

  • 内置属性:主要有两个常用内置属性

            ${basedir}表示项目根目录,即包含pom.xml文件的目录;

            ${version}表示项目版本。

  • POM属性:pom中对应元素的值。

            例如${project.artifactId}对应了<project><artifactId>元素的值。

      常用的POM属性包括:

  1.  ${project.build.sourceDirectory}:项目的主源码目录,默认为src/main/java/.                            
  2.  ${project.build.testSourceDirectory}:项目的测试源码目录,默认为/src/test/java/.                    
  3. ${project.build.directory}:项目构建输出目录,默认为target/.                                                  
  4.  ${project.build.outputDirectory}:项目主代码编译输出目录,默认为target/classes/.                
  5.  ${project.build.testOutputDirectory}:项目测试代码编译输出目录,默认为target/testclasses/.  
  6. ${project.groupId}:项目的groupId.                                                                                          
  7.  ${project.artifactId}:项目的artifactId.                                                                                          
  8. ${project.version}:项目的version,于${version}等价                                                                    
  9. ${project.build.finalName}:项目打包输出文件的名称,默认为  ${project.artifactId}${project.version}.
  • 自定义属性:在pom中<properties>元素下自定义的Maven属性。例如

自定义属性:在pom中<properties>元素下自定义的Maven属性。

eg:

<project>  
    <properties>  
        <my.prop>hello</my.prop>  
    </properties>  
</project>
  • Settings属性:与POM属性同理。如${settings.localRepository}指向用户本地仓库的地址。
  • Java系统属性:所有Java系统属性都可以使用Maven属性引用,例如${user.home}指向了用户目录。可以通过命令行mvn help:system查看所有的Java系统属性
  • 环境变量属性:所有环境变量都可以使用以env.开头的Maven属性引用。例如${env.JAVA_HOME}指代了JAVA_HOME环境变量的值。也可以通过命令行mvn help:system查看所有环境变量。

配置之后就可以在。其他目录文件中引用pom文件的属性。

简单的这个疑问解决了。关于Maven内置的三大特性:属性、Profile和资源过滤

这里并没有展开。这篇博客就是来解决我提出的疑问的。

更多内容可以看我的这篇博客:https://my.oschina.net/zjllovecode/blog/1789905

Logo

魔乐社区(Modelers.cn) 是一个中立、公益的人工智能社区,提供人工智能工具、模型、数据的托管、展示与应用协同服务,为人工智能开发及爱好者搭建开放的学习交流平台。社区通过理事会方式运作,由全产业链共同建设、共同运营、共同享有,推动国产AI生态繁荣发展。

更多推荐