代码生成界面 /tool/gen

操作步骤

1. 新增学生表

DROP TABLE IF EXISTS sys_student;
CREATE TABLE sys_student (student_id           INT(11)         AUTO_INCREMENT    COMMENT '编号',student_name         VARCHAR(30)     DEFAULT ''        COMMENT '学生名称',student_age          INT(3)          DEFAULT NULL      COMMENT '年龄',student_sex          CHAR(1)         DEFAULT '0'       COMMENT '性别（0男 1女 2未知）',student_status       CHAR(1)         DEFAULT '0'       COMMENT '状态（0正常 1停用）',student_birthday     DATETIME                          COMMENT '生日',remark               VARCHAR(500)    DEFAULT NULL      COMMENT '备注',PRIMARY KEY (student_id)
) ENGINE=INNODB AUTO_INCREMENT=1 COMMENT = '学生信息表';

2. 登录系统（系统工具 -> 代码生成 -> 导入对应表）
3. 代码生成列表中找到需要表（可预览、修改、删除生成配置）
4. 点击生成代码会得到一个ruoyi.zip 执行sql文件，按照包内目录结构复制到自己的项目中即可

GenController控制代码生成操作处理

package com.ruoyi.generator.controller;import java.io.IOException;
import java.util.List;
import java.util.Map;
import javax.servlet.http.HttpServletResponse;
import org.apache.commons.io.IOUtils;
import org.apache.shiro.authz.annotation.RequiresPermissions;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.ui.ModelMap;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import com.ruoyi.common.annotation.Log;
import com.ruoyi.common.core.controller.BaseController;
import com.ruoyi.common.core.domain.AjaxResult;
import com.ruoyi.common.core.page.TableDataInfo;
import com.ruoyi.common.core.text.Convert;
import com.ruoyi.common.enums.BusinessType;
import com.ruoyi.common.utils.security.PermissionUtils;
import com.ruoyi.generator.domain.GenTable;
import com.ruoyi.generator.domain.GenTableColumn;
import com.ruoyi.generator.service.IGenTableColumnService;
import com.ruoyi.generator.service.IGenTableService;/*** 代码生成 操作处理* * @author ruoyi*/
@Controller
@RequestMapping("/tool/gen")
public class GenController extends BaseController
{private String prefix = "tool/gen";@Autowiredprivate IGenTableService genTableService;@Autowiredprivate IGenTableColumnService genTableColumnService;@RequiresPermissions("tool:gen:view")@GetMapping()public String gen(){return prefix + "/gen";}

导入表 /too;/gen/improtTable

    /*** 导入表结构*/@RequiresPermissions("tool:gen:list")@GetMapping("/importTable")public String importTable(){return prefix + "/importTable";}/*** 导入表结构（保存）*/@RequiresPermissions("tool:gen:list")@Log(title = "代码生成", businessType = BusinessType.IMPORT)@PostMapping("/importTable")@ResponseBodypublic AjaxResult importTableSave(String tables){String[] tableNames = Convert.toStrArray(tables);// 查询表信息List<GenTable> tableList = genTableService.selectDbTableListByNames(tableNames);String operName = (String) PermissionUtils.getPrincipalProperty("loginName");genTableService.importGenTable(tableList, operName);return AjaxResult.success();}

查询数据表列表 /tool/gen/list

    /*** 查询数据库列表*/@RequiresPermissions("tool:gen:list")@PostMapping("/db/list")@ResponseBodypublic TableDataInfo dataList(GenTable genTable){startPage();List<GenTable> list = genTableService.selectDbTableList(genTable);return getDataTable(list);}

生成代码 /tool/gen/batchGenCode

项目使用了Velocity模板引擎实现Java语言转换成HTML

VelocityInitializer

package com.ruoyi.generator.util;import java.util.Properties;
import org.apache.velocity.app.Velocity;
import com.ruoyi.common.constant.Constants;/*** VelocityEngine工厂* 生成HTML代码* * @author RuoYi*/
public class VelocityInitializer
{/*** 初始化vm方法*/public static void initVelocity(){Properties p = new Properties();try{// 加载classpath目录下的vm文件p.setProperty("file.resource.loader.class", "org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader");// 定义字符集p.setProperty(Velocity.ENCODING_DEFAULT, Constants.UTF8);p.setProperty(Velocity.OUTPUT_ENCODING, Constants.UTF8);// 初始化Velocity引擎，指定配置PropertiesVelocity.init(p);}catch (Exception e){throw new RuntimeException(e);}}
}

service层

package com.ruoyi.generator.service.impl;import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.StringWriter;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.zip.ZipEntry;
import java.util.zip.ZipOutputStream;
import org.apache.commons.io.IOUtils;
import org.apache.velocity.Template;
import org.apache.velocity.VelocityContext;
import org.apache.velocity.app.Velocity;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;
import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import com.ruoyi.common.constant.Constants;
import com.ruoyi.common.constant.GenConstants;
import com.ruoyi.common.core.text.Convert;
import com.ruoyi.common.exception.BusinessException;
import com.ruoyi.common.utils.StringUtils;
import com.ruoyi.generator.domain.GenTable;
import com.ruoyi.generator.domain.GenTableColumn;
import com.ruoyi.generator.mapper.GenTableColumnMapper;
import com.ruoyi.generator.mapper.GenTableMapper;
import com.ruoyi.generator.service.IGenTableService;
import com.ruoyi.generator.util.GenUtils;
import com.ruoyi.generator.util.VelocityInitializer;
import com.ruoyi.generator.util.VelocityUtils;/*** 业务 服务层实现* * @author ruoyi*/
@Service
public class GenTableServiceImpl implements IGenTableService
{private static final Logger log = LoggerFactory.getLogger(GenTableServiceImpl.class);@Autowiredprivate GenTableMapper genTableMapper;@Autowiredprivate GenTableColumnMapper genTableColumnMapper;/*** 查询业务信息* * @param id 业务ID* @return 业务信息*/@Overridepublic GenTable selectGenTableById(Long id){GenTable genTable = genTableMapper.selectGenTableById(id);setTableFromOptions(genTable);return genTable;}/*** 查询业务列表* * @param genTable 业务信息* @return 业务集合*/@Overridepublic List<GenTable> selectGenTableList(GenTable genTable){return genTableMapper.selectGenTableList(genTable);}/*** 查询据库列表* * @param genTable 业务信息* @return 数据库表集合*/@Overridepublic List<GenTable> selectDbTableList(GenTable genTable){return genTableMapper.selectDbTableList(genTable);}/*** 查询据库列表* * @param tableNames 表名称组* @return 数据库表集合*/@Overridepublic List<GenTable> selectDbTableListByNames(String[] tableNames){return genTableMapper.selectDbTableListByNames(tableNames);}/*** 修改业务* * @param genTable 业务信息* @return 结果*/@Override@Transactionalpublic void updateGenTable(GenTable genTable){String options = JSON.toJSONString(genTable.getParams());genTable.setOptions(options);int row = genTableMapper.updateGenTable(genTable);if (row > 0){for (GenTableColumn cenTableColumn : genTable.getColumns()){genTableColumnMapper.updateGenTableColumn(cenTableColumn);}}}/*** 删除业务对象* * @param ids 需要删除的数据ID* @return 结果*/@Override@Transactionalpublic void deleteGenTableByIds(String ids){genTableMapper.deleteGenTableByIds(Convert.toLongArray(ids));genTableColumnMapper.deleteGenTableColumnByIds(Convert.toLongArray(ids));}/*** 导入表结构* * @param tableList 导入表列表* @param operName 操作人员*/@Override@Transactionalpublic void importGenTable(List<GenTable> tableList, String operName){for (GenTable table : tableList){try{String tableName = table.getTableName();GenUtils.initTable(table, operName);int row = genTableMapper.insertGenTable(table);if (row > 0){// 保存列信息List<GenTableColumn> genTableColumns = genTableColumnMapper.selectDbTableColumnsByName(tableName);for (GenTableColumn column : genTableColumns){GenUtils.initColumnField(column, table);genTableColumnMapper.insertGenTableColumn(column);}}}catch (Exception e){log.error("表名 " + table.getTableName() + " 导入失败：", e);}}}/*** 预览代码* * @param tableId 表编号* @return 预览数据列表*/@Overridepublic Map<String, String> previewCode(Long tableId){Map<String, String> dataMap = new LinkedHashMap<>();// 查询表信息GenTable table = genTableMapper.selectGenTableById(tableId);// 查询列信息List<GenTableColumn> columns = table.getColumns();setPkColumn(table, columns);VelocityInitializer.initVelocity();VelocityContext context = VelocityUtils.prepareContext(table);// 获取模板列表List<String> templates = VelocityUtils.getTemplateList(table.getTplCategory());for (String template : templates){// 渲染模板StringWriter sw = new StringWriter();Template tpl = Velocity.getTemplate(template, Constants.UTF8);tpl.merge(context, sw);dataMap.put(template, sw.toString());}return dataMap;}/*** 生成代码* * @param tableName 表名称* @return 数据*/@Overridepublic byte[] generatorCode(String tableName){// 生成输出流ByteArrayOutputStream outputStream = new ByteArrayOutputStream();// 生成打包流ZipOutputStream zip = new ZipOutputStream(outputStream);// 生成代码并打包generatorCode(tableName, zip);// 关闭流，忽略空值和异常IOUtils.closeQuietly(zip);// 将输出流转换为字节数组并返回return outputStream.toByteArray();}/*** 批量生成代码* * @param tableNames 表数组* @return 数据*/@Overridepublic byte[] generatorCode(String[] tableNames){ByteArrayOutputStream outputStream = new ByteArrayOutputStream();ZipOutputStream zip = new ZipOutputStream(outputStream);for (String tableName : tableNames){generatorCode(tableName, zip);}IOUtils.closeQuietly(zip);return outputStream.toByteArray();}/*** 查询表信息并生成代码*/private void generatorCode(String tableName, ZipOutputStream zip){// 查询表信息（表的名字、注释、类的名字、表类型、模块名、业务名……）GenTable table = genTableMapper.selectGenTableByName(tableName);// 查询列信息（学生编号、学生名称、学生年龄……）List<GenTableColumn> columns = table.getColumns();// 设置主键列信息 主键在GenTable中有是否是主键的字段setPkColumn(table, columns);// 设置Velocity模板引擎相关属性VelocityInitializer.initVelocity();// 设置模板变量信息VelocityContext context = VelocityUtils.prepareContext(table);// 获取模板列表List<String> templates = VelocityUtils.getTemplateList(table.getTplCategory());for (String template : templates){// 渲染模板StringWriter sw = new StringWriter();Template tpl = Velocity.getTemplate(template, Constants.UTF8);tpl.merge(context, sw);try{// 添加到zipzip.putNextEntry(new ZipEntry(VelocityUtils.getFileName(template, table)));IOUtils.write(sw.toString(), zip, Constants.UTF8);IOUtils.closeQuietly(sw);zip.flush();zip.closeEntry();}catch (IOException e){log.error("渲染模板失败，表名：" + table.getTableName(), e);}}}/*** 修改保存参数校验* * @param genTable 业务信息*/@Overridepublic void validateEdit(GenTable genTable){if (GenConstants.TPL_TREE.equals(genTable.getTplCategory())){String options = JSON.toJSONString(genTable.getParams());JSONObject paramsObj = JSONObject.parseObject(options);if (StringUtils.isEmpty(paramsObj.getString(GenConstants.TREE_CODE))){throw new BusinessException("树编码字段不能为空");}else if (StringUtils.isEmpty(paramsObj.getString(GenConstants.TREE_PARENT_CODE))){throw new BusinessException("树父编码字段不能为空");}else if (StringUtils.isEmpty(paramsObj.getString(GenConstants.TREE_NAME))){throw new BusinessException("树名称字段不能为空");}}}/*** 设置主键列信息* * @param genTable 业务表信息* @param columns 业务字段列表*/public void setPkColumn(GenTable table, List<GenTableColumn> columns){for (GenTableColumn column : columns){if (column.isPk()){table.setPkColumn(column);break;}}if (StringUtils.isNull(table.getPkColumn())){table.setPkColumn(columns.get(0));}}/*** 设置代码生成其他选项值* * @param genTable 设置后的生成对象*/public void setTableFromOptions(GenTable genTable){JSONObject paramsObj = JSONObject.parseObject(genTable.getOptions());if (StringUtils.isNotNull(paramsObj)){String treeCode = paramsObj.getString(GenConstants.TREE_CODE);String treeParentCode = paramsObj.getString(GenConstants.TREE_PARENT_CODE);String treeName = paramsObj.getString(GenConstants.TREE_NAME);genTable.setTreeCode(treeCode);genTable.setTreeParentCode(treeParentCode);genTable.setTreeName(treeName);}}
}