/*
 * Copyright 2002-2019 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.aop.scope;

import org.springframework.aop.framework.autoproxy.AutoProxyUtils;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.config.BeanDefinitionHolder;
import org.springframework.beans.factory.support.AbstractBeanDefinition;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.beans.factory.support.RootBeanDefinition;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;

Utility class for creating a scoped proxy.

Used by ScopedProxyBeanDefinitionDecorator and ClassPathBeanDefinitionScanner.

Author:Mark Fisher, Juergen Hoeller, Rob Harrop, Sam Brannen
Since:2.5
/** * Utility class for creating a scoped proxy. * * <p>Used by ScopedProxyBeanDefinitionDecorator and ClassPathBeanDefinitionScanner. * * @author Mark Fisher * @author Juergen Hoeller * @author Rob Harrop * @author Sam Brannen * @since 2.5 */
public abstract class ScopedProxyUtils { private static final String TARGET_NAME_PREFIX = "scopedTarget."; private static final int TARGET_NAME_PREFIX_LENGTH = TARGET_NAME_PREFIX.length();
Generate a scoped proxy for the supplied target bean, registering the target bean with an internal name and setting 'targetBeanName' on the scoped proxy.
Params:
  • definition – the original bean definition
  • registry – the bean definition registry
  • proxyTargetClass – whether to create a target class proxy
See Also:
Returns:the scoped proxy definition
/** * Generate a scoped proxy for the supplied target bean, registering the target * bean with an internal name and setting 'targetBeanName' on the scoped proxy. * @param definition the original bean definition * @param registry the bean definition registry * @param proxyTargetClass whether to create a target class proxy * @return the scoped proxy definition * @see #getTargetBeanName(String) * @see #getOriginalBeanName(String) */
public static BeanDefinitionHolder createScopedProxy(BeanDefinitionHolder definition, BeanDefinitionRegistry registry, boolean proxyTargetClass) { String originalBeanName = definition.getBeanName(); BeanDefinition targetDefinition = definition.getBeanDefinition(); String targetBeanName = getTargetBeanName(originalBeanName); // Create a scoped proxy definition for the original bean name, // "hiding" the target bean in an internal target definition. RootBeanDefinition proxyDefinition = new RootBeanDefinition(ScopedProxyFactoryBean.class); proxyDefinition.setDecoratedDefinition(new BeanDefinitionHolder(targetDefinition, targetBeanName)); proxyDefinition.setOriginatingBeanDefinition(targetDefinition); proxyDefinition.setSource(definition.getSource()); proxyDefinition.setRole(targetDefinition.getRole()); proxyDefinition.getPropertyValues().add("targetBeanName", targetBeanName); if (proxyTargetClass) { targetDefinition.setAttribute(AutoProxyUtils.PRESERVE_TARGET_CLASS_ATTRIBUTE, Boolean.TRUE); // ScopedProxyFactoryBean's "proxyTargetClass" default is TRUE, so we don't need to set it explicitly here. } else { proxyDefinition.getPropertyValues().add("proxyTargetClass", Boolean.FALSE); } // Copy autowire settings from original bean definition. proxyDefinition.setAutowireCandidate(targetDefinition.isAutowireCandidate()); proxyDefinition.setPrimary(targetDefinition.isPrimary()); if (targetDefinition instanceof AbstractBeanDefinition) { proxyDefinition.copyQualifiersFrom((AbstractBeanDefinition) targetDefinition); } // The target bean should be ignored in favor of the scoped proxy. targetDefinition.setAutowireCandidate(false); targetDefinition.setPrimary(false); // Register the target bean as separate bean in the factory. registry.registerBeanDefinition(targetBeanName, targetDefinition); // Return the scoped proxy definition as primary bean definition // (potentially an inner bean). return new BeanDefinitionHolder(proxyDefinition, originalBeanName, definition.getAliases()); }
Generate the bean name that is used within the scoped proxy to reference the target bean.
Params:
  • originalBeanName – the original name of bean
See Also:
Returns:the generated bean to be used to reference the target bean
/** * Generate the bean name that is used within the scoped proxy to reference the target bean. * @param originalBeanName the original name of bean * @return the generated bean to be used to reference the target bean * @see #getOriginalBeanName(String) */
public static String getTargetBeanName(String originalBeanName) { return TARGET_NAME_PREFIX + originalBeanName; }
Get the original bean name for the provided target bean name.
Params:
  • targetBeanName – the target bean name for the scoped proxy
Throws:
See Also:
Returns:the original bean name
Since:5.1.10
/** * Get the original bean name for the provided {@linkplain #getTargetBeanName * target bean name}. * @param targetBeanName the target bean name for the scoped proxy * @return the original bean name * @throws IllegalArgumentException if the supplied bean name does not refer * to the target of a scoped proxy * @since 5.1.10 * @see #getTargetBeanName(String) * @see #isScopedTarget(String) */
public static String getOriginalBeanName(@Nullable String targetBeanName) { Assert.isTrue(isScopedTarget(targetBeanName), () -> "bean name '" + targetBeanName + "' does not refer to the target of a scoped proxy"); return targetBeanName.substring(TARGET_NAME_PREFIX_LENGTH); }
Determine if the beanName is the name of a bean that references the target bean within a scoped proxy.
Since:4.1.4
/** * Determine if the {@code beanName} is the name of a bean that references * the target bean within a scoped proxy. * @since 4.1.4 */
public static boolean isScopedTarget(@Nullable String beanName) { return (beanName != null && beanName.startsWith(TARGET_NAME_PREFIX)); } }