Spring 5 SimpleAliasRegistry 源码注释

tech2022-10-13  123

相关源码注释

Spring 5 SimpleAliasRegistry 源码注释 Spring 5 DefaultSingletonBeanRegistry 源码注释 Spring 5 FactoryBeanRegistrySupport 源码注释 Spring 5 AbstractBeanFactory 源码注释 Spring 5 AbstractAutowireCapableBeanFactory 源码注释 Spring 5 DefaultLisbaleBeanFactory 源码注释

UML类图

源码

/** * Simple implementation of the {@link AliasRegistry} interface. * Serves as base class for * {@link org.springframework.beans.factory.support.BeanDefinitionRegistry} * implementations. * <p>AliasRegistry接口的简单实现。 * 作为org.springframework.bean.factory.support.BeanDefinitionRegistry的基础实现</p> * * @author Juergen Hoeller * @since 2.5.2 */ public class SimpleAliasRegistry implements AliasRegistry { /** Logger available to subclasses. */ protected final Log logger = LogFactory.getLog(getClass()); /** * Map from alias to canonical name. * <p>从别名映射到规范名称</p> * <p>整个Map数据结构应该要抽象理解为一个二维数组,因为在检索别名的时候,是可以通过别名查别名的。</p> * <p>举个栗子: * <ol> * <li>A是B的别名,C是B的别名,存放到aliasMap中的数据结构就是:[{key=B,val=A},{key=C,val=B}]</li> * <li>当要获取A的所有别名[B,C]时:先获取A的Key->B,则通过递归形式获取B的key->C。</li> * </ol> * </p> * */ private final Map<String, String> aliasMap = new ConcurrentHashMap<>(16); @Override public void registerAlias(String name, String alias) { Assert.hasText(name, "'name' must not be empty"); Assert.hasText(alias, "'alias' must not be empty"); synchronized (this.aliasMap) { if (alias.equals(name)) { this.aliasMap.remove(alias); if (logger.isDebugEnabled()) { logger.debug("Alias definition '" + alias + "' ignored since it points to same name"); } } else { String registeredName = this.aliasMap.get(alias); if (registeredName != null) { if (registeredName.equals(name)) { // An existing alias - no need to re-register return; } if (!allowAliasOverriding()) { throw new IllegalStateException("Cannot define alias '" + alias + "' for name '" + name + "': It is already registered for name '" + registeredName + "'."); } if (logger.isDebugEnabled()) { logger.debug("Overriding alias '" + alias + "' definition for registered name '" + registeredName + "' with new target name '" + name + "'"); } } checkForAliasCircle(name, alias); this.aliasMap.put(alias, name); if (logger.isTraceEnabled()) { logger.trace("Alias definition '" + alias + "' registered for name '" + name + "'"); } } } } /** * Return whether alias overriding is allowed. * Default is {@code true}. */ protected boolean allowAliasOverriding() { return true; } /** * Determine whether the given name has the given alias registered. * @param name the name to check * @param alias the alias to look for * @since 4.2.1 */ public boolean hasAlias(String name, String alias) { for (Map.Entry<String, String> entry : this.aliasMap.entrySet()) { String registeredName = entry.getValue(); if (registeredName.equals(name)) { String registeredAlias = entry.getKey(); if (registeredAlias.equals(alias) || hasAlias(registeredAlias, alias)) { return true; } } } return false; } @Override public void removeAlias(String alias) { synchronized (this.aliasMap) { String name = this.aliasMap.remove(alias); if (name == null) { throw new IllegalStateException("No alias '" + alias + "' registered"); } } } /** * 确定此给定名称是否定义为别名:返回name是否存在于别名Map【aliasMap】中 * @param name the name to check -- 要检查的名称 */ @Override public boolean isAlias(String name) { //返回name是否存在于别名Map中 return this.aliasMap.containsKey(name); } /** * 返回给定bean名称的别名(如果有) * @param name the bean name to check for aliases -- 用来检测别名的bena名称 * @return 别名,如果没有则为空数组 */ @Override public String[] getAliases(String name) { //定义一个用于存放别名的集合 List<String> result = new ArrayList<>(); //使用aliasMap加锁,以保证线程安全 synchronized (this.aliasMap) { //以递归的形式获取name的所有别名,将所有别名存放的result中 retrieveAliases(name, result); } //将result转换成String数组 return StringUtils.toStringArray(result); } /** * <p>以递归的形式获取name的所有别名,将所有别名存放的result中: * <ol> * <li>遍历 aliasMap【key为别名【alias】,value为已注册名称【registeredName】】: * <ol> * <li>如果registeredName与name相同: * <ol> * <li>将alias添加到result中</li> * <li>递归该方法,查找该alias的别名。</li> * </ol> * </li> * </ol> * </li> * </ol> * </p> * Transitively retrieve all aliases for the given name. * <p>传递检索给定名称的所有别名</p> * @param name the target name to find aliases for * -- 查找别名的目标名称 * @param result the resulting aliases list * -- 结果别名列表 */ private void retrieveAliases(String name, List<String> result) { //遍历 aliasMap this.aliasMap.forEach((alias, registeredName) -> { //如果已注册名称与要查找别名的目标名称相同 if (registeredName.equals(name)) { //将别名添加到result中 result.add(alias); //递归该方法,查找该别名的别名。 retrieveAliases(alias, result); } }); } /** * Resolve all alias target names and aliases registered in this * factory, applying the given StringValueResolver to them. * <p>The value resolver may for example resolve placeholders * in target bean names and even in alias names. * @param valueResolver the StringValueResolver to apply */ public void resolveAliases(StringValueResolver valueResolver) { Assert.notNull(valueResolver, "StringValueResolver must not be null"); synchronized (this.aliasMap) { Map<String, String> aliasCopy = new HashMap<>(this.aliasMap); aliasCopy.forEach((alias, registeredName) -> { String resolvedAlias = valueResolver.resolveStringValue(alias); String resolvedName = valueResolver.resolveStringValue(registeredName); if (resolvedAlias == null || resolvedName == null || resolvedAlias.equals(resolvedName)) { this.aliasMap.remove(alias); } else if (!resolvedAlias.equals(alias)) { String existingName = this.aliasMap.get(resolvedAlias); if (existingName != null) { if (existingName.equals(resolvedName)) { // Pointing to existing alias - just remove placeholder this.aliasMap.remove(alias); return; } throw new IllegalStateException( "Cannot register resolved alias '" + resolvedAlias + "' (original: '" + alias + "') for name '" + resolvedName + "': It is already registered for name '" + registeredName + "'."); } checkForAliasCircle(resolvedName, resolvedAlias); this.aliasMap.remove(alias); this.aliasMap.put(resolvedAlias, resolvedName); } else if (!registeredName.equals(resolvedName)) { this.aliasMap.put(alias, resolvedName); } }); } } /** * Check whether the given name points back to the given alias as an alias * in the other direction already, catching a circular reference upfront * and throwing a corresponding IllegalStateException. * @param name the candidate name * @param alias the candidate alias * @see #registerAlias * @see #hasAlias */ protected void checkForAliasCircle(String name, String alias) { if (hasAlias(alias, name)) { throw new IllegalStateException("Cannot register alias '" + alias + "' for name '" + name + "': Circular reference - '" + name + "' is a direct or indirect alias for '" + alias + "' already"); } } /** * <p>获取name的最终别名或者是全类名 * <ol> * <li>通过递归形式在aliasMap【别名映射到规范名称集合】中得到最终的规范名称</li> * </ol> * </p> * Determine the raw name, resolving aliases to canonical names. * <p>确定原始名称,将别名解析为规范名称</p> * @param name the user-specified name - 用户指定的名称 * @return the transformed name - 转换后的名称 */ public String canonicalName(String name) { //规范名称初始化化传入的name String canonicalName = name; // Handle aliasing... 处理别名 String resolvedName; //从下面代码可以看出,aliasMap的存储形式是: // C是真正的规范名称,A,B都是别名: // aliasMap={key:A,val:B;key:B,val:C},通过A拿到B,再通过B拿到C do { //通过 规范名称 从 aliasMap中获取解析后的名称 resolvedName = this.aliasMap.get(canonicalName); //如果找到了解析后的名称 if (resolvedName != null) { //规范名称重新赋值为解析后名称 canonicalName = resolvedName; } } //只要找到了解析后的名称 while (resolvedName != null); return canonicalName; } }
最新回复(0)