10. maven属性
·
1. maven属性
1.1 maven属性概述
-
经常在maven项目的pom文件中，看到这样的代码
<properties> <spring.framework>4.0.4.RELEASE</spring.framework> </properties> <dependencies> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-core</artifactId> <version>${spring.framework}</version> </dependency> </dependencies> -
这段xml代码，先自定义了一个maven属性
spring.framework，然后${spring.framework}的方式引用该maven属性的值。 -
maven完成依赖解析后，
spring-core依赖的版本为4.0.4.RELEASE。 -
其实，这就是maven属性使用方式中的一种：先自定义maven属性，然后在其他地方以特定语法格式引用该属性的值
<!-- 自定义属性 --> <property_name>property_value</property_name> <!-- 引用方式 --> ${property_name}
1.2 maven属性的分类
1.2.1 内部属性
1.2.1.1 内置属性
- 书中介绍了两个内置属性：
${basedir}和${version}。${basedir}是maven项目的根目录，也就是pom.xml文件的父目录${version}是maven项目的版本号，与${project.version}等价
1.2.1.2 项目属性（pom属性）
-
我们知道在pom文件中有很多标签，大部分的标签都可以作为maven属性，被称作项目属性
-
项目属性，以
project为前缀，引用方式为${project.label_name} -
例如，访问
<artifactId>标签的值，引用方式为${project.artifactId} -
项目属性的分类如下：
项目属性归类 举例 与项目坐标有关的 ${project.groupId}、${project.version}、${project.packaging}等，甚至可以引用父模块的项目属性：${project.parent.groupId}与项目文件目录有关的属性 ${project.basedir}、${project.build.directory}等，一般都对应项目的target目录、target/classes目录等
1.2.1.3 settings属性
- settings.xml文件中也有很多标签，这些标签也可以作为maven属性去使用，被称为settings属性
- settings属性，以
settings为前缀，引用方式为${settings.label_name} - 例如：访问
<localRepository>标签的值，引用方式为${settings.localRepository}
1.2.1.4 自定义属性
- 上面三种属性都是maven内部已有的属性，并不能完全满足用户需求
- 例如，某个项目中，与sprinboot有关的依赖的version要求统一使用
4.0.0 - 如果直接在version中重复书写4.0.0，之后的维护将会非常困难：修改version变更，需要修改多处，还可能遗漏
- 这时候，自定义属性就派上了用场：在pom文件中通过
<properties>标签自定义maven属性，然后以${property_name}的形式引用 - 自定义属性的使用，可以参考1.1中的介绍
1.2.2 外部属性
1.2.2.1 java系统属性
- java有很多系统属性：
System.getProperty()或System.setProperty()进行访问与设置，也可以在Java命令行通过-Dproperty=value进行传参 - 这些系统属性也可以作为maven属性使用，通过
${java_property_name}进行访问 - 对于Java自带的系统属性，可以直接通过
${java_property_name}进行访问，而无需单独赋值-
config.properties文件，在文件中访问
${runtime.version}的值runtime.version=${java.runtime.version} -
在pom.xml中，开启资源过滤，这样就能将Java系统属性
${java.runtime.version}的值成功赋值给config.properties中的runtime.version<build> <resources> <resource> <directory>${project.basedir}/src/main/resources</directory> <filtering>true</filtering> </resource> </resources> </build> -
编写代码，获取config.properties中属性的值
public static void main(String[] args) throws IOException { InputStream resourceAsStream = Test.class.getClassLoader().getResourceAsStream("config.properties"); Properties properties = new Properties(); properties.load(resourceAsStream); properties.forEach((x, y) -> System.out.printf("%s: %s\n", x, y)); } -
使用
mvn clean package -DskipTests命令，生成jar包，然后执行jar。 -
执行结果如下，成功通过maven访问到Java系统属性
-
- 若使用Java自定义的系统属性，则需在执行mvn命令时，通过
-Dproperty=value为系统属性赋值，这与Java系统属性的赋值是一致的- 将config.properties文件修改如下
app.env=${app.env} - 生成java的mvn修改为
mvn clean package -DskipTests -Dapp.env="sunrise dev" - 注意： 如果属性值中有空格，需要使用
" "进行修饰 - 最终的执行结果如下，与传入的Java自定义系统属性值一致
- 将config.properties文件修改如下
1.2.2.2 环境变量属性
- 一般安装软件时，都会配置系统环境变量，例如
JAVA_HOME，这些环境变量也可以作为maven属性，被称为环境变量属性 - 环境变量属性，以
env为前缀，引用方式为${env.variable_name，例如：${env.PATH}
1.3 题外话
- 学习《maven实战》该部分内容时，发现这篇博客讲解的不错：maven笔记：maven属性大全
- 对maven属性的分类，自己也是按照理解进行的分类，不同的资料可能分类有所不同
2. maven属性+profile实现资源过滤
2.1 为什么要进行资源过滤？
- 在spring boot项目的开发中，我们会为项目配置mysql信息，一般存放在resources目录下的xxx.properties文件中，
- 在开发环境，使用dev数据库；在预发环境，使用pre数据库；在线上环境，使用prd数据库
- 将该项目部署到不同环境之前，需要将mysql信息更新为对应的数据库信息，否则项目将无法运行
- 其实，我们可以将这些变化的内容抽象成maven属性，通过某种方式将这些maven属性按照dev、pre、prd组织起来
- 最后，在项目安装或打包时根据我们传入的dev/pre/prd来决定mysql数据库信息到底使用哪个分组中的值
- 书中，将这种对项目资源文件进行动态配置叫做资源过滤。在笔者看来，就是maven属性组的匹配与使用
- 因为使用
<profile>定义的profile，可以通过profile id、activation定义的条件等，激活一个profile，从而可以访问profile中定义的若干属性
2.2 maven属性结合profile实现资源过滤
-
需求描述：主资源目录下有一个
config.prooperties文件，其中的部分属性值会随dev、pre环境而变化，而user信息是固定min.connection=${min.connection} max.timeout=${max.timeout} user.first.name=${user.first.name} user.password=${user.password} -
接着，在pom.xml中定义profile，按照dev、pre组织不同环境的值，并定义user属性组的值
<profiles> <profile> <id>dev</id> <properties> <min.connection>20</min.connection> <max.timeout>10</max.timeout> </properties> </profile> <profile> <id>pre</id> <properties> <min.connection>50</min.connection> <max.timeout>20</max.timeout> </properties> </profile> <profile> <id>user</id> <properties> <user.first.name>lucy</user.first.name> <user.password>********</user.password> </properties> </profile> </profiles> -
然后，在pom.xml中开启资源过滤
<build> <resources> <resource> <directory>${project.basedir}/src/main/resources</directory> <filtering>true</filtering> </resource> </resources> </build> -
编写程序，获取config.prooperties中的属性值
public static void main(String[] args) throws IOException { InputStream resourceAsStream = Test.class.getClassLoader().getResourceAsStream("config.properties"); Properties properties = new Properties(); properties.load(resourceAsStream); properties.forEach((x, y) -> System.out.printf("%s: %s\n", x, y)); } -
在编译时，通过
-P选项指定profile id，多个profile id之间使用,分隔mvn clean package -DskipTests -Ppre,user # -P与profile id之间也可以存在空格 mvn clean package -DskipTests -P pre,user -
执行jar包，打印结果如下，成功获取到pom.xml中定义的pre和user profile的值
2.3 激活profile
2.3.1 通过maven命令的-P选项激活
- 上面的示例，展示了如何通过mvn命令的
-P选项激活profile
2.3.2 settings.xml中通过<activeProfile>激活
- 可以在settings.xml中配置profile id，使其一直处于激活状态
<settings> ... <!-- 省略其他无关配置 --> <activeProfiles> <activeProfile>dev</activeProfile> <activeProfile>user</activeProfile> </activeProfiles> </settings> - 使用
mvn clean package -DskipTests生成jar包，执行jar包，发现成功获取dev和user的属性值
profile id覆盖问题
- 如果编译时，再次通过
-P选项，将环境指定为pre，则setttings.xml的配置将会被覆盖
- 这说明，-P选项指定profile id的优先级
高于settings.xml中的activeProfile指定profile id的优先级 - 所以，笔者认为：settings.xml中设置profile id可以作为默认的profile，兜底使用
2.3.3 <activation>定义激活条件
- 可以通过
<activation>标签，为每个profile定义激活条件 - 执行maven命令时，如果满足激活条件，则可以激活该profile
2.3.3.1 使用自定义的系统属性激活profile
-
通过
<activation>为dev这个profile配置激活条件：存在系统属性test时，激活dev profile<profile> <id>dev</id> <properties> <min.connection>20</min.connection> <max.timeout>10</max.timeout> </properties> <activation> <property> <name>test</name> </property> </activation> </profile> -
config.properties文件定义如下：
min.connection=${min.connection} max.timeout=${max.timeout} -
执行maven命令时，通过
-Dtest去激活dev profile
-
若不指定
-Dtest，则无法激活dev profile，则打印出的config.properties中的property值为原始的字符串（无法编译替换）
-
甚至，还可以规定在系统属性值为期望值时，才激活profile。
-
例如下面的配置，执行maven命令时，通过
-Dtest=10激活dev profile<profile> <id>dev</id> <properties> <min.connection>20</min.connection> <max.timeout>10</max.timeout> </properties> <activation> <property> <name>test</name> <value>10</value> </property> </activation> </profile>
2.3.3.2 其他激活方式
- 除此之外，还可以根据os的类型去激活profile
<profiles> <profile> <activation> <os> <name>Windows XP</name> <family>Windows</family> <arch>x86</arch> <version>5.1.2600</version> </os> </activation> ... </profile> - 还有根据文件存在与否去激活profile等，更多高阶用法可以参考maven官方文档：Introduction to Build Profiles
2.3.3.3 默认激活配置
-
将
<activeByDefault>设置为true，表示默认激活该profile<activation> <activeByDefault>true</activeByDefault> </activation> -
默认激活是级别最低的一种激活方式，一但使用了前面的激活方式激活profile，则默认激活配置会失效。
-
下面的profile定义中，dev和pre都有相同的属性值；dev profile默认为激活状态，但在执行maven命令时，通过
-Ppre激活了pre profile<profiles> <profile> <id>pre</id> <properties> <min.connection>50</min.connection> <max.timeout>20</max.timeout> </properties> </profile> <profile> <id>dev</id> <properties> <min.connection>20</min.connection> <max.timeout>10</max.timeout> </properties> <activation> <activeByDefault>true</activeByDefault> </activation> </profile> </profiles> -
最终，config.properties中的，将获取到pre profile中的属性值
2.4 其他知识
2.4.1 profile的配置方式
- profile的配置方式共有四种，其中后3种，maven均不建议
- pom.xml：在pom文件中配置profile，对当前模块有效
- 用户settings.xml：在用户目录下有一个
.m2/settings.xml，其中配置的profile对当前用户的maven项目有效 - 全局settings.xml：在maven的安装目录下的
conf/settings.xml，其中配置的profile对本机所有的maven项目有效 - profiles.xml： 这是maven2中的配置方式，在maven3中已废弃
2.4.2 web项目中的web资源过滤
-
在web项目中往往存在这样的需求：某段文字的颜色需要随着业务变化而变化，这时也可以使用profile去实现
-
实现方式与上面的资源过滤一致，大致流程如下：
- 将变化的值抽象成maven属性
- 在pom文件中创建profile
- 在插件中开启web资源过滤
- 通过命令行激活过滤 maven命令？
-
具体实现方式，可以查阅资料
-
在此简单记录，自己对Java web项目理解不是很深刻
2.4.3 通过profile激活集成测试
- 书中还介绍了，如何基于TestNG，激活集成测试
- 具体实现方式，可以查阅资料
3. 总结
- 这一章，最重要的内容是maven属性：maven属性的分类、使用方式
- maven属性 + profile实现资源过滤：抽象变化的内容、设置profile、开启资源过滤、激活profile；profile的激活方式和配置类型
- 两种实践：针对web项目的web资源过滤，通过profile激活基于TestNG的集成测试
北京人形旗下天工造物具身智能开源社区，聚焦具身天工与慧思开物两大平台
更多推荐
2
0- 0
已为社区贡献12条内容
所有评论(0)