maven中profiles使用详解

使用的场景

常常遇到一些项目中多环境切换的问题。比如在开发过程中用到开发环境，在测试中使用测试环境，在生产中用生产环境的情况。springboot中提供了 spring.profile.active的方式来实现多环境的切换，通过设置环境变量和启动参数的方式。但是这样做终究不能一劳永逸，要么需要修改yml文件，要么需要记得启动的时候带上参数。而利用maven的profiles，可以减少很多工作。让我们通过几个例子一步步的掌握使用maven的profiles属性。

快速上手

pom.xml文件设置

        
            
            dev
            
                
                dev
            
        
        
            prod
            
                prod
            
            
                true
            
        
        
            test
            
                test
            
        

目录结构。

application.yml

spring:
  profiles:
    active: @profiles.active@

application-dev.yml中代码如下

server:
  port: 7091

其他几个文件我只是把端口号进行了修改，方便打包看不同的效果。

maven打包与激活profiles

你可以执行命令

mvn clean package -Ptest

然后启动jar包，可以看到jar包启动的是test的配置，如果换成-Pdev启动的就是dev包的端口。

默认启动方式

如果不带-Ptest，启动的是 prod的端口。因为在profiles中我们看到有配置默认的选项。

 
  true

settings.xml中使用activeProfiles指定

  
     profileTest1  
  

通过IDEA的可视化的方式

当然如果使用IDEA工具进行开发，还可以使用可视化的方式进行打包。

更高级的玩法

通过和pom结合的方式设置动态参数

如果我们希望通过docker-maven-plugin插件，把编译好的jar打包成docker并且传入相应的开发、测试、生产的服务器中去。这个时候，我们就需要根据不同的条件去传入不同的服务器。

在profiles中我们可以做以下定义

 
        
            dev
            
                dev
                http://dev.demo.com:2375
            
            
                true
            
        
        
            test
            
                test
                http://test.demo.com375
            
        
        
            prod
            
                prod
                http://prod.demo.com:2375
            
        
    

而在build控件中我们可以使用以下配置

  
     
                com.spotify
                docker-maven-plugin
                1.1.0
                
                    
                        build-image
                        package
                        
                            build
                        
                    
                
                
                    demo/${project.artifactId}
                    
                        ${project.version}-${current.time}
                        latest
                    
                    true
                    ${docker.host}
                    true
                    java:8
                    ["java", "-jar", "/${project.build.finalName}.jar"]
                    
                        
                            /
                            ${project.build.directory}
                            ${project.build.finalName}.jar
                        
                    
                
            
  

其中 ${project.artifactId} 和${project.version}是关于 节点下面 和 的引用。${current.time}是在build-helper-maven-plugin定义的，我们回头再研究。

${docker.host}则是我们在profiles中定义的，可以随着我们选择不同的profile，把jar包build成不同的docker镜像，并传入指定服务器。

通过和yml结合设置动态参数

除了可以在pom中设置动态参数，使得其根据profile的不同选择不同的参数。还可以通过设置不同的profile，让yml选择不同的参数。这点和快速上手的例子有点相似。具体如下：

设置profiles

        
            dev
            
                dev
                http://127.0.0.1:8001/eureka
            
            
                true
            
        
        
            test
            
                test
                http://base-registry:8001/eureka
            
        
        
            prod
            
                prod
                http://base-registry:8001/eureka
            
        
        
            new
            
                new
                http://base-registry:8001/eureka
            
        
    

我们在profile中设置了一个eureka.url的属性，就可以在yml中直接调用。

eureka:
  client:
    service-url:
      defaultZone: @eureka.url@
    registry-fetch-interval-seconds: 10
  instance:
    prefer-ip-address: true

在IDEA调试和启动的时候，一般会报错如下：

org.yaml.snakeyaml.scanner.ScannerException: while scanning for the next token
found character ‘@’ that cannot start any token.

解决方法就是引入yaml.sankeyaml的jar包

            org.yaml
            snakeyaml

打包不同的资源

在profile打包yml文件的时候，如果我们解压了jar包，会发现还是把所有的application-profile.yml文件给打包进去了。这个可以通过设置打包参数，只打包需要的application文件。

 
        
            dev
            
                dev
            
            
                true
            
        
        
            prd
            
                prd
            
        
    


    
        springmvc
        
            
                src/main/java
                
                    *.xml
                
            
            
                src/main/resources
                
                    dev/*
                    prd/*
                
            
            
                src/main/resources/${env}
            
        
    

目录结构如下：