基于Maven profile的配置管理

应用场景

在java项目的开发过程中,配置文件中相关配置项的值是应不同的执行环境所变化的,并且这种变化也可能是事前未知的。

纵向变化-执行者

一种是随着执行者的不同而不同,譬如说开发人员开发过程中debug的环境(简称dev)、个人CI与单元测试环境(ut)、团队CI环境、测试环境可能使用不同类型的数据库和执行环境。

横向变化-时间

另外一种是随着时间的变化而变化的。例如在笔者所服务的公司,通过使用模板机VM的方式提供带系统、数据库和基础数据的开发测试环境给大家使用,但是随着版本不断上线,模板机VM会不断被更新。在模板机被更新后,需要重新clone环境并使用,这时如IP等信息基本都会有变化,因此即使是如团队CI环境,可能也会需要变化。

解决方案1- profile

通过maven profile来针对横向变化的部分来形成一个个profile,在运行时动态选择即可。

解决方案2 - filter

在maven profile的基础上,针对临时变化的部分,可以通过filter在runtime动态指定环境的参数值。

利用spring框架自身提供的profile机制

最终的解决方案

针对公司现有java类产品的开发框架(springMvc),使用了如下的方式
1、将src/main/resouces下的配置文件复制到src/test/resouces下,对需要参数化的配置项的值进行参数化修改。
key=123 修改为key=${key}
2、在pom.xml中建立dev/ut/ci/qa等profile

<profiles>
<profile>
    <id>dev</id>
    <!-- 默认激活开发配制,使用app_dev.properties来替换设置过虑的资源文件中的${key} -->
    <activation>
        <activeByDefault>true</activeByDefault>
    </activation>
    <build>
        <filters>
            <filter>src/test/resources/app_dev.properties</filter>
        </filters>
    </build>
</profile>
<profile>
    <id>ut</id>
    <activation>
        <activeByDefault>false</activeByDefault>
    </activation>
    <build>
        <filters>
            <filter>src/test/resources/app_ut.properties</filter>
        </filters>
    </build>
</profile>
</profiles>

3、在pom.xml的<build/>部分加入filter,指定需要被替换的参数文件

   <build>
            <testResources>
                <!-- filter global.properties frameworkConfig.properties -->
            <testResource>
                <directory>src/test/resources</directory>
                <includes>
                    <include>frameworkConfig.properties</include>
                    <include>cfc_config.properties</include>
                    </includes>
                <filtering>true</filtering>
            </testResource>
           <!-- inlcude other files like root-context.xml-->
             <testResource>
                <directory>src/test/resources</directory>
                <excludes>
                    <exclude>frameworkConfig.properties</exclude>
                    <exclude>cfc_config.properties</exclude>
                    <exclude>app_*.properties</exclude>
                    </excludes>
                <filtering>true</filtering>
            </testResource>
        </testResources>
   </build>

这里有个坑要注意,一般在网上搜来的都是profile/filter介绍都是关于<resource/>标签的,其实对应的是src/main/resouces目录。如果要操作src/test/resources目录,则需要使用<testResources/>标签。
4、在src/test/resouces下建立类似app_dev/app_qa等配置文件,文件中填写相应的配置项的值。
如:key=123
5、在pom.xml的<build/> 的filter中增加exclude部分来剔除4中的配置文件,以免污染构建后的二进制文件夹。

        <exclude>app_*.properties</exclude>

6、如果有临时变化,不需要通过commit到代码库中,则可以在运行时,通过类似

mvn test -Pdev -Dkey=666

的方式来动态修改key的值。

为什么不用配置中心

笔者所在的公司也建设了配置中心,所有系统在启动时都需要通过配置中心来获取对应配置项中的值。在其设计过程中,除了prod环境外,也规划了dev/qa等环境。 由于配置中心是一个web服务,对于多个开发/测试人员,如果在同时针对某个系统进行开发/测试,但使用不同的环境,其在配置中心的配置项的值也不同,如果使用同一个配置中心,则会造成配置项的值冲突。
现实中,也是通过模板机来部署多套配置中心来规避上述问题。但是在开发/单元测试/集成测试的过程中,我们希望配置值能跟随代码库进行配置管理。

With the above configuration, both main/resources and test/resources folders are treated as resources while the second one should be treated as test resources. Because of that, the resources:resources goal handles not only the config.xml but also test-config.xml and both lands in target/classes properly filtered.
Because of default definition, the other goal resources:testResources copies test-config.xml to target/test-classes without applying the filters (as by default filtering is disabled).

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,654评论 18 139
  • 用两张图告诉你,为什么你的 App 会卡顿? - Android - 掘金 Cover 有什么料? 从这篇文章中你...
    hw1212阅读 12,723评论 2 59
  • 最近一段时间,无论是各大新闻网站,还是微博,都被《恶棍天使》是烂片霸屏了,各种谩骂声此起彼伏,各种犀利影评。 反复...
    陌上香阅读 992评论 0 2
  • 啦啦啦啦啦啦啦空军建军节 啊啊啊不吃了KKK啦咯具体咯啦咯啦
    trueche阅读 278评论 0 0
  • 《一字禅笔记》 坎:是坑,是水。如果你把它放在路上,它会挡住你的脚步;如果你把它变成你...
    燕赵北羽阅读 908评论 0 3