最实用的代码重构小技巧排行榜TOP10

这次我们抛开JAVA虚拟机源码这些相对底层的东西,来与各位探讨一下几个代码重构的小技巧,这些内容部分来自于书籍当中,部分来自于项目当中的一些实践经验。如果猿友们曾经用过这种手法,也不妨参与到文章的留言当中,将你的小心得、小体会共享与他人,也可以拿来冲击LZ自己定义的排行榜,LZ不甚欢迎。

  重构的手法有很多种,相对而言,一篇文章的涵盖量自然是无法提到所有,LZ这里也只能提出一些平时会经常使用的一些手法,像一些比较高端的手法,各位有兴趣的可以去找一些专门的书籍涉猎。

  本文部分重构小技巧可能主要与JAVA语言,或者说与面向对象的语言息息相关,不过大多数技巧,无论是面向过程的语言,还是面向对象的语言,都是可以相互通用的。

  废话不多说,我们来看看实用重构技巧的排行榜吧。

  No.1:重复代码的提炼

  重复代码是重构收效最大的手法之一,进行这项重构的原因不需要多说。它有很多很明显的好处,比如总代码量大大减少,维护方便,代码条理更加清晰易读。

  它的重点就在于寻找代码当中完成某项子功能的重复代码,找到以后请毫不犹豫将它移动到合适的方法当中,并存放在合适的类当中。

  小实例

  No.2:冗长方法的分割

  有关冗长方法的分割,其实有时候与重复代码的提炼是有着不可分割的关系的,往往在我们提炼重复代码的过程中,就不知不觉的完成了对某一个超长方法的分割。倘若在你提炼了大部分的重复代码之后,某一些冗长方法依然留存,此时就要静下心来专门处理这些冗长方法了。

  这其中有一点是值得注意的,由于我们在分割一个大方法时,大部分都是针对其中的一些子功能分割,因此我们需要给每一个子功能起一个恰到好处的方法名,这很重要。可以说,能否给方法起一个好名字,有时候能体现出一个程序猿的大致水准。

  小实例

class BadExample {

public void someMethod(){

//function[1]

//function[2]

//function[3]

}

}

/* ---------------------分割线---------------------- */

class GoodExample {

public void someMethod(){

function1();

function2();

function3();

}

private void function1(){

//function[1]

}

private void function2(){

//function[2]

}

private void function3(){

//function[3]

}

}

  No.3:嵌套条件分支的优化(1)

  大量的嵌套条件分支是很容易让人望而却步的代码,我们应该极力避免这种代码的出现。尽管结构化原则一直在说一个函数只能有一个出口,但是在这么大量的嵌套条件分支下,让我们忘了这所谓的规则吧。

  有一个专业名词叫卫语句,可以治疗这种恐怖的嵌套条件语句。它的核心思想是,将不满足某些条件的情况放在方法前面,并及时跳出方法,以免对后面的判断造成影响。经过这项手术的代码看起来会非常的清晰,下面LZ就给各位举一个经典的例子,各位可以自行评判一下这两种方式,哪个让你看起来更清晰一点。

  小实例

class BadExample {

public void someMethod(Object
A,Object B){

if (A != null)
{

if (B != null)
{

//code[1]

}else {

//code[3]

}

}else {

//code[2]

}

}

}

/* ---------------------分割线---------------------- */

class GoodExample {

public void someMethod(Object
A,Object B){

if (A == null)
{

//code[2]

return;

}

if (B == null)
{

//code[3]

return;

}

//code[1]

}

}

 No.4:嵌套条件分支的优化(2)

  此处所说的嵌套条件分支与上面的有些许不同,它无法使用卫语句进行优化,而应该是将条件分支合并,以此来达到代码清晰的目的。由这两条也可以看出,嵌套条件分支在编码当中应当尽量避免,它会大大降低代码的可读性。

  下面请尚且不明觉厉的猿友看下面这个典型的小例子。

  小实例

class BadExample {

public void someMethod(Object
A,Object B){ 

if (A != null)
{

if (B != null)
{

//code

}

}

}

}

/* ---------------------分割线---------------------- */

class GoodExample {

public void someMethod(Object
A,Object B){

if (A != null && B != null)
{

//code

}

}

}

  No.5:去掉一次性的临时变量

  生活当中我们都经常用一次性筷子,这无疑是对树木的摧残。然而在程序当中,一次性的临时变量不仅是对性能上小小的摧残,更是对代码可读性的亵渎。因此我们有必要对一些一次性的临时变量进行手术。

  小实例

class BadExample {

private int i;

public int someMethod(){

int temp = getVariable();

return temp * 100;

}

public int getVariable(){

return i;

}

}

/* ---------------------分割线---------------------- */

class GoodExample {

private int i;

public int someMethod(){

return getVariable() * 100;

}

public int getVariable(){

return i;

}

}

  No.6:消除过长参数列表

  对于一些传递了大批参数的方法,对于追求代码整洁的程序猿来说,是无法接受的。我们可以尝试将这些参数封装成一个对象传递给方法,从而去除过长的参数列表。大部分情况下,当你尝试寻找这样一个对象的时候,它往往已经存在了,因此绝大多数情况下,我们并不需要做多余的工作。

  小实例

class BadExample {

public void someMethod(int i,int j,int k,int l,int m,int n){

//code

}

}

/* ---------------------分割线---------------------- */

class GoodExample {

public void someMethod(Data
data){

//code

}

}

class Data{

private int i;

private int j;

private int k;

private int l;

private int m;

private int n;  //getter&&setter

}

  No.7:提取类或继承体系中的常量

  这项重构的目的是为了消除一些魔数或者是字符串常量等等,魔数所带来的弊端自不用说,它会让人对程序的意图产生迷惑。而对于字符串等类型的常量的消除,更多的好处在于维护时的方便。因为我们只需要修改一个常量,就可以完成对程序中所有使用该常量的代码的修改。

  顺便提一句,与此类情况类似并且最常见的,就是Action基类中,对于INPUT、LIST、SUCCESS等这些常量的提取。

  小实例

class BadExample {

public void someMethod1(){

send("您的操作已成功!");

}

public void someMethod2(){

send("您的操作已成功!");

}

public void someMethod3(){

send("您的操作已成功!");

}

private void send(String
message){

//code

}

}

/* ---------------------分割线---------------------- */

class GoodExample {

protected static final String
SUCCESS_MESSAGE = "您的操作已成功!";

public void someMethod1(){

send(SUCCESS_MESSAGE);

}

public void someMethod2(){

send(SUCCESS_MESSAGE);

}

public void someMethod3(){

send(SUCCESS_MESSAGE);

}

private void send(String
message){

//code

}

}

No.8:让类提供应该提供的方法

  很多时候,我们经常会操作一个类的大部分属性,从而得到一个最终我们想要的结果。这种时候,我们应该让这个类做它该做的事情,而不应该让我们替它做。而且大部分时候,这个过程最终会成为重复代码的根源。

  小实例

class BadExample {

public int someMethod(Data
data){

int i = data.getI();

int j = data.getJ();

int k = data.getK();

return i * j * k;

}

public static class Data{

private int i;

private int j;

private int k;

public Data(int i, int j, int k)
{

super();

this.i = i;

this.j = j;

this.k = k;

}

public int getI()
{

return i;

}

public int getJ()
{

return j;

}

public int getK()
{

return k;

}

}

}

/* ---------------------分割线---------------------- */

class GoodExample {

public int someMethod(Data
data){

return data.getResult();

}

public static class Data{

private int i;

private int j;

private int k;

public Data(int i, int j, int k)
{

super();

this.i = i;

this.j = j;

this.k = k;

}

public int getI()
{

return i;

}

public int getJ()
{

return j;

}

public int getK()
{

return k;

}

public int getResult(){

return i * j * k;

}

}

}

  No.9:拆分冗长的类

  这项技巧其实也是属于非常实用的一个技巧,只不过由于它的难度相对较高,因此被LZ排在了后面。针对这个技巧,LZ很难像上面的技巧一样,给出一个即简单又很容易说明问题的小例子,因为它已经不仅仅是小手段了。

  大部分时候,我们拆分一个类的关注点应该主要集中在类的属性上面。拆分出来的两批属性应该在逻辑上是可以分离的,并且在代码当中,这两批属性的使用也都分别集中于某一些方法当中。如果实在有一些属性同时存在于拆分后的两批方法内部,那么可以通过参数传递的方式解决这种依赖。

  类的拆分是一个相对较大的工程,毕竟一个大类往往在程序中已经被很多类所使用着,因此这项重构的难度相当之大,一定要谨慎,并做好足够的测试。

  No.10:提取继承体系中重复的属性与方法到父类

  这项技巧大部分时候需要足够的判断力,很多时候,这其实是在向模板方法模式迈进的过程。它的实例这里无法给出,原因是因为它的小实例会毫无意义,无非就是子类有一样的属性或者方法,然后删除子类的重复属性或方法放到父类当中。

  往往这一类重构都不会是小工程,因此这一项重构与第九种类似,都需要足够的谨慎与测试。而且需要在你足够确认,这些提取到父类中的属性或方法,应该是子类的共性的时候,才可以使用这项技巧。

  结束语

  因此上面这十种手法,几乎都已经一一尝试过了,可喜的是效果都还不错。

  限于最后两种与实际情况的联系太过紧密,因此无法给出简单的实例,不过后面两种毕竟不是常用的重构手法,因此也算是可以接受了。不过不常用不代表不重要,各位猿友还是要知道这一点的。另外还要说的是,上面的实例只是手法的一种简单展示,实际应用当中,代码的结构可能是千奇百怪,但却万变不离其宗。因此只要抓住每种手法的核心,就不难从这些乱军丛中安然穿过。

  好了,本次的小分享希望各位猿友如果觉得有所收获,可以推荐一下鼓励下,顺便也让更多的人看到。这样的话,或许我们每一个接手的项目代码,都不至于十分的糟糕了。



欢迎加入微信公众号:Java和Android大牛频道群,共同交流和学习!

扫描下发的二维码即可快速关注!!!

大家也可以加我们运营的微信:AMEPRE 或者 QQ:124526720

或者加入官方QQ群:558902989

时间: 2024-10-01 00:31:53

最实用的代码重构小技巧排行榜TOP10的相关文章

最实用的10个重构小技巧排行榜

LZ最近一直在研究虚拟机源码,可惜目前还只是稍微有一点点头绪,无法与各位分享,庞大的JAVA虚拟机源码果然不是一朝一夕能搞定的,LZ汗颜. 本次我们抛开JAVA虚拟机源码这些相对底层的东西,LZ来与各位探讨一下几个代码重构的小技巧,这些内容部分来自于书籍当中,部分来自于LZ维护项目当中的一些实践经验.如果猿友们曾经用过这种手法,也不妨参与到文章的留言当中,将你的小心得.小体会共享与他人,也可以拿来冲击LZ自己定义的排行榜,LZ不甚欢迎. 重构的手法有很多种,相对而言,一篇文章的涵盖量自然是无法提

放松一下】北美小游戏排行榜TOP10——“点击英雄”

大家平时工作都比较忙,在这里推荐一款游戏让大家放松一下,让你体验到指数爆炸般挣钱的快感. 北美小游戏排行榜TOP10--"点击英雄" 简要说明: 游戏可以挂机,关闭电脑,游戏也会自动赚钱(游戏金币) 操作简单,鼠标点击怪物,升级即可 全球点到爆根本停不下来! 游戏地址:http://bbs.phpthinking.com/forum.php?mod=viewthread&tid=135 游戏截图: 快来一起玩到爆吧!

python 实用的30个小技巧

所有的这些技巧都能帮助你压缩代码并且优化运行.此外,你可以在日常工作中很容易地在真实项目中使用他们. 贴士#1. 原地交换两个数字 Python 提供了一个直观的在一行代码中赋值与交换(变量值)的方法,请参见下面的示例: x, y = 10, 20 print(x, y)   x, y = y, x print(x, y)   #1 (10, 20) #2 (20, 10) 赋值的右侧形成了一个新的元组,左侧立即解析(unpack)那个(未被引用的)元组到变量 <a> 和 <b>.

优化C/C++代码的小技巧

说明: 无意看到一篇小短文,猜测作者应该是一个图形学领域的程序员或专家,介绍了在光线(射线)追踪程序中是如何优化C/C++代码的.倒也有一些参考意义,当然有的地方我并不赞同或者说我也不完全理解,原文在此,我的粗糙翻译如下: 1. 牢记Ahmdal定律 funccost表示是函数func的运行时间百分比,funcspeedup是你优化后函数的运行系数: 所以,如果函数TriangleIntersect()占用40%的运行时间,而在你优化后使它运行快了两倍,那么你的程序运行能够快了25%: 这意味着

优化C/C++代码的小技巧(转)

源:http://www.cnblogs.com/lizhenghn/p/3969531.html 说明: 无意看到一篇小短文,猜测作者应该是一个图形学领域的程序员或专家,介绍了在光线(射线)追踪程序中是如何优化C/C++代码的.倒也有一些参考意义,当然有的地方我并不赞同或者说我也不完全理解,原文在此,我的粗糙翻译如下: 1. 牢记Ahmdal定律 funccost表示是函数func的运行时间百分比,funcspeedup是你优化后函数的运行系数: 所以,如果函数TriangleIntersec

phpstorm用正则删除PHP代码空行小技巧

有很多小伙伴会遇到代码空行特别多,但是一行一行删除肯定很烦躁,这时候就需要用到批量删除空行. 怎么批量删除空行呢? 我的办法是用正则把所有空行找到,然后一键全部替换. 首先把Match Case和Regex打上勾 第一个搜索框就填写正则规则:^\n 匹配到所有空行之后,点击[Replace all]即可. 替换效果如下:

js脚本代码调试小技巧

以前写js代码调试代码查看数据是否正确的时候不知道F12(开发者工具),都是alert(xxx)或者console.log(xxx), 现在知道还可以用document.write或者try...catch或者window.onerror 还发现一个好用的东西,JSON.stringify(xxx),如果参数为对象,会显示对象的内容,不用用循环什么的了,对数组或数据对象之类的挺有用,像下面弹窗就是一个数据对象作为JSON.stringify参数的结果

响应式设计代码(小技巧)

1.媒体查询,包含将帮助您快速开始自己的多屏幕网站开发的示例. 2.前5项功能(width.height.device-width.device-height和orientation)是最有用的. 3.为移动电话.平板电脑和桌面计算机提供不同的式样 4.添加带有这些设置的视口<meta>标签能够确保智能手机和平板电脑遵守媒体查询中的宽度设置. 此外,将初始数值设置为1也能够确保iPhone.iPad和Pod touch在横向正确地应用宽度设置. 5.省略高度使得你能够在较小的屏幕上将图像缩小而

代码重构的技巧——合理使用@Deprecated

最近由于工作环境不太理想,很长时间没心情写技术博文,今天在调试springMVC的DispatcherSevlet类的代码时,看到一处代码且联想到项目中程序员的一些做法,觉得有必要写一下. 我们在做项目时,前期写的类中的一些代码可能由于需求变化的原因需要重写,有时重写时方法的传参和返回值也会发生变化,这样往往导致调用的代码也跟着出错,我们看下spring的代码是如何处理这样的事,先看下面两段代码,上面这段是之前的getHandler方法,现在需要改成第二段代码,方法的参数cache不要了,而且方