在实际项目开发过程中,我们往往需要区分开发,测试,预发布,生产等环境,而这几个环境的配置也会有些不同。今天我给大家介绍下用spring实现这种需求,常见几种方法:
一.使用yml文件进行区分
这种方法又可以细分为两种方法:
1.使用application.yml 配置共同的参数,并确定当前运行环境(也可以在启动部署包时指定,例如:java -jar test.jar --spring.profiles.active=dev)
mybatis:
mapper-locations: classpath:mapping/*.xml
type-aliases-package: com.fhbean.springboot.mybatisdemo.model
pagehelper:
helperDialect: mysql
reasonable: true
supportMethodsArguments: true
params: count=countSql
spring:
profiles:
active: dev
//表示单前为dev环境,取值可为开发dev、测试test、预生产stage,生产pro
紧接着编写application-{profile}.yml不同文件,{profile}的取值可以是dev, test, rc,pro,可以配置不同环境个性化配置。
2.可以只需要一个application.yml 文件,在这个文件中用 ---
区分不同环境,首先第一部分为公共配置,不同环境之间用 ---
隔开(确定当前环境的方式同上)
例如:
spring:
profiles:
active: dev
//该部分为公共配置部分,可以配置当前要使用哪个环境
---
server:
port: 8081
spring:
profiles: dev
---
server:
port: 8081
spring:
profiles: test
---
server:
port: 8081
spring:
profiles: stage
---
server:
port: 8081
spring:
profiles: stage
---
server:
port: 8081
spring:
profiles: prod
二.使用properties文件进行区分
这种方法跟使用yml文件方法类似,可以通过生成application-{profile}.properties,其中({profile}的取值可以是dev, test, rc,pro)区分不同环境,application.properties配置公共属性以及确定当前使用的环境。与yml区分在于,properties文件相对冗余些,spring默认优先使用yml文件。
三.使用maven进行区分
一般来说我们都会在src/main/resources 目录下面建一个文件夹,里面分别放三个环境对应的文件dev、pre、pro,如下
实际项目中引用的配置文件是config.properties
driver=${db_driver}
url=${db_url}
username=${db_username}
password=${db_password}
把在config.properties文件中所有用到的变量都放到对于环境的文件夹中,例如dev.properties文件内容:
db_driver=com.mysql.jdbc.Driver
db_url=jdbc:mysql://localhost:3306/anhoo
db_username=root
db_password=root
紧接着,就需要在pom里面进行设置了三个环境对应的变量:
<profiles>
<profile>
<id>dev</id>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
<properties>
<env>dev</env>
<!--<redis_host>127.0.0.1</redis_host>-->
</properties>
</profile>
<profile>
<id>pre</id>
<properties>
<env>pre</env>
</properties>
</profile>
<profile>
<id>pro</id>
<properties>
<env>pro</env>
</properties>
</profile>
</profiles>
<!-- 使用指定的filter进行过滤,在执行mvn命令的时候带上-Ppro就代表生产环境,就会加载生产环境的properties,-Pdev就代表开发环境(默认) -->
<filters>
<filter>src/main/resources/properties/env/${env}.properties</filter>
</filters>
<!-- 资源文件位置src/main/resources/,这下面的资源文件的${}会全部被替换成filter中的标签内容。
directory指定的value会作为classes的资源跟目录,
比如指定:src/main/resources/,则classes下会出现jdbc等包,
若指定:src/main/resources/jdbc/,则classes下直接出现jdbc包下的文件,不会额外出现jdbc等其他包结构。因为他把jdbc作为了根目录
-->
<resources>
<resource>
<directory>src/main/resources</directory>
<filtering>true</filtering>
<!--
exclude可以排除指定文件,支持通配符 ,匹配项不会生成到classes目录下,路径是以directory开始的
在这里就是directory(src/main/resources/)/properties/env/pro.properties
-->
<!--<excludes>-->
<!--<exclude>properties/env/pro.properties</exclude>-->
<!--</excludes>-->
</resource>
</resources>
当然我们也可以把所有的变量放在pom的环境分类的properties节点里面,如被注释的部分,这样一来也是可以的,当然如果这样做的话,filters部分就多此一举了,而且我们可以直接在.xml文件中进行这些变量的引用。两种方法效果都一样,没啥区别,就看个人爱好了。
打包命令:
mvn clean package -Pdev(-Ppre,-Ppro)
打包war包后,里面对应的配置就变了
四.使用分布式配置文件
前面几种我们都是通过本地代码配置文件实现,当我们需要修改里面配置时候,需要修改文件,再进行打包发布。在这个追求效率时代,在我们推崇自动化管理的情况下,使用前面几种方式,就很难做到。于是我们可以使用分布式配置,这里我简单介绍下以下两种,详细内容建议大家去它们官网查看demo练习:
1.springcloud中的config组件,我们可以将我们要配置的application.{profiles}\properties等文件写到git上面或者svn上面,config组件可以实现去远程读取这些文件,这样我们就可以根据需要到svn或git上修改文件,而不用去修改代码文件,也就不用去重新打包发布代码,从而实现热部署。
2.可以使用阿里提供的edas配置中心形式,我们可以通过里面的groupId区分不同环境,dataId可以写为配置文件的名称,然后通过增加官方提供组件,进行读取。
五.写在最后
以上几种方法是本人实际开发中使用过的,每种方法都有其优缺点,我们根据实际需要进行选择。不知道大家一般使用哪种方式或者有其他方式推荐,可以留言讨论,一起学习下。