Java编写高质量的方法

工作中我们经常编写大量方法来实现我们的需求,如写一些公用方法处理相同业务。虽然我们每天都要写很多方法,不过很多人并不知道如何编写高质量的方法,写的方法也是乱成一团,本次参考《代码大全》中高质量的子程序一章,介绍下如何编写高质量的方法,让我们的代码看起来更优秀。
一.我们为什么要编写方法
1.避免代码重复。试想,如果对每个方法的调用都重复写出代码,而不是转到相应的方法中,那么代码会变得多么臃肿。
2.可维护性。如果某些部分需求需要进行修改,我们只需要修改这个需求对应的方法即可,如果没有写到方法中,那么我们需要修改的就太多了。
3.可读性。我们提供一个方法,说明功能是什么,输入输出结果是什么,怎么调用即可,其他人从方法名就知道是什么意思,不需要关心具体实现,同时整个项目的结构也更好理解。
4.方便优化性能。我们可以对方法进行性能监控,知道哪些方法性能低,就可以对相关方法进行优化而不改变其他逻辑。
二.编写高质量方法我们需要注意什么?
1.方法名。首先我们要有一个好的方法名,方法名称需要遵循命名规则,通常我们使用驼峰式命名,如ComputeReportTotals。还有,我们需要通过方法名能让人明确知道方法的功能,即见名之意。
2.文档及注释。我们需要用文档或注释告诉其他人这个方法的作用,完善的文档和注释能让代码维护起来成本更低,没有文档和注释过不了多久连作者都不清楚方法的具体实现了。
3.单一目的。一个函数应该有一个单一而明确的目的,不要为了方便就把一些不相关的逻辑放到一起,这也是我们工作中经常犯的错误。
4.防范错误数据。我们对外提供了方法,就要保证方法的健壮性,不能因为外界调用输入错误某个参数导致方法的崩溃,这里需要对参数的合法性进行校验。
5.方法的参数控制。首先如果一些参数我们在方法中根本没有使用,那么我们就不要在方法上声明这些参数。其次,方法参数的数量不要太多,上限大概是7个左右(7个也有点多),参数太多会导致调用方很难以理解。另外我们需要在方法上用文档详细说明各个参数的作用。
6.不要修改输入变量的值。一般的时候我们不应该在方法中改变输入变量的值,否则将会大大提升维护的难度。
三.好的方法名字及正确的使用参数
1.方法名字要描述方法所做的所有事情。方法的名字应当描述其所有的输出结果以及副作用。
2.避免使用无意义的,表述不清的动词做方法名。
3.根据需要确定方法名称的长度。
4.使用所有的参数。如果某个参数没用到,就把它从方法的接口中删除。
5.把状态或出错变量放到最后。按照习惯做法,状态变量和那些用于指示发生错误的变量应该放在参数表的最后,它们指示附属于程序的功能。
6.不要把方法的参数用作工作变量。正确的做法是引入新的变量把输入值赋给工作变量。
7.如果几个方法都用了类似的一些参数,应该让这些参数的排列顺序保持一致。


评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值