Spring的profile与条件注入浅谈【原创】

Spring环境与profile、条件化的bean(@condition)浅谈

作者的话

对于不同的环境,代码是有些差异的,开发环境、验证环境或者是生成环境,这就是需要用到profile来限定不同环境选择初始化的bean是不同的,或者是满足了某些条件才会去初始化特别的bean。

本篇文章主要谈及到两个知识点,spring的profile和注解condition,也引入一下简单的代码来验证。

对于项目来说,一般开发是直接在开发环境dev进行,如果没有问题会在SIT(System Integration Testing)系统集成测试,再到UAT(User Acceptance Testing)用户验收测试,最终上生产,这些都是需要不同的数据库或者是流程平台等,不可能换个环境就手动改很多代码。

代码示例

1、profile的使用

需要测试的bean,用于注入的spring

public class DemoBean {
​
 private String content;
​
 public DemoBean(String content) {
 super();
 this.content = content;
 }
​
 public String getContent() {
 return content;
 }
​
 public void setContent(String content) {
 this.content = content;
 }
}

配置类,对于Bean可以是数据库信息等的声明

@Configuration
public class ProfileConfig {
​
 /**
 * Profile 为dev时,实例化devDemoBean 开发环境
 * @return
 */
 @Bean
 @Profile("dev")
 public DemoBean devDemoBean() {
 return new DemoBean("from development profile");
 }
​
 /**
 * Profile 为prod时,实例化prodDemoBean  生成环境
 * @return
 */
 @Bean
 @Profile("prod")
 public DemoBean prodDemoBean() {
 return new DemoBean("from production profile");
 }
}

测试程序入口

public class ProfileMain {
 public static void main(String[] args) {
 AnnotationConfigApplicationContext context =
 new AnnotationConfigApplicationContext(ProfileConfig.class);
​
 /**
 * 1、先将活动的profile设置为prod
 * 2、后注册Bean配置类,不然会报Bean未定义的错误
 * 3、刷新容器
 */
 context.getEnvironment().setActiveProfiles("prod");
 context.register(ProfileConfig.class);
 context.refresh();
 DemoBean demoBean = context.getBean(DemoBean.class);
​
 System.out.println(demoBean.getContent());
​
 context.close();
 }
}

Profile 可以是不同环境有不同的配置,对于自己本地开发demo项目也是可以使用的,我之前开发一个项目时,每次部署时都需要去改一下配置文件甚是着急,如果使用了profile,就会省去很多工作量。

2、Condition的使用

需要初始化类对于的接口

public interface ListService {
​
 /**
 * 不同操作系统环境下的命令
 * @return  操作系统命令
 */
 public String showListCmd();
}

接口对于的两个类

public class WindowsListService implements ListService {
 @Override
 public String showListCmd() {
 return "dir";
 }
}
public class LinuxListService implements ListService {
 @Override
 public String showListCmd() {
 return "ls";
 }
}

根据添加创建的bean

import org.springframework.context.annotation.Condition;
import org.springframework.context.annotation.ConditionContext;
import org.springframework.core.type.AnnotatedTypeMetadata;
​
/**
 * @description: 判断条件定义,判断Windows的条件
 *
 * @author: Shenshuaihu
 * @version: 1.0
 * @data: 2019-05-30 23:12
 */
public class WindowsCondition implements Condition {
​
 /**
 * 如果返回的为True,改内容会被创建
 * @param conditionContext
 * @param annotatedTypeMetadata
 * @return
 */
 @Override
 public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) {
 return conditionContext.getEnvironment().getProperty("os.name").contains("Windows");
 }
}
import org.springframework.context.annotation.Condition;
import org.springframework.context.annotation.ConditionContext;
import org.springframework.core.type.AnnotatedTypeMetadata;
​
/**
 * @description: 判断添加定义,判断Linux的条件
 *
 * @author: Shenshuaihu
 * @version: 1.0
 * @data: 2019-05-30 23:15
 */
public class LinuxCondition implements Condition {
 @Override
 public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) {
 return conditionContext.getEnvironment().getProperty("os.name").contains("Linux");
 }
 }

核心配置类

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Conditional;
import org.springframework.context.annotation.Configuration;
​
/**
 * @description:    配置类
 * @author: Shenshuaihu
 * @version: 1.0
 * @data: 2019-05-30 23:20
 */
@Configuration
@ComponentScan("com.ch3.conditional")
public class ConditionConfig {
​
 /**
 * 通过 @Conditional 符号Windows条件则实例化 windowsListService
 *
 * @return
 */
 @Bean
 @Conditional(WindowsCondition.class)
 public ListService windowsListService() {
 return new WindowsListService();
 }
​
 @Bean
 @Conditional(LinuxCondition.class)
 public ListService linuxListService() {
 return new LinuxListService();
 }
}

测试启动类

import org.springframework.context.annotation.AnnotationConfigApplicationContext;
​
/**
 * @description:
 * @author: Shenshuaihu
 * @version: 1.0
 * @data: 2019-05-30 23:22
 */
public class ConditionMain {
 public static void main(String[] args) {
​
 AnnotationConfigApplicationContext context =
 new AnnotationConfigApplicationContext(ConditionConfig.class);
​
 ListService listService = context.getBean(ListService.class);
 System.out.println(context.getEnvironment().getProperty("os.name")
 + " 系统下的列表命令为: "
 + listService.showListCmd()
 );
 }
}

对于LinuxCondition类 继承了Condition,重写matches方法,如果返回true则可以创建该类,可以是在不同的环境实现不同的方法,或者是当存在什么属性时则可以实例化,特定的方法。

使用场景就不赘述了,读者可以自行配置使用。

参考相关的文章:

Spring - Profile

Spring profile 实现开发,测试,部署等不同环境中间的配置切换【原创】

2019/6/1 晚 于成都

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

推荐阅读更多精彩内容