com.nepxion.matrix.selector.RelaxedPropertyResolver Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of matrix-aop Show documentation
Nepxion Matrix is an AOP framework integrated with Spring AutoProxy, Spring Registrar and Spring Import Selector
There is a newer version: 3.0.0
package com.nepxion.matrix.selector;

/**
 * Title: Nepxion Matrix
 * Description: Nepxion Matrix AOP
 * Copyright: Copyright (c) 2017-2050
 * Company: Nepxion
 * @author Haojun Ren
 * @version 1.0
 */

import java.util.Map;

import org.springframework.core.env.ConfigurableEnvironment;
import org.springframework.core.env.Environment;
import org.springframework.core.env.PropertyResolver;
import org.springframework.core.env.PropertySourcesPropertyResolver;
import org.springframework.util.Assert;

public class RelaxedPropertyResolver implements PropertyResolver {

   private final PropertyResolver resolver;

   private final String prefix;

   public RelaxedPropertyResolver(PropertyResolver resolver) {
       this(resolver, null);
   }

   public RelaxedPropertyResolver(PropertyResolver resolver, String prefix) {
       Assert.notNull(resolver, "PropertyResolver must not be null");
       this.resolver = resolver;
       this.prefix = (prefix != null ? prefix : "");
   }

   @Override
   public String getRequiredProperty(String key) throws IllegalStateException {
       return getRequiredProperty(key, String.class);
   }

   @Override
   public  T getRequiredProperty(String key, Class targetType)
           throws IllegalStateException {
       T value = getProperty(key, targetType);
       Assert.state(value != null, String.format("required key [%s] not found", key));
       return value;
   }

   @Override
   public String getProperty(String key) {
       return getProperty(key, String.class, null);
   }

   @Override
   public String getProperty(String key, String defaultValue) {
       return getProperty(key, String.class, defaultValue);
   }

   @Override
   public  T getProperty(String key, Class targetType) {
       return getProperty(key, targetType, null);
   }

   @Override
   public  T getProperty(String key, Class targetType, T defaultValue) {
       RelaxedNames prefixes = new RelaxedNames(this.prefix);
       RelaxedNames keys = new RelaxedNames(key);
       for (String prefix : prefixes) {
           for (String relaxedKey : keys) {
               if (this.resolver.containsProperty(prefix + relaxedKey)) {
                   return this.resolver.getProperty(prefix + relaxedKey, targetType);
               }
           }
       }
       return defaultValue;
   }

   /*@Override
   @Deprecated
   public  Class getPropertyAsClass(String key, Class targetType) {
       RelaxedNames prefixes = new RelaxedNames(this.prefix);
       RelaxedNames keys = new RelaxedNames(key);
       for (String prefix : prefixes) {
           for (String relaxedKey : keys) {
               if (this.resolver.containsProperty(prefix + relaxedKey)) {
                   return this.resolver.getPropertyAsClass(prefix + relaxedKey,
                           targetType);
               }
           }
       }
       return null;
   }*/

   // 兼容 Spring 5.x.x
   @SuppressWarnings("unchecked")
   @Deprecated
   public  Class getPropertyAsClass(String key, Class targetType) {
       RelaxedNames prefixes = new RelaxedNames(this.prefix);
       RelaxedNames keys = new RelaxedNames(key);
       for (String prefix : prefixes) {
           for (String relaxedKey : keys) {
               if (this.resolver.containsProperty(prefix + relaxedKey)) {
                   return (Class) this.resolver.getProperty(prefix + relaxedKey,
                           targetType);
               }
           }
       }
       return null;
   }

   @Override
   public boolean containsProperty(String key) {
       RelaxedNames prefixes = new RelaxedNames(this.prefix);
       RelaxedNames keys = new RelaxedNames(key);
       for (String prefix : prefixes) {
           for (String relaxedKey : keys) {
               if (this.resolver.containsProperty(prefix + relaxedKey)) {
                   return true;
               }
           }
       }
       return false;
   }

   @Override
   public String resolvePlaceholders(String text) {
       throw new UnsupportedOperationException(
               "Unable to resolve placeholders with relaxed properties");
   }

   @Override
   public String resolveRequiredPlaceholders(String text)
           throws IllegalArgumentException {
       throw new UnsupportedOperationException(
               "Unable to resolve placeholders with relaxed properties");
   }

   /**
    * Return a Map of all values from all underlying properties that start with the
    * specified key. NOTE: this method can only be used if the underlying resolver is a
    * {@link ConfigurableEnvironment}.
    * @param keyPrefix the key prefix used to filter results
    * @return a map of all sub properties starting with the specified key prefix.
    * @see PropertySourceUtils#getSubProperties
    */
   public Map getSubProperties(String keyPrefix) {
       Assert.isInstanceOf(ConfigurableEnvironment.class, this.resolver,
               "SubProperties not available.");
       ConfigurableEnvironment env = (ConfigurableEnvironment) this.resolver;
       return PropertySourceUtils.getSubProperties(env.getPropertySources(), this.prefix,
               keyPrefix);
   }

   /**
    * Return a property resolver for the environment, preferring one that ignores
    * unresolvable nested placeholders.
    * @param environment the source environment
    * @param prefix the prefix
    * @return a property resolver for the environment
    * @since 1.4.3
    */
   public static RelaxedPropertyResolver ignoringUnresolvableNestedPlaceholders(
           Environment environment, String prefix) {
       Assert.notNull(environment, "Environment must not be null");
       PropertyResolver resolver = environment;
       if (environment instanceof ConfigurableEnvironment) {
           resolver = new PropertySourcesPropertyResolver(
                   ((ConfigurableEnvironment) environment).getPropertySources());
           ((PropertySourcesPropertyResolver) resolver)
                   .setIgnoreUnresolvableNestedPlaceholders(true);
       }
       return new RelaxedPropertyResolver(resolver, prefix);
   }
}