diff --git a/cloud-common/cloud-common-core/pom.xml b/cloud-common/cloud-common-core/pom.xml index 1316e57..2c079fa 100644 --- a/cloud-common/cloud-common-core/pom.xml +++ b/cloud-common/cloud-common-core/pom.xml @@ -152,6 +152,12 @@ org.springframework.boot spring-boot-starter-test + + io.swagger.core.v3 + swagger-annotations-jakarta + 2.2.28 + compile + diff --git a/cloud-common/cloud-common-core/src/main/java/com/muyu/common/core/web/page/PageReq.java b/cloud-common/cloud-common-core/src/main/java/com/muyu/common/core/web/page/PageReq.java index ac14125..5057c64 100644 --- a/cloud-common/cloud-common-core/src/main/java/com/muyu/common/core/web/page/PageReq.java +++ b/cloud-common/cloud-common-core/src/main/java/com/muyu/common/core/web/page/PageReq.java @@ -1,6 +1,7 @@ package com.muyu.common.core.web.page; import com.muyu.common.core.utils.StringUtils; +import io.swagger.v3.oas.annotations.media.Schema; import lombok.AllArgsConstructor; import lombok.Data; import lombok.NoArgsConstructor; @@ -21,26 +22,31 @@ public class PageReq { /** * 当前记录起始索引 */ + @Schema(title = "pageNum", name = "当前页", description = "当前记录起始索引", defaultValue = "1") private Integer pageNum; /** * 每页显示记录数 */ + @Schema(title = "pageSize", name = "分页条数", description = "每页显示记录数", defaultValue = "10") private Integer pageSize; /** * 排序列 */ + @Schema(title = "orderByColumn", name = "排序列", description = "列表查询排序列") private String orderByColumn; /** * 排序的方向desc或者asc */ + @Schema(title = "isAsc", name = "排序方向", description = "排序的方向desc或者asc", defaultValue = "asc") private String isAsc = "asc"; /** * 分页参数合理化 */ + @Schema(title = "reasonable", name = "合理分页参数", description = "分页参数合理化") private Boolean reasonable = true; public String getOrderBy () { diff --git a/cloud-modules/cloud-modules-gen/src/main/resources/vm/java/domain.java.vm b/cloud-modules/cloud-modules-gen/src/main/resources/vm/java/domain.java.vm index 51adc2b..f895aa9 100644 --- a/cloud-modules/cloud-modules-gen/src/main/resources/vm/java/domain.java.vm +++ b/cloud-modules/cloud-modules-gen/src/main/resources/vm/java/domain.java.vm @@ -26,7 +26,7 @@ import com.muyu.common.core.web.domain.TreeEntity; #end /** - * ${functionName}对象 ${tableName} + * ${functionName}数据库映射对象 ${tableName} * * @author ${author} * @date ${datetime} @@ -40,16 +40,17 @@ import com.muyu.common.core.web.domain.TreeEntity; @SuperBuilder @NoArgsConstructor @AllArgsConstructor -@TableName("${tableName}") +@TableName("${tableName}对数据库映射对象") @EqualsAndHashCode(callSuper = true) -@Schema(description = "${functionName}") public class ${ClassName} extends ${Entity} { @Serial private static final long serialVersionUID = 1L; #foreach ($column in $columns) #if(!$table.isSuperColumn($column.javaField)) - /** $column.columnComment */ + /** + * $column.columnComment + */ #if($column.list) #set($parentheseIndex=$column.columnComment.indexOf("(")) #if($parentheseIndex != -1) @@ -73,15 +74,13 @@ public class ${ClassName} extends ${Entity} { #if($column.isRequired == '1') #set($comment=', required = true') #end - @Schema(name = "${column.columnComment}") private $column.javaType $column.javaField; #end #end - /** - * 添加构造器 - */ + * 添加构造器 + */ public static ${ClassName} saveBuild(${ClassName}SaveReq ${className}SaveReq){ return ${ClassName}.builder() #foreach ($column in $columns) @@ -92,16 +91,16 @@ public class ${ClassName} extends ${Entity} { #else #set($AttrName=$column.javaField.substring(0,1).toUpperCase() + ${column.javaField.substring(1)}) #end - .${column.javaField}(${className}SaveReq.get${AttrName}()) + .${column.javaField}(${className}SaveReq.get${AttrName}()) #end #end #end - .build(); + .build(); } /** - * 修改构造器 - */ + * 修改构造器 + */ public static ${ClassName} editBuild(${pkColumn.javaType} ${pkColumn.javaField}, ${ClassName}EditReq ${className}EditReq){ return ${ClassName}.builder() .${pkColumn.javaField}(${pkColumn.javaField}) @@ -113,11 +112,11 @@ public class ${ClassName} extends ${Entity} { #else #set($AttrName=$column.javaField.substring(0,1).toUpperCase() + ${column.javaField.substring(1)}) #end - .${column.javaField}(${className}EditReq.get${AttrName}()) + .${column.javaField}(${className}EditReq.get${AttrName}()) #end #end #end - .build(); + .build(); } } diff --git a/cloud-modules/cloud-modules-gen/src/main/resources/vm/java/edit.java.vm b/cloud-modules/cloud-modules-gen/src/main/resources/vm/java/edit.java.vm index d7dd164..5fe76cd 100644 --- a/cloud-modules/cloud-modules-gen/src/main/resources/vm/java/edit.java.vm +++ b/cloud-modules/cloud-modules-gen/src/main/resources/vm/java/edit.java.vm @@ -12,7 +12,7 @@ import lombok.AllArgsConstructor; import lombok.experimental.SuperBuilder; /** - * ${functionName}对象 ${tableName} + * ${functionName}修改请求对象 * * @author ${author} * @date ${datetime} @@ -26,13 +26,15 @@ import lombok.experimental.SuperBuilder; @SuperBuilder @NoArgsConstructor @AllArgsConstructor -@Schema(description = "${functionName}") +@Schema(description = "${functionName}修改请求对象") public class ${ClassName}EditReq { #foreach ($column in $columns) #if(!$table.isSuperColumn($column.javaField)) #if($column.isEdit == '1') - /** $column.columnComment */ + /** + * $column.columnComment + */ #if($column.list) #set($parentheseIndex=$column.columnComment.indexOf("(")) #if($parentheseIndex != -1) @@ -48,7 +50,7 @@ public class ${ClassName}EditReq { #if($column.isRequired == '1') #set($isRequired=', required = true') #end - @Schema(name = "${column.columnComment}" $isRequired) + @Schema(name = "${column.javaField}", title = "${column.columnComment}", description = "${column.columnComment}" $isRequired) private $column.javaType $column.javaField; #end diff --git a/cloud-modules/cloud-modules-gen/src/main/resources/vm/java/query.java.vm b/cloud-modules/cloud-modules-gen/src/main/resources/vm/java/query.java.vm index 791c88d..4fa386a 100644 --- a/cloud-modules/cloud-modules-gen/src/main/resources/vm/java/query.java.vm +++ b/cloud-modules/cloud-modules-gen/src/main/resources/vm/java/query.java.vm @@ -15,7 +15,7 @@ import lombok.experimental.SuperBuilder; import ${packageName}.domain.model.${ClassName}QueryModel; /** - * ${functionName}对象 ${tableName} + * ${functionName}查询请求对象 * * @author ${author} * @date ${datetime} @@ -29,14 +29,16 @@ import ${packageName}.domain.model.${ClassName}QueryModel; @SuperBuilder @NoArgsConstructor @AllArgsConstructor -@Schema(description = "${functionName}") +@Schema(description = "${functionName}查询请求对象") @EqualsAndHashCode(callSuper = true) public class ${ClassName}QueryReq extends PageReq { #foreach ($column in $columns) #if(!$table.isSuperColumn($column.javaField)) #if($column.isQuery == '1') - /** $column.columnComment */ + /** + * $column.columnComment + */ #if($column.list) #set($parentheseIndex=$column.columnComment.indexOf("(")) #if($parentheseIndex != -1) @@ -51,7 +53,7 @@ public class ${ClassName}QueryReq extends PageReq { #if($column.javaField == $pkColumn.javaField) @TableId(value = "${pkColumn.javaField}",type = IdType.AUTO) #end - @Schema(name = "${column.columnComment}") + @Schema(name = "${column.javaField}", title = "${column.columnComment}", description = "${column.columnComment}") private $column.javaType $column.javaField; #end diff --git a/cloud-modules/cloud-modules-gen/src/main/resources/vm/java/queryModel.java.vm b/cloud-modules/cloud-modules-gen/src/main/resources/vm/java/queryModel.java.vm index 268d4e2..a2dec72 100644 --- a/cloud-modules/cloud-modules-gen/src/main/resources/vm/java/queryModel.java.vm +++ b/cloud-modules/cloud-modules-gen/src/main/resources/vm/java/queryModel.java.vm @@ -5,7 +5,6 @@ import ${import}; #end import com.muyu.common.core.web.model.QueryModel; import com.muyu.system.domain.req.StudentInfoQueryReq; -import io.swagger.v3.oas.annotations.media.Schema; import lombok.Data; import lombok.EqualsAndHashCode; import lombok.NoArgsConstructor; @@ -13,7 +12,7 @@ import lombok.AllArgsConstructor; import lombok.experimental.SuperBuilder; /** - * ${functionName}对象 ${tableName} + * ${functionName}查询请求模型对象 * * @author ${author} * @date ${datetime} @@ -27,14 +26,15 @@ import lombok.experimental.SuperBuilder; @SuperBuilder @NoArgsConstructor @AllArgsConstructor -@Schema(description = "${functionName}") @EqualsAndHashCode(callSuper = true) public class ${ClassName}QueryModel extends QueryModel<${ClassName}QueryModel> { #foreach ($column in $columns) #if(!$table.isSuperColumn($column.javaField)) #if($column.isQuery == '1') - /** $column.columnComment */ + /** + * $column.columnComment + */ #if($column.list) #set($parentheseIndex=$column.columnComment.indexOf("(")) #if($parentheseIndex != -1) @@ -43,17 +43,16 @@ public class ${ClassName}QueryModel extends QueryModel<${ClassName}QueryModel> { #set($comment=$column.columnComment) #end #end - @Schema(name = "${column.columnComment}") private $column.javaType $column.javaField; #end #end #end /** - * 查询构造器 - */ + * 查询构造器 + */ public static ${ClassName}QueryModel reqBuild( ${ClassName}QueryReq queryReq){ - ${ClassName}QueryModel ${className}QueryModel = ${ClassName}QueryModel.builder() + ${ClassName}QueryModel ${className}QueryModel = ${ClassName}QueryModel.builder() #foreach ($column in $columns) #if($column.isQuery == '1') #if(!$table.isSuperColumn($column.javaField)) @@ -62,12 +61,12 @@ public class ${ClassName}QueryModel extends QueryModel<${ClassName}QueryModel> { #else #set($AttrName=$column.javaField.substring(0,1).toUpperCase() + ${column.javaField.substring(1)}) #end - .${column.javaField}(queryReq.get${AttrName}()) + .${column.javaField}(queryReq.get${AttrName}()) #end #end #end .build(); - ${className}QueryModel.domainBuild(queryReq); + ${className}QueryModel.domainBuild(queryReq); return ${className}QueryModel; } } diff --git a/cloud-modules/cloud-modules-gen/src/main/resources/vm/java/save.java.vm b/cloud-modules/cloud-modules-gen/src/main/resources/vm/java/save.java.vm index e4773c2..144bb4b 100644 --- a/cloud-modules/cloud-modules-gen/src/main/resources/vm/java/save.java.vm +++ b/cloud-modules/cloud-modules-gen/src/main/resources/vm/java/save.java.vm @@ -12,7 +12,7 @@ import lombok.AllArgsConstructor; import lombok.experimental.SuperBuilder; /** - * ${functionName}对象 ${tableName} + * ${functionName}保存请求对象 * * @author ${author} * @date ${datetime} @@ -26,14 +26,16 @@ import lombok.experimental.SuperBuilder; @SuperBuilder @NoArgsConstructor @AllArgsConstructor -@Schema(description = "${functionName}") +@Schema(description = "${functionName}保存请求对象") public class ${ClassName}SaveReq{ #foreach ($column in $columns) #if(!$table.isSuperColumn($column.javaField)) #if($column.isInsert == '1') - /** $column.columnComment */ + /** + * $column.columnComment + */ #if($column.list) #set($parentheseIndex=$column.columnComment.indexOf("(")) #if($parentheseIndex != -1) @@ -50,7 +52,7 @@ public class ${ClassName}SaveReq{ #if($column.isRequired == '1') #set($isRequired=', required = true') #end - @Schema(name = "${column.columnComment}" $isRequired) + @Schema(name = "${column.javaField}", title = "${column.columnComment}", description = "${column.columnComment}" $isRequired) private $column.javaType $column.javaField; #end diff --git a/cloud-modules/cloud-modules-gen/src/main/resources/vm/java/serviceImpl.java.vm b/cloud-modules/cloud-modules-gen/src/main/resources/vm/java/serviceImpl.java.vm index 5ef5421..353b041 100644 --- a/cloud-modules/cloud-modules-gen/src/main/resources/vm/java/serviceImpl.java.vm +++ b/cloud-modules/cloud-modules-gen/src/main/resources/vm/java/serviceImpl.java.vm @@ -33,29 +33,29 @@ public class ${ClassName}ServiceImpl extends ServiceImpl<${ClassName}Mapper, ${C @Override public PageQueryModel<${ClassName}> pageQuery(${ClassName}QueryModel pageQueryModel) { LambdaQueryWrapper<${ClassName}> queryWrapper = new LambdaQueryWrapper<>(); -#foreach($column in $columns) - #set($queryType=$column.queryType) - #set($javaField=$column.javaField) - #set($JavaField=$column.javaField.substring(0,1).toUpperCase() + ${column.javaField.substring(1)}) - #if($column.query) + #foreach($column in $columns) + #set($queryType=$column.queryType) + #set($javaField=$column.javaField) + #set($JavaField=$column.javaField.substring(0,1).toUpperCase() + ${column.javaField.substring(1)}) + #if($column.query) #if($queryType == "EQ") - queryWrapper.eq(ObjectUtil.isNotNull(pageQueryModel.get$JavaField()), ${ClassName}::get$JavaField, pageQueryModel.get$JavaField()); + queryWrapper.eq(ObjectUtil.isNotNull(pageQueryModel.get$JavaField()), ${ClassName}::get$JavaField, pageQueryModel.get$JavaField()); #elseif($queryType == "NE") - queryWrapper.ne(ObjectUtil.isNotNull(pageQueryModel.get$JavaField()),${ClassName}::get$JavaField, pageQueryModel.get$JavaField()); + queryWrapper.ne(ObjectUtil.isNotNull(pageQueryModel.get$JavaField()),${ClassName}::get$JavaField, pageQueryModel.get$JavaField()); #elseif($queryType == "GT") - queryWrapper.gt(ObjectUtil.isNotNull(pageQueryModel.get$JavaField()),${ClassName}::get$JavaField, pageQueryModel.get$JavaField()); + queryWrapper.gt(ObjectUtil.isNotNull(pageQueryModel.get$JavaField()),${ClassName}::get$JavaField, pageQueryModel.get$JavaField()); #elseif($queryType == "GTE") - queryWrapper.ge(ObjectUtil.isNotNull(pageQueryModel.get$JavaField()),${ClassName}::get$JavaField, pageQueryModel.get$JavaField()); + queryWrapper.ge(ObjectUtil.isNotNull(pageQueryModel.get$JavaField()),${ClassName}::get$JavaField, pageQueryModel.get$JavaField()); #elseif($queryType == "LT") - queryWrapper.lt(ObjectUtil.isNotNull(pageQueryModel.get$JavaField()),${ClassName}::get$JavaField, pageQueryModel.get$JavaField()); + queryWrapper.lt(ObjectUtil.isNotNull(pageQueryModel.get$JavaField()),${ClassName}::get$JavaField, pageQueryModel.get$JavaField()); #elseif($queryType == "LTE") - queryWrapper.le(ObjectUtil.isNotNull(pageQueryModel.get$JavaField()), ${ClassName}::get$JavaField, pageQueryModel.get$JavaField()); + queryWrapper.le(ObjectUtil.isNotNull(pageQueryModel.get$JavaField()), ${ClassName}::get$JavaField, pageQueryModel.get$JavaField()); #elseif($queryType == "LIKE") - queryWrapper.like(ObjectUtil.isNotNull(pageQueryModel.get$JavaField()),${ClassName}::get$JavaField, pageQueryModel.get$JavaField()); + queryWrapper.like(ObjectUtil.isNotNull(pageQueryModel.get$JavaField()),${ClassName}::get$JavaField, pageQueryModel.get$JavaField()); #elseif($queryType == "BETWEEN") - queryWrapper.between(ObjectUtil.isNotNull(pageQueryModel.get$JavaField()),${ClassName}::get$JavaField, pageQueryModel.getBeginParam("$JavaField"),pageQueryModel.getEndParam("$JavaField")); -#end #end #end - Page<${ClassName}> page = this.page(pageQueryModel.buildPage(), queryWrapper); + queryWrapper.between(ObjectUtil.isNotNull(pageQueryModel.get$JavaField()),${ClassName}::get$JavaField, pageQueryModel.getBeginParam("$JavaField"),pageQueryModel.getEndParam("$JavaField")); + #end #end #end + Page<${ClassName}> page = this.page(pageQueryModel.buildPage(), queryWrapper); return PageQueryModel.of(page); } @@ -75,22 +75,22 @@ public class ${ClassName}ServiceImpl extends ServiceImpl<${ClassName}Mapper, ${C #set($JavaField=$column.javaField.substring(0,1).toUpperCase() + ${column.javaField.substring(1)}) #if($column.query) #if($queryType == "EQ") - queryWrapper.eq(ObjectUtil.isNotNull(pageQueryModel.get$JavaField()), ${ClassName}::get$JavaField, pageQueryModel.get$JavaField()); + queryWrapper.eq(ObjectUtil.isNotNull(pageQueryModel.get$JavaField()), ${ClassName}::get$JavaField, pageQueryModel.get$JavaField()); #elseif($queryType == "NE") - queryWrapper.ne(ObjectUtil.isNotNull(pageQueryModel.get$JavaField()),${ClassName}::get$JavaField, pageQueryModel.get$JavaField()); + queryWrapper.ne(ObjectUtil.isNotNull(pageQueryModel.get$JavaField()),${ClassName}::get$JavaField, pageQueryModel.get$JavaField()); #elseif($queryType == "GT") - queryWrapper.gt(ObjectUtil.isNotNull(pageQueryModel.get$JavaField()),${ClassName}::get$JavaField, pageQueryModel.get$JavaField()); + queryWrapper.gt(ObjectUtil.isNotNull(pageQueryModel.get$JavaField()),${ClassName}::get$JavaField, pageQueryModel.get$JavaField()); #elseif($queryType == "GTE") - queryWrapper.ge(ObjectUtil.isNotNull(pageQueryModel.get$JavaField()),${ClassName}::get$JavaField, pageQueryModel.get$JavaField()); + queryWrapper.ge(ObjectUtil.isNotNull(pageQueryModel.get$JavaField()),${ClassName}::get$JavaField, pageQueryModel.get$JavaField()); #elseif($queryType == "LT") - queryWrapper.lt(ObjectUtil.isNotNull(pageQueryModel.get$JavaField()),${ClassName}::get$JavaField, pageQueryModel.get$JavaField()); + queryWrapper.lt(ObjectUtil.isNotNull(pageQueryModel.get$JavaField()),${ClassName}::get$JavaField, pageQueryModel.get$JavaField()); #elseif($queryType == "LTE") - queryWrapper.le(ObjectUtil.isNotNull(pageQueryModel.get$JavaField()), ${ClassName}::get$JavaField, pageQueryModel.get$JavaField()); + queryWrapper.le(ObjectUtil.isNotNull(pageQueryModel.get$JavaField()), ${ClassName}::get$JavaField, pageQueryModel.get$JavaField()); #elseif($queryType == "LIKE") - queryWrapper.like(ObjectUtil.isNotNull(pageQueryModel.get$JavaField()),${ClassName}::get$JavaField, pageQueryModel.get$JavaField()); + queryWrapper.like(ObjectUtil.isNotNull(pageQueryModel.get$JavaField()),${ClassName}::get$JavaField, pageQueryModel.get$JavaField()); #elseif($queryType == "BETWEEN") - queryWrapper.between(ObjectUtil.isNotNull(pageQueryModel.get$JavaField()),${ClassName}::get$JavaField, pageQueryModel.getBeginParam("$JavaField"),pageQueryModel.getEndParam("$JavaField")); + queryWrapper.between(ObjectUtil.isNotNull(pageQueryModel.get$JavaField()),${ClassName}::get$JavaField, pageQueryModel.getBeginParam("$JavaField"),pageQueryModel.getEndParam("$JavaField")); #end #end #end - return this.list(queryWrapper); + return this.list(queryWrapper); } }