【QA能力建设】Java Spring Boot项目-代码走读

以下内容为个人理解,有不足之处还望指正......

背景:我们多数时候,测试都是基于表层现象看问题,部分缺陷很容易发现(开发代码写错),但因为测试场景的遗漏,导致上线出问题。所以我们需要对开发的代码有整体了解。

目的:1.加强对需求实现的了解;2.对项目整体可以做到心中有数,以确定测试边界(有疑问或不理解的地方,可以和开发进行思维碰撞;了解越多,测试设计可以更加充分);3.识别一些低级别缺陷。


以下一、二、三大点是走读代码的前置条件

一.了解Java项目关键字 (部分参考网上)

在一般工程中,基本上都会出现controller、service、impl、Dao等关键字,来说下这些关键字之间的联系

Controller:负责具体的业务模块流程控制,在此层里面要调用Serice层的接口来控制业务流程,控制的配置是在Spring的配置文件里面进行,针对具体的业务流程,会有不同的控制器。

Service:Service层主要负责业务模块的逻辑应用设计。同样是首先设计接口,再设计其实现的类(impl),接着再Spring的配置文件中配置其实现的关联。Service层的业务实现,具体要调用到已定义的Dao层的接口。

Dao:Dao层主要是做数据持久层的工作,负责与数据库进行联络的一些任务都封装在此,Dao层的设计首先是设计Dao的接口,然后在Spring的配置文件中定义此接口的实现类,然后就可在模块中调用此接口来进行数据业务的处理,而不用关心此接口的具体实现类是哪个类,显得结构非常清晰,Dao层的数据源配置,以及有关数据库连接的参数都在Spring的配置文件中进行配置。

二.了解maven

1.简介参考maven(一) maven到底是个啥玩意~

2.安装maven查看

3.公司私库配置。

配置完成后,在IDEA>Terminal中跑sh package.sh ,出现如下所示 就代表成功导入 公司私库内的jar包。

image.jpeg

4.做以上操作的目的?

为了能在Java项目 代码走读时看到Dao内方法的具体实现(对数据库的增删改查)。

三.了解pom.xml文件

pom是项目对象模型(Project Object Model)的简称,它是Maven项目中的文件,使用XML表示,名称叫做pom.xml。作用类似ant的build.xml文件,功能更强大。该文件用于管理:源代码、配置文件、开发者的信息和角色、问题追踪系统、组织信息、项目授权、项目的url、项目的依赖关系等等。详细可查看

四.小白实操 代码走读

示例 project:dada-api-learning branch:feature/LEAR-1781

image.jpeg

❀前戏❀

1.到公司gitlab获取工程,克隆仓库到本地。

git clone git@xxxxxxxxxxxxxx/dada-api-learning.git;然后 git checkout feature/LEAR-1781 ----git命令不熟的自己去补

2.打开IntelliJ IDEA读取工程。

❀开始❀

思考下,整个工程那么多代码,我们应重点关注什么???

我的理解:后端代码主要实现业务数据的增删改查,将数据返回客户端。

故而,我们关注的重点就是由客户端发送HTTP请求--->后端接收请求--->进行逻辑处理,提取数据--->将数据返回客户端。这整个过程。

那么,咱们详细解读下整个过程 (示例API:/v2/learning/yearendreport/getReport)


*首先,客户端发来的HTTP请求是由Controller接收的

那么我们要找到Controller目录(在src/main/java/com.dadaabc.api.learning/controller),然后再找对应业务命名的Controller文件进入 || 若不知文件名,可以复制对应API 包含的方法名,在IDEA中双击shift打开搜索框搜索进入
image.jpeg

下图为Controller层代码
image.jpeg

Controller层详解:

1.@RestController关键字会接收客户端发来的HTTP请求,然后用@RequestMapping关键字去匹配对应路径的请求(关键字后跟的("/v2/learning/yearendreport")就是对应接口的前置路径)

2.如果匹配成功,然后就执行下面的YearEndReportController类

1)private static final Logger logger = LoggerFactory.getLogger(YearEndReportController.class); 意思是使用指定YearEndReportController类初始化日志对象,方便在日志输出的时候,打印日志信息。

2)自动装配了这个接口的业务实现逻辑(service),具体为什么会在这个地方引入,咱们先不深究。

@Autowired

private YearEndReportService yearEndReportService;

@Autowired

private YearEndReportInitService initService;

@Autowired

private AsyncService asyncService;

3.@RequestMapping(value = "/getReport", method = RequestMethod.POST) 这块就是真正匹配接口了,意思是以/v2/learning/yearendreport/getReport结尾的post请求会匹配执行getReport()方法

1) @RequestBody JSONObject jsonObject 意思是接收的参数来自于requestBody中(即请求体),且传参为json格式。

2)Integer studentId = jsonObject.getInteger("studentId");表示去取前端传递的参数(参数为整型)

4.以下代码表示先校验学生id,若id不存在就直接返回错误code码和message 至客户端。

if (studentId == null) {

logger.info("getReport studentId is null");

return ErrorCode.BAD_PARAMETER;

}

5.以下代码中的yearEndReportService就是具体业务逻辑实现的类(service层),getReportByStudentId就是业务实现的具体方法;可以按住Ctrl,点击getReportByStudentId跳转查看具体实现。(这一步就跳转到了业务具体实现的service层)

ResponseData responseData = yearEndReportService.getReportByStudentId(studentId);

下图为Service层代码(这块是设计接口,具体实现逻辑在ResponseData getReportByStudentId(int studentId);)
image.jpeg

点左侧 箭头指向处 可跳转查看具体实现的类(impl)

下图为Service具体实现的类(impl)方法,这块也就是 核心业务逻辑

image.jpeg

Service层详解:

1.YearEndReport report = yearEndReportDao.findByStudentId(studentId); 这块意思是在yearEndReportDao下的findByStudentId方法里去查学生的信息,需传入studentId,将查出的结果赋值给report变量。 ---Dao层在最后提及

2.以下代码的意思是,如果查表得出的学生信息不存在,就去调createNewUserReport方法实时创建用户的报告(需传入学生id);若实时创建时也找不到学生信息,那么就打印日志说“这个学生依旧没有报告”,并且return出去(将code码和"null"返回客户端);若创建报告成功,那么就将报告数据插入到yearEndReport表中

if (report == null) {

report = createNewUserReport(studentId);

if (report == null) {

    logger.info("getReportByStudentId this student still dont have studentId:{}", studentId);

return new ResponseData(ResponseData.CODE_SUCCESS, report);

}

logger.info("getReportByStudentId this student is new,studentId:{},newReport:{}", studentId, report);

yearEndReportDao.insertReport(report);

}

3.JSONObject jsonReport = JSONObject.parseObject(reportInfo); 意思是将报告内容转换成json格式

4.以下代码的意思是,更新 studentName/studentAvatar/likeReport/avatarInfo这4项信息到报告内容中去,最后将所有信息返回客户端(包括code_success状态码和json格式的报告内容)

JSONObject jsonReport = JSONObject.parseObject(reportInfo);

jsonReport.put("studentName", report.getStudentName());

jsonReport.put("studentAvatar", report.getStudentAvatar());

jsonReport.put("likeReport", report.getLikeReport());

String avatarInfo = jsonReport.getString("avatarInfo");

jsonReport.put("avatarInfo", JSONObject.parseObject(avatarInfo));

return new ResponseData(ResponseData.CODE_SUCCESS, jsonReport);

下图为Dao层代码:

Dao入口:(点击截图箭头指向区域跳转查看)
image.jpeg

下图是实现Dao的接口,具体逻辑都在YearEndReport findByStudentId(int studentId);内,点击图中箭头指向处,跳转查看SQL语句

image.jpeg

Dao层详解:

下图就是上面跳转过来的具体的实现(SQL查询),其中#{studentId} 读取的是跳转前传过来的参数

SQL : SELECT id,student_id,student_name, student_avatar,like_report, report_info FROM year_end_report WHERE student_id = #{studentId} order by id desc limit 1;
image.jpeg

读到这里,后端接收HTTP请求—>处理数据—>将数据返回客户端,这整个流程的代码算是走读完毕。

通过以上步骤,你应该知道这个接口到底查了什么东西,与你的预期结果是否一致。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,546评论 6 507
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,224评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,911评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,737评论 1 294
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,753评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,598评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,338评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,249评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,696评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,888评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,013评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,731评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,348评论 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,929评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,048评论 1 270
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,203评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,960评论 2 355