第47次 · 项目代码整理与问题复盘
第47次 · 项目代码整理与问题复盘
第1/7页 · 先知道今天要做什么
先从一个熟悉的场景想一想:这节课的代码在帮我们解决什么问题?
先来一个生活里的画面
你把积木作品交给同学,只给一箱零件却不说第一步怎么搭,同学很容易卡住。README 是可照着做的装配说明,要告诉他打开哪个 pom、准备哪些服务、运行哪个 main,再核对哪条真实请求。
你已经会的知识
用前面课的类、方法、参数和返回值来读本次例子。遇到新名字先看下一页;不用一开始读完整个工程。
为什么要学这一课
把自己修改的第14章工程整理成同学能找到入口的作品。README要对应实际项目与依赖,不写未经运行的一键启动承诺。
今天完成的事情
在 IDEA 整理 README,让同学按说明找到并启动自己的工程副本。
这课在哪里做
| 要找什么 | 真实位置 |
|---|---|
| 下载后打开 | 04_源代码/chapter14/heima-leadnews/pom.xml |
| 本次先读 | src/main/java/com/itheima/LeadNewsApplication.java |
| 运行或请求入口 | src/main/java/com/itheima/LeadNewsApplication.java |
看到什么才算完成一小步
- 同学找到入口与自己改的文件:记录定位步骤是否清晰。
- 环境具备并重启请求:写真实响应,缺环境写卡点。
- 只有文件能打开:不能据此宣称服务和全部接口可运行。
阅读顺序
第2页查新词,第3页读这一份工程的代码,第4页先找文件和入口。第5页在 IDEA 按步骤修改;第6页对照效果和问题;第7页用自己的话复盘。
操作位置
下载、解压、打开、修改和运行在本机 IDEA;教学网站用于看讲义、下载资源、保存草稿和提交。请教师先准备本章练习数据库与测试账号,以及 application.yml 中需要的对象存储等服务。数据库初始化脚本在解压包的 05_课程素材/chapter14/sql脚本/leadnews.sql。仅在本地或教师指定练习环境操作;记录配置键与是否连通,提交材料中去掉密码和登录token。原包含完成工程和“初始工程”,本页操作的是 04_源代码 下的完成工程。
来源:第14章 综合实战-黑马头条 · 课件第27、50、63页(课件页码,不是教材印刷页码)
第2/7页 · 把新词说清楚
先把本课用得到的名字认清;看到名字时回到真实文件定位。
新词与本课含义
| 名字 | 在这个例子里是什么意思 |
|---|---|
| README | 告诉同学怎样找到、配置、启动你的实际工程。 |
| 源码与构建物 | src/pom 是输入,target 是构建输出。 |
| 复现 | 给相同输入,观察同一个错误或修复效果。 |
| 占位配置 | 说明键与填写方式,提交文件不含真实密码。 |
把生活画面对应到教材代码
| 生活里的角色或动作 | 本课真正的代码 |
|---|---|
| 积木装配入口 | 04_源代码/chapter14/heima-leadnews/pom.xml |
| 第一只启动开关 | LeadNewsApplication |
| 装好后的一次检查 | README 中的真实请求与预期 |
类比怎样用
先借这个画面记住分工,再回到本课文件逐项定位。生活里的角色只是类比,程序的实际行为以教材代码、配置和本机观察为准。
先对照文件名
src/main/java/com/itheima/LeadNewsApplication.java 是本次主阅读文件,位置在 04_源代码/chapter14/heima-leadnews 内。目录、类、方法和对象登记名是四种不同名字,不要随意互相替换。
读代码时只问三个问题
- 它从哪里得到输入:方法参数、XML、请求还是数据库?
- 它调用哪个具体方法:到同一个工程中查这个名字。
- 结果从哪里看:Run 控制台、请求响应还是数据库?本课第1页检查表给出位置。
先不用背术语
先能找到文件、指出一行的动作并描述输出。术语用来给已经看过的动作命名,不用它替代操作过程。
来源:第14章 综合实战-黑马头条 · 课件第27、50、63页(课件页码,不是教材印刷页码)
第3/7页 · 先看一个小例子
下面的教材片段来自本课下载项目;新增练习代码会另外标明。不要把节选直接当完整文件覆盖。
先猜一猜,读完代码再回答
为了说明启动,是否应该把本机密码也写进 README?
三个具体例子:先给输入,再想结果
| 输入或改动 | 应该观察什么 | 为什么 |
|---|---|---|
| 说明清楚 pom 与 main | 同学应能定位正确工程入口 | 具体路径比“打开项目”更可操作。 |
| 只写“一键启动”却没列数据库存储 | 同学可能卡在依赖 | 运行条件不能靠一句口号省掉。 |
| 只拿旧截图展示 | 不能证明本次能按说明复现 | 记录当前机器与当前输入的实际结果。 |
把例子用起来
这些是课堂推演,帮你看清“只改一个输入,结果怎样变化”。涉及数据库的编号、余额和数量是示意,动手时换成教师提供的真实练习数据;在 IDEA 写下自己的预测,再运行核对。
打开这一份文件
04_源代码/chapter14/heima-leadnews/src/main/java/com/itheima/LeadNewsApplication.java。在 IDEA 双击打开;以下只是它的第11—14行,完整类、import 和配置仍保留在项目中。
LeadNewsApplication.java:先读这一段
04_源代码/chapter14/heima-leadnews/src/main/java/com/itheima/LeadNewsApplication.java 第11—14行
public static void main(String[] args) {
SpringApplication.run(LeadNewsApplication.class,args);
}
}
先看第1个动作
启动入口仍是LeadNewsApplication,不把其他工具类main当成Web启动。
先看第2个动作
README写打开路径、JDK、Maven、数据库脚本与存储条件。
先看第3个动作
配置用键名与占位符说明,真实密码和token不放提交文件。
先看第4个动作
让同学按说明定位和实际运行,把卡住处写回README。
先读再动手
先在 IDEA 找到以上几行,逐项说出它们做什么。第5页会明确告诉你改哪一行、加到哪个大括号里、运行哪个入口;今天只改那几处。
来源:第14章 综合实战-黑马头条 · 课件第27、50、63页(课件页码,不是教材印刷页码)
第4/7页 · 一步一步做出来
先认清项目、文件和运行入口;保持同一个例子,再去第5页做个人修改。
本课项目目录
04_源代码/chapter14/heima-leadnews/pom.xml;选择直接包含 pom.xml 和 src 的这一层。
把这条路线讲成一段小故事
- 整理真实目录
- 写配置键与依赖条件
- 让同学按步骤找到并启动
- 根据实际卡点改说明
先完成打开项目这一步
- 在讲义顶部点“下载代码资源”。等 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/java/com/itheima/LeadNewsApplication.java | 先双击定位,与第5页指定的修改步骤对照;原包已有。 |
| src/main/resources/application.yml | 先双击定位,与第5页指定的修改步骤对照;原包已有。 |
| src/main/java/com/itheima/controller/NewsController.java | 先双击定位,与第5页指定的修改步骤对照;原包已有。 |
不要急着执行
请教师先准备本章练习数据库与测试账号,以及 application.yml 中需要的对象存储等服务。数据库初始化脚本在解压包的 05_课程素材/chapter14/sql脚本/leadnews.sql。仅在本地或教师指定练习环境操作;记录配置键与是否连通,提交材料中去掉密码和登录token。原包含完成工程和“初始工程”,本页操作的是 04_源代码 下的完成工程。
本页先定位,第5页再修改运行
下面说明本课的运行方式,先找到对应按钮。到第5页完成指定配置、新建文件或修改代码后,再按这些步骤执行;还不存在的类或测试方法先不要运行。
本课怎样运行:启动 Spring Boot
- 按本页前置条件完成本地配置,再打开 src/main/java/com/itheima/LeadNewsApplication.java
- 点启动类 main 左侧绿色三角 → Run。看 Run 日志出现 Started 与实际服务端口后再请求;若只有前几行文字或错误堆栈,服务尚未启动。
- 默认用本机 http://localhost:日志显示端口;application.yml 若配置 context-path,要加实际前缀。不要用教学网站172.18.1.33的地址运行下载项目。
- 修改后 Save All,点红色 Stop 停止旧实例,再 Run。不要反复启动多个实例,避免端口冲突。停止以后网页或接口将不可访问,这是正常现象。
本课入口是否需要新增
运行入口已在下载包中;第5页先做必要的配置或改动,再执行这个入口。JUnit 只运行指定方法,避免其它实验一起改数据。
完成修改后检查
| 操作或输入 | 预期观察 |
|---|---|
| 同学找到入口与自己改的文件 | 记录定位步骤是否清晰。 |
| 环境具备并重启请求 | 写真实响应,缺环境写卡点。 |
| 只有文件能打开 | 不能据此宣称服务和全部接口可运行。 |
记录一遍过程
在第5页按顺序改完,每次 Save All 再运行。写下本次实际入口、输入与结果,和表里的预期逐项对照;第一次未成功就按第6页定位。
来源:第14章 综合实战-黑马头条 · 课件第27、50、63页(课件页码,不是教材印刷页码)
第5/7页 · 换成自己的代码
下载项目后,在电脑的 IntelliJ IDEA 中一步一步修改、运行并检查;网站最后只接收你的作业。
本课在 IDEA 中完成什么
在 IDEA 整理 README,让同学按说明找到并启动自己的工程副本。
今天就用这个具体版本练习
请同学照 README 找 pom、main 和你改的一处方法。每卡住一次就补一句具体位置或动作,再重读检查。
这七页使用同一个工程例子
前面的代码阅读和下面的练习都使用本课下载项目。表中列出的文件已在包中;写明“新建”的文件由你按步骤在 IDEA 创建。先保留本地正确包名和目录,再按真实文件名提交修改后的文本。
本课项目目录
04_源代码/chapter14/heima-leadnews;选择这一层的 pom.xml。运行入口:src/main/java/com/itheima/LeadNewsApplication.java。# 后面的文字表示要单独运行的测试方法。
第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/java/com/itheima/LeadNewsApplication.java | 在 IDEA 左侧 Project 按路径展开、双击;这份文件已在下载包中。 |
| src/main/resources/application.yml | 在 IDEA 左侧 Project 按路径展开、双击;这份文件已在下载包中。 |
| src/main/java/com/itheima/controller/NewsController.java | 在 IDEA 左侧 Project 按路径展开、双击;这份文件已在下载包中。 |
第1步前:准备运行依赖
请教师先准备本章练习数据库与测试账号,以及 application.yml 中需要的对象存储等服务。数据库初始化脚本在解压包的 05_课程素材/chapter14/sql脚本/leadnews.sql。仅在本地或教师指定练习环境操作;记录配置键与是否连通,提交材料中去掉密码和登录token。原包含完成工程和“初始工程”,本页操作的是 04_源代码 下的完成工程。 本章从 resources/application.yml 定位数据库与存储配置;SQL脚本导入到教师指定练习库。
本课怎样运行:启动 Spring Boot
- 按本页前置条件完成本地配置,再打开 src/main/java/com/itheima/LeadNewsApplication.java
- 点启动类 main 左侧绿色三角 → Run。看 Run 日志出现 Started 与实际服务端口后再请求;若只有前几行文字或错误堆栈,服务尚未启动。
- 默认用本机 http://localhost:日志显示端口;application.yml 若配置 context-path,要加实际前缀。不要用教学网站172.18.1.33的地址运行下载项目。
- 修改后 Save All,点红色 Stop 停止旧实例,再 Run。不要反复启动多个实例,避免端口冲突。停止以后网页或接口将不可访问,这是正常现象。
发送接口请求:GET 与 POST 分开操作
- GET 请求可在电脑浏览器地址栏输入本机完整地址,结果页面或 JSON 在浏览器看,服务器输出在 IDEA 的 Run/Tomcat 控制台看。
- POST/JSON 请求不能只在地址栏输入。IDEA 支持 HTTP Client 时,在项目根目录 New → File 建 lessonXX.http,按下方示例或教师已验证样例填方法、完整本机地址、Headers,空一行后写 JSON,再点请求左边运行图标。没有 HTTP Client 时,用教师提供的 Postman:New → HTTP Request → 选 POST → 填地址 → Body → raw → JSON → Send。
- 需要登录凭据时在请求 Headers 增加本项目实际使用的 token 键,值用刚登录得到的凭据。文件上传则在 Postman Body 选 form-data、指定键名并将类型由 Text 切到 File。
- 同时记录 HTTP 状态、业务返回码/提示、控制台和实际数据。HTTP200并不保证业务成功;请求示例中的中文占位值必须先替换,端口取启动日志。
第1步:在 IDEA 操作并核对
在 Project 最外层 heima-leadnews 右键 New → File,新建或打开 README.md。第一行写自己的项目名,再列真实完成与未完成的功能。不要改目录中的 pom 项目名来代替说明。
第2步:在 IDEA 操作并核对
写明解压后应打开 04_源代码/chapter14/heima-leadnews/pom.xml、JDK17、启动类 LeadNewsApplication、数据库脚本位置和存储前提;版本从本地 pom 核对。
第3步:在 IDEA 操作并核对
写 File → Open、Maven Reload、运行 main、看 Started 和实际端口的步骤;配置只列键和占位值。把第45课第一条成功请求及预期响应加入 README,去掉密码和token。
第4步:在 IDEA 操作并核对
让同学在自己的电脑/机房 IDEA 按 README 打开你的工程副本,找启动类和一处自己改过的 Controller。如果环境具备就启动并请求;不具备时记录卡在什么依赖,别写一键可运行。
第5步:在 IDEA 操作并核对
根据同学卡住的位置修改 README,再做一次检查。整理时保留 src、pom、必要SQL与说明;不要把 target、.idea、本机密钥和运行日志当成源码提交。
第6步:在 IDEA 操作并核对
选一个自己真实遇到的问题,按现象、复现输入、定位依据、修改文件、重新运行结果五项写进 README;尚未修好明确写未修复。
在本地写练习记录
- 在 IDEA 项目根目录右键 New → File,新建 练习说明.md。填写改过的完整文件路径、方法或行位置,别只写“改了代码”。
- 每组检查写输入/操作、预期、实际结果;文字输出从 Run 控制台抄,接口结果从本机请求抄,数据库结果写实际查到的值。未运行就写“未实测”,并说明卡在哪一步。
- 临时故意写错的对象名、请求或配置按本课要求恢复,Save All。关闭再打开修改文件,确认本地改动保留;最终效果用最后一次重新运行检查。
最后才回网站交作业
本课代码的打开、修改、运行和检查都在本机 IDEA 完成。网站只用来下载讲义/资源和提交结果,不能运行 Java。完成后点讲义顶部“打开代码任务”,将自己在 IDEA 改过的文本文件复制到任务对应文件中;名称与模板不同就“+ 添加文件”填写真实文件名,不为迁就网站模板改错本地包名。保留自己的旧草稿,只提交需要交的源码和练习说明。
保存与提交
添加练习说明.md 并核对本地运行记录 → 保存草稿 → 等显示已保存 → 正式提交并核对新增版本。草稿不计入正式提交次数。项目 ZIP 留在电脑,按教师指定方式另交;不要把 ZIP 二进制内容粘进文本编辑器。提交材料去掉真实密码与登录token。
来源:第14章 综合实战-黑马头条 · 课件第27、50、63页(课件页码,不是教材印刷页码)
第6/7页 · 出错时从哪里查
先保留现象,只检查这一课的同一条调用路线。一次改一处,再重跑确认。
常见现象
| 现象 | 先做什么 |
|---|---|
| IDEA 没有运行三角或依赖报红 | 先查已安装的 JDK17、Maven 导入与下载错误;不要给 DAO/Controller 硬加 main。 |
| 运行结果还是旧的 | 核对右上角入口与当前工程;main/JUnit重新 Run,Web修改后重新编译部署或重启。 |
| 连接或启动失败 | 按第一段关键错误定位数据库、配置、端口或存储;环境未就绪先请教师检查。 |
| 没有预期数据或文字 | 按下面的具体输入表查调用链,分开看控制台、响应和真实数据,不把无报错等同完成。 |
遇到问题,先演一遍这一条路线
整理真实目录 → 写配置键与依赖条件 → 让同学按步骤找到并启动 → 根据实际卡点改说明
用本课的输入复查
| 操作或输入 | 对照实际结果 |
|---|---|
| 同学找到入口与自己改的文件 | 记录定位步骤是否清晰。 |
| 环境具备并重启请求 | 写真实响应,缺环境写卡点。 |
| 只有文件能打开 | 不能据此宣称服务和全部接口可运行。 |
按本课路线检查
- 启动入口仍是LeadNewsApplication,不把其他工具类main当成Web启动。
- README写打开路径、JDK、Maven、数据库脚本与存储条件。
- 配置用键名与占位符说明,真实密码和token不放提交文件。
- 让同学按说明定位和实际运行,把卡住处写回README。
需要老师帮忙时交这些
工程名 chapter14/heima-leadnews;运行入口 src/main/java/com/itheima/LeadNewsApplication.java;你改的文件;输入或请求;第一段关键错误;本次预期与实际。截图之外保留错误文字,方便找到具体行。
把预测和实测分开
检查表是预期,不是替你运行过的证明。未在本机执行就写“未实测”;原教材配置或逻辑出现问题时记录原文件与现象,不写“系统判错”。
来源:第14章 综合实战-黑马头条 · 课件第27、50、63页(课件页码,不是教材印刷页码)
第7/7页 · 用自己的话讲一遍
用真实文件和本机结果说明你完成了什么;先说动作,再说术语。
回到第3页:你刚才猜对了吗?
为了说明启动,是否应该把本机密码也写进 README?
老师带你说清原因
不用。写配置键、占位值和取得教学配置的方式。让同学知道填哪里,不把真实凭据交进文档。
请换一个自己的例子
照着本课三个例子的写法,说清“我只改什么、预计哪一处变化、到哪里看结果”。不需要再发明一个陌生项目;用本课同一组文件和入口。
回答本课的两个问题
| 问题 | 参考解释 |
|---|---|
| README最先解决什么问题? | 别人应该打开哪个pom、运行哪个main、先准备哪些服务。 |
| 下载的全部教材代码都算个人贡献吗? | 不算,明确自己修改与仅参考的部分。 |
按这个顺序讲给同学听
- 我打开的工程是 chapter14/heima-leadnews,本次阅读文件是 src/main/java/com/itheima/LeadNewsApplication.java。
- 我实际改了哪一行、加了哪个方法;指着 IDEA 的代码说明。
- 我运行或请求的入口是 src/main/java/com/itheima/LeadNewsApplication.java,输入是什么。
- 我在控制台、响应或数据库看到了什么,与第1页预期有什么差异。
- 我还有哪步没完成,保留了什么错误信息。
交作业前最后检查
文件与练习说明在 IDEA 已保存,正式提交的是自己的最终文本。下载包原样未改的部分标为参考;配置去掉真实密码和token。原有草稿不会被起始文件覆盖,需要时在代码任务查看本次起始文件对照。
课后再做一个小对照
只换本课检查表的一项输入,按同一入口重新执行,补一行预期和实际。没有环境时写明前置条件并停在实际完成的位置;不增加下一章的陌生功能。
来源:第14章 综合实战-黑马头条 · 课件第27、50、63页(课件页码,不是教材印刷页码)