• Ruoyi框架的代码生成器在前后端分离项目中的应用现状

  • 优化动机：提升生成代码的可读性、维护性和一致性

  • 目标：通过MyBatis-Plus特性优化代码生成模板

controller.java.vm

package ${packageName}.controller;
​
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.enums.BusinessType;
import ${packageName}.domain.req.${ClassName}CreateReq;
import ${packageName}.domain.req.${ClassName}PageReq;
import ${packageName}.domain.req.${ClassName}UpdateReq;
import ${packageName}.domain.resp.${ClassName}Resp;
import ${packageName}.service.I${ClassName}Service;
import jakarta.annotation.Resource;
import jakarta.validation.Valid;
import jakarta.validation.constraints.NotNull;
import org.springframework.security.access.prepost.PreAuthorize;
import org.springframework.web.bind.annotation.*;
​
/**
 * ${functionName}Controller
 * @author ${author}
 */
@RestController
@RequestMapping("/${moduleName}/${businessName}")
public class ${ClassName}Controller extends BaseController {
​
    @Resource
    private I${ClassName}Service ${className}Service;
​
    /**
     * 分页查询${functionName}列表
     */
    @PreAuthorize("@ss.hasPermi('${moduleName}:${businessName}:page')")
    @PostMapping("/page")
    public TableDataInfo page(@RequestBody @Valid ${ClassName}PageReq request) {
        return ${className}Service.page(request);
    }
​
    /**
     * 导出${functionName}列表
     */
    @PreAuthorize("@ss.hasPermi('${moduleName}:${businessName}:export')")
    @Log(title = "${functionName}", businessType = BusinessType.EXPORT)
    @PostMapping("/export")
    public AjaxResult export(@RequestBody @Valid ${ClassName}PageReq request) {
            ${className}Service.export(request);
        return toAjax(true);
    }
​
    /**
     * 获取${functionName}详情
     */
    @PreAuthorize("@ss.hasPermi('${moduleName}:${businessName}:detail')")
    @GetMapping(value = "/detail/{id}")
    public AjaxResult detail(@PathVariable("id") @NotNull Long id) {
        return success(${className}Service.detail(id));
    }
​
    /**
     * 创建${functionName}
     */
    @PreAuthorize("@ss.hasPermi('${moduleName}:${businessName}:create')")
    @Log(title = "${functionName}", businessType = BusinessType.INSERT)
    @PostMapping("/create")
    public AjaxResult create(@RequestBody @Valid ${ClassName}CreateReq request) {
            ${ClassName}Resp result = ${className}Service.create(request);
        return success(result);
    }
​
    /**
     * 修改${functionName}
     */
    @PreAuthorize("@ss.hasPermi('${moduleName}:${businessName}:update')")
    @Log(title = "${functionName}", businessType = BusinessType.UPDATE)
    @PutMapping("/update")
    public AjaxResult update(@RequestBody @Valid ${ClassName}UpdateReq request) {
            ${ClassName}Resp result = ${className}Service.update(request);
        return success(result);
    }
​
    /**
     * 删除${functionName}
     */
    @PreAuthorize("@ss.hasPermi('${moduleName}:${businessName}:delete')")
    @Log(title = "${functionName}", businessType = BusinessType.DELETE)
    @DeleteMapping("/delete/{ids}")
    public AjaxResult delete(@PathVariable @NotNull Long[] ids) {
            ${className}Service.delete(ids);
        return toAjax(true);
    }
}
​

 

updateReq.java.vm

package ${packageName}.domain.req;
​
import jakarta.validation.constraints.NotEmpty;
import jakarta.validation.constraints.NotNull;
import lombok.Data;
​
import java.io.Serial;
import java.io.Serializable;
​
/**
 * ${functionName}修改参数
 */
@Data
public class ${ClassName}UpdateReq implements Serializable {
​
    @Serial
    private static final long serialVersionUID = 1L;
​
    /**
     * 记录ID
     */
    @NotNull(message = "记录ID不能为空")
    private Long id;
​
    #foreach ($column in $columns)
        #if(!$table.isSuperColumn($column.javaField) && $column.isEdit == '1')
            /**
             * $column.columnComment
             */
            #if($column.isRequired == '1' && $column.javaType != 'Long')
            @NotEmpty(message = "$column.columnComment不能为空")
            #elseif($column.isRequired == '1' && $column.javaType == 'Long')
            @NotNull(message = "$column.columnComment不能为空")
            #end
        private $column.javaType $column.javaField;
​
        #end
    #end
    /**
     * 备注
     */
    private String remark;
}
​

 

serviceImpl.java.vm

package ${packageName}.service.impl;
​
import cn.hutool.core.collection.CollUtil;
import cn.hutool.extra.spring.SpringUtil;
import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.ruoyi.common.constant.ErrorCodeConstants;
import com.ruoyi.common.core.domain.model.LoginUser;
import com.ruoyi.common.core.domain.ops.PageResult;
import com.ruoyi.common.enums.FileBizTypeEnum;
import com.ruoyi.common.utils.AssertUtil;
import com.ruoyi.common.utils.SecurityUtils;
import com.ruoyi.common.utils.StringUtils;
import ${packageName}.domain.${ClassName};
import ${packageName}.domain.req.${ClassName}CreateReq;
import ${packageName}.domain.req.${ClassName}PageReq;
import ${packageName}.domain.req.${ClassName}UpdateReq;
import ${packageName}.domain.resp.${ClassName}Resp;
import ${packageName}.mapper.${ClassName}Mapper;
import ${packageName}.service.I${ClassName}Service;
import com.ruoyi.support.convert.${ClassName}Convert;
import com.ruoyi.support.export.ExportService;
import com.ruoyi.support.export.PageExportDTO;
import com.ruoyi.support.export.PageExportExecutor;
import com.ruoyi.support.pager.BasePageNoPager;
import com.ruoyi.support.pager.Pager;
import jakarta.annotation.Resource;
import org.springframework.stereotype.Service;
​
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
​
/**
 * ${functionName}Service业务层处理
 * @author ${author}
 */
@Service
public class ${ClassName}ServiceImpl implements I${ClassName}Service {
​
    @Resource
    private ${ClassName}Mapper ${className}Mapper;
​
    @Resource
    private ExportService exportService;
​
    @Override
    public ${ClassName}Resp detail(Long id) {
        ${ClassName} ${className} = ${className}Mapper.selectById(id);
        return convertToResp(${className});
    }
​
    @Override
    public PageResult<${ClassName}Resp> page(${ClassName}PageReq request) {
        Page<${ClassName}> pageResult = getSelf().basePage(request);
​
        List<${ClassName}Resp> result = pageResult.getRecords()
                .stream()
                .map(this::convertToResp)
                .toList();
        return new PageResult<>(result, pageResult.getTotal());
    }
​
    public Page<${ClassName}> basePage(${ClassName}PageReq request) {
        LambdaQueryWrapper<${ClassName}> queryWrapper = buildQueryWrapper(request);
        return ${className}Mapper.selectPage(request.toPageOps(), queryWrapper);
    }
​
    private LambdaQueryWrapper<${ClassName}> buildQueryWrapper(${ClassName}PageReq request) {
        LambdaQueryWrapper<${ClassName}> queryWrapper = new LambdaQueryWrapper<>(${ClassName}.class);
        #foreach ($column in $columns)
            #if($column.isQuery == '1' && !$table.isSuperColumn($column.javaField))
                #if($column.javaType == 'String')
                    queryWrapper.like(StringUtils.isNotEmpty(request.get${column.javaField.substring(0,1).toUpperCase()}${column.javaField.substring(1)}()),
                        ${ClassName}::get${column.javaField.substring(0,1).toUpperCase()}${column.javaField.substring(1)},
                            request.get${column.javaField.substring(0,1).toUpperCase()}${column.javaField.substring(1)}());
                #else
                    queryWrapper.eq(request.get${column.javaField.substring(0,1).toUpperCase()}${column.javaField.substring(1)}() != null,
                        ${ClassName}::get${column.javaField.substring(0,1).toUpperCase()}${column.javaField.substring(1)},
                            request.get${column.javaField.substring(0,1).toUpperCase()}${column.javaField.substring(1)}());
                #end
            #end
        #end
        queryWrapper.orderByDesc(${ClassName}::getCreateTime)
                   .orderByDesc(${ClassName}::getUpdateTime);
        return queryWrapper;
    }
​
    @Override
    public void export(${ClassName}PageReq request) {
        LoginUser loginUser = SecurityUtils.getLoginUser();
        PageExportDTO<${ClassName}PageReq, ${ClassName}> pageExportDTO =
                PageExportDTO.create(request, loginUser, FileBizTypeEnum.${tableName.toUpperCase()}_EXPORT, new PageExportExecutor<>() {
                    @Override
                    public void checkPageCount(${ClassName}PageReq page) {
                        Long count = ${className}Mapper.selectCount(buildQueryWrapper(page));
                        AssertUtil.isTrue(count > 0L, ErrorCodeConstants.PARAM_VALIDATE_ERROR, "导出数据为空");
                    }
​
                    @Override
                    public Pager<${ClassName}> exportPager(${ClassName}PageReq page) {
                        return new BasePageNoPager<${ClassName}>() {
                            @Override
                            public List<${ClassName}> fetchNext(int limit) {
                                page.setPageNum(getLastPageNo());
                                page.setPageSize(limit);
                                return getSelf().basePage(page).getRecords();
                            }
                        };
                    }
​
                    @Override
                    public List<List<String>> exportOnePage(List<${ClassName}> list) {
                        if (CollUtil.isEmpty(list)) {
                            return Collections.emptyList();
                        }
                        return list.stream().map(${ClassName}::toFields).toList();
                    }
​
                    @Override
                    public List<String> exportFileHeader() {
                        return ${ClassName}.toFieldNames();
                    }
                });
        exportService.export(pageExportDTO);
    }
​
    @Override
    public ${ClassName}Resp create(${ClassName}CreateReq request) {
        ${ClassName} ${className} = convertCreateReqToDomain(request);
        LoginUser loginUser = SecurityUtils.getLoginUser();
        ${className}.fillCreateInfo(loginUser);
            ${className}Mapper.insert(${className});
        return convertToResp(${className});
    }
​
    @Override
    public ${ClassName}Resp update(${ClassName}UpdateReq request) {
        ${ClassName} ${className} = convertUpdateReqToDomain(request);
        LoginUser loginUser = SecurityUtils.getLoginUser();
        ${className}.fillUpdateInfo(loginUser);
            ${className}Mapper.updateById(${className});
        return convertToResp(${className});
    }
​
    @Override
    public void delete(Long[] ids) {
            ${className}Mapper.deleteBatchIds(Arrays.stream(ids).toList());
    }
​
    private ${ClassName} convertCreateReqToDomain(${ClassName}CreateReq request) {
        ${ClassName} ${className} = new ${ClassName}();
        #foreach ($column in $columns)
            #if(!$table.isSuperColumn($column.javaField) && $column.isInsert == '1')
                ${className}.set${column.javaField.substring(0,1).toUpperCase()}${column.javaField.substring(1)}(request.get${column.javaField.substring(0,1).toUpperCase()}${column.javaField.substring(1)}());
            #end
        #end
        ${className}.setRemark(request.getRemark());
        return ${className};
    }
​
    private ${ClassName} convertUpdateReqToDomain(${ClassName}UpdateReq request) {
        ${ClassName} ${className} = new ${ClassName}();
        ${className}.setId(request.getId());
        #foreach ($column in $columns)
            #if(!$table.isSuperColumn($column.javaField) && $column.isEdit == '1')
                ${className}.set${column.javaField.substring(0,1).toUpperCase()}${column.javaField.substring(1)}(request.get${column.javaField.substring(0,1).toUpperCase()}${column.javaField.substring(1)}());
            #end
        #end
        ${className}.setRemark(request.getRemark());
        return ${className};
    }
​
    private ${ClassName}Resp convertToResp(${ClassName} ${className}) {
            ${ClassName}Resp resp = new ${ClassName}Resp();
        if (${className} == null) {
            return resp;
        }
        resp.setId(${className}.getId());
        #foreach ($column in $columns)
            #if(!$table.isSuperColumn($column.javaField) && $column.isList == '1')
                resp.set${column.javaField.substring(0,1).toUpperCase()}${column.javaField.substring(1)}(${className}.get${column.javaField.substring(0,1).toUpperCase()}${column.javaField.substring(1)}());
            #end
        #end
        resp.setRemark(${className}.getRemark());
        resp.setCreateTime(${className}.getCreateTime());
        resp.setUpdateTime(${className}.getUpdateTime());
        return resp;
    }
​
    /**
     * 获得自身的代理对象，解决 AOP 生效问题
     */
    private ${ClassName}ServiceImpl getSelf() {
        return SpringUtil.getBean(getClass());
    }
}
​

 

service.java.vm

package ${packageName}.service;
​
import com.ruoyi.common.core.domain.ops.PageResult;
import com.ruoyi.platform.domain.req.${ClassName}CreateReq;
import com.ruoyi.platform.domain.req.${ClassName}PageReq;
import com.ruoyi.platform.domain.req.${ClassName}UpdateReq;
import com.ruoyi.platform.domain.resp.${ClassName}Resp;
​
/**
 * ${functionName}Service接口
 * @author ${author}
 */
public interface I${ClassName}Service {
    /**
     * 获取${functionName}详情
     * @param id id
     * @return 详情
     */
        ${ClassName}Resp detail(Long id);
​
    /**
     * 分页查询${functionName}列表
     * @param request 请求参数
     * @return 分页列表
     */
    PageResult<${ClassName}Resp> page(${ClassName}PageReq request);
​
    /**
     * 导出${functionName}列表
     * @param request 导出请求参数
     */
    void export(${ClassName}PageReq request);
​
    /**
     * 创建${functionName}
     * @param request 管理
     * @return 创建的管理
     */
        ${ClassName}Resp create(${ClassName}CreateReq request);
​
    /**
     * 修改${functionName}
     * @param request 管理
     * @return 修改的管理
     */
        ${ClassName}Resp update(${ClassName}UpdateReq request);
​
    /**
     * 批量删除${functionName}
     * @param ids 需要删除的ID
     */
    void delete(Long[] ids);
}
​

 

resp.java.vm

package ${packageName}.domain.resp;
​
import lombok.Data;
​
import java.io.Serial;
import java.io.Serializable;
import java.util.Date;
​
/**
 * ${functionName}响应参数
 */
@Data
public class ${ClassName}Resp implements Serializable {
​
    @Serial
    private static final long serialVersionUID = 1L;
​
    /**
     * 记录ID
     */
    private Long id;
​
    #foreach ($column in $columns)
        #if(!$table.isSuperColumn($column.javaField) && $column.isList == '1')
            /**
             * $column.columnComment
             */
            private $column.javaType $column.javaField;
​
        #end
    #end
    /**
     * 备注
     */
    private String remark;
​
    /**
     * 创建时间
     */
    private Date createTime;
​
    /**
     * 更新时间
     */
    private Date updateTime;
}
​

 

pageReq.java.vm

package ${packageName}.domain.req;
​
import com.baomidou.mybatisplus.core.metadata.OrderItem;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.ruoyi.common.core.domain.BasePageReqVO;
import ${packageName}.domain.${ClassName};
import lombok.Data;
import lombok.EqualsAndHashCode;
import org.apache.commons.lang3.StringUtils;
​
import java.io.Serial;
​
/**
 * ${functionName}分页请求参数
 * @author ${author}
 */
@EqualsAndHashCode(callSuper = true)
@Data
public class ${ClassName}PageReq extends BasePageReqVO<${ClassName}> {
​
    @Serial
    private static final long serialVersionUID = 1L;
​
    #foreach ($column in $columns)
        #if($column.isQuery == '1' && !$table.isSuperColumn($column.javaField))
            /**
             * $column.columnComment
             */
            private $column.javaType $column.javaField;
​
        #end
    #end
​
    @Override
    public Page<${ClassName}> toPageOps() {
        Page<${ClassName}> page = new Page<>(this.getPageNum(), this.getPageSize());
        // 添加排序
        if (StringUtils.isNotEmpty(this.getOrderByColumn())) {
            String orderBy = this.getOrderByColumn();
            if ("asc".equalsIgnoreCase(this.getIsAsc())) {
                page.addOrder(OrderItem.asc(orderBy));
            } else {
                page.addOrder(OrderItem.desc(orderBy));
            }
        }
        return page;
    }
}

 

mapper.java.vm

package ${packageName}.mapper;
​
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import ${packageName}.domain.${ClassName};
import org.apache.ibatis.annotations.Mapper;
​
/**
 * ${functionName}Mapper接口
 */
@Mapper
public interface ${ClassName}Mapper extends BaseMapper<${ClassName}> {
}
​

 

domain.java.vm

package ${packageName}.domain;
​
import com.baomidou.mybatisplus.annotation.TableName;
import com.ruoyi.common.core.domain.BaseEntity;
import lombok.Data;
import lombok.EqualsAndHashCode;
​
import java.io.Serial;
import java.util.List;
​
/**
 * ${functionName}对象 ${tableName}
 * @author ${author}
 */
@EqualsAndHashCode(callSuper = true)
@Data
@TableName("${tableName}")
public class ${ClassName} extends BaseEntity {
​
    @Serial
    private static final long serialVersionUID = 1L;
​
    #foreach ($column in $columns)
        #if(!$table.isSuperColumn($column.javaField))
            /**
             * $column.columnComment
             */
            private $column.javaType $column.javaField;
​
        #end
    #end
​
    /**
     * 获取字段名称列表（用于导出）
     */
    public static List<String> toFieldNames() {
        return List.of(
            #set($count=0)
            #foreach ($column in $columns)
                #if($column.isList == '1' && !$table.isSuperColumn($column.javaField))
                    #if($count > 0),
                    #end
                        "${column.columnComment}"##
                    #set($count=$count+1)
                #end
            #end
        );
    }
​
    /**
     * 获取字段值列表（用于导出）
     */
    public List<String> toFields() {
        return List.of(
            #set($count=0)
            #foreach ($column in $columns)
                #if($column.isList == '1' && !$table.isSuperColumn($column.javaField))
                    #if($count > 0),
                    #end
                        this.$column.javaField##
                    #set($count=$count+1)
                #end
            #end
        );
    }
}
​

 

createReq.java.vm

package ${packageName}.domain.req;

import jakarta.validation.constraints.NotEmpty;
import jakarta.validation.constraints.NotNull;
import lombok.Data;

import java.io.Serial;
import java.io.Serializable;

/**
 * ${functionName}创建参数
 */
@Data
public class ${ClassName}CreateReq implements Serializable {

    @Serial
    private static final long serialVersionUID = 1L;

    #foreach ($column in $columns)
        #if(!$table.isSuperColumn($column.javaField) && $column.isInsert == '1')
            /**
             * $column.columnComment
             */
            #if($column.isRequired == '1' && $column.javaType != 'Long')
            @NotEmpty(message = "$column.columnComment不能为空")
            #elseif($column.isRequired == '1' && $column.javaType == 'Long')
            @NotNull(message = "$column.columnComment不能为空")
            #end
        private $column.javaType $column.javaField;

        #end
    #end
    /**
     * 备注
     */
    private String remark;
}

sql.vm

-- 菜单 SQL
insert into sys_menu (menu_name, parent_id, order_num, path, component, is_frame, is_cache, menu_type, visible, status, perms, icon, create_by, create_time, update_by, update_time, remark)
values('${functionName}', '${parentMenuId}', '1', '${businessName}', '${moduleName}/${businessName}/index', 1, 0, 'C', '0', '0', '${moduleName}:${businessName}:list', '#', 'admin', sysdate(), '', null, '${functionName}菜单');

-- 按钮父菜单ID
SELECT @parentId := LAST_INSERT_ID();

-- 按钮 SQL
insert into sys_menu (menu_name, parent_id, order_num, path, component, is_frame, is_cache, menu_type, visible, status, perms, icon, create_by, create_time, update_by, update_time, remark)
values('${functionName}分页查询', @parentId, '1',  '#', '', 1, 0, 'F', '0', '0', '${moduleName}:${businessName}:page',        '#', 'admin', sysdate(), '', null, '');

insert into sys_menu (menu_name, parent_id, order_num, path, component, is_frame, is_cache, menu_type, visible, status, perms, icon, create_by, create_time, update_by, update_time, remark)
values('${functionName}导出', @parentId, '2',  '#', '', 1, 0, 'F', '0', '0', '${moduleName}:${businessName}:export',          '#', 'admin', sysdate(), '', null, '');

insert into sys_menu (menu_name, parent_id, order_num, path, component, is_frame, is_cache, menu_type, visible, status, perms, icon, create_by, create_time, update_by, update_time, remark)
values('${functionName}详情', @parentId, '3',  '#', '', 1, 0, 'F', '0', '0', '${moduleName}:${businessName}:detail',         '#', 'admin', sysdate(), '', null, '');

insert into sys_menu (menu_name, parent_id, order_num, path, component, is_frame, is_cache, menu_type, visible, status, perms, icon, create_by, create_time, update_by, update_time, remark)
values('${functionName}创建', @parentId, '4',  '#', '', 1, 0, 'F', '0', '0', '${moduleName}:${businessName}:create',       '#', 'admin', sysdate(), '', null, '');

insert into sys_menu (menu_name, parent_id, order_num, path, component, is_frame, is_cache, menu_type, visible, status, perms, icon, create_by, create_time, update_by, update_time, remark)
values('${functionName}修改', @parentId, '5',  '#', '', 1, 0, 'F', '0', '0', '${moduleName}:${businessName}:update',       '#', 'admin', sysdate(), '', null, '');

insert into sys_menu (menu_name, parent_id, order_num, path, component, is_frame, is_cache, menu_type, visible, status, perms, icon, create_by, create_time, update_by, update_time, remark)
values('${functionName}删除', @parentId, '6',  '#', '', 1, 0, 'F', '0', '0', '${moduleName}:${businessName}:delete',       '#', 'admin', sysdate(), '', null, '');

新增template.yml

# 新模板配置
templates:
  - name: "mybatisplus"
    desc: "MyBatisPlus风格模板"
    files:
      - "vm/java/controller.java.vm"
      - "vm/java/domain.java.vm"
      - "vm/java/createReq.java.vm"
      - "vm/java/pageReq.java.vm"
      - "vm/java/updateReq.java.vm"
      - "vm/java/resp.java.vm"
      - "vm/java/mapper.java.vm"
      - "vm/java/service.java.vm"
      - "vm/java/serviceImpl.java.vm"
      - "vm/sql/sql.vm"

修改VelocityUtils

package com.ruoyi.generator.util;

import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Set;

import org.apache.velocity.VelocityContext;
import com.alibaba.fastjson2.JSON;
import com.alibaba.fastjson2.JSONObject;
import com.ruoyi.common.constant.GenConstants;
import com.ruoyi.common.utils.DateUtils;
import com.ruoyi.common.utils.StringUtils;
import com.ruoyi.generator.domain.GenTable;
import com.ruoyi.generator.domain.GenTableColumn;

/**
 * 模板处理工具类
 * @author ruoyi
 */
public class VelocityUtils {
    /**
     * 项目空间路径
     */
    private static final String PROJECT_PATH = "main/java";

    /**
     * mybatis空间路径
     */
    private static final String MYBATIS_PATH = "main/resources/mapper";

    /**
     * 默认上级菜单，系统工具
     */
    private static final String DEFAULT_PARENT_MENU_ID = "3";

    /**
     * 设置模板变量信息
     * @return 模板列表
     */
    public static VelocityContext prepareContext(GenTable genTable) {
        String moduleName = genTable.getModuleName();
        String businessName = genTable.getBusinessName();
        String packageName = genTable.getPackageName();
        String tplCategory = genTable.getTplCategory();
        String functionName = genTable.getFunctionName();

        VelocityContext velocityContext = new VelocityContext();
        velocityContext.put("tplCategory", genTable.getTplCategory());
        velocityContext.put("tableName", genTable.getTableName());
        velocityContext.put("functionName", StringUtils.isNotEmpty(functionName) ? functionName : "【请填写功能名称】");
        velocityContext.put("ClassName", genTable.getClassName());
        velocityContext.put("className", StringUtils.uncapitalize(genTable.getClassName()));
        velocityContext.put("moduleName", genTable.getModuleName());
        velocityContext.put("BusinessName", StringUtils.capitalize(genTable.getBusinessName()));
        velocityContext.put("businessName", genTable.getBusinessName());
        velocityContext.put("basePackage", getPackagePrefix(packageName));
        velocityContext.put("packageName", packageName);
        velocityContext.put("author", genTable.getFunctionAuthor());
        velocityContext.put("datetime", DateUtils.getDate());
        velocityContext.put("pkColumn", genTable.getPkColumn());
        velocityContext.put("importList", getImportList(genTable));
        velocityContext.put("permissionPrefix", getPermissionPrefix(moduleName, businessName));
        velocityContext.put("columns", genTable.getColumns());
        velocityContext.put("table", genTable);
        velocityContext.put("dicts", getDicts(genTable));
        setMenuVelocityContext(velocityContext, genTable);
        if (GenConstants.TPL_TREE.equals(tplCategory)) {
            setTreeVelocityContext(velocityContext, genTable);
        }
        if (GenConstants.TPL_SUB.equals(tplCategory)) {
            setSubVelocityContext(velocityContext, genTable);
        }
        return velocityContext;
    }

    public static void setMenuVelocityContext(VelocityContext context, GenTable genTable) {
        String options = genTable.getOptions();
        JSONObject paramsObj = JSON.parseObject(options);
        String parentMenuId = getParentMenuId(paramsObj);
        context.put("parentMenuId", parentMenuId);
    }

    public static void setTreeVelocityContext(VelocityContext context, GenTable genTable) {
        String options = genTable.getOptions();
        JSONObject paramsObj = JSON.parseObject(options);
        String treeCode = getTreecode(paramsObj);
        String treeParentCode = getTreeParentCode(paramsObj);
        String treeName = getTreeName(paramsObj);

        context.put("treeCode", treeCode);
        context.put("treeParentCode", treeParentCode);
        context.put("treeName", treeName);
        context.put("expandColumn", getExpandColumn(genTable));
        if (paramsObj.containsKey(GenConstants.TREE_PARENT_CODE)) {
            context.put("tree_parent_code", paramsObj.getString(GenConstants.TREE_PARENT_CODE));
        }
        if (paramsObj.containsKey(GenConstants.TREE_NAME)) {
            context.put("tree_name", paramsObj.getString(GenConstants.TREE_NAME));
        }
    }

    public static void setSubVelocityContext(VelocityContext context, GenTable genTable) {
        GenTable subTable = genTable.getSubTable();
        String subTableName = genTable.getSubTableName();
        String subTableFkName = genTable.getSubTableFkName();
        String subClassName = genTable.getSubTable().getClassName();
        String subTableFkClassName = StringUtils.convertToCamelCase(subTableFkName);

        context.put("subTable", subTable);
        context.put("subTableName", subTableName);
        context.put("subTableFkName", subTableFkName);
        context.put("subTableFkClassName", subTableFkClassName);
        context.put("subTableFkclassName", StringUtils.uncapitalize(subTableFkClassName));
        context.put("subClassName", subClassName);
        context.put("subclassName", StringUtils.uncapitalize(subClassName));
        context.put("subImportList", getImportList(genTable.getSubTable()));
    }

    /**
     * 获取模板信息
     * @param tplCategory 生成的模板
     * @param tplWebType  前端类型
     * @return 模板列表
     */
    public static List<String> getTemplateList(String tplCategory, String tplWebType) {
        String useWebType = "vm/vue";
        if ("element-plus".equals(tplWebType)) {
            useWebType = "vm/vue/v3";
        }
        List<String> templates = new ArrayList<>();
        templates.add("vm/java/domain.java.vm");
        templates.add("vm/java/createReq.java.vm");
        templates.add("vm/java/pageReq.java.vm");
        templates.add("vm/java/updateReq.java.vm");
        templates.add("vm/java/resp.java.vm");
        templates.add("vm/java/mapper.java.vm");
        templates.add("vm/java/service.java.vm");
        templates.add("vm/java/serviceImpl.java.vm");
        templates.add("vm/java/controller.java.vm");
        templates.add("vm/sql/sql.vm");
        templates.add("vm/js/api.js.vm");
        if (GenConstants.TPL_CRUD.equals(tplCategory)) {
            templates.add(useWebType + "/index.vue.vm");
        } else if (GenConstants.TPL_TREE.equals(tplCategory)) {
            templates.add(useWebType + "/index-tree.vue.vm");
        } else if (GenConstants.TPL_SUB.equals(tplCategory)) {
            templates.add(useWebType + "/index.vue.vm");
            templates.add("vm/java/sub-domain.java.vm");
        }
        return templates;
    }

    /**
     * 获取文件名
     */
    public static String getFileName(String template, GenTable genTable) {
        // 文件名称
        String fileName = "";
        // 包路径
        String packageName = genTable.getPackageName();
        // 模块名
        String moduleName = genTable.getModuleName();
        // 大写类名
        String className = genTable.getClassName();
        // 业务名称
        String businessName = genTable.getBusinessName();

        String javaPath = PROJECT_PATH + "/" + StringUtils.replace(packageName, ".", "/");
        String vuePath = "vue";

        if (template.contains("domain.java.vm")) {
            fileName = StringUtils.format("{}/domain/{}.java", javaPath, className);
        }
        else if (template.contains("createReq.java.vm")) {
            fileName = StringUtils.format("{}/domain/req/{}CreateReq.java", javaPath, className);
        }
        else if (template.contains("pageReq.java.vm")) {
            fileName = StringUtils.format("{}/domain/req/{}PageReq.java", javaPath, className);
        }
        else if (template.contains("updateReq.java.vm")) {
            fileName = StringUtils.format("{}/domain/req/{}UpdateReq.java", javaPath, className);
        }
        else if (template.contains("resp.java.vm")) {
            fileName = StringUtils.format("{}/domain/resp/{}Resp.java", javaPath, className);
        }
        else if (template.contains("mapper.java.vm")) {
            fileName = StringUtils.format("{}/mapper/{}Mapper.java", javaPath, className);
        }
        else if (template.contains("service.java.vm")) {
            fileName = StringUtils.format("{}/service/I{}Service.java", javaPath, className);
        }
        else if (template.contains("serviceImpl.java.vm")) {
            fileName = StringUtils.format("{}/service/impl/{}ServiceImpl.java", javaPath, className);
        }
        else if (template.contains("controller.java.vm")) {
            fileName = StringUtils.format("{}/controller/{}Controller.java", javaPath, className);
        }
        else if (template.contains("sql.vm")) {
            fileName = businessName + "Menu.sql";
        } else if (template.contains("api.js.vm")) {
            fileName = StringUtils.format("{}/api/{}/{}.js", vuePath, moduleName, businessName);
        } else if (template.contains("index.vue.vm")) {
            fileName = StringUtils.format("{}/views/{}/{}/index.vue", vuePath, moduleName, businessName);
        } else if (template.contains("index-tree.vue.vm")) {
            fileName = StringUtils.format("{}/views/{}/{}/index.vue", vuePath, moduleName, businessName);
        }
        return fileName;
    }

    /**
     * 获取包前缀
     * @param packageName 包名称
     * @return 包前缀名称
     */
    public static String getPackagePrefix(String packageName) {
        int lastIndex = packageName.lastIndexOf(".");
        return StringUtils.substring(packageName, 0, lastIndex);
    }

    /**
     * 根据列类型获取导入包
     * @param genTable 业务表对象
     * @return 返回需要导入的包列表
     */
    public static HashSet<String> getImportList(GenTable genTable) {
        List<GenTableColumn> columns = genTable.getColumns();
        GenTable subGenTable = genTable.getSubTable();
        HashSet<String> importList = new HashSet<String>();
        if (StringUtils.isNotNull(subGenTable)) {
            importList.add("java.util.List");
        }
        for (GenTableColumn column : columns) {
            if (!column.isSuperColumn() && GenConstants.TYPE_DATE.equals(column.getJavaType())) {
                importList.add("java.util.Date");
                importList.add("com.fasterxml.jackson.annotation.JsonFormat");
            } else if (!column.isSuperColumn() && GenConstants.TYPE_BIGDECIMAL.equals(column.getJavaType())) {
                importList.add("java.math.BigDecimal");
            }
        }
        return importList;
    }

    /**
     * 根据列类型获取字典组
     * @param genTable 业务表对象
     * @return 返回字典组
     */
    public static String getDicts(GenTable genTable) {
        List<GenTableColumn> columns = genTable.getColumns();
        Set<String> dicts = new HashSet<String>();
        addDicts(dicts, columns);
        if (StringUtils.isNotNull(genTable.getSubTable())) {
            List<GenTableColumn> subColumns = genTable.getSubTable().getColumns();
            addDicts(dicts, subColumns);
        }
        return StringUtils.join(dicts, ", ");
    }

    /**
     * 添加字典列表
     * @param dicts   字典列表
     * @param columns 列集合
     */
    public static void addDicts(Set<String> dicts, List<GenTableColumn> columns) {
        for (GenTableColumn column : columns) {
            if (!column.isSuperColumn() && StringUtils.isNotEmpty(column.getDictType()) && StringUtils.equalsAny(
                    column.getHtmlType(),
                    new String[]{GenConstants.HTML_SELECT, GenConstants.HTML_RADIO, GenConstants.HTML_CHECKBOX})) {
                dicts.add("'" + column.getDictType() + "'");
            }
        }
    }

    /**
     * 获取权限前缀
     * @param moduleName   模块名称
     * @param businessName 业务名称
     * @return 返回权限前缀
     */
    public static String getPermissionPrefix(String moduleName, String businessName) {
        return StringUtils.format("{}:{}", moduleName, businessName);
    }

    /**
     * 获取上级菜单ID字段
     * @param paramsObj 生成其他选项
     * @return 上级菜单ID字段
     */
    public static String getParentMenuId(JSONObject paramsObj) {
        if (StringUtils.isNotEmpty(paramsObj) && paramsObj.containsKey(GenConstants.PARENT_MENU_ID)
                && StringUtils.isNotEmpty(paramsObj.getString(GenConstants.PARENT_MENU_ID))) {
            return paramsObj.getString(GenConstants.PARENT_MENU_ID);
        }
        return DEFAULT_PARENT_MENU_ID;
    }

    /**
     * 获取树编码
     * @param paramsObj 生成其他选项
     * @return 树编码
     */
    public static String getTreecode(JSONObject paramsObj) {
        if (paramsObj.containsKey(GenConstants.TREE_CODE)) {
            return StringUtils.toCamelCase(paramsObj.getString(GenConstants.TREE_CODE));
        }
        return StringUtils.EMPTY;
    }

    /**
     * 获取树父编码
     * @param paramsObj 生成其他选项
     * @return 树父编码
     */
    public static String getTreeParentCode(JSONObject paramsObj) {
        if (paramsObj.containsKey(GenConstants.TREE_PARENT_CODE)) {
            return StringUtils.toCamelCase(paramsObj.getString(GenConstants.TREE_PARENT_CODE));
        }
        return StringUtils.EMPTY;
    }

    /**
     * 获取树名称
     * @param paramsObj 生成其他选项
     * @return 树名称
     */
    public static String getTreeName(JSONObject paramsObj) {
        if (paramsObj.containsKey(GenConstants.TREE_NAME)) {
            return StringUtils.toCamelCase(paramsObj.getString(GenConstants.TREE_NAME));
        }
        return StringUtils.EMPTY;
    }

    /**
     * 获取需要在哪一列上面显示展开按钮
     * @param genTable 业务表对象
     * @return 展开按钮列序号
     */
    public static int getExpandColumn(GenTable genTable) {
        String options = genTable.getOptions();
        JSONObject paramsObj = JSON.parseObject(options);
        String treeName = paramsObj.getString(GenConstants.TREE_NAME);
        int num = 0;
        for (GenTableColumn column : genTable.getColumns()) {
            if (column.isList()) {
                num++;
                String columnName = column.getColumnName();
                if (columnName.equals(treeName)) {
                    break;
                }
            }
        }
        return num;
    }
}

 

# mybatis # java # spring boot
Logo
2048 AI社区

有“AI”的1024 = 2048，欢迎大家加入2048 AI社区

更多推荐

cover

亲测好用8个AI论文工具，本科生轻松搞定毕业论文！

avatar 2048 AI社区

告别熬夜做 PPT！这 8 个 AI 工具，输入文字自动生成排版 + 配图

制作 PPT 是许多人学习与工作中绕不开的任务 —— 无论是大学生筹备答辩演示，还是职场人打磨工作汇报，不少人都会陷入相似的困境：面对空白页面无从下手，耗费大量时间在模板筛选、排版调整与数据可视化上，最终的成品却往往难以达到专业水准。随着 AI 技术的发展，AI 辅助制作 PPT 的工具逐渐成熟，能够有效帮助使用者从繁琐的重复性工作中解脱，将更多精力聚焦于内容本身的打磨。

avatar 2048 AI社区
cover

5 款 AI 写论文哪个好？实测揭秘：这款「学术全能王」竟无短板！

avatar 2048 AI社区