分析springboot2.5启动gradle编译任务的启动器类

这是springboot2.5启动gradle编译任务的启动器类:

package org.springframework.boot.build.starters;

import java.io.File;
import java.io.FileReader;
import java.io.FileWriter;
import java.io.IOException;
import java.io.PrintWriter;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;
import java.util.Properties;
import java.util.Set;
import java.util.TreeSet;
import java.util.stream.Collectors;
import java.util.stream.Stream;

import org.gradle.api.DefaultTask;
import org.gradle.api.Task;
import org.gradle.api.artifacts.Configuration;
import org.gradle.api.file.FileCollection;
import org.gradle.api.tasks.InputFiles;
import org.gradle.api.tasks.OutputDirectory;
import org.gradle.api.tasks.PathSensitive;
import org.gradle.api.tasks.PathSensitivity;
import org.gradle.api.tasks.TaskAction;

import org.springframework.util.StringUtils;

/**
 * {@link Task} to document all starter projects.
 *
 * @author Andy Wilkinson
 */
public class DocumentStarters extends DefaultTask {

	private final Configuration starters;

	private File outputDir;

	public DocumentStarters() {
		// 创建一个配置（启动器）
		this.starters = getProject().getConfigurations().create("starters");
		// 调用gradle生成项目评测操作
		getProject().getGradle().projectsEvaluated((gradle) -> {
			// 编译所有项目
			gradle.allprojects((project) -> {
				// 如果存在启动器插件，设置项目路径和启动器元数据参数到项目依赖中
				if (project.getPlugins().hasPlugin(StarterPlugin.class)) {
					Map<String, String> dependency = new HashMap<>();
					dependency.put("path", project.getPath());
					dependency.put("configuration", "starterMetadata");
					this.starters.getDependencies().add(project.getDependencies().project(dependency));
				}
			});
		});
	}

	@OutputDirectory
	public File getOutputDir() {
		return this.outputDir;
	}

	public void setOutputDir(File outputDir) {
		this.outputDir = outputDir;
	}

	@InputFiles
	@PathSensitive(PathSensitivity.RELATIVE)
	public FileCollection getStarters() {
		return this.starters;
	}

	/**
	 * 文档启动器操作
	 */
	@TaskAction
	void documentStarters() {
		// 获取所有启动器集合
		Set starters = this.starters.getFiles().stream().map(this::loadStarter)
				.collect(Collectors.toCollection(TreeSet::new));
		// 打印表格-应用程序启动器
		writeTable("application-starters", starters.stream().filter(Starter::isApplication));
		writeTable("production-starters", starters.stream().filter(Starter::isProduction));
		writeTable("technical-starters", starters.stream().filter(Starter::isTechnical));
	}

	/**
	 * 加载配置元数据，并返回包含依赖的启动器
	 * @param metadata
	 * @return
	 */
	private Starter loadStarter(File metadata) {
		Properties properties = new Properties();
		try (FileReader reader = new FileReader(metadata)) {
			properties.load(reader);
			return new Starter(properties.getProperty("name"), properties.getProperty("description"),
					StringUtils.commaDelimitedListToSet(properties.getProperty("dependencies")));
		}
		catch (IOException ex) {
			throw new RuntimeException(ex);
		}
	}

	/**
	 * 给启动器打印表格内容到指定名称的adoc文件中
	 * @param name
	 * @param starters
	 */
	private void writeTable(String name, Stream starters) {
		File output = new File(this.outputDir, name + ".adoc");
		output.getParentFile().mkdirs();
		try (PrintWriter writer = new PrintWriter(new FileWriter(output))) {
			writer.println("|===");
			writer.println("| Name | Description");
			starters.forEach((starter) -> {
				writer.println();
				writer.printf("| [[%s]]`%s`%n", starter.name, starter.name);
				writer.printf("| %s%n", postProcessDescription(starter.description));
			});
			writer.println("|===");
		}
		catch (IOException ex) {
			throw new RuntimeException(ex);
		}
	}

	private String postProcessDescription(String description) {
		return addStarterCrossLinks(description);
	}

	private String addStarterCrossLinks(String input) {
		return input.replaceAll("(spring-boot-starter[A-Za-z-]*)", "<<$1,`$1`>>");
	}

	/**
	 * 定义一个可比较的启动器
	 */
	private static final class Starter implements Comparable {

		private final String name;

		private final String description;

		private final Set dependencies;

		private Starter(String name, String description, Set dependencies) {
			this.name = name;
			this.description = description;
			this.dependencies = dependencies;
		}

		/**
		 * 判定是否生产
		 * @return
		 */
		private boolean isProduction() {
			return this.name.equals("spring-boot-starter-actuator");
		}

		/**
		 * 判定是否技术
		 * @return
		 */
		private boolean isTechnical() {
			return !Arrays.asList("spring-boot-starter", "spring-boot-starter-test").contains(this.name)
					&& !isProduction() && !this.dependencies.contains("spring-boot-starter");
		}

		/**
		 * 判定是否应用
		 * @return
		 */
		private boolean isApplication() {
			return !isProduction() && !isTechnical();
		}

		@Override
		public int compareTo(Starter other) {
			return this.name.compareTo(other.name);
		}

	}

}

声明: 除非转自他站（如有侵权，请联系处理）外，本文采用 BY-NC-SA 协议进行授权 | 嗅谱网
转载请注明：转自《分析springboot2.5启动gradle编译任务的启动器类》
本文地址：http://www.xiupu.net/archives-10617.html
关注公众号：