阿里的同事，写的代码真 TMD 优雅！

来源：https://www.cnblogs.com/liuboren/p/17017421.html

前言

1.为什么要保持代码整洁?

• 代码不易扩展或扩展容易引发其他问题
• 程序崩溃
• 加班
• 增加公司成本(加人)
• 甚至可能造成公司倒闭

一图胜千言

1.1 所以从一开始就要保持整洁

later equal never

想想是不是这个道理,你有多少以后再说、以后再改的东西都抛诸脑后了.

1.2 如何写出整洁的代码?

• 可读性要高: 代码要像散文一样优雅易读,见码知意
• 拒绝重复代码
• 满足设计模式原则
• 单一职责
• 开闭原则
• 里氏替换原则
• 依赖倒转原则
• 接口隔离原则
• 迪米特法则
• 合成复用法则

专属福利 
👉点击领取：最全Python资料合集

2.命名

2.1 不好的命名方式

1. 没有任何意义的命名方式

public interface Animal {    void abc();}

public interface Animal {    void cry();}

我们将方法名命名为cry(喊叫,呼喊),调用的人就知道这个方法的作用是什么了.

这种情况体现在明明是同一行为,但是却有不同的命名,前后不一致,让人造成混淆.

public interface StudentRepository extends JpaRepository<AlertAll, String> {    Student findOneById(            @Param("id") String id    );
    List<Student> queryAllStudent(    );
}

public interface StudentRepository extends JpaRepository<AlertAll, String> {    Student findOneById(            @Param("id") String id    );
    List<Student> findAll(    );
}

2.3命名冗余

所以命名中不要出现冗余的单词, 并且提前约定好命名的规范.

// 获取单个对象的方法用get做前缀getXxx();//获取多个对象用list做前缀listXxxx();

3.类

• 单一职责
• 开闭原则
• 高内聚性

3.1单一职责

• 降低类的复杂度
• 提高类的可读性
• 提高系统的可维护性
• 降低变更引起的风险

职责过多的例子,可以看到以下类有两个职责:

public abstract class Sql {    // 操作SQL的职责    public abstract void insert();

    // 统计SQL操作的职责    public abstract void countInsert();
}

public abstract class CountSql {
    public abstract void countInsert();
}

3.2 开闭原则

不满足开闭原则的例子:

public abstract class Sql {    public abstract void insert();    public abstract void update();    public abstract void delete();}

public abstract class Sql {    public abstract void generate();

}
public class CreateSql extends Sql {
    @java.lang.Override    public void generate() {        // 省略实现    }}

public class UpdateSql extends Sql {
    @Override    public void generate() {        // 省略实现    }}

当我们要增加删除方法时可以很容易的扩展.

系统应该由许多短小的类而不是少量巨大的类组成,每个小类封装一个权责,只有一个修改的原因,并与少数其他类一起协同达成期望的系统行为.

3.3 内聚

4.函数

• 只做一件事
• 好的命名
• 整洁的参数
• 注意返回内容

4.1 只做一件事

how?
以下是重构前的代码, 这个方法有三个职责,并且该方法很长达到了80+50+5 = 135行

public class PicService {
    public String upload(){        // 校验图片的方法 伪代码80行
        // 压缩图片的方法 伪代码50行
        // 返回成功或失败标识 0,1 伪代码5行        return "0";    }}

 public String upload(){        // 校验图片的方法        check();        // 压缩图片的方法        compress();        // 返回成功或失败标识 0,1        return "0";    }

而里面的每个方法,也都有着自己各自的职责(校验图片 、压缩图片 、返回结果).

4.2 函数命名

1. 函数名应见名知意
   函数拥有描述性的名称，不要害怕长名称.

不好的命名方式:

public String addCharacter(String originString, char ch);

这个函数，一咋看，还不错，从函数字面意思看是给某个字符串添加一个字符。但是到底是在原有字符串首部添加，还是在原有字符串末尾追加呢？亦或是在某个固定位置插入呢？从函数名字完全看不出来这个函数的真正意图，只能继续往下读这个函数的具体实现才知道。

而下面这几个名字就比上面要好得多：

// 追加到末尾public String appendCharacter(String originString, char ch);   
// 插入指定位置public String insertCharacter(String originString, char ch, int insertPosition);

2.函数应该无副作用

4.3 参数

示例:

public List<Student> findStudent(int age, String name, String country, int gender);
//封装参数public List<Student> findStudent(Student student);

不要使用标识参数

正确的做法是拆分为两个方法:

//标识参数方法render(Boolean isSuite);
//重构为两个方法reanderForSuite();renderForSingleTest();

1. 不要使用输出参数

将变量作为参数传入方法,并且将变量输出, 这就是输出参数

public void findStudent(){Student student = new Student();doSomething(student);return student;}
int doSomething(Student student){// 省略一些student逻辑return student;}

为什么不应该有输出参数?

// 将doSomething()方法内聚到student对象本身student.doSomething();

4.4 返回值

1. 分离指令与讯问
   示例代码:

Pulic Boolean addElement(Element element)

指令为增加某个元素,询问是否成功,

这样做的坏处是职责不单一，所以应该拆分为两个方法

public void addElement(Element element);public Boolean isAdd(Element element);

2.使用异常替代返回错误码

代码示例:

// 使用错误码导致多层嵌套...public class DeviceController{
  public void sendShutDown(){    DeviceHandle handle=getHandle(DEV1);     //Check the state of the device     if (handle != DeviceHandle.INVALID){      // Save the device status to the record field       retrieveDeviceRecord(handle);      // If nat suspended,shut down      if (record.getStatus()!=DEVICE_SUSPENDED){         pauseDevice(handle);         clearDeviceWorkQueue(handle);         closeDevice(handle);      }else{        logger.log("Device suspended. Unable to shut down");       }    }else{      logger.log("Invalid handle for: " +DEV1.tostring());   }}

重构后:

//  将代码拆分为一小段一小段, 降低复杂度,更加清晰public class DeviceController{
  public void sendShutDowm(){     try{      tryToShutDown();    } catch (DeviceShutDownError e){       logger.log(e);    }
  private void tryToShutDown() throws DeviceShutDownError{     DeviceHandle handle =getHandle(DEV1);     retrieveDeviceRecord(handle);     pauseDevice(handle);     clearDeviceWorkQueue(handle);     closeDevice(handle);  }
  private DeviceHandle getHandle(DeviceID id){              // 省略业务逻辑    throw new DeviceShutDownError("Invalid handle for:"+id.tostring());   }}

4.5 怎样写出这样的函数?

4.6 代码质量扫描工具

5.测试

5.1 TDD

5.2 FIRST原则

5.3 测试代码模式

代码示例

/**  * If an item is loaded from the repository, the name of that item should   * be transformed into uppercase.  */@Testpublic void shouldReturnItemNameInUpperCase() {
    // Given    Item mockedItem = new Item("it1", "Item 1", "This is item 1", 2000, true);    when(itemRepository.findById("it1")).thenReturn(mockedItem);
    // When    String result = itemService.getItemNameUpperCase("it1");
    // Then    verify(itemRepository, times(1)).findById("it1");    assertThat(result, is("ITEM 1"));}

使用give-when-then 模式可提高测试代码的可读性.

5.4 自动生成单测

• Squaretest插件（收费）
• TestMe插件(免费)

结束语

再重复一次,我们应该及时的写出整洁的代码,而不是想着事后采取补救。

 1

热门推荐

• 现在大厂出来，还能爆杀小公司吗?
• Chrome插件: JSONView 插件让你告别数据混乱！
• 又一个超实用的Python打包神器！