spring GeneratedClasses 源码

spring GeneratedClasses 代码

文件路径：/spring-core/src/main/java/org/springframework/aot/generate/GeneratedClasses.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.aot.generate;

import java.io.IOException;
import java.util.ArrayList;
import java.util.Comparator;
import java.util.List;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import java.util.function.Consumer;

import org.springframework.javapoet.ClassName;
import org.springframework.javapoet.TypeSpec;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;

/**
 * A managed collection of generated classes.
 *
 * <p>This class is stateful, so the same instance should be used for all class
 * generation.
 *
 * @author Phillip Webb
 * @author Stephane Nicoll
 * @since 6.0
 * @see GeneratedClass
 */
public class GeneratedClasses {

	private final ClassNameGenerator classNameGenerator;

	private final List<GeneratedClass> classes;

	private final Map<Owner, GeneratedClass> classesByOwner;


	/**
	 * Create a new instance using the specified naming conventions.
	 * @param classNameGenerator the class name generator to use
	 */
	GeneratedClasses(ClassNameGenerator classNameGenerator) {
		this(classNameGenerator, new ArrayList<>(), new ConcurrentHashMap<>());
	}

	private GeneratedClasses(ClassNameGenerator classNameGenerator,
			List<GeneratedClass> classes, Map<Owner, GeneratedClass> classesByOwner) {
		Assert.notNull(classNameGenerator, "'classNameGenerator' must not be null");
		this.classNameGenerator = classNameGenerator;
		this.classes = classes;
		this.classesByOwner = classesByOwner;
	}


	/**
	 * Get or add a generated class for the specified {@code featureName} and no
	 * particular component. If this method has previously been called with the
	 * given {@code featureName} the existing class will be returned, otherwise
	 * a new class will be generated.
	 * @param featureName the name of the feature to associate with the
	 * generated class
	 * @param type a {@link Consumer} used to build the type
	 * @return an existing or newly generated class
	 */
	public GeneratedClass getOrAddForFeature(String featureName,
			Consumer<TypeSpec.Builder> type) {

		Assert.hasLength(featureName, "'featureName' must not be empty");
		Assert.notNull(type, "'type' must not be null");
		Owner owner = new Owner(this.classNameGenerator.getFeatureNamePrefix(), featureName, null);
		GeneratedClass generatedClass = this.classesByOwner.computeIfAbsent(owner, key -> createAndAddGeneratedClass(featureName, null, type));
		generatedClass.assertSameType(type);
		return generatedClass;
	}

	/**
	 * Get or add a generated class for the specified {@code featureName}
	 * targeting the specified {@code component}. If this method has previously
	 * been called with the given {@code featureName}/{@code target} the
	 * existing class will be returned, otherwise a new class will be generated,
	 * otherwise a new class will be generated.
	 * @param featureName the name of the feature to associate with the
	 * generated class
	 * @param targetComponent the target component
	 * @param type a {@link Consumer} used to build the type
	 * @return an existing or newly generated class
	 */
	public GeneratedClass getOrAddForFeatureComponent(String featureName,
			Class<?> targetComponent, Consumer<TypeSpec.Builder> type) {

		Assert.hasLength(featureName, "'featureName' must not be empty");
		Assert.notNull(targetComponent, "'targetComponent' must not be null");
		Assert.notNull(type, "'type' must not be null");
		Owner owner = new Owner(this.classNameGenerator.getFeatureNamePrefix(), featureName, targetComponent);
		GeneratedClass generatedClass = this.classesByOwner.computeIfAbsent(owner, key ->
				createAndAddGeneratedClass(featureName, targetComponent, type));
		generatedClass.assertSameType(type);
		return generatedClass;
	}

	/**
	 * Add a new generated class for the specified {@code featureName} and no
	 * particular component.
	 * @param featureName the name of the feature to associate with the
	 * generated class
	 * @param type a {@link Consumer} used to build the type
	 * @return the newly generated class
	 */
	public GeneratedClass addForFeature(String featureName, Consumer<TypeSpec.Builder> type) {
		Assert.hasLength(featureName, "'featureName' must not be empty");
		Assert.notNull(type, "'type' must not be null");
		return createAndAddGeneratedClass(featureName, null, type);
	}

	/**
	 * Add a new generated class for the specified {@code featureName} targeting
	 * the specified {@code component}.
	 * @param featureName the name of the feature to associate with the
	 * generated class
	 * @param targetComponent the target component
	 * @param type a {@link Consumer} used to build the type
	 * @return the newly generated class
	 */
	public GeneratedClass addForFeatureComponent(String featureName,
			Class<?> targetComponent, Consumer<TypeSpec.Builder> type) {

		Assert.hasLength(featureName, "'featureName' must not be empty");
		Assert.notNull(targetComponent, "'targetComponent' must not be null");
		Assert.notNull(type, "'type' must not be null");
		return createAndAddGeneratedClass(featureName, targetComponent, type);
	}

	private GeneratedClass createAndAddGeneratedClass(String featureName,
			@Nullable Class<?> targetComponent, Consumer<TypeSpec.Builder> type) {

		ClassName className = this.classNameGenerator.generateClassName(featureName, targetComponent);
		GeneratedClass generatedClass = new GeneratedClass(className, type);
		this.classes.add(generatedClass);
		return generatedClass;
	}

	/**
	 * Write the {@link GeneratedClass generated classes} using the given
	 * {@link GeneratedFiles} instance.
	 * @param generatedFiles where to write the generated classes
	 * @throws IOException on IO error
	 */
	void writeTo(GeneratedFiles generatedFiles) {
		Assert.notNull(generatedFiles, "'generatedFiles' must not be null");
		List<GeneratedClass> generatedClasses = new ArrayList<>(this.classes);
		generatedClasses.sort(Comparator.comparing(GeneratedClass::getName));
		for (GeneratedClass generatedClass : generatedClasses) {
			generatedFiles.addSourceFile(generatedClass.generateJavaFile());
		}
	}

	GeneratedClasses withFeatureNamePrefix(String name) {
		return new GeneratedClasses(this.classNameGenerator.withFeatureNamePrefix(name),
				this.classes, this.classesByOwner);
	}

	private record Owner(String featureNamePrefix, String featureName, @Nullable Class<?> target) {
	}

}

相关信息

spring 源码目录

相关文章

spring AccessVisibility 源码

spring AppendableConsumerInputStreamSource 源码

spring ClassNameGenerator 源码

spring DefaultGenerationContext 源码

spring FileSystemGeneratedFiles 源码

spring GeneratedClass 源码

spring GeneratedFiles 源码

spring GeneratedMethod 源码

spring GeneratedMethods 源码

spring GeneratedTypeReference 源码