使用 Maven Profile 和 Filtering 打各种环境的包

每个项目都会有多套运行环境(开发,测试,正式等等),不同的环境配置也不尽相同(如jdbc.url),借助Jenkins和自动部署提供的便利,我们可以把不同环境的配置文件单独抽离出来,打完包后用对应环境的配置文件替换打包后的文件,其实maven已经给我们提供了替换方案:profile + filtering

Filtering

Filtering 是 maven 的 resource 插件 提供的功能,作用是用环境变量、pom文件里定义的属性和指定配置文件里的属性替换属性(*.properties)文件里的占位符(${jdbc.url}),具体使用如下:
src/main/resources目录有个配置文件jdbc.properties,内容如下:

jdbc.url=${pom.jdbc.url}
jdbc.username=${pom.jdbc.username}
jdbc.passworkd=${pom.jdbc.password}

配置 resource 插件,启用filtering功能并添加属性到pom:


    ...
        
    
        jdbc:mysql://127.0.0.1:3306/dev
        root
        123456
    
    
      ...
        
        
            src/main/filters.properties
        
        
          
            src/main/resources
            true
          
        
        ...
    
    ...

编译包后target目录下的jdbc.properties:

jdbc.url=jdbc:mysql://127.0.0.1:3306/dev
jdbc.username=root
jdbc.passworkd=123456

Profile 简介

什么是profile?就像一样是pom文件里的一个xml元素,在profile里几乎可以定义所有在pom里的定义的内容(,插件配置等等,不过不能再定义他自己了)。当一个profile被激活时,它定义的等就会覆盖掉原pom里定义的相同内容,从而可以通过激活不同的profile来使用不同的配置。



    ...
    
      
        dev
        
            dev
            jdbc:mysql://127.0.0.1:3306/dev
        
        
            true
        
        
            
                org.springframework
                spring-context
                3.2.4.RELEASE
            
        
      
    
    
        
            log4j
            log4j
            1.2.14
        
    
    ...

Profile 如何配置

可以在两个位置配置profile:settings.xmlpom.xml

  • settings.xml里定义的profile是全局的,对所有的项目都可用,在里面定义的配置项也稍微少了些,只能定义远程服务器的信息和属性信息(,, )。这些信息在pom.xml里也是可以定义的。

  • pom.xml里可以定义的配置如下:

  • 以及build下的:

如果profile被激活,profile里的配置和原pom的配置会做覆盖合并。

如何激活Profile

可以通过多种方式激活profile(显式的,隐式的)

显式的激活

通过maven 的-P参数激活指定的profile,参数的值是profile的id,多个profile以逗号分割,如果不想激活某个默认的profile,就在它的id前加个!

mvn -U clean package -Ptest,local,!ignore

IDEA里则可以在 Maven Projects 里直接勾选想要激活的profile

隐式的激活

配置profile时,可以在 元素下配置隐式激活的信息。

默认激活

  • pom.xml文件里



  
    
        true
    
  
  • settings.xml文件里则是通过来配置默认激活的profile列表


    artifactory

根据操作系统类型激活


    
        
            
                
                linux
                unix
                amd64
                3.19.0-30-generic
            
      
    

关于OS值的更多信息可以参考这里

根据JDK版本激活



  
    
      1.8
    
    

也可以通过[1.6,1.8)匹配多个jdk版本,关于匹配模式的详细信息可以参考这里

根据环境变量激活




  
    
      
        debug
        true
      
    
  

mvn -U clean package -Ddebug=true

通过判断文件是否存在激活


  
    
      
        /path/to/missing/file
        /path/to/exists/file
      
    
    ...
  

不同类型的隐式激活方式可以组合使用,如根据同时指定根据操作系统类型和JDK版本来激活profile,只有但两个条件都匹配是才激活之。

Filtering + Profile

思路:在不同的profile里配置不同的属性(properties),然后激活相应的profile,用其中的属性去替换jdbc.properties里的占位符。
继续使用介绍Filtering时的例子,现在添加三个profile配置,分别对应开发,测试,正式环境。
修改后的pom文件如下:


...

    
        src/main/filters-${active.profile}.properties
    
    
        
            src/main/resources
                true
        
    


    
        dev
        
            dev
        
        
        
            true
        
    
    
        test
        
            test
        
    
    
        product
        
            product
        
    
...

然后在src/main下新建三个文件:filters-dev.properties,filters-test.properties,filters-product.properties,文件内容如下(以filters-dev.properties为例):

pom.jdbc.url=jdbc:mysql://127.0.0.1:3306/dev
pom.jdbc.username=root
pom.jdbc.password=123456

用 dev profile 打开发包mvn clean package -Pdev, 打包后jdbc.properties文件内容如下:

jdbc.url=jdbc:mysql://127.0.0.1:3306/dev
jdbc.username=root
jdbc.password=123456

如果不同的运行环境只是属性值的不同,用上面的 profile + filtering 进行下变量替换可以很好的满足打包需求,如果不是简单的替换(如log4j.xml,开发环境只要输出到标准输出,测试和线上环境则还需要打到文件且文件的位置和策略也不相同),这个就需要借助maven 的 ant 插件。src/main/resources目录下有三个log4j的配置文件,分别对应三个运行环境:

resources
├── log4j-product.xml

├── log4j-test.xml
└── log4j.xml

配置如下profile:


        
            dev
            
                true
            
            
                
                    
                        src/main/resources
                        
                            config.*.properties
                            log4j-*.xml
                        
                    
                
            
        
        
            test
            
                
                    
                        maven-antrun-plugin
                        
                            
                                test
                                
                                    run
                                
                                
                                    
                                        
                                        
                                        
                                    
                                
                            
                        
                    
                
            
        
        
            product
            
                product
            
            
                
                    
                        maven-antrun-plugin
                        
                            
                                test
                                
                                    run
                                
                                
                                    
                                        
                                        
                                        
                                    
                                
                            
                        
                    
                
            
        

参考

你可能感兴趣的:(maven,profile)