SimpleAliasRegistry源码分析

AliasRegistry接口定义了对别名的增删改查操作。
其中仅有四个方法:

//给定名称,为其注册别名。
void registerAlias(String name, String alias);
//从此注册表中删除指定的别名。
void removeAlias(String alias);
//确定此给定名称是否定义为别名(而不是实际注册的组件的名称)。
boolean isAlias(String name);
//如果已定义,则返回给定名称的别名。
String[] getAliases(String name);

该接口的实现类有很多,首先解析一下SimpleAliasRegistry实现类

/** Map from alias to canonical name. */
private final Map<String, String> aliasMap = new ConcurrentHashMap<>(16);

可以看到,SimpleAliasRegistry使用了ConcurrentHashMap当做注册表用来保存名称和别名的映射关系。

首先来看一下registerAlias方法,代码如下:

@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 + "'");
			}
		}
	}
}

registerAlias方法的入参有两个,分别是name、alias,name指的是原名称,alias则是别名。
第3、4行会对入参进行校验,如果入参是null或者空字符串,会抛出IllegalArgumentException异常。

synchronized (this.aliasMap) {

这一行可以看到对aliasMap进行了加锁操作。这一步不是很理解,ConcurrentHashMap是线程安全的,为什么还要锁住呢?

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 + "'");
	}
}

如果别名和名称不相同,首先会从注册表中尝试获取该别名,如果别名已存在,则判断一下注册该别名的名称是不是和传入的名称相同,如果相同,说明注册已完成,方法结束。

if (registeredName.equals(name)) {
// An existing alias - no need to re-register
	return;
}

如果不相同,首先会检查是不是允许存在又名,即一个名称存在多个别名的情况。如果不允许,则抛出IllegalStateException异常。

if (!allowAliasOverriding()) {
	throw new IllegalStateException("Cannot define alias '" + alias + "' for name '" +
			name + "': It is already registered for name '" + registeredName + "'.");
}

接下来会检查给定的名称是否已经指向了别名,如果不进行这一步检查的话,会导致出现名称和别名之间的循环,例如:a->b b->c c->a

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");
	}
}
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;
}

在hasAlias方法中,会遍历整个注册表,取出注册表中的别名和传入的名称进行对比,如果传入的名称和注册表中的别名相同,则会取出注册了该别名的名称和传入的名称进行比较,如果相同,则认为传入的名称已经注册了传入的别名,返回true,否则的话会递归进行该步骤。

相等
相等
遍历
获取
name1
已经注册过的别名alias2
alias1
注册该别名的名称name2
注册表
说明name1已经注册过别名alias1

如果检查通过,则将别名注册到名称上,注册便完成了。
注册的难点在于如何防止重现名称和别名之间的重复引用。
另外注册表在注册时为什么要加锁,思考如下:
虽然ConcurrentHashMap是线程安全的,但是在注册别名时,检查别名是否注册过名称这一步,如果不对注册表加锁,会导致检查出现问题,最终导致出现重复引用
例如:

注册
注册
name1
alias1
alias1
name1

两个注册过程并发进行,在检查时两个注册过程均未发现问题,但是注册过后便会出现问题

注册
注册
name1
alias1

你可能感兴趣的:(SimpleAliasRegistry源码分析)