《代码重构》之方法到底多长算“长”?

《一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码》点击传送门,即可获取!

public void executeTask() {

ObjectMapper mapper = new ObjectMapper();

CloseableHttpClient client = HttpClients.createDefault();

List chapters = this.chapterService.getUntranslatedChapters();

for (Chapter chapter : chapters) {

// Send Chapter

SendChapterRequest sendChapterRequest = new SendChapterRequest();

sendChapterRequest.setTitle(chapter.getTitle());

sendChapterRequest.setContent(chapter.getContent());

HttpPost sendChapterPost = new HttpPost(sendChapterUrl);

CloseableHttpResponse sendChapterHttpResponse = null;

String chapterId = null;

try {

String sendChapterRequestText = mapper.writeValueAsString(sendChapterRequest);

sendChapterPost.setEntity(new StringEntity(sendChapterRequestText));

sendChapterHttpResponse = client.execute(sendChapterPost);

HttpEntity sendChapterEntity = sendChapterPost.getEntity();

SendChapterResponse sendChapterResponse = mapper.readValue(sendChapterEntity.getContent(), SendChapterResponse.class);

chapterId = sendChapterResponse.getChapterId();

} catch (IOException e) {

throw new RuntimeException(e);

} finally {

try {

if (sendChapterHttpResponse != null) {

sendChapterHttpResponse.close();

}

} catch (IOException e) {

// ignore

}

}

// Translate Chapter

HttpPost translateChapterPost = new HttpPost(translateChapterUrl);

CloseableHttpResponse translateChapterHttpResponse = null;

try {

TranslateChapterRequest translateChapterRequest = new TranslateChapterRequest();

translateChapterRequest.setChapterId(chapterId);

String translateChapterRequestText = mapper.writeValueAsString(translateChapterRequest);

translateChapterPost.setEntity(new StringEntity(translateChapterRequestText));

translateChapterHttpResponse = client.execute(translateChapterPost);

HttpEntity translateChapterEntity = translateChapterHttpResponse.getEntity();

TranslateChapterResponse translateChapterResponse = mapper.readValue(translateChapterEntity.getContent(), TranslateChapterResponse.class);

if (!translateChapterResponse.isSuccess()) {

logger.warn(“Fail to start translate: {}”, chapterId);

}

} catch (IOException e) {

throw new RuntimeException(e);

} finally {

if (translateChapterHttpResponse != null) {

try {

translateChapterHttpResponse.close();

} catch (IOException e) {

// ignore

}

}

}

}

把没有翻译过的章节发到翻译引擎,然后,启动翻译过程。

翻译引擎是另外一个服务,需通过 HTTP 的形式向它发送请求。相对而言,这段代码还算直白,当你知道了我上面所说的逻辑,你是很容易看懂这段代码。

这段代码之所以很长,主要原因就是把前面所说的逻辑全部平铺直叙地摆在那里了,这里既有业务处理的逻辑,比如,把章节发送给翻译引擎,然后,启动翻译过程;又有处理的细节,比如,把对象转成 JSON,然后,通过 HTTP 客户端发送出去。

从这段代码中,可看到平铺直叙的代码存在的两个典型问题:

  • 把多个业务处理流程放在一个函数里实现

  • 把不同层面的细节放到一个函数里实现

这里发送章节和启动翻译是两个过程,显然,这是可以放到两个不同的函数中去实现的,所以,我们只要做一下提取函数,就可以把这个看似庞大的函数拆开,而拆出来的几个函数规模都会小很多,像下面这样:

public void executeTask() {

ObjectMapper mapper = new ObjectMapper();

CloseableHttpClient client = HttpClients.createDefault();

List chapters = this.chapterService.getUntranslatedChapters();

for (Chapter chapter : chapters) {

String chapterId = sendChapter(mapper, client, chapter);

translateChapter(mapper, client, chapterId);

}

}

拆出来的部分,实际上就是把对象打包发送的过程,我们以发送章节为例,先来看拆出来的发送章节部分:

private String sendChapter(final ObjectMapper mapper,

final CloseableHttpClient client,

final Chapter chapter) {

SendChapterRequest request = asSendChapterRequest(chapter);

CloseableHttpResponse response = null;

String chapterId = null;

try {

HttpPost post = sendChapterRequest(mapper, request);

response = client.execute(post);

chapterId = asChapterId(mapper, post);

} catch (IOException e) {

throw new RuntimeException(e);

} finally {

try {

if (response != null) {

response.close();

}

} catch (IOException e) {

// ignore

}

}

return chapterId;

}

private HttpPost sendChapterRequest(final ObjectMapper mapper, final SendChapterRequest sendChapterRequest) throws JsonProcessingException, UnsupportedEncodingException {

HttpPost post = new HttpPost(sendChapterUrl);

String requestText = mapper.writeValueAsString(sendChapterRequest);

post.setEntity(new StringEntity(requestText));

return post;

}

private String asChapterId(final ObjectMapper mapper, final HttpPost sendChapterPost) throws IOException {

String chapterId;

HttpEntity entity = sendChapterPost.getEntity();

SendChapterResponse response = mapper.readValue(entity.getContent(), SendChapterResponse.class);

chapterId = response.getChapterId();

return chapterId;

}

private SendChapterRequest asSendChapterRequest(final Chapter chapter) {

SendChapterRequest request = new SendChapterRequest();

request.setTitle(chapter.getTitle());

request.setContent(chapter.getContent());

return request

这个代码还算不上已经处理得很整洁了,但至少同之前相比,已经简洁了一些。我们只用了最简单的提取函数这个重构手法,就把一个大函数拆分成了若干的小函数。

长函数往往还隐含着一个命名问题。如果你看修改后的sendChapter,其中的变量命名明显比之前要短,理解的成本也相应地会降低。因为变量都是在这个短小的上下文里,也就不会产生那么多的命名冲突,变量名当然就可以写短一些。

平铺直叙的代码,一个关键点就是没有把不同的东西分解出来。如果我们用设计的眼光衡量这段代码,这就是“分离关注点”没有做好,把不同层面的东西混在了一起,既有不同业务混在一起,也有不同层次的处理混在了一起。我在《软件设计之美》专栏中,也曾说过,关注点越多越好,粒度越小越好。

一次加一点

====================================================================

有时,一段代码一开始的时候并不长,就像下面这段代码,它根据返回的错误进行相应地错误处理:

if (code == 400 || code == 401) {

// 做一些错误处理

}

然后,新的需求来了,增加了新的错误码,它就变成了这个样子:

if (code == 400 || code == 401 || code == 402) {

// 做一些错误处理

}

这段代码有很多次被修改的机会,日积月累:

if (code == 400 || code == 401 || code == 402 || …

|| code == 500 || …

|| …

|| code == 10000 || …) {

}

后人看到就想骂人。任何代码都经不起这种无意识的累积,每个人都没做错,但最终的结果很糟糕。对抗这种逐渐糟糕腐坏的代码,需要知道“童子军军规”:

让营地比你来时更干净

Robert Martin 把它借鉴到了编程领域,我们应该看看自己对于代码的改动是不是让原有的代码变得更糟糕了,如果是,那就改进它。

但这一切的前提是,你要能看出自己的代码是不是让原有的代码变得糟糕了,所以,学习代码的坏味道还是很有必要的。

总结

本文从基础到高级再到实战,由浅入深,把MySQL讲的清清楚楚,明明白白,这应该是我目前为止看到过最好的有关MySQL的学习笔记了,我相信如果你把这份笔记认真看完后,无论是工作中碰到的问题还是被面试官问到的问题都能迎刃而解!

MySQL50道高频面试题整理:

《一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码》点击传送门,即可获取!
变得更糟糕了,如果是,那就改进它。

但这一切的前提是,你要能看出自己的代码是不是让原有的代码变得糟糕了,所以,学习代码的坏味道还是很有必要的。

总结

本文从基础到高级再到实战,由浅入深,把MySQL讲的清清楚楚,明明白白,这应该是我目前为止看到过最好的有关MySQL的学习笔记了,我相信如果你把这份笔记认真看完后,无论是工作中碰到的问题还是被面试官问到的问题都能迎刃而解!

MySQL50道高频面试题整理:

[外链图片转存中…(img-Jp2mlx31-1714774786008)]

《一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码》点击传送门,即可获取!

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值