第29次 · 逆向工程与生成代码审查
第29次 · 逆向工程与生成代码审查
第1/7页 · 先知道今天要做什么
先从一个熟悉的场景想一想:这节课的代码在帮我们解决什么问题?
先来一个生活里的画面
制作班级档案表时,可以先按照学校的表头印出空表,大家再补具体内容。生成器也能按照 book 表生成实体和 Mapper 的骨架;它省去重复录入字段,不会替你完成网站的业务与页面。
你已经会的知识
用前面课的类、方法、参数和返回值来读本次例子。遇到新名字先看下一页;不用一开始读完整个工程。
为什么要学这一课
让生成器根据教学book表产生实体、接口与映射。先改到副本的新输出目录,避免覆盖自己已经修改的工程。
今天完成的事情
在工程副本中生成代码,找到实际生成的实体和映射文件。
这课在哪里做
| 要找什么 | 真实位置 |
|---|---|
| 下载后打开 | 04_源代码/chapter11/pom.xml |
| 本次先读 | src/main/resources/generatorConfig.xml |
| 运行或请求入口 | src/main/resources/generatorConfig.xml |
看到什么才算完成一小步
- 在工程副本执行generate成功:在generated/java、generated/resources看到真实输出。
- 只有BUILD SUCCESS但没核对文件:还不能说明输出位置与类正确。
- 生成失败:读连接和配置错误,不手工造文件冒充生成结果。
阅读顺序
第2页查新词,第3页读这一份工程的代码,第4页先找文件和入口。第5页在 IDEA 按步骤修改;第6页对照效果和问题;第7页用自己的话复盘。
操作位置
下载、解压、打开、修改和运行在本机 IDEA;教学网站用于看讲义、下载资源、保存草稿和提交。先请教师提供本章的独立练习数据库、已初始化的表和连接参数。按指定配置文件填写本地连接;配置未就绪时先停在这一步。读到 SQLException 不等于 Java 写错。只在自己的教学库做新增、修改和回滚练习,单独运行指定测试方法,不点整个测试类的 Run All。
来源:第11章 MyBatis的逆向工程和缓存机制 · 课件第7、9、11页(课件页码,不是教材印刷页码)
第2/7页 · 把新词说清楚
先把本课用得到的名字认清;看到名字时回到真实文件定位。
新词与本课含义
| 名字 | 在这个例子里是什么意思 |
|---|---|
| 逆向工程 | 根据数据库表生成代码结构。 |
| 生成目标目录 | generated/java 和 generated/resources 放本次新输出。 |
| 包名 | 生成配置里必须与计划的 com.itheima 对齐。 |
| Maven 目标 | mybatis-generator:generate 是本次运行动作,不是 Java main。 |
把生活画面对应到教材代码
| 生活里的角色或动作 | 本课真正的代码 |
|---|---|
| 已有的正式表头 | 数据库 book 表结构 |
| 按表头制作模板 | mybatis-generator:generate |
| 放新印出的表 | generated/java 与 generated/resources |
类比怎样用
先借这个画面记住分工,再回到本课文件逐项定位。生活里的角色只是类比,程序的实际行为以教材代码、配置和本机观察为准。
先对照文件名
src/main/resources/generatorConfig.xml 是本次主阅读文件,位置在 04_源代码/chapter11 内。目录、类、方法和对象登记名是四种不同名字,不要随意互相替换。
读代码时只问三个问题
- 它从哪里得到输入:方法参数、XML、请求还是数据库?
- 它调用哪个具体方法:到同一个工程中查这个名字。
- 结果从哪里看:Run 控制台、请求响应还是数据库?本课第1页检查表给出位置。
先不用背术语
先能找到文件、指出一行的动作并描述输出。术语用来给已经看过的动作命名,不用它替代操作过程。
来源:第11章 MyBatis的逆向工程和缓存机制 · 课件第7、9、11页(课件页码,不是教材印刷页码)
第3/7页 · 先看一个小例子
下面的教材片段来自本课下载项目;新增练习代码会另外标明。不要把节选直接当完整文件覆盖。
先猜一猜,读完代码再回答
生成的 Book 实体能自动决定“谁可以改这本书”吗?
三个具体例子:先给输入,再想结果
| 输入或改动 | 应该观察什么 | 为什么 |
|---|---|---|
| 正确连接与输出目录 | 按本例生成对应文件 | 生成器有真实表结构可读取。 |
| 只有 BUILD SUCCESS 没打开输出 | 还没确认生成了哪几个文件 | 要到指定目录核对实际产物。 |
| 把产物当完整网站 | 还缺业务流程与请求层等内容 | 表结构只描述数据,不描述全部功能。 |
把例子用起来
这些是课堂推演,帮你看清“只改一个输入,结果怎样变化”。涉及数据库的编号、余额和数量是示意,动手时换成教师提供的真实练习数据;在 IDEA 写下自己的预测,再运行核对。
打开这一份文件
04_源代码/chapter11/src/main/resources/generatorConfig.xml。在 IDEA 双击打开;以下只是它的第24—30行,完整类、import 和配置仍保留在项目中。
generatorConfig.xml:先读这一段
04_源代码/chapter11/src/main/resources/generatorConfig.xml 第24—30行
<javaModelGenerator targetPackage="com.ithema.entity" targetProject="src/main/java">
<!--是否让数据表名作为包的子包,将生成的Java实体类放在该子包中-->
<property name="enableSubPackages" value="false"/>
<!--是否对字符串类型的字段值进行自动去除首尾空白-->
<property name="trimStrings" value="true"/>
</javaModelGenerator>
先看第1个动作
jdbcConnection 指定读哪份教学数据库。
先看第2个动作
javaModelGenerator决定实体的包与输出目录;原包名com.ithema要按第5页统一。
先看第3个动作
sqlMapGenerator与javaClientGenerator分别输出XML与Mapper接口。
先看第4个动作
Maven的mybatis-generator:generate执行生成;配置文件本身不能右键当main运行。
先读再动手
先在 IDEA 找到以上几行,逐项说出它们做什么。第5页会明确告诉你改哪一行、加到哪个大括号里、运行哪个入口;今天只改那几处。
来源:第11章 MyBatis的逆向工程和缓存机制 · 课件第7、9、11页(课件页码,不是教材印刷页码)
第4/7页 · 一步一步做出来
先认清项目、文件和运行入口;保持同一个例子,再去第5页做个人修改。
本课项目目录
04_源代码/chapter11/pom.xml;选择直接包含 pom.xml 和 src 的这一层。
把这条路线讲成一段小故事
- 核对教学库与生成配置
- 指定副本的新输出目录
- 运行 Maven 生成目标
- 打开产物比对表字段
先完成打开项目这一步
- 在讲义顶部点“下载代码资源”。等 ZIP 下载完成,在电脑文件管理器找到它,右键选择“全部提取/解压”,先解压成普通文件夹。不要直接在 ZIP 预览窗口中打开 Java 文件。
- 把解压目录复制一份作为自己的本课练习副本,例如 lesson-课次-学号。保留原包不改,后续课需要同章工程时可继续自己的副本,也可从原包重新开始。
- 按本页列出的“本课项目目录”进入到直接含 pom.xml 和 src 的那一层。整个 ZIP 解压目录、04_源代码 外层都不是这次的 Maven 项目根目录。
- 打开 IntelliJ IDEA。欢迎页点 Open(打开);已打开别的项目则点 File → Open。选择本课 pom.xml,出现选项时选 Open as Project(作为项目打开),或直接选它所在目录。已有项目时用 New Window,避免混淆。
- 导入后选择已安装的 JDK17,打开 Maven 面板 Reload All Maven Projects;依赖完成、代码无编译错误后再运行。
沿这些真实文件找代码
| 工程内路径 | 本次作用 |
|---|---|
| src/main/resources/generatorConfig.xml | 先双击定位,与第5页指定的修改步骤对照;原包已有。 |
| pom.xml | 先双击定位,与第5页指定的修改步骤对照;原包已有。 |
不要急着执行
先请教师提供本章的独立练习数据库、已初始化的表和连接参数。按指定配置文件填写本地连接;配置未就绪时先停在这一步。读到 SQLException 不等于 Java 写错。只在自己的教学库做新增、修改和回滚练习,单独运行指定测试方法,不点整个测试类的 Run All。
本页先定位,第5页再修改运行
下面说明本课的运行方式,先找到对应按钮。到第5页完成指定配置、新建文件或修改代码后,再按这些步骤执行;还不存在的类或测试方法先不要运行。
本课运行方式
这节运行 Maven 的代码生成目标;下面步骤会说明具体菜单。generatorConfig.xml 不能当 Java 类直接 Run。
本课入口是否需要新增
运行入口已在下载包中;第5页先做必要的配置或改动,再执行这个入口。JUnit 只运行指定方法,避免其它实验一起改数据。
完成修改后检查
| 操作或输入 | 预期观察 |
|---|---|
| 在工程副本执行generate成功 | 在generated/java、generated/resources看到真实输出。 |
| 只有BUILD SUCCESS但没核对文件 | 还不能说明输出位置与类正确。 |
| 生成失败 | 读连接和配置错误,不手工造文件冒充生成结果。 |
记录一遍过程
在第5页按顺序改完,每次 Save All 再运行。写下本次实际入口、输入与结果,和表里的预期逐项对照;第一次未成功就按第6页定位。
来源:第11章 MyBatis的逆向工程和缓存机制 · 课件第7、9、11页(课件页码,不是教材印刷页码)
第5/7页 · 换成自己的代码
下载项目后,在电脑的 IntelliJ IDEA 中一步一步修改、运行并检查;网站最后只接收你的作业。
本课在 IDEA 中完成什么
在工程副本中生成代码,找到实际生成的实体和映射文件。
今天就用这个具体版本练习
在副本生成后挑两个真实表字段,分别指出实体属性和映射位置。把输出路径写进记录,不覆盖自己已改的源码。
这七页使用同一个工程例子
前面的代码阅读和下面的练习都使用本课下载项目。表中列出的文件已在包中;写明“新建”的文件由你按步骤在 IDEA 创建。先保留本地正确包名和目录,再按真实文件名提交修改后的文本。
本课项目目录
04_源代码/chapter11;选择这一层的 pom.xml。运行入口:src/main/resources/generatorConfig.xml。# 后面的文字表示要单独运行的测试方法。
第0步:下载、解压并在 IDEA 打开项目
- 在讲义顶部点“下载代码资源”。等 ZIP 下载完成,在电脑文件管理器找到它,右键选择“全部提取/解压”,先解压成普通文件夹。不要直接在 ZIP 预览窗口中打开 Java 文件。
- 把解压目录复制一份作为自己的本课练习副本,例如 lesson-课次-学号。保留原包不改,后续课需要同章工程时可继续自己的副本,也可从原包重新开始。
- 按本页列出的“本课项目目录”进入到直接含 pom.xml 和 src 的那一层。整个 ZIP 解压目录、04_源代码 外层都不是这次的 Maven 项目根目录。
- 打开 IntelliJ IDEA。欢迎页点 Open(打开);已打开别的项目则点 File → Open。选择本课 pom.xml,出现选项时选 Open as Project(作为项目打开),或直接选它所在目录。已有项目时用 New Window,避免混淆。
- 确认导入方式为 Maven。若出现信任提示,先核对这确实是本课程下载的工程再信任。等右下角索引与依赖下载结束,不在下载尚未完成时急着运行。
- 点 File → Project Structure → Project,将 SDK 设为已安装的 JDK 17。列表没有17就按教师安装包先安装,再 Add SDK/JDK 选择实际安装目录;不要把语言级别选17当作JDK已安装。
- 打开 View → Tool Windows → Maven,点击 Reload All Maven Projects(重新加载全部 Maven 项目)。若没有Maven面板,右键本课 pom.xml → Add as Maven Project。红色依赖仍存在时看下载错误,先解决网络/仓库和JDK配置。
- 回到左侧 Project,按本课文件表展开目录并双击文件。Java包可能合并显示为 com.itheima;表中的 src/main/java 表示主代码,src/test/java 表示测试。先核对包名与文件名,再修改。
先找到这些真实文件
| 项目根目录下的路径 | 怎么找到 |
|---|---|
| src/main/resources/generatorConfig.xml | 在 IDEA 左侧 Project 按路径展开、双击;这份文件已在下载包中。 |
| pom.xml | 在 IDEA 左侧 Project 按路径展开、双击;这份文件已在下载包中。 |
第1步前:准备运行依赖
先请教师提供本章的独立练习数据库、已初始化的表和连接参数。按指定配置文件填写本地连接;配置未就绪时先停在这一步。读到 SQLException 不等于 Java 写错。只在自己的教学库做新增、修改和回滚练习,单独运行指定测试方法,不点整个测试类的 Run All。 本章配置在 resources/mybatis-config.xml 的 environments/dataSource;不要把教材默认连接直接当成机房已提供的教学库。
本课运行方式
这节运行 Maven 的代码生成目标;下面步骤会说明具体菜单。generatorConfig.xml 不能当 Java 类直接 Run。
第1步:在 IDEA 操作并核对
用文件管理器把整个 chapter11 目录复制为 lesson29-自己的学号,IDEA File → Open 打开这个副本的 pom.xml。不要在后续缓存实验的原目录上覆盖生成代码。
第2步:在 IDEA 操作并核对
打开 generatorConfig.xml,按教师提供的教学库修改 jdbcConnection;保留 tableName=“book”。原 javaModelGenerator 的包 com.ithema.entity 有拼写差异,统一为 com.itheima.entity,核对三处 targetProject。
第3步:在 IDEA 操作并核对
在副本根目录新建 generated/java 和 generated/resources 文件夹;把 javaModelGenerator 与 javaClientGenerator 的 targetProject 改成 generated/java,把 sqlMapGenerator 的 targetProject 改成 generated/resources。它们仅是输出目录,本次不导入为编译源。
第4步:在 IDEA 操作并核对
打开右侧 Maven → Plugins → mybatis-generator,双击 mybatis-generator:generate;如果没显示该目标,在 Maven 的 Run Maven Goal 输入 mybatis-generator:generate。观察 Run 输出是否 BUILD SUCCESS。
第5步:在 IDEA 操作并核对
在 Project 中展开 generated,找到 Book.java、BookMapper.java、BookMapper.xml。对照 book 表的列,检查字段、接口方法与 SQL 是否匹配。生成失败停在日志,不手工造文件冒充生成结果。
第6步:在 IDEA 操作并核对
给生成文件中一处方法加自己的说明注释,保存。记录“输入表、输出目录、实际文件、自己仍需补的业务规则”;不要把生成的增删改接口等同于完整业务。
在本地写练习记录
- 在 IDEA 项目根目录右键 New → File,新建 练习说明.md。填写改过的完整文件路径、方法或行位置,别只写“改了代码”。
- 每组检查写输入/操作、预期、实际结果;文字输出从 Run 控制台抄,接口结果从本机请求抄,数据库结果写实际查到的值。未运行就写“未实测”,并说明卡在哪一步。
- 临时故意写错的对象名、请求或配置按本课要求恢复,Save All。关闭再打开修改文件,确认本地改动保留;最终效果用最后一次重新运行检查。
最后才回网站交作业
本课代码的打开、修改、运行和检查都在本机 IDEA 完成。网站只用来下载讲义/资源和提交结果,不能运行 Java。完成后点讲义顶部“打开代码任务”,将自己在 IDEA 改过的文本文件复制到任务对应文件中;名称与模板不同就“+ 添加文件”填写真实文件名,不为迁就网站模板改错本地包名。保留自己的旧草稿,只提交需要交的源码和练习说明。
保存与提交
添加练习说明.md 并核对本地运行记录 → 保存草稿 → 等显示已保存 → 正式提交并核对新增版本。草稿不计入正式提交次数。项目 ZIP 留在电脑,按教师指定方式另交;不要把 ZIP 二进制内容粘进文本编辑器。提交材料去掉真实密码与登录token。
来源:第11章 MyBatis的逆向工程和缓存机制 · 课件第7、9、11页(课件页码,不是教材印刷页码)
第6/7页 · 出错时从哪里查
先保留现象,只检查这一课的同一条调用路线。一次改一处,再重跑确认。
常见现象
| 现象 | 先做什么 |
|---|---|
| IDEA 没有运行三角或依赖报红 | 先查已安装的 JDK17、Maven 导入与下载错误;不要给 DAO/Controller 硬加 main。 |
| 运行结果还是旧的 | 核对右上角入口与当前工程;main/JUnit重新 Run,Web修改后重新编译部署或重启。 |
| 连接或启动失败 | 按第一段关键错误定位数据库、配置、端口或存储;环境未就绪先请教师检查。 |
| 没有预期数据或文字 | 按下面的具体输入表查调用链,分开看控制台、响应和真实数据,不把无报错等同完成。 |
遇到问题,先演一遍这一条路线
核对教学库与生成配置 → 指定副本的新输出目录 → 运行 Maven 生成目标 → 打开产物比对表字段
用本课的输入复查
| 操作或输入 | 对照实际结果 |
|---|---|
| 在工程副本执行generate成功 | 在generated/java、generated/resources看到真实输出。 |
| 只有BUILD SUCCESS但没核对文件 | 还不能说明输出位置与类正确。 |
| 生成失败 | 读连接和配置错误,不手工造文件冒充生成结果。 |
按本课路线检查
- jdbcConnection 指定读哪份教学数据库。
- javaModelGenerator决定实体的包与输出目录;原包名com.ithema要按第5页统一。
- sqlMapGenerator与javaClientGenerator分别输出XML与Mapper接口。
- Maven的mybatis-generator:generate执行生成;配置文件本身不能右键当main运行。
需要老师帮忙时交这些
工程名 chapter11;运行入口 src/main/resources/generatorConfig.xml;你改的文件;输入或请求;第一段关键错误;本次预期与实际。截图之外保留错误文字,方便找到具体行。
把预测和实测分开
检查表是预期,不是替你运行过的证明。未在本机执行就写“未实测”;原教材配置或逻辑出现问题时记录原文件与现象,不写“系统判错”。
来源:第11章 MyBatis的逆向工程和缓存机制 · 课件第7、9、11页(课件页码,不是教材印刷页码)
第7/7页 · 用自己的话讲一遍
用真实文件和本机结果说明你完成了什么;先说动作,再说术语。
回到第3页:你刚才猜对了吗?
生成的 Book 实体能自动决定“谁可以改这本书”吗?
老师带你说清原因
不能。它描述字段;身份、权限和业务规则要由自己的代码与设计决定。
请换一个自己的例子
照着本课三个例子的写法,说清“我只改什么、预计哪一处变化、到哪里看结果”。不需要再发明一个陌生项目;用本课同一组文件和入口。
回答本课的两个问题
| 问题 | 参考解释 |
|---|---|
| 生成器输入和输出是什么? | 输入教学book表和配置;输出Java实体、Mapper接口与XML。 |
| 生成代码等于完整网站吗? | 不等于,它不决定业务、页面与访问规则。 |
按这个顺序讲给同学听
- 我打开的工程是 chapter11,本次阅读文件是 src/main/resources/generatorConfig.xml。
- 我实际改了哪一行、加了哪个方法;指着 IDEA 的代码说明。
- 我运行或请求的入口是 src/main/resources/generatorConfig.xml,输入是什么。
- 我在控制台、响应或数据库看到了什么,与第1页预期有什么差异。
- 我还有哪步没完成,保留了什么错误信息。
交作业前最后检查
文件与练习说明在 IDEA 已保存,正式提交的是自己的最终文本。下载包原样未改的部分标为参考;配置去掉真实密码和token。原有草稿不会被起始文件覆盖,需要时在代码任务查看本次起始文件对照。
课后再做一个小对照
只换本课检查表的一项输入,按同一入口重新执行,补一行预期和实际。没有环境时写明前置条件并停在实际完成的位置;不增加下一章的陌生功能。
来源:第11章 MyBatis的逆向工程和缓存机制 · 课件第7、9、11页(课件页码,不是教材印刷页码)