SpringBoot基础教程(十八)——自定义条件注解

spring boot 扩展了spring 的@Conditional注解,提供了很多常用的注解,例如@ConditionalOnProperty根据属性来判断是否要激活这个配置文件或者是激活这个Bean,@ConditionalOnBean根据容器中是否有这个Bean来判断,
@ConditionalOnClass根据项目路径中是否有某个Class来判断,等等吧,但是官方提供的有时不能完全满足我们的需求,就需要我们自己来进行扩展。例如我们设想一个场景:不同的环境不同的配置,有个配置我们希望只在开发环境与测试环境存在,生产环境不存在,硬编码太low了,我们可以试用下spring提供的Conditional,通过描述,是根据描述环境的属性来判断这个Bean是否创建,可以联想到是@ConditionalOnProperty,但是这个注解有个havingValue只接受一个值,不能接受两个值(dev和test),这个时候我们就需要扩展这个注解。下面我们开始吧,pom相对于上一节没啥特别的变化,就不说了,我们就从代码开始。

首先声明一个注解

package com.shuqi.anno;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import com.shuqi.MyOnPropertyCondition;
import org.springframework.context.annotation.Conditional;
import org.springframework.core.env.Environment;

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.METHOD})
@Documented
@Conditional(MyOnPropertyCondition.class)
public @interface MyConditionalOnProperty {

    
    String value();

    
    String prefix() default "";

    
    String[] name() default {};

    
    String havingValue() default "";

   
    boolean matchIfMissing() default false;

    
    boolean relaxedNames() default true;


    //TODO ADD ONE PROPERTY
    String[] havingValues() default {};

}

没啥太多的不同,只不过多了一个属性havingValues是一个字符串数组类型的。下面我们看下,通过这个注解引入的Condition的判断逻辑类MyOnPropertyCondition

package com.shuqi;

import com.shuqi.anno.MyConditionalOnProperty;
import org.springframework.context.annotation.Condition;
import org.springframework.context.annotation.ConditionContext;
import org.springframework.core.type.AnnotatedTypeMetadata;

import java.util.Map;


/**
 * @author olifer
 */
public class MyOnPropertyCondition implements Condition {

    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        Map<String, Object> annotationAttributes = metadata.getAnnotationAttributes(MyConditionalOnProperty.class.getName());
        String propertyName = (String) annotationAttributes.get("value");
        String[] values = (String[]) annotationAttributes.get("havingValues");
        String propertyValue = context.getEnvironment().getProperty(propertyName);
        for (String havingValue : values) {
            if (propertyValue.equalsIgnoreCase(havingValue)) {
                return true;
            }
        }
        return false;
    }
}

里面的逻辑也很简单,从注解中拿到value和havingValues的值,将value的内容作为key从环境中获取到对应的value与havingValues中的内容进行对比,如果匹配上,返回true,那么标示这个条件通过。看下我们的配置文件中的内容

env: test

最后看下我们的配置类中的使用方式:

package com.shuqi;

import com.shuqi.anno.MyConditionalOnProperty;
import com.shuqi.model.Person;
import lombok.extern.slf4j.Slf4j;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * @author linyang on 18/5/1.
 */
@Slf4j
@Configuration
public class MyConfig {

    @Bean
    @MyConditionalOnProperty(value = "env",havingValues = {"dev","test"})
    public Person person(){
        log.info("创建Bean");
        return new Person();
    }
}

表达的含义是,获取env这个属性的值与test和dev进行判断,如果包含的话,这个名字叫做person的Bean就会创建,否则不会创建。

今天就说到这里,大家可以拉取源码看看效果。

本节项目源码

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,596评论 18 139
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,736评论 6 342
  • 本来是准备看一看Spring源码的。然后在知乎上看到来一个帖子,说有一群**自己连Spring官方文档都没有完全读...
    此鱼不得水阅读 6,926评论 4 21
  • 一一 宣恩爱宝贝教育托辅中心一一 寒假将至,很多父母会带孩子回老家或者外出游玩,车站、游乐场、商场、马路等地方人流...
    龙红阅读 378评论 1 0
  • 沒有孤獨 只有孤獨的指令 行与不行 死或是生 只在指尖轻轻一拧 居于大城 穿行者 有如魅魂 伏身低眉 全是臣服的自...
    平天下之文世界阅读 132评论 0 1