spring RegisteredBean 源码

spring RegisteredBean 代码

文件路径：/spring-beans/src/main/java/org/springframework/beans/factory/support/RegisteredBean.java

/*
 * Copyright 2002-2022 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.beans.factory.support;

import java.util.function.BiFunction;
import java.util.function.Supplier;

import org.springframework.beans.factory.BeanFactory;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.config.BeanDefinitionHolder;
import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
import org.springframework.core.ResolvableType;
import org.springframework.core.style.ToStringCreator;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
import org.springframework.util.ClassUtils;
import org.springframework.util.StringUtils;

/**
 * A {@code RegisteredBean} represents a bean that has been registered with a
 * {@link BeanFactory}, but has not necessarily been instantiated. It provides
 * access to the bean factory that contains the bean as well as the bean name.
 * In the case of inner-beans, the bean name may have been generated.
 *
 * @author Phillip Webb
 * @since 6.0
 */
public final class RegisteredBean {

	private final ConfigurableListableBeanFactory beanFactory;

	private final Supplier<String> beanName;

	private final boolean generatedBeanName;

	private final Supplier<RootBeanDefinition> mergedBeanDefinition;

	@Nullable
	private final RegisteredBean parent;


	private RegisteredBean(ConfigurableListableBeanFactory beanFactory, Supplier<String> beanName,
			boolean generatedBeanName, Supplier<RootBeanDefinition> mergedBeanDefinition,
			@Nullable RegisteredBean parent) {

		this.beanFactory = beanFactory;
		this.beanName = beanName;
		this.generatedBeanName = generatedBeanName;
		this.mergedBeanDefinition = mergedBeanDefinition;
		this.parent = parent;
	}


	/**
	 * Create a new {@link RegisteredBean} instance for a regular bean.
	 * @param beanFactory the source bean factory
	 * @param beanName the bean name
	 * @return a new {@link RegisteredBean} instance
	 */
	public static RegisteredBean of(ConfigurableListableBeanFactory beanFactory,
			String beanName) {

		Assert.notNull(beanFactory, "'beanFactory' must not be null");
		Assert.hasLength(beanName, "'beanName' must not be empty");
		return new RegisteredBean(beanFactory, () -> beanName, false,
				() -> (RootBeanDefinition) beanFactory.getMergedBeanDefinition(beanName),
				null);
	}

	/**
	 * Create a new {@link RegisteredBean} instance for an inner-bean.
	 * @param parent the parent of the inner-bean
	 * @param innerBean a {@link BeanDefinitionHolder} for the inner bean
	 * @return a new {@link RegisteredBean} instance
	 */
	public static RegisteredBean ofInnerBean(RegisteredBean parent,
			BeanDefinitionHolder innerBean) {

		Assert.notNull(innerBean, "'innerBean' must not be null");
		return ofInnerBean(parent, innerBean.getBeanName(),
				innerBean.getBeanDefinition());
	}

	/**
	 * Create a new {@link RegisteredBean} instance for an inner-bean.
	 * @param parent the parent of the inner-bean
	 * @param innerBeanDefinition the inner-bean definition
	 * @return a new {@link RegisteredBean} instance
	 */
	public static RegisteredBean ofInnerBean(RegisteredBean parent,
			BeanDefinition innerBeanDefinition) {

		return ofInnerBean(parent, null, innerBeanDefinition);
	}

	/**
	 * Create a new {@link RegisteredBean} instance for an inner-bean.
	 * @param parent the parent of the inner-bean
	 * @param innerBeanName the name of the inner bean or {@code null} to
	 * generate a name
	 * @param innerBeanDefinition the inner-bean definition
	 * @return a new {@link RegisteredBean} instance
	 */
	public static RegisteredBean ofInnerBean(RegisteredBean parent,
			@Nullable String innerBeanName, BeanDefinition innerBeanDefinition) {

		Assert.notNull(parent, "'parent' must not be null");
		Assert.notNull(innerBeanDefinition, "'innerBeanDefinition' must not be null");
		InnerBeanResolver resolver = new InnerBeanResolver(parent, innerBeanName,
				innerBeanDefinition);
		Supplier<String> beanName = StringUtils.hasLength(innerBeanName)
				? () -> innerBeanName : resolver::resolveBeanName;
		return new RegisteredBean(parent.getBeanFactory(), beanName,
				innerBeanName == null, resolver::resolveMergedBeanDefinition, parent);
	}


	/**
	 * Return the name of the bean.
	 * @return the beanName the bean name
	 */
	public String getBeanName() {
		return this.beanName.get();
	}

	/**
	 * Return if the bean name is generated.
	 * @return {@code true} if the name was generated
	 */
	public boolean isGeneratedBeanName() {
		return this.generatedBeanName;
	}

	/**
	 * Return the bean factory containing the bean.
	 * @return the bean factory
	 */
	public ConfigurableListableBeanFactory getBeanFactory() {
		return this.beanFactory;
	}

	/**
	 * Return the user-defined class of the bean.
	 * @return the bean class
	 */
	public Class<?> getBeanClass() {
		return ClassUtils.getUserClass(getBeanType().toClass());
	}

	/**
	 * Return the {@link ResolvableType} of the bean.
	 * @return the bean type
	 */
	public ResolvableType getBeanType() {
		return getMergedBeanDefinition().getResolvableType();
	}

	/**
	 * Return the merged bean definition of the bean.
	 * @return the merged bean definition
	 * @see ConfigurableListableBeanFactory#getMergedBeanDefinition(String)
	 */
	public RootBeanDefinition getMergedBeanDefinition() {
		return this.mergedBeanDefinition.get();
	}

	/**
	 * Return if this instance is for an inner-bean.
	 * @return if an inner-bean
	 */
	public boolean isInnerBean() {
		return this.parent != null;
	}

	/**
	 * Return the parent of this instance or {@code null} if not an inner-bean.
	 * @return the parent
	 */
	@Nullable
	public RegisteredBean getParent() {
		return this.parent;
	}

	@Override
	public String toString() {
		return new ToStringCreator(this).append("beanName", getBeanName())
				.append("mergedBeanDefinition", getMergedBeanDefinition()).toString();
	}


	/**
	 * Resolver used to obtain inner-bean details.
	 */
	private static class InnerBeanResolver {

		private final RegisteredBean parent;

		@Nullable
		private final String innerBeanName;

		private final BeanDefinition innerBeanDefinition;

		@Nullable
		private volatile String resolvedBeanName;


		InnerBeanResolver(RegisteredBean parent, @Nullable String innerBeanName,
				BeanDefinition innerBeanDefinition) {

			Assert.isInstanceOf(AbstractAutowireCapableBeanFactory.class,
					parent.getBeanFactory());
			this.parent = parent;
			this.innerBeanName = innerBeanName;
			this.innerBeanDefinition = innerBeanDefinition;
		}


		String resolveBeanName() {
			String resolvedBeanName = this.resolvedBeanName;
			if (resolvedBeanName != null) {
				return resolvedBeanName;
			}
			resolvedBeanName = resolveInnerBean(
					(beanName, mergedBeanDefinition) -> beanName);
			this.resolvedBeanName = resolvedBeanName;
			return resolvedBeanName;
		}

		RootBeanDefinition resolveMergedBeanDefinition() {
			return resolveInnerBean(
					(beanName, mergedBeanDefinition) -> mergedBeanDefinition);
		}

		private <T> T resolveInnerBean(
				BiFunction<String, RootBeanDefinition, T> resolver) {

			// Always use a fresh BeanDefinitionValueResolver in case the parent merged bean definition has changed.
			BeanDefinitionValueResolver beanDefinitionValueResolver = new BeanDefinitionValueResolver(
					(AbstractAutowireCapableBeanFactory) this.parent.getBeanFactory(),
					this.parent.getBeanName(), this.parent.getMergedBeanDefinition());
			return beanDefinitionValueResolver.resolveInnerBean(this.innerBeanName,
					this.innerBeanDefinition, resolver);
		}

	}

}

相关信息

spring 源码目录

相关文章

spring AbstractAutowireCapableBeanFactory 源码

spring AbstractBeanDefinition 源码

spring AbstractBeanDefinitionReader 源码

spring AbstractBeanFactory 源码

spring AutowireCandidateQualifier 源码

spring AutowireCandidateResolver 源码

spring AutowireUtils 源码

spring BeanDefinitionBuilder 源码

spring BeanDefinitionDefaults 源码

spring BeanDefinitionOverrideException 源码