【若依框架】代码生成详细教程

本是古典何须时尚 2022-10-30 12:29 1661阅读 0赞

### 若依框架 ###

*  1、修改代码生成配置
 *  2、新建数据库表结构（单表）
 *  3、项目中新建模块，并解决项目依赖的关系
 *  4、若依系统中新建一个目录 - 学生管理
 *  5、导入一开始建的表并设置上级目录，生成代码
 *  6、执行生成的SQL
 *  7、将生成的代码放入项目中
 *  8、重启项目，访问页面

> [若依官网的代码生成文档][Link 1]

我觉得若依官方的代码生成教程过于简单，网上的教程很多连个效果图都没有。。

--------------------

本文要达到的效果如下：\[学生管理\] 下有个 \[学生信息\] 菜单，里面可以增删改查  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70]

# 1、修改代码生成配置 #

> 这步其实可做可不做。

*  单应用：编辑`ruoyi-admin`中`resources`目录下的`application.yml`
 *  多模块：编辑`ruoyi-generator`中的`resources`目录下的`generator.yml`

我们这里做的是单应用，所以改`ruoyi-admin`里的`application.yml`

author: lzy # 开发者姓名，生成到类注释上
    packageName: com.ruoyi.student # 默认生成包路径
    autoRemovePre: true # 是否自动去除表前缀
    tablePrefix: stu # 表前缀

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 1]

# 2、新建数据库表结构（单表） #

若依建表有个要求：**表字段** 和 **表**，都需要加注释，**注释就是生成页面的显示内容**

这个sql和官网的sql除了表名其他都一样，我们用这个建表  
（如果是用图形化工具或者自己写SQL一定要记得加注释）

drop table if exists stu_student;
    
    create table stu_student (
      student_id           int(11)         auto_increment    comment '编号',
      student_name         varchar(30)     default ''        comment '学生名称',
      student_age          int(3)          default null      comment '年龄',
      student_hobby        varchar(30)     default ''        comment '爱好（0代码 1音乐 2电影）',
      student_sex          char(1)         default '0'       comment '性别（0男 1女 2未知）',
      student_status       char(1)         default '0'       comment '状态（0正常 1停用）',
      student_birthday     datetime                          comment '生日',
      primary key (student_id)
    ) engine=innodb auto_increment=1 comment = '学生信息表';

# 3、项目中新建模块，并解决项目依赖的关系 #

①新建一个名为 `ruoyi-student` 的模块：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 2]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 3]  
②我们要在 RuoYi 整个项目下的`pom.xml`中引入刚刚新建的模块：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 4]

<dependency>
        <groupId>com.ruoyi</groupId>
        <artifactId>ruoyi-student</artifactId>
        <version>${ruoyi.version}</version>
    </dependency>

③还需要在`ruoyi-admin`这个模块的`pom.xml`中引入刚刚新建戴尔模块：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 5]

<dependency>
        <groupId>com.ruoyi</groupId>
        <artifactId>ruoyi-student</artifactId>
    </dependency>

④由于自动生成的代码会用到`ruoyi-common`中的内容，我们需要将`ruoyi-common`引入到我们新建的模块中：（不做这个后面代码会报错，也会自动引入）  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 6]

<dependencies>
        <dependency>
            <groupId>com.ruoyi</groupId>
            <artifactId>ruoyi-common</artifactId>
        </dependency>
    </dependencies>

# 4、若依系统中新建一个目录 - 学生管理 #

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 7]  
但是现在只是建好了目录，里面还没有内容，所以打开是404。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 8]

# 5、导入一开始建的表并设置上级目录，生成代码 #

把刚刚新建的表导入：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 9]  
导入后点击 \[编辑\] ，\[生成信息\] ：建议把**生成模块名**和**生成业务名**写的不一样，否则后面可能会遇到问题，后面运行时会讲到。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 10]  
设置完毕后，生成代码。

> **这里说明一些上面填的东西会生成什么**
> 
>  *  **生成包路径** `com.ruoyi.student`，就是生成的后端代码的包路径  
>     ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 11]
>  *  **生成模块名**和**生成业务名**一起构成后端代码里自动生成的请求路径，即页面路径  
>     ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 12]  
>     ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 13]

# 6、执行生成的SQL #

自动生成的压缩包里有个SQL，这是用来**生成菜单**的，去数据库里执行一下这个SQL。  
![在这里插入图片描述][20210219174553993.png]  
执行完后【学生管理】下就有【学生信息】这个菜单了，但是旁边还没有页面，因为我们代码还没放进项目。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 14]

# 7、将生成的代码放入项目中 #

①将自动生成的代码文件main目录直接复制到我们的新建模块的src下，替换原本的main目录。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 15]

> 若此时报错则是该模块没有引入ruoyi-common，见第3步的④。

②将templates目录拷贝到`ruoyi-admin`目录下的`resources`中：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 16]

# 8、重启项目，访问页面 #

> 注意：如果在上面取名的时候，**生成模块名**和**生成业务名**取的是一样的，可能会遇到一个问题：将代码从Idea移到项目中时候，windows会将相同的两层文件夹自动合并。  
> 比如：`templates.student.student.`会被合并为`templates.student`，此时在Idea里右键改名是没用的（它会把文件夹名字改为`student.student`，并不是两层文件夹），需要去磁盘里手动调整目录，再回来运行。  
> ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 17]

**一定要重启**！然后就可以访问了。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70]  
然后按自己的需要修改，定制。

[Link 1]: http://doc.ruoyi.vip/ruoyi/document/htsc.html#%E4%BB%A3%E7%A0%81%E7%94%9F%E6%88%90
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70]: /images/20221024/22a94667a11f44959a88e78a81bb3a88.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 1]: /images/20221024/8ec9df5222034b0899a8d84bec7e1267.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 2]: /images/20221024/ce26f1751d524a6aa55a2517a407f477.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 3]: /images/20221024/1954f3b3cd5a47ecad5cfc907a875e12.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 4]: /images/20221024/c9b7dd474979452da5bfab6c2ef9ba14.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 5]: /images/20221024/1b610a3382d34bafbd3f0cf784b25bf0.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 6]: /images/20221024/e24a0b10adf644ce8e7c644d87125e49.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 7]: /images/20221024/15005d18602745d7b7bae7101a550eed.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 8]: /images/20221024/8b72553a44aa47a6ab2cd644aa533e6d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 9]: /images/20221024/7ca1415efaa342fc945ad32dd40c3cab.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 10]: /images/20221024/90b639339c8c4edca77aaf175bb5457f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 11]: /images/20221024/262e941293244974a171d51f08177192.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 12]: /images/20221024/1e8e148295b34d159bf11b71ec16888b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 13]: /images/20221024/7584c215111549b784f206bf8d6125a0.png
[20210219174553993.png]: /images/20221024/4356a6ff29544358bbe9dfe779b370db.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 14]: /images/20221024/90167cc9928745d989f5b7b953d9d3b7.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 15]: /images/20221024/068b49c8fa58464689b018e6b2b9706d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 16]: /images/20221024/9bc2d2a24d90428f9aea5c81dfd6f390.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 17]: /images/20221024/e441ce5a8ee84e9090cefe981b87bd60.png