若依代码生成器的使用

已于 2023-03-30 21:24:26 修改
阅读量7.2k 收藏 65
点赞数 14
分类专栏： 软件工程 文章标签： 软件工程 Powered by 金山文档
于 2023-03-09 10:58:36 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_61935738/article/details/129418725
版权

一、代码生成器的使用

1.新建maven模块

原则上，我们的业务代码和若依系统本身的系统代码是要做隔离的，一方面是易于之后随着若依系统升级而升级，另一方面则是纯粹的合理性考虑。

这里新建一个ruoyi-business模块作为业务代码模块，新建完ruoyi-business模块之后添加ruoyi-framework依赖，pom文件如下所示

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>ruoyi</artifactId>
        <groupId>com.ruoyi</groupId>
        <version>3.4.0</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.kdyzm</groupId>
    <artifactId>ruoyi-business</artifactId>
    <version>1.0.0-SNAPSHOT</version>
    <dependencies>
        <!-- 核心模块-->
        <dependency>
            <groupId>com.ruoyi</groupId>
            <artifactId>ruoyi-framework</artifactId>
        </dependency>
    </dependencies>
</project>

之后在ruoyi-admin添加ruoyi-business模块的依赖

<dependency>
    <groupId>com.kdyzm</groupId>
    <artifactId>ruoyi-business</artifactId>
    <version>1.0.0-SNAPSHOT</version>
</dependency>

2.准备代码生成器配置

ruoyi-vue系统中代码生成器相代码都在ruoyi-generator模块中，代码生成的配置在resources/generator.yml文件中，由于要在新的模块ruoyi-business中做开发，要有个新包名，包名取作com.kdyzm.business，所以generator.yml配置文件内容如下：

# 代码生成
gen: 
  # 作者
  author: wusihao
  # 默认生成包路径 system 需改成自己的模块名称 如 system monitor tool
  packageName: com.kdyzm.business
  # 自动去除表前缀，默认是false
  autoRemovePre: false
  # 表前缀（生成类名不会包含表前缀，多个用逗号分隔）
  tablePrefix: sys_

另外，这里要使用自定义包名com.kdyzm.business，所以若依系统中mybatis也要做相应的修改

  • 修改mybatis别名配置，增加对com.kdyzm包名的识别

# MyBatis配置
mybatis:
    # 搜索指定包别名
    typeAliasesPackage: com.ruoyi.**.domain,com.kdyzm.**.domain

  • 修改mybatis的mapper扫描包路径

修改com.ruoyi.framework.config.ApplicationConfig类的MapperScan注解，增加对com.kdyzm包的扫描

@MapperScan({"com.ruoyi.**.mapper","com.kdyzm.**.mapper"})
public class ApplicationConfig{
    ...
}

最后，在ruoyi-admin新增一个Config类，扫描com.kdyzm包，以将ruoyi-business模块中的所有组件纳入spring管理。

package com.ruoyi.config;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;

/**
 * @author kdyzm
 */
@Configuration
@ComponentScan(basePackages = "com.kdyzm")
public class Config {
}

3.准备表

这里新建一张商品表作为示例，注意，这里的字段和表都要加上注释

CREATETABLE `goods` (
  `id` int(11) NOTNULL AUTO_INCREMENT COMMENT '主键',
  `GOODS_NAME` varchar(255) DEFAULTNULL COMMENT '商品名字',
  `put_way_flag` tinyint(1) DEFAULTNULL COMMENT '商品是否上架，0：下架，1：上架',
  `create_time` datetime DEFAULTNULL COMMENT '创建时间',
  `create_by` varchar(64) DEFAULTNULL COMMENT '创建人',
  `update_time` datetime DEFAULTNULL COMMENT '更新时间',
  `update_by` varchar(64) DEFAULTNULL COMMENT '更新人',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='商品表'

4.生成代码

进入系统工具-代码生成页面，点击导入按钮，找到goods表并导入，如下图所示

然后点击生成代码按钮

之后，就可以得到一个ruoyi.zip压缩文件，压缩文件中包含生成的前后端代码以及sql语句文件，生成的代码目录结构如下所示

├── goodsMenu.sql
├── main
│   ├── java
│   │   └── com
│   │       └── kdyzm
│   │           └── business
│   │               ├── controller
│   │               │   └── GoodsController.java
│   │               ├── domain
│   │               │   └── Goods.java
│   │               ├── mapper
│   │               │   └── GoodsMapper.java
│   │               └── service
│   │                   ├── IGoodsService.java
│   │                   └── impl
│   │                       └── GoodsServiceImpl.java
│   └── resources
│       └── mapper
│           └── business
│               └── GoodsMapper.xml
└── vue
    ├── api
    │   └── business
    │       └── goods.js
    └── views
        └── business
            └── goods
                └── index.vue

二、将生成的代码应用到项目

1.后端代码

将生成代码中的main目录直接拷贝到ruoyi-business模块下的src目录，可以看到生成的代码是典型的三层架构，从controller到mapper都已经帮我们生成好了。

2.前端代码

前端代码对应着生成目录中的vue目录，这里将vue/api目录中的内容拷贝到ruoyi-ui/src/api目录中，将vue/views中的内容拷贝到ruoyi-ui/src/views目录,操作上，直接将生成的api和views目录拷贝到src目录即可。

3.sql代码

生成的sql代码是创建菜单和按钮权限使用的，直接在ruoyi数据库下执行 goodsMenu.sql 文件中的内容即可。

-- 菜单 SQLinsertinto 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('商品', '3', '1', 'goods', 'business/goods/index', 1, 0, 'C', '0', '0', 'business:goods:list', '#', 'admin', sysdate(), '', null, '商品菜单');

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

-- 按钮 SQLinsertinto 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('商品查询', @parentId, '1',  '#', '', 1, 0, 'F', '0', '0', 'business:goods:query',        '#', 'admin', sysdate(), '', null, '');

insertinto 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('商品新增', @parentId, '2',  '#', '', 1, 0, 'F', '0', '0', 'business:goods:add',          '#', 'admin', sysdate(), '', null, '');

insertinto 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('商品修改', @parentId, '3',  '#', '', 1, 0, 'F', '0', '0', 'business:goods:edit',         '#', 'admin', sysdate(), '', null, '');

insertinto 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('商品删除', @parentId, '4',  '#', '', 1, 0, 'F', '0', '0', 'business:goods:remove',       '#', 'admin', sysdate(), '', null, '');

insertinto 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('商品导出', @parentId, '5',  '#', '', 1, 0, 'F', '0', '0', 'business:goods:export',       '#', 'admin', sysdate(), '', null, '');

三、测试

重新运行前后端代码，打开系统工具菜单（为何在这里？这是若依vue的bug，已经提到gitee，bug链接： I3915P ）的商品菜单

可以看到，前后端代码只是复制粘贴，后端接口、前端菜单、权限等等一切都已经被代码生成器帮我们做完了，可以说代码生成器极大的简化了我们的开发。

四、代码生成器高级使用

在三的测试过程中，我们发现，商品是否上架这个字段对应的前端表单是个文本输入框，但是实际上这里应该是个下拉列表框或者单选按钮才对，因为它只有两个值：0或者1，ruoyi-vue代码生成器实际上是支持这种操作的。之前生成代码的时候导入表之后直接点击了下载按钮生成了代码，实际上跳过了一个重要的步骤，那就是编辑代码生成选项。

点击编辑按钮之后，跳转修改生成配置页面。

在这个页面中，可以修改字段在前端的显示类型以及字典类型，比如，要想“商品是否上架”在前端展示为单选框，就可以修改显示类型为“单选框”，字典类型设置为“业务是否（需要新增数据字典，0表示下架，1表示上架）”。

提交之后重新生成的代码样式：

可以看到，商品是否字段变成了下拉列表和单选框的样式。

另外，若依代码生成器支持三种数据格式模板的代码生成：单表、树表、主子表，这里默认使用的是单表模板，也是最常使用的模板。

五、代码生成器原理

1.Velocity

Velocity是一个基于Java的模板引擎，其提供了一个Context容器，在java代码里面我们可以往容器中存值，然后在vm文件中使用特定的语法获取，这是velocity基本的用法，其与jsp、freemarker并称为三大视图展现技术。作为一个模块引擎，除了作为前后端分离的MVC展现层，Velocity还有一些其他用途，比如源代码生成。

在若依Vue系统中，正是使用了Velocity技术实现的源代码生成。大体上，源代码生成只需三步走：

  1. 创建模板文件

  1. 准备上下文（变量值）

  1. 替换模板文件中的变量

三步走完之后源代码就生成了，说起来是很简单的，但是实际上做起来会比较麻烦，特别是第一步创建模板文件是最复杂的，以下为index.vue模板文件部分源代码：

#foreach($column in $columns)
#if($column.query)
#set($dictType=$column.dictType)
#set($AttrName=$column.javaField.substring(0,1).toUpperCase() + ${column.javaField.substring(1)})
#set($parentheseIndex=$column.columnComment.indexOf("（"))
#if($parentheseIndex != -1)
#set($comment=$column.columnComment.substring(0, $parentheseIndex))
#else
#set($comment=$column.columnComment)
#end
#if($column.htmlType == "input")
...

可以看到，该vue模板文件中充斥着大量Velocity的if-else语法，嵌套在一起更是显得无比复杂。

总之，整体上来看，java代码的模板比较简单，vue和mybatis mapper的模板文件比较复杂。

2.information_schema 数据库

mysql数据库中有一个information_schema数据库，它是mysql的系统数据库之一，它里面存储着两个表TABLES以及COLUMNS，这两个表分别存储着所有的表信息以及所有表中的列信息，代码生成器正是以两张表的信息为核心实现的。

3.ruoyi-vue代码生成器源码分析

ruoyi-vue代码生成器相关代码均位于ruoyi-generator模块中，根据之前的实际操作体验上来看，最简单的情况，前端页面只需要两步即可完成代码生成

  • 导入表结构

  • 生成代码

实际上这两步对应着后端的两个接口：com.ruoyi.generator.controller.GenController#importTableSave 和 com.ruoyi.generator.controller.GenController#batchGenCode ，生成源码的步骤就要从这两步下手。

首先看com.ruoyi.generator.controller.GenController#importTableSave 接口，它做了以下这些事情

  1. 从information_schema数据库的tables表中查询目标表的表明、标注释、创建时间和更新时间，但是忽略掉定时任务的表和已经生成过的表。

  1. 初始化表数据并将数据插入ruoyi数据库的gen_table表

  1. 从information_schema数据库的columns表中查询目标表的列信息，包含字段名、字段注释、字段类型、是否允许为null等详细信息

  1. 初始化列信息并将数据插入ruoyi数据库的gen_table_column表

接下来看下 com.ruoyi.generator.controller.GenController#batchGenCode 接口，它做了以下这些事情

  1. 从ruoyi数据库的gen_table、gen_table_column表查询出生成代码需要的表和列信息。

  1. 初始化Velocity

  1. 准备Velocity上下文信息（变量值信息）

  1. 读取模板、渲染模板，然后将渲染后的模板内容添加进如压缩流，之后前端就可以下载zip压缩文件了。

完毕。

六、扩展篇：封装独立版ruoyi-vue代码生成器

1.为什么要做这个

作为一个后端开发，我最经常做的事情不是搞啥系统架构，而是最简单的CRUD。。。若是能有一个代码一键生成工具自动根据已经创建的表信息生成CRUD后端代码，那岂不是能节省老鼻子功夫了——若依系统已经实现了这个代码生成器的工具，但是它依赖于前端页面，必须有权限访问“系统工具-代码生成”菜单才行，而这在企业中像我这种普通研发往往是是没有权限访问的。但是我有权限访问表，查看表结构。作为一个有追求的开发，既不肯开口问别人要权限，还想要实现代码生成器，该怎么做？

自己搞一个呗。

在这里封装的代码生成器不考虑前端页面调整功能，其实现的功能更加注重于后端代码，其作用和“系统工具-代码生成”页面中最简单的生成代码的两步（导入表和下载代码，无编辑）结果等效。

2.抽离ruoyi-vue代码生成器逻辑

ruoyi-vue中的ruoyi-generator模块有着完整的代码生成逻辑，但是它依托于ruoyi-admin的spring-boot框架才能运行，现在我要将ruoyi-generator模块的功能独立于spring-boot，让其作为一个普通的spring的程序，只有一个普通的main方法，实现和原来等效的功能。

这里的做法是直接修改ruoyi-generator模块，删除spring-boot的相关功能，但是保留spring、mybatis、druid等基础组件的依赖，然后将这些组件手动重新纳入spring容器中进行管理，最后通过main方法调用到相关模块。

具体就不展开讲了，有兴趣的可以看看我的源代码：https://gitee.com/kdyzm/ruoyi-vue-gen

3.独立版代码生成器使用方法

3.1 配置application.properties配置文件

该配置文件的内容如下：

mysql.username=${dbUserName}
mysql.password=${dbPassword}
mysql.connectionUrl=${dbUrl}
mysql.driverClass=${dbDriverClassName}

gen.author=kdyzm
gen.packageName=com.kdyzm.business
gen.autoRemovePre=false
gen.tableName=news
gen.tablePrefix=sys_

上半部分是数据库配置，连接的是ruoyi-vue数据库，正常配置即可；下半部分是生成配置，除了gen.tableName，其它配置和原ruoyi-vue代码生成器的配置相同。

要注意，代码生成结果仅使用用ruoyi-vue项目，如需自定义模板，需要修改源代码。

3.2 打包和运行

在项目根目录运行命令mvn clean package，打包完成之后切换到target目录，使用命令java -jar ruoyi-vue-gen-1.0-SNAPSHOT.jar运行jar包得到ruoyi.zip压缩文件

啥也不会hh
关注
  • 14
    点赞
  • 踩
  • 65
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 1
    评论
专栏目录
RuoYi若依代码生成+一键部署
04-05
若依代码生成器很强大的，可以让我们写增删改查的效率大增。但是我在用的过程中总感觉还不够爽快。我想根据自己的想法改造一下。 总体来说操作还是有些繁琐的。我想实现的是只需要点一个按钮，就可以完成以上所有内容： - 下载代码 - 解压代码 - 复制前端代码 - 复制后端代码 - 自动执行菜单SQL - 编译代码并重启服务
若依后台管理系统（IDEA）-- 代码生成器傻瓜教程
CJW的博客
07-25 2万+
1.建数据库表（字段及表必须添加注释），表名形如：shop_order 2.修改ruoyi-admin的配置文件application.yml author: cjw # 开发者姓名，生成到类注释上 packageName: com.ruoyi.xxx # 默认生成包路径 autoRemovePre: true # 是否自动去除表前缀 tablePrefix: shop # 表前缀（与数据库建立的表对应比如shop_order） 3.新建模块ruoyi-xxx,如ruoyi-goods 引入common模
若依框架（前后端分离）——代码生成器使用详细教程（24年新版）
最新发布
weixin_45715650的博客
04-11 2295
在使用若依框架系统自带的代码生成器时，试了很多教程多多少少都运行不成功，花了大量的功夫找bug，可能是若依版本的限制，也可能是其他因素，所以在此写下这篇详细的搭建教程。一方面是为了帮助大家，一方面也是形成笔记，若是自己忘了，可以回来翻阅，更快上手。↓ ↓ ↓ 正文开始 ↓ ↓ ↓。
RuoYi 若依 代码生成器使用教程
热门推荐
zyqytsoft的博客
03-22 2万+
RuoYi 若依 代码生成器使用教程 你好！ 如果你想学习如何使用RuoYi 若依 代码生成器, 可以仔细阅读这篇文章，了解一下RuoYi 若依 代码生成器的基本知识。 新建数据表（注意字段一定要写注释） USE ry; /*Table structure for table sys_zyq */ DROP TABLE IF EXISTS sys_zyq; CREATE TABLE sys_zyq...
若依代码生成（超详细的图文教程）
Keep__Me的博客
07-30 1万+
最近因为要使用若依框架生成代码，因为刚开始不熟悉，所以耗费了挺长时间的，按照网上的教程都是新建一个mudel，我是想把生成的代码直接放到我原来的系统中，自己摸索耗费了点时间，所以特地记录一下。
若依代码生成器的使用方式
weixin_51885039的博客
04-25 1075
若依代码生成器的使用方式
RuoYi 若依 代码生成器
qq_33446686的博客
09-19 620
ruoyi-system java
若依代码生成使用教程
Andrew0219的博客
10-26 4618
1.先在若依数据库里建好库并且给库名备注一下，方便在若依上看，怎么备注看我这个博客 https://blog.csdn.net/Andrew0219/article/details/118728251 2.打开若依-系统工具-代码生成-导入 3.编辑-修改里面的信息 4.生成代码-打开生成压缩包，把里面的sql文件在数据库再运行一次 5.导入main 6.先给导入的项目xml添加依赖 <dependencies> <dependency>
若依源码解析：代码生成ruoyi-generator
字节叔叔
05-29 7935
若依的代码生成器模块（ruoyi-generator）可以根据数据库表的设计信息和配置的模板，自动生成相应的Java代码文件。代码生成器使用Velocity作为模板引擎，根据模板文件中的占位符和变量替换规则，将元数据信息嵌入到生成的代码中，生成具体的代码文件。通过导入表结构和生成代码两个后端接口，实现了快速导入数据库表结构和生成代码的功能。
快速上手若依代码生成器(2022)
weixin_51751186的博客
09-20 6578
快速上手若依
若依代码生成工具v4.6.0.zip
06-03
1、双击“启动工具.bat”进行打开 2、工具内置tomcat，默认端口为：5064 3、如果需要更改端口号，打开“启动工具.bat”找到“--server.port=5064”更改 4、tomcat启动后会自动打开浏览器，优先级为：谷歌→火狐→-...
动软代码生成器工具2023
02-20
动软代码生成器 同时提供便捷的开发管理功能和多项开发工作中常用到的辅助工具功能，您可以很方便轻松地进行项目开发，让软件开发变得轻松而快乐！帮您快速开发项目，缩短开发周期，减少开发成本，大大提高了企业的...
伪代码生成器PseudoCodeTool
06-07
适用于java/C/C++等代码，源代码为java代码通过运行代码将代码输入程序框中D盘自动生成伪代码文件PseudoCode.txt。(注意：由于是简单代码只可适用于糊弄老师，实验报告等，不可用于学术研究)。
javaweb代码生成工具源码
03-10
这是一款代码生成工具，可自定义模板生成不同的代码，支持MySQL、Oracle、SQL Server、PostgreSQL。 只需要一个Java8环境，下载后即可运行使用。 步骤简单，只需配置一个数据源，然后勾选模板即可生成代码。 默认...
若依（ruoyi）系统代码生成工具使用说明
清宵尚温的博客
02-26 1万+
若依（ruoyi）系统代码生成使用说明1、修改代码生成配置2、新建数据库表结构（单表生成）3、登录系统（系统工具 -> 代码生成 -> 导入对应表）4、代码生成列表中找到需要表（可预览、修改、删除生成配置）5、点击生成代码会得到一个ruoyi.zip， 执行sql文件，按照包内目录结构复制到自己的项目中即可 最近开发若依项目，不知道怎么操作，多亏有好人将这篇文章相赠，特地分享出来供大家...
若依框架代码生成器的应用
caomnnnnnn的博客
04-24 854
先设计数据库中的表 我这里的表名为 food找到代码生成器 点击导入表，然后选择要导入的表名 这里选择的是点击编辑这里填 表明和实体类的类名 一般不需要填都是自动生成的，然后作者名 可以填 自己的作者名称。生成信息可以参考下方的图片稍微修改一下。点击生成代码，然后会出现一个压缩包 将其进行解压 会生成一下目录结构将main中的文件依次对应放入到 目录下 这里需要注意的是 controller包 要放到admin模块中这里放入的是controller 包下的内容。
若依后台管理系统（IDEA）-- 代码生成器
m0_71410677的博客
10-12 535
生成后打开压缩文件，将压缩文件中main文件夹复制src目录下，将压缩文件中vue文件夹下复制到前端src目录下,将sql文件导入到sys_menu表中。登录Ruoyi系统，点击系统工具，进入代码生成模块。
若依笔记（四）：代码生成器
叶子叶来
11-02 744
已知使用MyBatisPlus代码生成器可以自动生成Entity、Mapper、Service、Controller代码，前提是数据库中有数据表，生成pojo类以及对于该数据表的增删改查命令的代码，若依更进一步能选择表后生成代码、预览、下载，同时可以生产前端代码，与后端一起还能实现权限管理和数据隔离。
若依代码生成器（mybatis-plus）
anxiaoxiao61的博客
04-29 7665
看这篇文章之前，先去看一下我前面的文章： 若依前后端分离整合mybatis-plus_wjdsg的博客-CSDN博客 用过若依都知道，若依自带的代码生成器，是下载下来，然后自己粘贴到若依项目里，不太方便，毕竟已经整合了mybatis-plus。 所有，介绍一款mybatis-plus代码生成器，自己一直在用： package com.ruoyi; import com.baomidou.mybatisplus.generator.FastAutoGenerator; import...
若依代码生成 前台代码
11-24
根据您提供的引用内容，若依代码生成器可以帮助您快速生成前台代码。具体步骤如下： 1. 打开若依代码生成器，选择“在线生成”选项卡。 2. 在“选择模板”下拉菜单中选择您需要生成的模板类型，例如“表格CRUD”、“表单CRUD”等。 3. 在“选择表”下拉菜单中选择您需要生成代码的数据库表。 4. 点击“生成代码”按钮，等待代码生成器生成前台代码。 5. 将生成的代码复制到您的项目中，即可使用。 需要注意的是，生成的代码可能需要根据您的具体需求进行一定的修改和调整。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

啥也不会hh

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值