Springboot 打包时切换配置文件

一、初步,使用多个配置文件

我们在使用Springboot时,springboot默认会获取classpath根目录下的application.properties和application.yml,由于开发、内测、用户测试、生产等各种环境需要有不同的配置文件,可以根据需要新建多个配置文件来区分环境

  1. 新建不同环境的application.yml文件


    image.png
  2. 我们在不同的文件中自定义配置一些参数
    主配置里是共用的参数,不需要切换环境的放在application.yml中:

server:
  port: 8384
  servlet:
    context-path: /
my:
  info:
    travel: ship

application-bar.yml中:

my:
  info:
    name: Jack

application-foo.yml中:

my:
  info:
    name: Rose
  1. Controller中使用自定义参数
@SpringBootApplication
@RestController
public class ProfilesApplication {

    @Value("${my.info.name}")
    private String name;

    @Value("${my.info.travel}")
    private String travel;

    @GetMapping("/info")
    public String info(){
        String text = "Hi,My name's " + name + ", and I'm like go to travel by " + travel + ".";
        return text;
    }

    public static void main(String[] args) {
        SpringApplication.run(ProfilesApplication.class, args);
    }
}
  1. jar包运行,使用参数来告诉springboot使用对应的配置文件
$ mvn clean package
$ java -jar -Dspring.profiles.active=foo ./target/profile.jar

请求 http://localhost:8384/info

image.png

停止服务,切换环境至bar运行

$ java -jar -Dspring.profiles.active=bar ./target/profile.jar
image.png
  1. war包部署到外置tomcat中
    需要将环境配置文件,显示的声明到主配置文件中,打war包时,需要修改主配置文件application.yml的spring.profiles.active
server:
  port: 8384
  servlet:
    context-path: /
my:
  info:
    travel: ship
spring:
  profiles:
    active: foo

二、打包时,使用参数来切换不同配置文件

很多时候,我们在开发项目中是由多人团队协作,经常的修改主配置文件就容易让本地的源码改动提交到项目远程仓库,因此在打包时能够使用参数来区分环境显得尤为重要

  1. 在pom.xml中添加<profile></profile>标签来定义环境
<profiles>
        <profile>
            <id>foo</id>
            <properties>
                <profileActive>foo</profileActive>
            </properties>
            <activation>
                <activeByDefault>true</activeByDefault>
            </activation>
        </profile>

        <profile>
            <id>bar</id>
            <properties>
                <profileActive>bar</profileActive>
            </properties>
        </profile>
    </profiles>

其中properties标签下的profileActive使我们自定义的节点,我们可以在配置文件中直接引用该节点中的值,< activation>的<activeByDefault>告诉打包时,默认使用的参数值

  1. 主配置文件application.yml中,修改spring.profiles.active
server:
  port: 8384
  servlet:
    context-path: /
my:
  info:
    travel: ship
spring:
  profiles:
    active: @profileActive@

profileActive就是我们自定义的节点,在打包时可以替换为对应的环境名称

  1. 修改pom.xml打包时插件的分隔符为@
    告诉maven插件以哪个特殊符号为准,我们配置maven-resources-plugin
<plugin>
                <artifactId>maven-resources-plugin</artifactId>
                <configuration>
                    <delimiters>@</delimiters>
                    <useDefaultDelimiters>false</useDefaultDelimiters>
                </configuration>
            </plugin>
  1. pom.xml中定义资源,maven插件打包时,可以知道哪些文件需要做profile的替换,对需要替换的文件进行配置
<resources>
            <resource>
                <directory>${project.basedir}/src/main/resources</directory>
                <filtering>true</filtering>
                <includes>
                    <include>application.yml</include>
                    <include>application-${profileActive}.yml</include>
                </includes>
                <excludes>
                    <exclude>db/**</exclude>
                    <exclude>static/**</exclude>
                    <exclude>templates/**</exclude>
                </excludes>
            </resource>
            <resource>
                <directory>${project.basedir}/src/main/resources</directory>
                <filtering>false</filtering>
                <includes>
                    <include>db/**</include>
                    <include>static/**</include>
                    <include>templates/**</include>
                </includes>
                <excludes>
                    <exclude>application*.yml</exclude>
                </excludes>
            </resource>
        </resources>

filtering为true时,编译时,会对含有@@的符号内容进行替换,可以看到,这个地方我写了2个,1个是除除application之外的资源文件,另一个是application的配置文件。其他资源如果被maven-resources-plugin过滤过,会造成页面资源或者其他配置文件的错误,因此一定要配置2个<resource>

  1. mave打包使用参数
    假如我们希望使用bar参数来打包
$ mvn clean package -P bar
$ java -jar ./target/profile.jar

启动后日志刷出来的配置:


image.png
image.png

验证一下,请求 http://localhost:8384/info

三、总结

该解决方案对IDE友好,不用修改配置文件,保证了代码版本不乱提交,建议把开发环境设置为默认,如果在开发工具中切换,可以在maven边栏中修改


image.png
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 217,185评论 6 503
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,652评论 3 393
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 163,524评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,339评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,387评论 6 391
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,287评论 1 301
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,130评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,985评论 0 275
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,420评论 1 313
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,617评论 3 334
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,779评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,477评论 5 345
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,088评论 3 328
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,716评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,857评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,876评论 2 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,700评论 2 354