最近遇到Spring-boot的多个profile切换问题,应用程

作者:美狮美高梅官方网站

最近遇到Spring-boot的多个profile切换问题,需求是这样的:微服务中引入了Spring Cloud Config,服务启动的时候,从Config Server中读取该实例对应的配置信息。本地开发环境可能使用的profile是default,到了集成测试环境就需要切换到jenkins,到了预发布环境又变成了prod。多个profile需要之间可以切换。

最近遇到Spring-boot的多个profile切换问题,需求是这样的:微服务中引入了Spring Cloud Config,服务启动的时候,从Config Server中读取该实例对应的配置信息。本地开发环境可能使用的profile是default,到了集成测试环境就需要切换到jenkins,到了预发布环境又变成了prod。多个profile需要之间可以切换。

在后端开发中,应用程序在不同的环境可能会有不同的配置,例如数据库连接、日志级别等,开发,测试,生产每个环境可能配置都不一致。

这边设置的时候还走了点弯路,先是探索了一遍pom的profile,后来才到Spring-boot的配置文件。

这边设置的时候还走了点弯路,先是探索了一遍pom的profile,后来才到Spring-boot的配置文件。

使用Spring Boot的Profile可以实现多场景下的配置切换,方便开发中进行测试和部署生产环境。 下面就大致介绍一下yml配置文件跟properties配置文件怎么使用profile配置不同环境的配置文件。

新美高梅网站 ,这两部分实现的功能不太一样,本文将会具体讲下这两部分。

这两部分实现的功能不太一样,本文将会具体讲下这两部分。

美狮美高梅官方网站 ,开发环境

  • JDK 1.8
  • Maven 3.x
  • Spring Boot 1.5.8
  • Intellij Idea 2017

maven切换profile的命令很简单,加上-P参数指定你的profile,如指定prod:

1. profile之Maven

maven切换profile的命令很简单,加上-P参数指定你的profile,如指定prod:

> mvn clean package -P prod

maven使用名字为prod的profile来打包,即所有的配置文件都使用生产环境。

下面看下pom中的profiles:

> <profiles>
> 
> <profile>
> 
> <id>dev</id>
> 
> <activation>
> 
> <activeByDefault>true</activeByDefault>
> 
> </activation>
> 
> <properties>
> 
> <profileActive>dev</profileActive>
> 
> </properties>
> 
> <dependencies>
> 
> <dependency>
> 
> <groupId>org.springframework.boot</groupId>
> 
> <artifactId>spring-boot-devtools</artifactId>
> 
> <optional>true</optional>
> 
> </dependency>
> 
> </dependencies>
> 
> </profile>
> 
> <profile>
> 
> <id>prod</id>
> 
> <dependencies>
> 
> <dependency>
> 
> <groupId>org.springframework.boot</groupId>
> 
> <artifactId>spring-boot-starter-undertow</artifactId>
> 
> </dependency>
> 
> </dependencies>
> 
> <properties>
> 
> <profileActive>prod</profileActive>
> 
> </properties>
> 
> </profile>
> 
> </profiles>

对于resources的配置如下:

> <build>
> 
> <resources>
> 
> <resource>
> 
> <directory>src/main/resources</directory>
> 
> <filtering>true</filtering>
> 
> <!-- 过滤掉所有配置文件-->
> 
> <excludes>
> 
> <exclude>application-dev.yml</exclude>
> 
> <exclude>application-prod.yml</exclude>
> 
> </excludes>
> 
> </resource>
> 
> <resource>
> 
> <filtering>true</filtering>
> 
> <directory>src/main/resources</directory>
> 
> <!--根据profile中的变量profileActive指定对应的配置文件-->
> 
> <includes>
> 
> <include>application-${profileActive}.yml</include>
> 
> </includes>
> 
> </resource>
> 
> </resources>
> 
> </build>

上面的两段pom配置相结合,当指定profile为prod时,环境变量profileActive的属性值变为prod。指定打包时,包含application-prod.yml。

所以当你有多套配置文件,可以动态根据mvn命令的参数-P动态指定你所需要加载的配置文件。

一、使用Spring Boot Profiles

mvn clean package -P prod

2. profile之Spring boot

Profile是Spring boot用来针对不同环境对不同配置提供支持的,全局Profile配置使用。

application-{profile}.yml 如:application-yml。

spring通过配置spring.profiles.active指定激活某个具体的profile。除了spring.profiles.active来激活一个或者多个profile之外,还可以用spring.profiles.include来叠加profile。

spring.profiles.include: prod,dev

下面看一下我们的application.yml中包含的配置:

> spring:
> 
> profiles:
> 
> active: dev
> 
> ---
> 
> #开发环境配置
> 
> spring:
> 
> profiles: dev
> 
> server:
> 
> port: 8080
> 
> ---
> 
> #测试环境配置
> 
> spring:
> 
> profiles: test
> 
> server:
> 
> port: 8081
> 
> ---
> 
> #生产环境配置
> 
> spring:
> 
> profiles: prod
> 
> server:
> 
> port: 8082

application.yml文件分为四部分,使用一组(—)来作为分隔符。第一部分,通用配置部分,表示三个环境都通用的属性,默认激活了dev的profile;后面三部分分别表示不同的环境,指定了不同的port。

部署到服务器的话,正常会打成jar包,加上参数

--spring.profiles.active=test指定加载哪个环境的配置。

在IDE中也可以直接配置激活的profile。

![idea配置(http://upload-images.jianshu.io/upload_images/9005929-29ccd8302a49a5e5?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)

新美高梅网站 1

idea配置profile

1. 使用yml文件

首先,我们先创建一个名为 application.yml的属性文件,如下:

server:
  port: 8080

my:
  name: demo

spring:
  profiles:
    active: dev

---
#development environment
spring:
  profiles: dev

server:
  port: 8160

my:
  name: ricky

---
#test environment
spring:
  profiles: test

server:
  port: 8180

my:
  name: test

---
#production environment
spring:
  profiles: prod

server:
  port: 8190

my:
  name: prod

application.yml文件分为四部分,使用 --- 来作为分隔符,第一部分通用配置部分,表示三个环境都通用的属性, 后面三段分别为:开发,测试,生产,用spring.profiles指定了一个值(开发为dev,测试为test,生产为prod),这个值表示该段配置应该用在哪个profile里面。

如果我们是本地启动,在通用配置里面可以设置调用哪个环境的profil,也就是第一段的spring.profiles.active=XXX, 其中XXX是后面3段中spring.profiles对应的value,通过这个就可以控制本地启动调用哪个环境的配置文件,例如:

spring:
    profiles:
        active: dev

表示默认 加载的就是开发环境的配置,如果dev换成test,则会加载测试环境的属性,以此类推。

注意:如果spring.profiles.active没有指定值,那么只会使用没有指定spring.profiles文件的值,也就是只会加载通用的配置。

maven使用名字为prod的profile来打包,即所有的配置文件都使用生产环境。下面看下pom中的profiles:

3. config server的配置

这节讲下与Spring cloud config的结合使用。既然使用了config server,动态配置这块基本就由配置服务器完成了。配置服务器中对该服务指定多个profile。config Server中的配置优先于本地配置,当服务启动时,根据激活的profile,去配置服务器拉取其对应的配置。

既然知道了上面的主要流程,就可以明白我们的需求其实是要在服务启动时指定激活的profile。所以上面一节关于Spring boot的profile动态配置,我们的问题就能解决了。但上面讲到的是jar包启动时指定--spring.profiles.active,实际都是微服务的容器化部署,服务通过容器直接启动jar包,这样就需要容器启动的时候能够动态指定active profile,所以上面的配置改一下,如下:

> spring:
> 
> profiles:
> 
> active: ${ACTIVE_PROFILE:dev}

新美高梅网站 2

容器启动截图profile

从容器的启动截图来看,指定了docker run -d -e ACTIVE_PROFILE=exp ...后,active profile 变味了exp,并且从config server中拉取对应的是gatewayserver的exp配置。

获取更多免费资料加群:554355695
如果你想学习Java工程化、高性能及分布式、高性能、深入浅出。性能调优、Spring,MyBatis,Netty源码分析和大数据等知识点可以来找我。
而现在我就有一个平台可以提供给你们学习,让你在实践中积累经验掌握原理。主要方向是JAVA架构师。如果你想拿高薪,想突破瓶颈,想跟别人竞争能取得优势的,想进BAT但是有担心面试不过的,可以加我的Java架构进阶群:554355695

启动参数

如果是部署到服务器的话,我们正常打成jar包,启动时通过 --spring.profiles.active=xxx 来控制加载哪个环境的配置,完整命令如下:

java -jar xxx.jar --spring.profiles.active=test 表示使用测试环境的配置

java -jar xxx.jar --spring.profiles.active=prod 表示使用生产环境的配置
<profiles> <profile> <id>dev</id> <activation> <activeByDefault>true</activeByDefault> </activation> <properties> <profileActive>dev</profileActive> </properties> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-devtools</artifactId> <optional>true</optional> </dependency> </dependencies> </profile> <profile> <id>prod</id> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-undertow</artifactId> </dependency> </dependencies> <properties> <profileActive>prod</profileActive> </properties> </profile></profiles>

4. 总结

本文主要写了Spring-boot配置服务器切换profile。首先描述了需求背景,然后是对maven pom中profile进行了探索与讲解,其次是讲解了Spring-boot中的profile切换,最后结合config server实现容器部署微服务的profile。笔者最开始一直认为通过pom的profile切换就可以设置服务启动的profile,经过一番探索,发现与配置服务器结合好像并不需要pom的profile这么繁琐,结合配置服务器可以更方便的使用Spring boot的profile。

使用多个yml配置文件进行配置属性文件

我们也可以使用多个yml来配置属性,将于环境无关的属性放置到application.yml文件里面;通过与配置文件相同的命名规范,创建application-{profile}.yml文件 存放不同环境特有的配置,例如 application-test.yml 存放测试环境特有的配置属性,application-prod.yml 存放生产环境特有的配置属性。

通过这种形式来配置多个环境的属性文件,在application.yml文件里面spring.profiles.active=xxx来指定加载不同环境的配置,如果不指定,则默认只使用application.yml属性文件,不会加载其他的profiles的配置。

对于resources的配置如下:

2. 使用properties文件

如果使用application.properties进行多个环境的配置,原理跟使用多个yml配置文件一致,创建application-{profile}.properties文件 存放不同环境特有的配置,将于环境无关的属性放置到application.properties文件里面,并在application.properties文件中通过spring.profiles.active=xxx 指定加载不同环境的配置。如果不指定,则默认加载application.properties的配置,不会加载带有profile的配置。

 <build> <resources> <resource> <directory>src/main/resources</directory> <filtering>true</filtering> <!-- 过滤掉所有配置文件--> <excludes> <exclude>application-dev.yml</exclude> <exclude>application-prod.yml</exclude> </excludes> </resource> <resource> <filtering>true</filtering> <directory>src/main/resources</directory> <!--根据profile中的变量profileActive指定对应的配置文件--> <includes> <include>application-${profileActive}.yml</include> </includes> </resource> </resources> </build>

二、Maven Profile

如果我们使用的是构建工具是Maven,也可以通过Maven的profile特性来实现多环境配置打包。

pom.xml配置如下:

<profiles>
        <!--开发环境-->
        <profile>
            <id>dev</id>
            <properties>
                <build.profile.id>dev</build.profile.id>
            </properties>
            <activation>
                <activeByDefault>true</activeByDefault>
            </activation>
        </profile>
        <!--测试环境-->
        <profile>
            <id>test</id>
            <properties>
                <build.profile.id>test</build.profile.id>
            </properties>
        </profile>
        <!--生产环境-->
        <profile>
            <id>prod</id>
            <properties>
                <build.profile.id>prod</build.profile.id>
            </properties>
        </profile>
    </profiles>

    <build>
        <finalName>${project.artifactId}</finalName>
        <resources>
            <resource>
                <directory>src/main/resources</directory>
                <filtering>false</filtering>
            </resource>
            <resource>
                <directory>src/main/resources.${build.profile.id}</directory>
                <filtering>false</filtering>
            </resource>
        </resources>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <classifier>exec</classifier>
                </configuration>
            </plugin>
        </plugins>
    </build>

通过执行 mvn clean package -P ${profile} 来指定使用哪个profile。

上面的两段pom配置相结合,当指定profile为prod时,环境变量profileActive的属性值变为prod。指定打包时,包含application-prod.yml。

参考资料

Spring Boot Reference Guide - Profiles

Maven profiles

本文由美狮美高梅官方网站发布,转载请注明来源

关键词: