swagger-codegen 生成代码原理

概述：

swagger-codegen可以通过命令行生成代码（v2.1.5 /Swagger格式），也可以通过web服务生成代码（v3.0.11/OpenAPI格式）。两者只是入口不一样，但实际都是调用的DefaultGenerator.generate（）来生成代码。

在整个生成代码的过程中，主要是 OpenAPI/Swagger，不同语言的CodegenConfig实现类（可以继承这个来实现自定义的处理方式），DefaultGenerator三者发挥着重要作用。

1. OpenAPI/Swagger用于装载代码信息（包括项目版本信息，server，标签，路径，返回参数类等）；
2. CodegenConfig是一个接口，不同语言会有对应的实现类，用于处理数据或者承载代码所共有的信息（比如文件路径，自定义标签信息等）；
3. DefaultGenerator就是生成代码的总指挥官，它会有所有的信息，包括了OpenAPI/Swagger，CodegenConfig所拥有的信息。

v2.1.5源码：https://github.com/swagger-api/swagger-codegen
v3.0.11源码：https://github.com/swagger-api/swagger-codegen/tree/v3.0.11

一.命令行入口

SwaggerCodegen.main：

public class SwaggerCodegen {
    public static void main(String[] args) {
        String version = Version.readVersionFromResources();
        @SuppressWarnings("unchecked")
        Cli.CliBuilder builder =
                Cli.builder("swagger-codegen-cli")
                        .withDescription(
                                String.format(
                                        "Swagger code generator CLI (version %s). More info on swagger.io",
                                        version))
                        .withDefaultCommand(Langs.class)
            //这里有Generate.class，其内部有run方法
                        .withCommands(Generate.class, Meta.class, Langs.class, Help.class,
                                ConfigHelp.class, Validate.class, Version.class);
		//调用上述Generate的run()
        builder.build().parse(args).run();
    }
}

Generate.run:

public void run() {
	......

    //设置代码数据
    if (isNotEmpty(spec)) {
        configurator.setInputSpec(spec);
    }
	//设置语言种类
    if (isNotEmpty(lang)) {
        configurator.setLang(lang);
    }
    //设置各种参数值
    ......
    applySystemPropertiesKvpList(systemProperties, configurator);
    applyInstantiationTypesKvpList(instantiationTypes, configurator);
    applyImportMappingsKvpList(importMappings, configurator);
    applyTypeMappingsKvpList(typeMappings, configurator);
    applyAdditionalPropertiesKvpList(additionalProperties, configurator);
    applyLanguageSpecificPrimitivesCsvList(languageSpecificPrimitives, configurator);
    applyReservedWordsMappingsKvpList(reservedWordsMappings, configurator);
    //转换成ClientOptInput
    final ClientOptInput clientOptInput = configurator.toClientOptInput();

    new DefaultGenerator().opts(clientOptInput).generate();
}

CodegenConfigurator.toClientOptInput:

public ClientOptInput toClientOptInput() {

    Validate.notEmpty(lang, "language must be specified");
    Validate.notEmpty(inputSpec, "input spec must be specified");

    setVerboseFlags();
    setSystemProperties();

    CodegenConfig config = CodegenConfigLoader.forName(lang);

    //设置各种属性
	......

    //处理动态属性至additionalProperties（如：XXXCodegen）
    handleDynamicProperties(config);

    if (isNotEmpty(library)) {
        config.setLibrary(library);
    }

    config.additionalProperties().putAll(additionalProperties);

    //设置对应语言的CodegenConfig
    ClientOptInput input = new ClientOptInput()
            .config(config);

    final List authorizationValues = AuthParser.parse(auth);

    //读取输入的数据
    Swagger swagger = new SwaggerParser().read(inputSpec, authorizationValues, true);

    input.opts(new ClientOpts())
            .swagger(swagger);

    return input;
}

二.web调用

GeneratorController

package io.swagger.v3.generator.online;

    public ResponseContext generate(RequestContext context, GenerationRequest generationRequest) {
        //预处理一些信息（比如：处理生成代码的路径）
        ......
        //调用生成代码的接口
        ResponseContext responseContext = generate(generationRequest, outputRootFolder, outputContentFolder, outputFile);
        LOGGER.debug("generate end - " + requestLog);
        return responseContext;

    }

    private ResponseContext generate(GenerationRequest generationRequest, File outputRootFolder, File outputContentFolder, File outputFile) {
        //生成器服务，用于配置CodegenConfig等
        GeneratorService generatorService = new GeneratorService();
        try {
            generatorService.generationRequest(generationRequest);
        } catch (Exception e) {
            String msg = "Error processing generation request: " + e.getMessage();
            LOGGER.error(msg, e);
            return new ResponseContext()
                    .status(400)
                    .contentType(MediaType.TEXT_PLAIN)
                    .entity(msg);
        }

        final List files;
        try {
            //1.生成代码！
            files = generatorService.generate();
        } catch (Exception e) {
            String msg = String.format("Error generating `%s` code : %s", generationRequest.getLang(), e.getMessage());
            LOGGER.error(msg, e);
            return new ResponseContext()
                    .status(500)
                    .contentType(MediaType.TEXT_PLAIN)
                    .entity(msg);
        }
       ......
    }

1.生成代码 GeneratorService.generate：也是调用的DefaultGenerator.opts(XXX)和DefaultGenerator.generate（）

opts方法主要是配置相关的信息，生成代码还是靠generate方法

public List generate() {
    //v3对应着3.0.11 OpenAPI的代码数据
    if (optsV3 != null) {
        return new DefaultGenerator().opts(optsV3).generate();
    } else if (optsV2 != null) {
         //v2对应着swagger的代码数据
        return new io.swagger.codegen.DefaultGenerator().opts(optsV2).generate();
    }
    throw new RuntimeException("missing opts input");
}

三.总指挥官

这里分析的是3.0.11的DefaultGenerator

DefaultGenerator.generate:

生成各种文件的流程是：处理数据，找到模板，生成文件

public List generate() {

    if (swagger == null || config == null) {
        throw new RuntimeException("missing swagger input or config!");
    }
    //添加一些生成器属性（名字，版本，生成时间等）和测试数据
    configureGeneratorProperties();
    //添加appname，license等信息
    configureSwaggerInfo();

    //处理model里面内联（包括array）
    InlineModelResolver inlineModelResolver = new InlineModelResolver();
    inlineModelResolver.flatten(swagger);

    List files = new ArrayList();
    // 1.生成models
    List