从码农到工匠-怎么写好一个方法

感谢你阅读本文

今天我们来分享一下怎么怎么写好一个方法，我记得大四的时候彪哥推荐我去读《代码精进之路，从码农到工匠》这本书，那时候由于项目经验不多，所以对于书中很多东西没有感同身受，所以不以为然。

后面做的项目越来越多，从痛苦中不断思考，也看了一些优秀开源框架的实现，逐渐对于开始理解书中的思想。

下文只列举了书中的的“方法封装”，“参数”和“方法短小”这三个，其他的没有列举，因为我觉得其实只要这三点我们执行到位，写出来的代码虽然谈不上优秀，但是维护性和可读性一定会大大提高。

封装的艺术

我们在学习面向对象编程时就知道面向对象的几大特征是抽象，继承，封装，多态，所以学会合理的封装是一件很重要的事情，这也是我们每个程序员应该有的意识。

判断封装

在方法中，总是难免会有很多判断，判断越多，程序就会变得越复杂，但是又不能不判断，我们可以使用设计模式来改善判断很多的方法，使用设计模式来优化判断，比如策略模式，但是其实它并没有消除判断，换句话说，判断是消除不了，我们能做的只能是让判断的代码可读，下面我们来看一段代码。

如下是一个判断，对文件小于1G，类型为txt，文件名中包含user_click_data或者super_user_click_data的文件可以进行处理

对于这个判断，虽然条件并不复杂，但是在代码中就显得“不清洁”，特别是随着系统的不断迭代，加入的人员不断增多，那么判断将会越来越多，如果开发人员加上清晰的注释，那么就比较容易读懂，但是并不是谁都有这样的习惯。

之前我遇到的代码中，有些一个方法中四五十个判断，而且判断还特别复杂，各种&&，||等一大堆，读起来十分费劲，对于这样的代码，遇到真的会让人抓狂。

如何解决呢？

封装判断就是一个好的方案，上面的判断代码我们就可以进行封装，如下。

上面我判断我们将其抽出来作为一个单独的方法，在加上可理解的方法名，那么别人在读你代码的时候就很容易读懂，也保证了代码的清洁，当然，方法命名是一件很难的事情，不过如果命名得不够准确，我们可以加上清晰的注释来解决。

虽然上面这段代码看似没啥改变，但是随着系统的不断复杂，就能体现出它的作用了，我经常看到别人在主流程的代码中加入很多复杂的判断，在我刚开始写代码的时候，也做过这种事，很多时候如果注释不清，命名不规范，上下文不清晰，那么读起来就很痛苦，而且整个方法看起来让人特别难受。

所以，一个看似很小的改动，却能在时间的作用下显得如此重要，保持这样一个习惯，不仅是对自己负责，也是对他人负责。

参数问题

参数问题也是我们应该去考虑的问题，当在一个方法中，如果参数特别多是很不友好的，我之前碰到过一个方法有十五六个参数，首先这么多个参数，在传递的时候，如果使用对IDEA使用比较熟悉，那么可以使用快捷键查看下一个参数是什么类型，如果使用不熟悉，那么就需要点进方法中去看，这是一个体力活。

加上参数越多，维护成本就越高，比如我需要加一个参数，但是这个参数并不是必须的，有些方法用到，有些不用，但是由于使用的是同一个方法，所以调用这个方法的地方都需要加上这个参数，调用的地方越多，成本就越大，如果是一个RPC接口，修改的成本更大。

复杂的参数封装成类。

对于复杂的参数，推荐封装成类然后进行传递，在添加或者减少字段的时候是在类中进行，没有对形参进行增加或者减少，对调用此方法的地方基本没任何影响，我们只需要在需要添加或者减少这个参数的地方进行操作，不需要的地方就保持不动。

方法尽量保持短小

方法短小更容易让人阅读和维护，当我去阅读别人的代码的时候，有些类有七八千行代码，一个方法有五六百行代码的时候，其实内心是奔溃的！

当然，在我刚开始写代码的时候，我也不懂，所以一个方法从来不去优化，也是一个方法一口气干到底，我记得当时给老师做一个项目，一个类我在Controller层直接写了几百行，Service层都不用，还有写Vue，也不会去使用组件和封装函数，所以一个Vue文件几千行，当需要修改的时候，十分麻烦，找一个方法和变量也特别费力。

记得上一个星期，我和前端同事联调，我看他去找一个方法找了足足三四分钟，因为项目十分庞大，加上设计有很大的缺陷，我看他们一个VUE文件可达到八九千行，所以才出现这个问题。

其实无论对于前端还是后端，Java还是golang等等，代码的短小都比较容易去阅读和维护，如果发现方法越写越大，那我们就要考虑去提取，去拆分了，《代码精进之路》作者推荐Java一个方法不要超过20行，不过也不是绝对的。

对于像Spring这种特别复杂的框架，因为不断升级和迭代，所以有些方法也变得特别长，代码也变得可读性不那个高，但是也不影响它是Java生态中使用最广泛，最强大的框架。

只不过对于我们普通人来说，因为水平肯定没有Spring团队的强，所以保证方法的可读性是十分重要的。

今天的分享就到这里，感谢你的观看，我们下期见。

参考：《代码精进之路，从码农到工匠》weread.qq.com/web/reader/…?