美文网首页
灵活的构建

灵活的构建

作者: 依然爱笑的薰衣草 | 来源:发表于2017-10-11 22:53 被阅读11次

    基础概念

    灵活的构建能够解决项目构建过程中一个常常需要面对的问题,就是不同的平台环境差异,这可能是操作系统的差异、平台开发和测试平台的差异、不同客户之间的差异。为了应对这些差异,Maven提供了属性、资源过滤以及profile三大特性。

    Maven属性

    内置属性:主要有两个常用内置属性,${basedir}表示项目根目录,即包含pom.xml文件的目录,${version}表示项目版本。

    POM属性:用户可以使用该类属性引用POM文件中对应元素的值。例如${project.artifactId}就对应了<project><artifactId>元素的值,常用的POM属性包括:

    ${project.build.sourceDirectory}:项目的主源码目录,默认为src/main/java/
    ${project.build.testSourceDirectory}:项目的测试源码目录,默认为src/main/test/java/
    ${project.build.directory}:项目构建输出目录,默认为target/
    ${project.outputDirectory}:项目主代码编译目录,默认为src/test/java/
    ${project.testOutputDirectory}:项目测试代码编译输出目录,默认为target/classes/
    

    这些属性都对应了一个POM元素,它们中一些属性的默认值都是在超级POM中定义的,更多POM元素也可以在超级POM中查看。

    自定义属性,用户可以在POM的<properties>元素下自定义Maven属性。例如:

    <properties>
      <my.prop>hello</my.prop>
    </properties>
    

    然后在POM中其它地方使用${my.prop}的时候会被替换成hello。

    Settings属性:与POM属性同理,用户使用以settings.开头的属性引用setting.xml文件中XML元素的值。如常用的${settings.localRepository}指向用户本地仓库的地址。

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

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

    资源过滤

    开启资源过滤只需要超级POM中,只需要在默认资源文件配置中,加入一行filtering配置即可,如代码清单:

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

    我们将数据库配置的变化部分提取成了Maven属性,在POM的profile中定义了这些属性的值,再通过命令行激活profile,Maven就能够在构建项目的时候使用profile中属性值替换数据库配置文件中的属性引用,运行命令如下:

    $mvn clean install-Pdev
    

    mvn的-P参数表示在命令行激活一个profile,当然可以同时激活几个,以‘,’隔开。

    激活profile的方法

    命令行激活:用户可以使用mvn命令行参数-P加上profile的id来激活profile。

    $ mvn clean install -Pdev,dev-y
    

    settings文件显式激活:如果用户希望某个profile默认一直处于激活状态,就可以配置settings.xml文件的activeProfiles元素,表示其配置的profile对于所有项目都处于激活状态

    <activeProfiles>
      <activeProfile>dev - x</activeProfile>
    </activeProfiles>
    

    系统属性激活:用户可以配置当某系统存在的时候,自动激活profile

    <profile>
      <activation>
        <property>
          <name>test</name>
        </property>
      </activation>
    </profile>
    

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

    <profile>
      <activation>
        <oa>
          <name>Windows XP</name>
          <family>Windows</family>
          <arch>x86</arch>
          <version>5.1.2600</version>
        </oa>
      </activation>
    </profile>
    

    这里family的值包括Windows、UNIX和MAac等,而其它几项name、arch、version,用户可以通过查看环境中的系统属性os.name、os.arch、os.version获得。

    文件存在与否激活
    Maven能够根据项目中某个文件存在与否来决定是否激活profile

    <profile>
      <activation>
        <file>
          <missing>x.properties</missing>
          <exists>y.properties</exists>
        </file>
      </activation>
    </profile>
    

    默认激活:用户可以在定义profile的时候指定其默认激活,不过如果POM中有任何一个profile通过以上其他任意一种方式被激活了,所有的默认激活配置都会失效。

    <profile>
      <id>dev</id>
      <activation>
        <activeByDefault>true</activeByDefault>
      </activation>
    </profile>
    

    补充:maven-help-plugin提供了一个目标帮助用户了解当前激活的profile,$ mvn help:active-profiles;它还有另一个目标用来列出当前所有的profile,$ mvn help:all-profiles

    profile的种类

    1.pom.xml:很显然,pom.xml声明的profile只对当前项目有效
    2.用户settings.xml:用户目录下.m2/settings.xml中的profile对本机上该用户所有的Maven项目有效
    3.全局settings.xml:Maven安装目录下conf/settings.xml对本机上所有的Maven项目有效
    4.profiles.xml:和pom.xml声明在同一目录下,基本不用不做介绍
    

    为了保证该profile伴随某个特定的pom.xml文件一起存在,profile大部分都是声明在pom.xml文件中的,它可以修改或者增加很多POM元素的。Maven不允许用户在settings.xml的profile中声明依赖或者插件,事实上,在pom.xml外部的profile只能够声明如下的几个元素:

    <project>
      <repositories></repositories>
      <pluginRepositories></pluginRepositories>
      <properties></properties>
    </project>
    

    现在不用担心POM外部的profile会对项目产生太大的影响了,事实上这样的profile仅仅能用来影响到项目的仓库和Maven属性。

    profile的使用

    Web资源过滤:Web项目中除了上述我们提到的src/main/resource/文件下的资源文件,还有另外一类资源文件,默认他们的源码位于src/main/webapp/目录,经打包后位于项目的WAR包的根目录。如css、js文件中的资源,如果需要针对不同用户使用不同的css,只需要配置不同的profile,在maven-war-plugin对src/main/webapp这一Web资源目录开启过滤,按用户需要的css文件选择对应的profile进行激活即可。

    在Profile激活集成测试:可以配置Maven默认只会执行单元测试,如果想要执行集成测试,就需要激活对应的profile文件才行。由此可见,profile不仅可以用来应对不同的构建环境以保持构建的可移植性,还可以用来分离构建的一些较耗时或者耗资源的行为,并给予更合适的构建频率。


    文章仅供参考,代码并不是全正确,只需要知道在对应的情况,可以做对应的处理,代码是变化的,我相信原理不变


    相关文章

      网友评论

          本文标题:灵活的构建

          本文链接:https://www.haomeiwen.com/subject/ktsgyxtx.html