From 8e0a2b32e21714f8b1296175165e8358ac676d75 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E7=A8=8B=E5=BA=8F=E5=91=98=E5=B0=8F=E5=A2=A8?= Date: Wed, 12 Feb 2025 17:02:10 +0800 Subject: [PATCH] =?UTF-8?q?feat:=20JavadocConfig=20setAuthor=20=E5=92=8C?= =?UTF-8?q?=20setSince=20=E6=96=B9=E6=B3=95=E4=BC=A0=E5=85=A5=E7=A9=BA?= =?UTF-8?q?=E5=AD=97=E7=AC=A6=E4=B8=B2=E6=97=B6=EF=BC=8C=E4=B8=8D=E6=B7=BB?= =?UTF-8?q?=E5=8A=A0=E6=B3=A8=E9=87=8A=20@author,=20@since=20=E9=83=A8?= =?UTF-8?q?=E5=88=86?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/zh/others/codegen.md | 4 ++-- .../src/main/resources/templates/enjoy/controller-Solon.tpl | 4 ++++ .../src/main/resources/templates/enjoy/controller.tpl | 4 ++++ .../src/main/resources/templates/enjoy/entity.kotlin.tpl | 5 +++++ .../src/main/resources/templates/enjoy/entityOrBase.tpl | 4 ++++ .../resources/templates/enjoy/entityWithBase.kotlin.tpl | 5 +++++ .../src/main/resources/templates/enjoy/entityWithBase.tpl | 5 +++++ .../src/main/resources/templates/enjoy/mapper.kotlin.tpl | 4 ++++ .../src/main/resources/templates/enjoy/mapper.tpl | 4 ++++ .../src/main/resources/templates/enjoy/package-info.tpl | 6 +++++- .../src/main/resources/templates/enjoy/service.kotlin.tpl | 4 ++++ .../src/main/resources/templates/enjoy/service.tpl | 4 ++++ .../main/resources/templates/enjoy/serviceImpl-Solon.tpl | 4 ++++ .../main/resources/templates/enjoy/serviceImpl.kotlin.tpl | 4 ++++ .../src/main/resources/templates/enjoy/serviceImpl.tpl | 4 ++++ .../src/main/resources/templates/enjoy/tableDef.tpl | 4 ++++ 16 files changed, 66 insertions(+), 3 deletions(-) diff --git a/docs/zh/others/codegen.md b/docs/zh/others/codegen.md index 93cd2cd4..0620d174 100644 --- a/docs/zh/others/codegen.md +++ b/docs/zh/others/codegen.md @@ -213,8 +213,8 @@ globalConfig.enableEntity() | 配置 | 描述 | 默认值 | |----------------------------------|-----------------|---------------------------------| -| setAuthor(String) | 作者 | System.getProperty("user.name") | -| setSince(String) | 自 | 日期（yyyy-MM-dd） | +| setAuthor(String) | 作者（可填写日期、版本号等，设置为 `""` 则不添加 `@author`） | System.getProperty("user.name") | +| setSince(String) | 自（可填写日期、版本号等，设置为 `""` 则不添加 `@since`） | `yyyy-MM-dd` 格式的日期 | | setTableCommentFormat(Function) | 表注释格式化 | 原表注释 | | setColumnCommentFormat(Function) | 字段注释格式化 | 原字段注释 | | setEntityPackage(String) | Entity 包注释 | "实体类层（Entity）软件包。" | diff --git a/mybatis-flex-codegen/src/main/resources/templates/enjoy/controller-Solon.tpl b/mybatis-flex-codegen/src/main/resources/templates/enjoy/controller-Solon.tpl index 159ad2f1..b7ca47e3 100644 --- a/mybatis-flex-codegen/src/main/resources/templates/enjoy/controller-Solon.tpl +++ b/mybatis-flex-codegen/src/main/resources/templates/enjoy/controller-Solon.tpl @@ -26,8 +26,12 @@ import java.util.List; /** * #(tableComment) 控制层。 * +#if(javadocConfig.getAuthor()) * @author #(javadocConfig.getAuthor()) +#end +#if(javadocConfig.getSince()) * @since #(javadocConfig.getSince()) +#end */ @Controller #if(withSwagger && swaggerVersion.getName() == "FOX") diff --git a/mybatis-flex-codegen/src/main/resources/templates/enjoy/controller.tpl b/mybatis-flex-codegen/src/main/resources/templates/enjoy/controller.tpl index de9ac41f..3d259c0a 100644 --- a/mybatis-flex-codegen/src/main/resources/templates/enjoy/controller.tpl +++ b/mybatis-flex-codegen/src/main/resources/templates/enjoy/controller.tpl @@ -39,8 +39,12 @@ import java.util.List; /** * #(tableComment) 控制层。 * +#if(javadocConfig.getAuthor()) * @author #(javadocConfig.getAuthor()) +#end +#if(javadocConfig.getSince()) * @since #(javadocConfig.getSince()) +#end */ #if(controllerConfig.restStyle) @RestController diff --git a/mybatis-flex-codegen/src/main/resources/templates/enjoy/entity.kotlin.tpl b/mybatis-flex-codegen/src/main/resources/templates/enjoy/entity.kotlin.tpl index c617e1ab..1bd43d0d 100644 --- a/mybatis-flex-codegen/src/main/resources/templates/enjoy/entity.kotlin.tpl +++ b/mybatis-flex-codegen/src/main/resources/templates/enjoy/entity.kotlin.tpl @@ -18,12 +18,17 @@ import io.swagger.annotations.ApiModelProperty #if(withSwagger && swaggerVersion.getName() == "DOC") import io.swagger.v3.oas.annotations.media.Schema #end + #if(!isBase) /** * #(table.getComment()) 实体类。 * +#if(javadocConfig.getAuthor()) * @author #(javadocConfig.getAuthor()) +#end +#if(javadocConfig.getSince()) * @since #(javadocConfig.getSince()) +#end */ #(table.buildTableAnnotation()) #end diff --git a/mybatis-flex-codegen/src/main/resources/templates/enjoy/entityOrBase.tpl b/mybatis-flex-codegen/src/main/resources/templates/enjoy/entityOrBase.tpl index 63563079..5a59cc09 100644 --- a/mybatis-flex-codegen/src/main/resources/templates/enjoy/entityOrBase.tpl +++ b/mybatis-flex-codegen/src/main/resources/templates/enjoy/entityOrBase.tpl @@ -43,8 +43,12 @@ import lombok.EqualsAndHashCode; /** * #(table.getComment()) 实体类。 * +#if(javadocConfig.getAuthor()) * @author #(javadocConfig.getAuthor()) +#end +#if(javadocConfig.getSince()) * @since #(javadocConfig.getSince()) +#end */ #if(withLombok) #if(withActiveRecord) diff --git a/mybatis-flex-codegen/src/main/resources/templates/enjoy/entityWithBase.kotlin.tpl b/mybatis-flex-codegen/src/main/resources/templates/enjoy/entityWithBase.kotlin.tpl index 572b64a4..10bd53c1 100644 --- a/mybatis-flex-codegen/src/main/resources/templates/enjoy/entityWithBase.kotlin.tpl +++ b/mybatis-flex-codegen/src/main/resources/templates/enjoy/entityWithBase.kotlin.tpl @@ -19,11 +19,16 @@ import io.swagger.annotations.ApiModelProperty #if(withSwagger && swaggerVersion.getName() == "DOC") import io.swagger.v3.oas.annotations.media.Schema #end + /** * #(table.getComment()) 实体类。 * +#if(javadocConfig.getAuthor()) * @author #(javadocConfig.getAuthor()) +#end +#if(javadocConfig.getSince()) * @since #(javadocConfig.getSince()) +#end */ #if(withSwagger && swaggerVersion.getName() == "FOX") @ApiModel("#(table.getComment())") diff --git a/mybatis-flex-codegen/src/main/resources/templates/enjoy/entityWithBase.tpl b/mybatis-flex-codegen/src/main/resources/templates/enjoy/entityWithBase.tpl index 1ddc3ed8..08b0c535 100644 --- a/mybatis-flex-codegen/src/main/resources/templates/enjoy/entityWithBase.tpl +++ b/mybatis-flex-codegen/src/main/resources/templates/enjoy/entityWithBase.tpl @@ -35,12 +35,17 @@ import lombok.NoArgsConstructor; #if(jdkVersion >= 14) import java.io.Serial; #end + #if(!isBase) /** * #(table.getComment()) 实体类。 * +#if(javadocConfig.getAuthor()) * @author #(javadocConfig.getAuthor()) +#end +#if(javadocConfig.getSince()) * @since #(javadocConfig.getSince()) +#end */ #end #if(withLombok) diff --git a/mybatis-flex-codegen/src/main/resources/templates/enjoy/mapper.kotlin.tpl b/mybatis-flex-codegen/src/main/resources/templates/enjoy/mapper.kotlin.tpl index 3eca9b3b..76d1ea2e 100644 --- a/mybatis-flex-codegen/src/main/resources/templates/enjoy/mapper.kotlin.tpl +++ b/mybatis-flex-codegen/src/main/resources/templates/enjoy/mapper.kotlin.tpl @@ -9,8 +9,12 @@ import #(packageConfig.entityPackage).#(table.buildEntityClassName()); /** * #(table.getComment()) 映射层。 * +#if(javadocConfig.getAuthor()) * @author #(javadocConfig.getAuthor()) +#end +#if(javadocConfig.getSince()) * @since #(javadocConfig.getSince()) +#end */ #if(mapperConfig.isMapperAnnotation()) @Mapper diff --git a/mybatis-flex-codegen/src/main/resources/templates/enjoy/mapper.tpl b/mybatis-flex-codegen/src/main/resources/templates/enjoy/mapper.tpl index 32670d19..16584189 100644 --- a/mybatis-flex-codegen/src/main/resources/templates/enjoy/mapper.tpl +++ b/mybatis-flex-codegen/src/main/resources/templates/enjoy/mapper.tpl @@ -9,8 +9,12 @@ import #(packageConfig.entityPackage).#(table.buildEntityClassName()); /** * #(table.getComment()) 映射层。 * +#if(javadocConfig.getAuthor()) * @author #(javadocConfig.getAuthor()) +#end +#if(javadocConfig.getSince()) * @since #(javadocConfig.getSince()) +#end */ #if(mapperConfig.isMapperAnnotation()) @Mapper diff --git a/mybatis-flex-codegen/src/main/resources/templates/enjoy/package-info.tpl b/mybatis-flex-codegen/src/main/resources/templates/enjoy/package-info.tpl index a0d305f9..5fbe2dbc 100644 --- a/mybatis-flex-codegen/src/main/resources/templates/enjoy/package-info.tpl +++ b/mybatis-flex-codegen/src/main/resources/templates/enjoy/package-info.tpl @@ -1,7 +1,11 @@ /** * #(packageComment) * +#if(javadocConfig.getAuthor()) * @author #(javadocConfig.getAuthor()) +#end +#if(javadocConfig.getSince()) * @since #(javadocConfig.getSince()) +#end */ -package #(packageName); \ No newline at end of file +package #(packageName); diff --git a/mybatis-flex-codegen/src/main/resources/templates/enjoy/service.kotlin.tpl b/mybatis-flex-codegen/src/main/resources/templates/enjoy/service.kotlin.tpl index dd4a3c45..ff34f21f 100644 --- a/mybatis-flex-codegen/src/main/resources/templates/enjoy/service.kotlin.tpl +++ b/mybatis-flex-codegen/src/main/resources/templates/enjoy/service.kotlin.tpl @@ -6,7 +6,11 @@ import #(packageConfig.entityPackage).#(table.buildEntityClassName()); /** * #(table.getComment()) 服务层。 * +#if(javadocConfig.getAuthor()) * @author #(javadocConfig.getAuthor()) +#end +#if(javadocConfig.getSince()) * @since #(javadocConfig.getSince()) +#end */ interface #(table.buildServiceClassName()) : #(serviceConfig.buildSuperClassName())<#(table.buildEntityClassName())> {} diff --git a/mybatis-flex-codegen/src/main/resources/templates/enjoy/service.tpl b/mybatis-flex-codegen/src/main/resources/templates/enjoy/service.tpl index f130340a..0e0d7b70 100644 --- a/mybatis-flex-codegen/src/main/resources/templates/enjoy/service.tpl +++ b/mybatis-flex-codegen/src/main/resources/templates/enjoy/service.tpl @@ -6,8 +6,12 @@ import #(packageConfig.entityPackage).#(table.buildEntityClassName()); /** * #(table.getComment()) 服务层。 * +#if(javadocConfig.getAuthor()) * @author #(javadocConfig.getAuthor()) +#end +#if(javadocConfig.getSince()) * @since #(javadocConfig.getSince()) +#end */ public interface #(table.buildServiceClassName()) extends #(serviceConfig.buildSuperClassName())<#(table.buildEntityClassName())> { diff --git a/mybatis-flex-codegen/src/main/resources/templates/enjoy/serviceImpl-Solon.tpl b/mybatis-flex-codegen/src/main/resources/templates/enjoy/serviceImpl-Solon.tpl index 6d40b932..f4bdf640 100644 --- a/mybatis-flex-codegen/src/main/resources/templates/enjoy/serviceImpl-Solon.tpl +++ b/mybatis-flex-codegen/src/main/resources/templates/enjoy/serviceImpl-Solon.tpl @@ -11,8 +11,12 @@ import org.noear.solon.annotation.Component; /** * #(table.getComment()) 服务层实现。 * +#if(javadocConfig.getAuthor()) * @author #(javadocConfig.getAuthor()) +#end +#if(javadocConfig.getSince()) * @since #(javadocConfig.getSince()) +#end */ @Component public class #(table.buildServiceImplClassName()) extends ServiceImpl<#(table.buildMapperClassName()), #(table.buildEntityClassName())> #if(table.getGlobalConfig().isServiceGenerateEnable()) implements #(table.buildServiceClassName()) #end{ diff --git a/mybatis-flex-codegen/src/main/resources/templates/enjoy/serviceImpl.kotlin.tpl b/mybatis-flex-codegen/src/main/resources/templates/enjoy/serviceImpl.kotlin.tpl index 7fad1e10..1ef415ee 100644 --- a/mybatis-flex-codegen/src/main/resources/templates/enjoy/serviceImpl.kotlin.tpl +++ b/mybatis-flex-codegen/src/main/resources/templates/enjoy/serviceImpl.kotlin.tpl @@ -11,8 +11,12 @@ import org.springframework.stereotype.Service; /** * #(table.getComment()) 服务层实现。 * +#if(javadocConfig.getAuthor()) * @author #(javadocConfig.getAuthor()) +#end +#if(javadocConfig.getSince()) * @since #(javadocConfig.getSince()) +#end */ @Service class #(table.buildServiceImplClassName()) : #(serviceImplConfig.buildSuperClassName())<#(table.buildMapperClassName()), #(table.buildEntityClassName())>()#if(table.getGlobalConfig().isServiceGenerateEnable()), #(table.buildServiceClassName())#end {} diff --git a/mybatis-flex-codegen/src/main/resources/templates/enjoy/serviceImpl.tpl b/mybatis-flex-codegen/src/main/resources/templates/enjoy/serviceImpl.tpl index 77242a7f..3bcefbb9 100644 --- a/mybatis-flex-codegen/src/main/resources/templates/enjoy/serviceImpl.tpl +++ b/mybatis-flex-codegen/src/main/resources/templates/enjoy/serviceImpl.tpl @@ -25,8 +25,12 @@ import java.util.List; /** * #(table.getComment()) 服务层实现。 * +#if(javadocConfig.getAuthor()) * @author #(javadocConfig.getAuthor()) +#end +#if(javadocConfig.getSince()) * @since #(javadocConfig.getSince()) +#end */ @Service #if(isCacheExample) diff --git a/mybatis-flex-codegen/src/main/resources/templates/enjoy/tableDef.tpl b/mybatis-flex-codegen/src/main/resources/templates/enjoy/tableDef.tpl index 009f6c66..8c145bf5 100644 --- a/mybatis-flex-codegen/src/main/resources/templates/enjoy/tableDef.tpl +++ b/mybatis-flex-codegen/src/main/resources/templates/enjoy/tableDef.tpl @@ -13,8 +13,12 @@ import java.io.Serial; /** * #(table.getComment()) 表定义层。 * +#if(javadocConfig.getAuthor()) * @author #(javadocConfig.getAuthor()) +#end +#if(javadocConfig.getSince()) * @since #(javadocConfig.getSince()) +#end */ public class #(tableDefClassName) extends TableDef {