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就会创建，否则不会创建。

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

本节项目源码