序文
私は最近、オープン ソース プロジェクトを見ました。jfinal-layui
このプロジェクトには代码生成器
機能
コードジェネレーターは使ったことはありますが、関連するソースコードを見たことがなかったので調べてみました.個人的には、このプロジェクトのコードジェネレーターはかなり良いと感じています.フロントエンドとバックエンドのコードを生成できます.指定されたデータベースとテーブルに、しかし、このプロジェクトのフレームワークは、jfinal
このコード ジェネレーターに関連するコードを自分のプロジェクトに直接コピーすることは機能せず、各プロジェクトの構造にはいくつかの固有のプロパティがあり、それを見つけるのは困難です。使用できるコード ジェネレーター このため、jfinal
フレームワーク
jfinal-layui
このプロジェクトを学習したい場合は、リンクhttps://gitee.com/QinHaiSenLin/Jfinal-layuiをクリックして、このプロジェクトのソース コードを取得できます。
I. 概要
コードジェネレーターはその名の通りコードを生成するソフトウェアです. 日常の開発において, コードジェネレーターを使用することで, 繰り返しの開発作業を減らし, オープンの効率を上げることができます. 例えば, 私たちがよく使うリバースエンジニアリングmybatis
がありますデータベース、マッパー、xml ファイルなどに対応するエンティティ クラスは、実際にはコード ジェネレーターです。
コードジェネレーターの原理は何ですか?
実は非常に単純で、生成したいファイルには一定のルールが必要であり、このルールに従って統一されたファイルを作成し、模板
このテンプレートに従って対応するコードを生成します。
2.手書きコード
1. 簡単な説明
以下の内容は参考用です. 私が提供するのは単なる実装ソリューションであり、あなたのプロジェクトには適していないかもしれません.
現場を離れたビジネスは無意味です. 前述したように、どのプロジェクトにも独自性があります. 私は自分のプロジェクトに基づいて要件を満たすコードジェネレーターを作成しています.
たとえば、私のプロジェクトでは、追加、削除、変更、およびチェックのためのインターフェイスの完全なセットを実装するために、次のクラスが存在する必要があり、選択された部分 (User.java、UserMapper.java、および UserMapper.xml ) は次红色框
の实体类
とおりmapper 文件
ですxml 文件
。 mybatisのリバースエンジニアリングで生成されたもので、绿色框
選択部分は自分で手動で書く必要があるので、書く必要があるコードジェネレーターは、緑枠の選択部分を生成するのに役立つファイルです。として: Controller
、Service
、ServiceImp
、请求体 dto
、相应体 dto
およびsubclass 包下的转换器
。
私のプロジェクトの特定の構築については、次のブログを参照してください: SpringBoot - Quick Construction
ではどのように実装すればよいのでしょうか? まず、標準的な追加、削除、修正、およびクエリを自分で作成し、それに従ってテンプレートを作成することをお勧めします. たとえば、ポジションのコントローラーを作成しました.コードは次のとおりです。
package com.duojiala.mikeboot.controller;
import com.duojiala.mikeboot.domain.req.QueryPostListReq;
import com.duojiala.mikeboot.domain.req.SavePostReq;
import com.duojiala.mikeboot.domain.dto.ResponseBean;
import io.swagger.annotations.ApiOperation;
import org.springframework.validation.annotation.Validated;
import java.util.List;
import com.duojiala.mikeboot.service.PostService;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
/**
* 顶部导航 Controller
* @author: mike
* @date: 2023-04-26 17:03
*/
@Slf4j
@RestController
@RequestMapping(value = "/post")
@RequiredArgsConstructor(onConstructor = @__(@Autowired))
@CrossOrigin(origins = "*", methods = {
RequestMethod.POST, RequestMethod.GET})
public class PostController {
private final PostService postService;
@PostMapping(value = "/save")
@ApiOperation(value = "保存")
public ResponseBean save(@RequestBody @Validated SavePostReq req) {
postService.save(req);
return ResponseBean.success();
}
@PostMapping(value = "/update")
@ApiOperation(value = "修改")
public ResponseBean update(@RequestBody @Validated SavePostReq req) {
postService.update(req);
return ResponseBean.success();
}
@PostMapping(value = "/detail")
@ApiOperation(value = "查询详情")
public ResponseBean detail(@RequestParam(required = false) String id) {
return ResponseBean.success(postService.detail(id));
}
@PostMapping(value = "/delete")
@ApiOperation(value = "删除")
public ResponseBean delete(@RequestParam(required = false) String id) {
postService.delete(id);
return ResponseBean.success();
}
@PostMapping(value = "/batch-delete")
@ApiOperation(value = "批量删除")
public ResponseBean batchDelete(@RequestParam(required = false) List<String> ids) {
postService.batchDelete(ids);
return ResponseBean.success();
}
@PostMapping(value = "/paginate-list")
@ApiOperation(value = "分页查询列表")
public ResponseBean paginateList(@RequestBody @Validated QueryPostListReq req) {
return ResponseBean.success(postService.paginateList(req));
}
}
だから私はこのようなテンプレートcontroller_template.jf
ファイル
package #(controllerPackagePath);
#if(isCRUD)
import com.duojiala.mikeboot.domain.req.#(QueryTargetListReq??);
import com.duojiala.mikeboot.domain.req.#(SaveTargetReq??);
import com.duojiala.mikeboot.domain.dto.ResponseBean;
import io.swagger.annotations.ApiOperation;
import org.springframework.validation.annotation.Validated;
import java.util.List;
#end
import com.duojiala.mikeboot.service.#(ServiceName??);
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
/**
* #(controllerRemark??) Controller
* @author: #(author?? 'JBolt-Generator')
* @date: #date()
*/
@Slf4j
@RestController
@RequestMapping(value = "/#(pathValue??)")
@RequiredArgsConstructor(onConstructor = @__(@Autowired))
@CrossOrigin(origins = "*", methods = {RequestMethod.POST, RequestMethod.GET})
public class #(ControllerName??) {
private final #(ServiceName??) #(serviceName??);
#if(isCRUD)
@PostMapping(value = "/save")
@ApiOperation(value = "保存")
public ResponseBean save(@RequestBody @Validated #(SaveTargetReq??) req) {
#(serviceName??).save(req);
return ResponseBean.success();
}
@PostMapping(value = "/update")
@ApiOperation(value = "修改")
public ResponseBean update(@RequestBody @Validated #(SaveTargetReq??) req) {
#(serviceName??).update(req);
return ResponseBean.success();
}
@PostMapping(value = "/detail")
@ApiOperation(value = "查询详情")
public ResponseBean detail(@RequestParam(required = false) String id) {
return ResponseBean.success(#(serviceName??).detail(id));
}
@PostMapping(value = "/delete")
@ApiOperation(value = "删除")
public ResponseBean delete(@RequestParam(required = false) String id) {
#(serviceName??).delete(id);
return ResponseBean.success();
}
@PostMapping(value = "/batch-delete")
@ApiOperation(value = "批量删除")
public ResponseBean batchDelete(@RequestParam(required = false) List<String> ids) {
#(serviceName??).batchDelete(ids);
return ResponseBean.success();
}
#if(needPaginate)
@PostMapping(value = "/paginate-list")
@ApiOperation(value = "分页查询列表")
public ResponseBean paginateList(@RequestBody @Validated #(QueryTargetListReq??) req) {
return ResponseBean.success(#(serviceName??).paginateList(req));
}
#else
@PostMapping(value = "/list")
@ApiOperation(value = "查询列表")
public ResponseBean list(@RequestBody @Validated #(QueryTargetListReq??) req) {
return ResponseBean.success(#(serviceName??).list(req));
}
#end
#end
}
これは、自分のプロジェクトでよく書かれているコードを介して、共通の場所を保持し、違いをいくつかのテンプレート エンジンの構文に置き換えます.一時的に理解できなくても問題ありません (構文テンプレート エンジンがこのコードを書いています。ジェネレーターはわかりませんが、他の人が書いたものと比較して書くことはできます)
最終的な効果
2. コードの書き方
のホイールjfinal
を、ここに を参照するjfinal
依存関係があります。
<!--JFianl-->
<dependency>
<groupId>com.jfinal</groupId>
<artifactId>jfinal</artifactId>
<version>5.0.4</version>
</dependency>
いくつかのツールもあります (これらは、独自のプロジェクトに従って選択されます)。
<!-- 转化器自动转换 -->
<dependency>
<groupId>org.mapstruct</groupId>
<artifactId>mapstruct</artifactId>
<version>1.4.2.Final</version>
</dependency>
<dependency>
<groupId>org.mapstruct</groupId>
<artifactId>mapstruct-processor</artifactId>
<version>1.4.2.Final</version>
</dependency>
<!-- 分页插件 -->
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper-spring-boot-starter</artifactId>
<version>1.2.12</version>
</dependency>
<!--工具类-->
<dependency>
<groupId>cn.hutool</groupId>
<artifactId>hutool-all</artifactId>
<version>5.8.18</version>
</dependency>
次に、テーブルが挿入されるたびにテーブルの列挙をこの列挙クラスに追加できることを期待して、列挙クラスも作成しました。
import lombok.AllArgsConstructor;
import lombok.Getter;
/**
* 表名枚举
*/
@Getter
@AllArgsConstructor
public enum TableEnum {
USER("用户表"),
;
private final String desc;
}
コード ジェネレーターを格納するパッケージを作成しますLogicGenerator.java
。まず、Controller
レイヤー
/**
* 生成 Controller 层的代码
*/
public void genController(LogicBean logicBean) {
// 获取实体类名称
String entityName = logicBean.getEntityClass().getSimpleName();
// 生成 Controller 类的名称
String controllerName = entityName + "Controller";
// 生成 Controller 类的完整名称
String controllerFullName = controllerName + ".java";
// 获取 Controller 类的路径
String controllerPackagePath = logicBean.getControllerPackagePath();
this.printMessageWithDate(String.format("正在生成 Controller:%s...", controllerFullName));
// 获取 Controller 生成路径
String targetOutputDir = this.getDirFromPackage(controllerPackagePath);
this.printMessageWithDate(String.format("Controller 生成路径:%s...", targetOutputDir));
// 判断将要生成的 Controller.java 是否存在
if (FileUtil.exist(targetOutputDir + File.separator + controllerFullName)) {
this.printMessageWithDate(String.format("Controller 文件[%s]已存在,忽略生成 ~~ ", controllerFullName));
} else {
String serviceName = entityName + "Service";
// 替换 .jf 文件中的内容,比如在 #(author??) 会替换成 logicBean.getAuthor() 这个值
Kv<String,Object> data = Kv.by("author", (Object)logicBean.getAuthor())
.set("controllerPackagePath", controllerPackagePath)
.set("QueryTargetListReq", "Query"+entityName+"ListReq")
.set("SaveTargetReq", "Save"+entityName+"Req")
.set("ServiceName", serviceName)
.set("controllerRemark", logicBean.getTableEnumDes())
.set("pathValue", StringUtils.isBlank(logicBean.getPathValue())?toFirstLower(entityName):logicBean.getPathValue())
.set("ControllerName", controllerName)
.set("serviceName", toFirstLower(serviceName))
.set("needPaginate", logicBean.isNeedPaginate())
.set("isCRUD",logicBean.isCrudType());
// 配置好模板路径,通过 engine 去生成相应的内容
String content = this.engine.getTemplate(controllerTemplate).renderToString(data);
// IO 写文件
this.writeToFile(targetOutputDir, controllerFullName, content);
}
}
次に、ジェネレーターを起動するmain
エントリとしてメソッド
public class MainLogicGenerator extends LogicGenerator {
public static void main(String[] args) {
// 启动代码生成器
}
}
3. 完全なコード
LogicGenerator.java
コードは以下のように表示されます:
package com.duojiala.mikeboot.extend.gen;
import cn.hutool.core.io.FileUtil;
import com.duojiala.mikeboot.utils.DateUtil;
import com.jfinal.kit.StrKit;
import com.jfinal.template.Engine;
import org.apache.commons.lang3.StringUtils;
import javax.persistence.Table;
import java.io.File;
import java.lang.reflect.Field;
import java.lang.reflect.Type;
import java.util.*;
/**
* 代码生成器主类
*/
public class LogicGenerator {
// 分隔符
public final String SEPARATOR;
// 项目路径
private final String PROJECT_PATH;
// 枚举类路径
private final String PROJECT_TABLE_ENUM_PATH;
// Controller 层模板
private static final String controllerTemplate = "/genera/controller_template.jf";
// Service 模板
private static final String serviceTemplate = "/genera/service_template.jf";
// ServiceImpl 模板
private static final String serviceImplTemplate = "/genera/service_impl_template.jf";
// 转换器模板
private static final String converterTemplate = "/genera/converter_template.jf";
// 通用 dto 模板
private static final String commonDtoTemplate = "/genera/common_dto_template.jf";
// 查询 dto 模板
private static final String queryDtoTemplate = "/genera/query_dto_template.jf";
// 生成类队列
private final List<LogicBean> logicBeans;
// jfinal 处理 jf 文件的引擎
private Engine engine;
/**
* 初始化
*/
public LogicGenerator() {
this.SEPARATOR = File.separator;
this.PROJECT_PATH = System.getProperty("user.dir");
this.PROJECT_TABLE_ENUM_PATH = this.PROJECT_PATH + this.SEPARATOR + "src" + this.SEPARATOR + "main" + this.SEPARATOR + "java" + this.SEPARATOR + "com" + this.SEPARATOR + "duojiala" + this.SEPARATOR + "mikeboot" + this.SEPARATOR + "extend" + this.SEPARATOR + "system" + this.SEPARATOR + "TableEnum.java";
logicBeans = new ArrayList<>();
this.initGenConfig();
this.initEngine();
}
/**
* 初始化模板引擎
*/
private void initEngine() {
this.printMessageWithDate("初始化模板引擎 ...");
this.engine = new Engine();
this.engine.setToClassPathSourceFactory();
this.engine.addSharedMethod(new StringKit());
}
/**
* 根据生成类队列里面的信息生成代码
*/
public void generate() {
this.printMessageWithDate("开始执行生成......");
this.logicBeans.forEach(this::generateOne);
this.printMessageWithDate("全部生成 结束 ...");
this.printMessageWithDate("==请刷新项目目录,检查生成结果==");
}
public void generateOne(LogicBean logicBean) {
this.printMessageWithDate("正在生成 ===> ["+logicBean.getEntityClass().getName()+"]");
// 生成枚举
this.genTableEnum(logicBean);
// 生成 Controller 类
this.genController(logicBean);
// 生成 Service 类
this.genService(logicBean);
// 生成 ServiceImpl 类
this.genServiceImpl(logicBean);
// 生成 相应的 DTO 类
this.genReqRespConverter(logicBean);
}
public void genTableEnum(LogicBean logicBean) {
Class<?> entityClass = logicBean.getEntityClass();
String simpleName = entityClass.getSimpleName();
this.printMessageWithDate("正在生成 "+simpleName+" 表枚举类型");
boolean exist = FileUtil.exist(this.PROJECT_TABLE_ENUM_PATH);
if (!exist) {
throw new RuntimeException(this.PROJECT_TABLE_ENUM_PATH + "文件不存在");
} else {
List<String> codeLines = FileUtil.readLines(this.PROJECT_TABLE_ENUM_PATH, "UTF-8");
if (codeLines != null && codeLines.size() != 0) {
Table annotation = entityClass.getAnnotation(Table.class);
String reallyName = annotation.name();
String tableEnumName = StringUtils.upperCase(reallyName);
String tableEnumDes = logicBean.getTableEnumDes()==null?tableEnumName:logicBean.getTableEnumDes();
String code = tableEnumName + "(\"" + tableEnumDes + "\"),";
if (this.checkFileContainCode(codeLines, code)) {
this.printMessageWithDate(String.format("TableEnum 文件中已存在 [%s][%s] 的定义,略过",tableEnumName,tableEnumDes));
} else {
int size = codeLines.size();
int insertIndex = 0;
int startIndex = -1;
for(int i = 1; i < size; ++i) {
String tmpCode = (String)codeLines.get(i);
if (!StringUtils.isBlank(tmpCode)) {
if (startIndex == -1 && tmpCode.trim().startsWith("public enum TableEnum")) {
startIndex = i + 1;
}
if (tmpCode.trim().equals(";")) {
insertIndex = i;
}
}
}
boolean needProcessUpComma = true;
if (insertIndex == 0) {
insertIndex = startIndex;
code = code + ",";
needProcessUpComma = false;
}
if (startIndex > 0) {
codeLines.add(insertIndex, "\t" + code);
if (needProcessUpComma) {
for(int i = insertIndex - 1; i > startIndex; --i) {
String tmp = (String)codeLines.get(i);
if (!StringUtils.isBlank(tmp)) {
String tmpTrim = tmp.trim();
if (tmpTrim.endsWith(",") || tmpTrim.endsWith(";") || tmpTrim.endsWith("{") || tmpTrim.endsWith("}")) {
break;
}
if (tmpTrim.charAt(tmpTrim.length() - 1) != ',') {
codeLines.set(i, "\t" + tmpTrim + ",");
break;
}
}
}
}
this.printMessageWithDate("正在重新生成新的 TableEnum...");
FileUtil.writeLines(codeLines, this.PROJECT_TABLE_ENUM_PATH, "UTF-8");
}
}
} else {
throw new RuntimeException(this.PROJECT_TABLE_ENUM_PATH + "文件内容异常");
}
}
}
private boolean checkFileContainCode(List<String> codeLines, String code) {
Iterator<String> var4 = codeLines.iterator();
String tmpCode;
String codeLine;
do {
if (!var4.hasNext()) {
return false;
}
codeLine = (String)var4.next();
tmpCode = codeLine.trim();
} while(StringUtils.isBlank(tmpCode) || tmpCode.startsWith("package ") || tmpCode.startsWith("public class ") || tmpCode.startsWith("return ") || tmpCode.equals("}") || !codeLine.contains(code));
return true;
}
public void genController(LogicBean logicBean) {
String entityName = logicBean.getEntityClass().getSimpleName();
String controllerName = entityName + "Controller";
String controllerFullName = controllerName + ".java";
String controllerPackagePath = logicBean.getControllerPackagePath();
this.printMessageWithDate(String.format("正在生成 Controller:%s...", controllerFullName));
String targetOutputDir = this.getDirFromPackage(controllerPackagePath);
this.printMessageWithDate(String.format("Controller 生成路径:%s...", targetOutputDir));
if (FileUtil.exist(targetOutputDir + File.separator + controllerFullName)) {
this.printMessageWithDate(String.format("Controller 文件[%s]已存在,忽略生成 ~~ ", controllerFullName));
} else {
String serviceName = entityName + "Service";
Kv<String,Object> data = Kv.by("author", (Object)logicBean.getAuthor())
.set("controllerPackagePath", controllerPackagePath)
.set("QueryTargetListReq", "Query"+entityName+"ListReq")
.set("SaveTargetReq", "Save"+entityName+"Req")
.set("ServiceName", serviceName)
.set("controllerRemark", logicBean.getTableEnumDes())
.set("pathValue", StringUtils.isBlank(logicBean.getPathValue())?toFirstLower(entityName):logicBean.getPathValue())
.set("ControllerName", controllerName)
.set("serviceName", toFirstLower(serviceName))
.set("needPaginate", logicBean.isNeedPaginate())
.set("isCRUD",logicBean.isCrudType());
String content = this.engine.getTemplate(controllerTemplate).renderToString(data);
this.writeToFile(targetOutputDir, controllerFullName, content);
}
}
private void genService(LogicBean logicBean) {
Class<?> entityClass = logicBean.getEntityClass();
String entityName = entityClass.getSimpleName();
String serviceName = entityName + "Service";
String serviceFullName = serviceName + ".java";
String servicePackagePath = logicBean.getServicePackagePath();
this.printMessageWithDate(String.format("正在生成 Service:%s...", serviceFullName));
String targetOutputDir = this.getDirFromPackage(servicePackagePath);
this.printMessageWithDate(String.format("Service 生成路径:%s...", targetOutputDir));
if (FileUtil.exist(targetOutputDir + File.separator + serviceFullName)) {
this.printMessageWithDate(String.format("Service 文件[%s]已存在,忽略生成 ~~ ", serviceFullName));
} else {
Kv<String,Object> data = Kv.by("author", (Object)logicBean.getAuthor())
.set("servicePackagePath", servicePackagePath)
.set("QueryTargetListReq", "Query"+entityName+"ListReq")
.set("SaveTargetReq", "Save"+entityName+"Req")
.set("EntityName", entityName)
.set("QueryTargetListResp", "Query"+entityName+"ListResp")
.set("ServiceName", serviceName)
.set("needPaginate", logicBean.isNeedPaginate())
.set("isCRUD",logicBean.isCrudType());
String content = this.engine.getTemplate(serviceTemplate).renderToString(data);
this.writeToFile(targetOutputDir, serviceFullName, content);
}
}
private void genServiceImpl(LogicBean logicBean) {
Class<?> entityClass = logicBean.getEntityClass();
String entityName = entityClass.getSimpleName();
String serviceImplName = entityName + "ServiceImpl";
String serviceImplFullName = serviceImplName + ".java";
String serviceImplPackagePath = logicBean.getServiceImplPackagePath();
this.printMessageWithDate(String.format("正在生成 ServiceImpl:%s...", serviceImplFullName));
String targetOutputDir = this.getDirFromPackage(serviceImplPackagePath);
this.printMessageWithDate(String.format("ServiceImpl 生成路径:%s...", targetOutputDir));
if (FileUtil.exist(targetOutputDir + File.separator + serviceImplFullName)) {
this.printMessageWithDate(String.format("ServiceImpl 文件[%s]已存在,忽略生成 ~~ ", serviceImplFullName));
} else {
List<Toggle> toggleList = new ArrayList<>();
Field[] declaredFields = entityClass.getDeclaredFields();
boolean isSoftDel = false;
for (Field declaredField : declaredFields) {
String fieldName = declaredField.getName();
if ("delFlag".equals(fieldName)) {
isSoftDel = true;
continue;
}
Type genericType = declaredField.getGenericType();
String[] genericArr = genericType.toString().split("\\.");
String type = genericArr[genericArr.length - 1];
if ("Boolean".equals(type)) {
toggleList.add(new Toggle(fieldName,"req.get" + toFirstUpper(fieldName) + "()"));
}
}
String keywordSelect = logicBean.getKeywordSelect();
boolean hasKeyword = false;
if (StringUtils.isNotBlank(keywordSelect)) {
// 有关键字,则拼装查询条件
hasKeyword = true;
String[] keywordArr = keywordSelect.split(",");
StringBuilder builder = new StringBuilder();
int i = 0;
builder.append("criteria.andCondition(\"");
do {
if (i != 0) {
builder.append("+ \" or \" + \"");
}
builder.append(keywordArr[i]).append(" like \" + ").append("\"%\"+").append("req.getKeyword()").append("+\"%\"");
} while (i++<keywordArr.length-1);
builder.append(");");
keywordSelect = builder.toString();
}
Kv<String,Object> data = Kv.by("author", (Object)logicBean.getAuthor())
.set("serviceImplPackagePath", serviceImplPackagePath)
.set("QueryTargetListRespConverter", "Query"+entityName+"ListRespConverter")
.set("queryTargetListRespConverter", "query"+entityName+"ListRespConverter")
.set("SaveTargetReqConverter", "Save"+entityName+"ReqConverter")
.set("saveTargetReqConverter", "save"+entityName+"ReqConverter")
.set("QueryTargetListReq", "Query"+entityName+"ListReq")
.set("SaveTargetReq", "Save"+entityName+"Req")
.set("EntityName", entityName)
.set("entityName", toFirstLower(entityName))
.set("QueryTargetListResp", "Query"+entityName+"ListResp")
.set("ServiceName", entityName + "Service")
.set("ServiceImplName", serviceImplName)
.set("toggleList", toggleList)
.set("hasKeyword", hasKeyword)
.set("keywordSelect", keywordSelect)
.set("isSoftDel", isSoftDel)
.set("needPaginate", logicBean.isNeedPaginate())
.set("isCRUD",logicBean.isCrudType());
String content = this.engine.getTemplate(serviceImplTemplate).renderToString(data);
this.writeToFile(targetOutputDir, serviceImplFullName, content);
}
}
private void genReqRespConverter(LogicBean logicBean) {
boolean isCRUD = logicBean.isCrudType();
if (isCRUD) {
genRequestBody(logicBean,OptionEnum.SAVE);
genRequestBody(logicBean,OptionEnum.PAGINATE);
genResponseBody(logicBean);
}
}
private void genRequestBody(LogicBean logicBean, OptionEnum optionEnum) {
// 生成请求体
Class<?> entityClass = logicBean.getEntityClass();
String entityName = entityClass.getSimpleName();
String targetReq = null;
boolean havePageInfo = false;
switch (optionEnum) {
case SAVE:
targetReq = "Save" + entityName + "Req";
break;
case PAGINATE:
targetReq = "Query" + entityName + "ListReq";
havePageInfo = true;
break;
default:
return;
}
String targetReqFullName = targetReq + ".java";
String requestPackagePath = logicBean.getRequestPackagePath();
this.printMessageWithDate(String.format("正在生成 RequestBoy:%s...", requestPackagePath));
String targetOutputDir = this.getDirFromPackage(requestPackagePath);
this.printMessageWithDate(String.format("RequestBoy 生成路径:%s...", targetOutputDir));
if (FileUtil.exist(targetOutputDir + File.separator + targetReqFullName)) {
this.printMessageWithDate(String.format("RequestBoy 文件[%s]已存在,忽略生成 ~~ ", targetReqFullName));
} else {
List<String> inserts = new ArrayList<>();
// 通过反射获取目标对象的属性
Field[] declaredFields = entityClass.getDeclaredFields();
for (Field declaredField : declaredFields) {
String fieldName = declaredField.getName();
switch (optionEnum) {
case SAVE:
if ("createTime".equals(fieldName)) continue;
if ("updateTime".equals(fieldName)) continue;
if ("delFlag".equals(fieldName)) continue;
inserts.add("private String " + fieldName + ";");
break;
case PAGINATE:
if ("delFlag".equals(fieldName)) continue;
Type genericType = declaredField.getGenericType();
String[] genericArr = genericType.toString().split("\\.");
String type = genericArr[genericArr.length - 1];
if ("Boolean".equals(type)) {
inserts.add("private " + type + " " + fieldName + ";");
}
break;
}
}
if (OptionEnum.PAGINATE == optionEnum) {
inserts.add("private String keyword;");
}
Kv<String,Object> data = Kv.by("author", (Object)logicBean.getAuthor())
.set("dtoPackagePath",requestPackagePath)
.set("DtoName", targetReq)
.set("havePageInfo", havePageInfo)
.set("inserts",inserts);
String content = this.engine.getTemplate(commonDtoTemplate).renderToString(data);
this.writeToFile(targetOutputDir, targetReqFullName, content);
}
if (OptionEnum.SAVE == optionEnum) {
genConverter(logicBean,targetReq,entityName,requestPackagePath+"."+targetReq);
}
}
private void genResponseBody(LogicBean logicBean) {
Class<?> entityClass = logicBean.getEntityClass();
String entityName = entityClass.getSimpleName();
String targetReq = "Query" + entityName + "ListResp";
String targetReqFullName = targetReq + ".java";
String responsePackagePath = logicBean.getResponsePackagePath();
this.printMessageWithDate(String.format("正在生成 ResponseBoy:%s...", responsePackagePath));
String targetOutputDir = this.getDirFromPackage(responsePackagePath);
this.printMessageWithDate(String.format("ResponseBoy 生成路径:%s...", targetOutputDir));
if (FileUtil.exist(targetOutputDir + File.separator + targetReqFullName)) {
this.printMessageWithDate(String.format("ResponseBoy 文件[%s]已存在,忽略生成 ~~ ", targetReqFullName));
} else {
List<String> inserts = new ArrayList<>();
Field[] declaredFields = entityClass.getDeclaredFields();
for (Field declaredField : declaredFields) {
String fieldName = declaredField.getName();
if ("createTime".equals(fieldName)) continue;
if ("updateTime".equals(fieldName)) continue;
if ("delFlag".equals(fieldName)) continue;
Type genericType = declaredField.getGenericType();
String[] genericArr = genericType.toString().split("\\.");
String type = genericArr[genericArr.length - 1];
inserts.add("private " + type + " " + fieldName + ";");
}
Kv<String,Object> data = Kv.by("author", (Object)logicBean.getAuthor())
.set("dtoPackagePath",responsePackagePath)
.set("DtoName", targetReq)
.set("inserts",inserts);
String content = this.engine.getTemplate(queryDtoTemplate).renderToString(data);
this.writeToFile(targetOutputDir, targetReqFullName, content);
}
genConverter(logicBean,targetReq,entityName,responsePackagePath+"."+targetReq);
}
private void genConverter(LogicBean logicBean,String A,String B,String AAllPath) {
String converterName = A + "Converter";
String converterFullName = converterName + ".java";
String converterPackagePath = logicBean.getConverterPackagePath();
this.printMessageWithDate(String.format("正在生成 Converter:%s...", converterPackagePath));
String targetOutputDir = this.getDirFromPackage(converterPackagePath);
this.printMessageWithDate(String.format("Converter 生成路径:%s...", targetOutputDir));
if (FileUtil.exist(targetOutputDir + File.separator + converterFullName)) {
this.printMessageWithDate(String.format("Converter 文件[%s]已存在,忽略生成 ~~ ", converterFullName));
} else {
Kv<String,Object> data = Kv.by("author", (Object)logicBean.getAuthor())
.set("converterPackagePath", converterPackagePath)
.set("Target", A)
.set("EntityName", B)
.set("TargetAllPath",AAllPath);
String content = this.engine.getTemplate(converterTemplate).renderToString(data);
this.writeToFile(targetOutputDir, converterFullName, content);
}
}
private void writeToFile(String targetOutputDir, String fileName, String content) {
if (!FileUtil.exist(targetOutputDir)) {
FileUtil.mkdir(targetOutputDir);
}
String target = targetOutputDir + File.separator + fileName;
if (!FileUtil.exist(target)) {
FileUtil.writeUtf8String(content, target);
}
}
/**
* 初始化配置,供子类实现
*/
public void initGenConfig() {
}
private String getDirFromPackage(String targetPackageName) {
return PROJECT_PATH + "/src/main/java/" + targetPackageName.replace(".", "/");
}
public void printMessageWithDate(String message) {
System.out.println("[Generate Log]:[" + DateUtil.format(new Date(), DateUtil.YMDHMS) + "]" + message);
}
public String toFirstLower(String var) {
return var.substring(0, 1).toLowerCase() + var.substring(1);
}
public String toFirstUpper(String var) {
return var.substring(0, 1).toUpperCase() + var.substring(1);
}
public void addGenBean(LogicBean logicBean) {
this.logicBeans.add(logicBean);
}
private enum OptionEnum {
SAVE,
PAGINATE;
}
public static class Toggle {
private String key;
private String value;
public Toggle() {
}
public Toggle(String key, String value) {
this.key = key;
this.value = value;
}
public String getKey() {
return key;
}
public void setKey(String key) {
this.key = key;
}
public String getValue() {
return value;
}
public void setValue(String value) {
this.value = value;
}
}
public static class StringKit extends StrKit {
private static final long serialVersionUID = -808251639784763326L;
}
/**
* 生成对象类
*/
public static class LogicBean {
private Class<?> entityClass;
private String author;
private String projectPath;
private String controllerPackagePath;
private String servicePackagePath;
private String serviceImplPackagePath;
private String converterPackagePath;
private String requestPackagePath;
private String responsePackagePath;
private String pathValue;
private String keywordSelect;
private boolean isCrudType;
private boolean needPaginate;
private boolean needSort;
private String tableEnumDes;
public LogicBean() {
}
public LogicBean(Class<?> entityClass,
String tableDes,
String author,
String pathValue,
String controllerPackagePath,
String servicePackagePath,
String serviceImplPackagePath,
String converterPackagePath,
String requestPackagePath,
String responsePackagePath,
String keywordSelect,
boolean needPaginate,
boolean isCrudType) {
if (!entityClass.isAnnotationPresent(Table.class)) {
throw new RuntimeException("Entity:" + entityClass.getName() + "必须有 @Table 注解");
}
this.entityClass = entityClass;
this.tableEnumDes = tableDes;
this.author = author;
this.pathValue = pathValue;
this.controllerPackagePath = controllerPackagePath;
this.servicePackagePath = servicePackagePath;
this.serviceImplPackagePath = serviceImplPackagePath;
this.converterPackagePath = converterPackagePath;
this.requestPackagePath = requestPackagePath;
this.responsePackagePath = responsePackagePath;
this.keywordSelect = keywordSelect;
this.needPaginate = needPaginate;
this.isCrudType = isCrudType;
}
public Class<?> getEntityClass() {
return entityClass;
}
public void setEntityClass(Class<?> entityClass) {
if (!entityClass.isAnnotationPresent(Table.class)) {
throw new RuntimeException("Entity:" + entityClass.getName() + "必须有 @Table 注解");
}
this.entityClass = entityClass;
}
public String getAuthor() {
return author;
}
public void setAuthor(String author) {
this.author = author;
}
public String getProjectPath() {
return projectPath;
}
public void setProjectPath(String projectPath) {
this.projectPath = projectPath;
}
public String getControllerPackagePath() {
return controllerPackagePath;
}
public void setControllerPackagePath(String controllerPackagePath) {
this.controllerPackagePath = controllerPackagePath;
}
public String getServicePackagePath() {
return servicePackagePath;
}
public void setServicePackagePath(String servicePackagePath) {
this.servicePackagePath = servicePackagePath;
}
public String getServiceImplPackagePath() {
return serviceImplPackagePath;
}
public void setServiceImplPackagePath(String serviceImplPackagePath) {
this.serviceImplPackagePath = serviceImplPackagePath;
}
public String getTableEnumDes() {
return tableEnumDes;
}
public void setTableEnumDes(String tableEnumDes) {
this.tableEnumDes = tableEnumDes;
}
public boolean isCrudType() {
return isCrudType;
}
public void setCrudType(boolean crudType) {
isCrudType = crudType;
}
public boolean isNeedPaginate() {
return needPaginate;
}
public void setNeedPaginate(boolean needPaginate) {
this.needPaginate = needPaginate;
}
public String getPathValue() {
return pathValue;
}
public void setPathValue(String pathValue) {
this.pathValue = pathValue;
}
public boolean isNeedSort() {
return needSort;
}
public void setNeedSort(boolean needSort) {
this.needSort = needSort;
}
public String getConverterPackagePath() {
return converterPackagePath;
}
public void setConverterPackagePath(String converterPackagePath) {
this.converterPackagePath = converterPackagePath;
}
public String getRequestPackagePath() {
return requestPackagePath;
}
public void setRequestPackagePath(String requestPackagePath) {
this.requestPackagePath = requestPackagePath;
}
public String getResponsePackagePath() {
return responsePackagePath;
}
public void setResponsePackagePath(String responsePackagePath) {
this.responsePackagePath = responsePackagePath;
}
public String getKeywordSelect() {
return keywordSelect;
}
public void setKeywordSelect(String keywordSelect) {
this.keywordSelect = keywordSelect;
}
}
public static class Kv<K,V> extends HashMap<K,V> {
private static final long serialVersionUID = -808251639784763326L;
public Kv() {
}
public Kv<K,V> set(K key, V value) {
super.put(key, value);
return this;
}
public Kv<K,V> set(Map<K,V> map) {
super.putAll(map);
return this;
}
public Kv<K,V> delete(K key) {
super.remove(key);
return this;
}
public static <K,V> Kv<K,V> by(K key, V value) {
return (new Kv<K,V>()).set(key, value);
}
public static <K,V> Kv<K,V> create() {
return new Kv<K,V>();
}
public Kv<K,V> setIfNotNull(K key, V value) {
if (value != null) {
this.set(key, value);
}
return this;
}
}
}
MainLogicGenerator.java
コードは以下のように表示されます:
package com.duojiala.mikeboot.extend.gen;
import com.duojiala.mikeboot.domain.entity.Post;
/**
* Controller Service 代码生成器
*/
public class MainLogicGenerator extends LogicGenerator {
public static void main(String[] args) {
new MainLogicGenerator().generate();
}
@Override
public void initGenConfig() {
// 以哪个实体类生成代码
Class<?> clazz = Post.class;
// 表描述
String tableDes = "职位"; // TableEnum.java 类中的枚举,tableDes 为表的描述信息,如果不填默认为类名的全大写
// 生成 java 代码的默认作者
String author = "mike";
// 映射路径
String pathValue = ""; // 如果不填默认为类的全小写
// Controller 类生成路径
String controllerPackagePath = "com.duojiala.mikeboot.controller";
// Service 类生成路径
String servicePackagePath = "com.duojiala.mikeboot.service";
// ServiceImpl 类生成路径
String serviceImplPackagePath = "com.duojiala.mikeboot.service.imp";
// Converter 转换器类生成路径
String converterPackagePath = "com.duojiala.mikeboot.domain.converter.subclass";
// Request 请求体类生成路径
String requestPackagePath = "com.duojiala.mikeboot.domain.req";
// Response 响应体类生成路径
String responsePackagePath = "com.duojiala.mikeboot.domain.resp";
// 是否需要分页查询
boolean needPaginate = true;
// 是否为普通增删操作
boolean isCrudType = true;
// 以那些字段进行模糊查询,多个用 "," 拼接,不设置默认为 name
String keywordSelect = "";
//创建主逻辑生成配置Bean
LogicBean logicBean = new LogicBean(clazz, tableDes, author, pathValue,
controllerPackagePath, servicePackagePath, serviceImplPackagePath,converterPackagePath,requestPackagePath,responsePackagePath,keywordSelect, needPaginate, isCrudType);
//加入到生成队列中
addGenBean(logicBean);
}
}
4. 試験効果
MainLogicGenerator
生成するテーブルの追加、削除、変更、クエリなど、スタートアップクラスで対応する情報を構成する必要があるだけで、対応する を構成し.class
、作成者、パス、ページング メソッドを生成するかどうかなどの条件を設定します。mian
メソッド。
たとえば、上に示したように、 post
tableが、Controller、Service、ServiceImpl
ここにはそのようなファイルがないことがわかります。
これらのファイルも実行後に生成されることがわかります。
3. プロジェクトのソースコード
これは私が書いたコード ジェネレーターであり、誰もがプレイできるように、以下のプロジェクトのダウンロード リンクも提供しています。
リンク: Baidu Netdisk
抽出コード: xb1k
次に、これらのエンティティ クラスのすべてのファイルとフロントエンドを生成する場合は、jfinal
その。