不少时候,咱们项目在开发环境和生成环境的环境配置是不同的,例如,数据库配置,在开发的时候,咱们通常用测试数据库,而在生产环境的时候,咱们是用正式的数据,这时候,咱们能够利用profile在不一样的环境下配置用不一样的配置文件或者不一样的配置html
spring boot容许你经过命名约定按照必定的格式(application-{profile}.properties)来定义多个配置文件,而后经过在application.properyies经过spring.profiles.active来具体激活一个或者多个配置文件,若是没有没有指定任何profile的配置文件的话,spring boot默认会启动application-default.properties。java
profile的配置文件能够按照application.properyies的放置位置同样,放于如下四个位置,spring
在这里咱们就定义俩个profile文件,application-cus1.properties和application-cus2.properties,并在俩个文件中都分别写上变量cusvar=cus1和cusvar=cus2sql
咱们在application.properyies也写上,并把profile切换到application-cus1.properties的配置文件数据库
cusvar=cus3 spring.profiles.active=cus1
能够经过这样子来测试安全
@RestController @RequestMapping("/task") public class TaskController { @RequestMapping(value = {"/",""}) public String hellTask(@Value("${cusvar}")String cusvar ){ return "hello task !! myage is " + cusvar; } }
在这里能够看到spring.profiles.active激活的profile不一样,打印出来的结果也不同。服务器
除了能够用profile的配置文件来分区配置咱们的环境变量,在代码里,咱们还能够直接用@Profile注解来进行配置,例如数据库配置,这里咱们先定义一个接口
app
public interface DBConnector { public void configure(); }
分别定义俩个实现类来实现它框架
/** * 测试数据库 */ @Component @Profile("testdb") public class TestDBConnector implements DBConnector { @Override public void configure() { System.out.println("testdb"); } } /** * 生产数据库 */ @Component @Profile("devdb") public class DevDBConnector implements DBConnector { @Override public void configure() { System.out.println("devdb"); } }
经过在配置文件激活具体使用哪一个实现类ide
spring.profiles.active=testdb
而后就能够这么用了
@RestController @RequestMapping("/task") public class TaskController { @Autowired DBConnector connector ; @RequestMapping(value = {"/",""}) public String hellTask(){ connector.configure(); //最终打印testdb return "hello task !! myage is " + myage; } }
除了spring.profiles.active来激活一个或者多个profile以外,还能够用spring.profiles.include来叠加profile
spring.profiles: testdb spring.profiles.include: proddb,prodmq
以上就是spring boot用profile的做用
相信使用过一段时间Spring Boot的用户,必定知道这条命令:java -jar xxx.jar --server.port=8888
,经过使用--server.port属性来设置xxx.jar应用的端口为8888。
在命令行运行时,连续的两个减号--
就是对application.properties
中的属性值进行赋值的标识。因此,java -jar xxx.jar --server.port=8888
命令,等价于咱们在application.properties
中添加属性server.port=8888
,该设置在样例工程中可见,读者可经过删除该值或使用命令行来设置该值来验证。
经过命令行来修改属性值当然提供了不错的便利性,可是经过命令行就能更改应用运行的参数,那岂不是很不安全?是的,因此Spring Boot也贴心的提供了屏蔽命令行访问属性的设置,只须要这句设置就能屏蔽:SpringApplication.setAddCommandLineProperties(false)
。
以上都不是重点,这才是重点,这才是重点,这才是重点,重要的事情说3遍。咱们在开发Spring Boot应用时,一般同一套程序会被应用和安装到几个不一样的环境,好比:开发、测试、生产等。其中每一个环境的数据库地址、服务器端口等等配置都会不一样,若是在为不一样环境打包时都要频繁修改配置文件的话,那必将是个很是繁琐且容易发生错误的事。
对于多环境的配置,各类项目构建工具或是框架的基本思路是一致的,经过配置多份不一样环境的配置文件,再经过打包命令指定须要打包的内容以后进行区分打包,Spring Boot也不例外,或者说更加简单。
在Spring Boot中多环境配置文件名须要知足application-{profile}.properties
的格式,其中{profile}
对应你的环境标识,好比:
application-dev.properties:开发环境
application-test.properties:测试环境
application-prod.properties:生产环境
至于哪一个具体的配置文件会被加载,须要在application.properties
文件中经过spring.profiles.active
属性来设置,其值对应{profile}
值。
如:spring.profiles.active=test
就会加载application-test.properties
配置文件内容
下面,以不一样环境配置不一样的服务端口为例,进行样例实验。
针对各环境新建不一样的配置文件application-dev.properties
、application-test.properties
、application-prod.properties
在这三个文件均都设置不一样的server.port
属性,如:dev环境设置为8080,test环境设置为9090,prod环境设置为80
application.properties中设置spring.profiles.active=dev
,就是说默认以dev环境设置
测试不一样配置的加载:
执行java -jar xxx.jar,能够观察到服务端口被设置为8080,也就是默认的开发环境(dev)
执行java -jar xxx.jar --spring.profiles.active=test,能够观察到服务端口被设置为9090,也就是测试环境的配置(test)
执行java -jar xxx.jar --spring.profiles.active=prod,能够观察到服务端口被设置为80,也就是生产环境的配置(prod)
按照上面的实验,能够以下总结多环境的配置思路:
application.properties中配置通用内容,并设置spring.profiles.active=dev,以开发环境为默认配置
application-{profile}.properties中配置各个环境不一样的内容
经过命令行方式去激活不一样环境的配置。
多环境高级应用
在某些状况下,应用的某些业务逻辑可能须要有不一样的实现。例如邮件服务,假设EmailService
中包含的send(String email)
方法向指定地址发送电子邮件,可是咱们仅仅但愿在生产环境中才执行真正发送邮件的代码,而开发环境里则不发送以避免向用户发送无心义的垃圾邮件。
咱们能够借助Spring的注解@Profile
实现这样的功能,这样须要定义两个实现EmailService
借口的类:
/** * 发送邮件接口. */ public interface EmailService { /**发送邮件*/ publicvoid send(); } 发送邮件的具体实现(dev-开发环境的代码): @Service @Profile("dev") //开发环境的时候. public class DevEmailServiceImpl implements EmailService{ @Override publicvoid send() { System.out.println("DevEmailServiceImpl.send().开发环境不执行邮件的发送."); } }
发送邮件的具体实现(prod-生产环境的代码):
@Service @Profile("prod") //生产环境. public class ProdEmailServiceImpl2 implements EmailService{ @Override publicvoid send() { System.out.println("DevEmailServiceImpl.send().生产环境执行邮件的发送."); //具体的邮件发送代码. //mail.send(); } }
@Profile("dev")
代表只有Spring定义的Profile为dev
时才会实例化DevEmailService
这个类。那么如何设置Profile呢?
在application.properties
中加入:
spring.profiles.active=dev
转http://www.leftso.com/blog/111.htmljava -jar app.jar --spring.profiles.active=dev