diff --git a/README.md b/README.md index 051468e..0fb4c6d 100644 --- a/README.md +++ b/README.md @@ -156,7 +156,9 @@ void documentGeneration() { //生成配置 .engineConfig(engineConfig) //生成配置 - .produceConfig(processConfig).build(); + .produceConfig(processConfig) + //自定义文档名称 + .docName(getDocName()).build(); //执行生成 new DocumentationExecute(config).execute(); } @@ -206,6 +208,8 @@ void documentGeneration() { ${project.version} 数据库文档 + + 测试文档名称 diff --git a/screw-core/src/main/java/cn/smallbun/screw/core/Configuration.java b/screw-core/src/main/java/cn/smallbun/screw/core/Configuration.java index 55e3ffa..9456d4e 100644 --- a/screw-core/src/main/java/cn/smallbun/screw/core/Configuration.java +++ b/screw-core/src/main/java/cn/smallbun/screw/core/Configuration.java @@ -69,6 +69,10 @@ public class Configuration implements Serializable { * 引擎配置,关于数据库文档生成相关配置 */ private EngineConfig engineConfig; + /** + * 自定义文档名称 + */ + private String docName; /** * 构造函数 @@ -80,10 +84,11 @@ public class Configuration implements Serializable { * @param dataSource {@link DataSource} 数据源 * @param produceConfig {@link ProcessConfig} 生成配置 * @param engineConfig {@link EngineConfig} 生成配置 + * @param docName {@link String} 自定义文档名称 */ private Configuration(String organization, String organizationUrl, String title, String version, String description, DataSource dataSource, ProcessConfig produceConfig, - EngineConfig engineConfig) { + EngineConfig engineConfig, String docName) { Assert.notNull(dataSource, "DataSource can not be empty!"); Assert.notNull(engineConfig, "EngineConfig can not be empty!"); this.title = title; @@ -94,6 +99,7 @@ public class Configuration implements Serializable { this.dataSource = dataSource; this.engineConfig = engineConfig; this.produceConfig = produceConfig; + this.docName = docName; } /** @@ -115,6 +121,7 @@ public class Configuration implements Serializable { private DataSource dataSource; private ProcessConfig produceConfig; private EngineConfig engineConfig; + private String docName; ConfigurationBuilder() { } @@ -159,6 +166,11 @@ public class Configuration implements Serializable { return this; } + public Configuration.ConfigurationBuilder docName(String docName) { + this.docName = docName; + return this; + } + /** * build * @@ -167,7 +179,7 @@ public class Configuration implements Serializable { public Configuration build() { return new Configuration(this.organization, this.organizationUrl, this.title, this.version, this.description, this.dataSource, this.produceConfig, - this.engineConfig); + this.engineConfig, this.docName); } } } diff --git a/screw-core/src/main/java/cn/smallbun/screw/core/execute/AbstractExecute.java b/screw-core/src/main/java/cn/smallbun/screw/core/execute/AbstractExecute.java index faba6f3..88272d9 100644 --- a/screw-core/src/main/java/cn/smallbun/screw/core/execute/AbstractExecute.java +++ b/screw-core/src/main/java/cn/smallbun/screw/core/execute/AbstractExecute.java @@ -51,6 +51,9 @@ public abstract class AbstractExecute implements Execute { * @return {@link String} 名称 */ String getDocName(String database) { + if (StringUtils.isNotBlank(config.getDocName())) { + return config.getDocName(); + } //描述 String description = config.getDescription(); if (StringUtils.isBlank(description)) { diff --git a/screw-maven-plugin/src/main/java/cn/smallbun/screw/maven/plugin/mojo/RunDocMojo.java b/screw-maven-plugin/src/main/java/cn/smallbun/screw/maven/plugin/mojo/RunDocMojo.java index 5dc4c2d..efb32b0 100644 --- a/screw-maven-plugin/src/main/java/cn/smallbun/screw/maven/plugin/mojo/RunDocMojo.java +++ b/screw-maven-plugin/src/main/java/cn/smallbun/screw/maven/plugin/mojo/RunDocMojo.java @@ -166,6 +166,12 @@ public class RunDocMojo extends AbstractMojo { @Parameter private String template; + /** + * 自定义文档名称 + */ + @Parameter + private String docName; + /** * 文档生成 */ @@ -192,7 +198,9 @@ public class RunDocMojo extends AbstractMojo { //引擎模板配置 .engineConfig(getEngineConfig()) //数据处理配置 - .produceConfig(getProcessConfig()).build(); + .produceConfig(getProcessConfig()) + //自定义文档名称 + .docName(getDocName()).build(); //生成文档 new DocumentationExecute(config).execute(); getLog().info(String.format(LOGGER_COMPLETE, (System.currentTimeMillis() - start) / 1000));