Cómo escribir código limpio.

---

Después de trabajar durante muchos años, siento cada vez más que el código está limpio y ordenado, ¡es realmente importante! Especialmente en el desarrollo de equipos, escribir un código elegante y ordenado puede hacer que los colegas estén más dispuestos a cooperar con usted.

A continuación, ordenaremos nuestro código a través de los cuatro capítulos de nombres, clases, funciones y pruebas.

1. ¿Por qué mantener tu código limpio?

Cuando el código desordenado aumenta con el tiempo, la productividad disminuye. Los resultados son:

• El código no es fácil de expandir o la expansión es fácil de causar otros problemas
• bloqueo del programa
• trabajar horas extra
• Incrementa el costo de la empresa (agregando personas) e incluso puede llevar a la empresa a la quiebra Una imagen vale más que mil palabras

1.1 Así que mantenlo ordenado desde el principio

Así que escribe un código limpio al principio, si hay un código desordenado, debes rectificarlo a tiempo. ¡Nunca tengas la idea de cambiarlo más tarde, porque!

later equal never
复制代码

Piense si esta es la razón, cuántas cosas de las que hablará más tarde y cambiará más tarde quedan atrás.

Si tienes que hacer algo, ¡hazlo temprano!

1.2 ¿Cómo escribir código limpio?

Entonces, la pregunta ahora es qué tipo de código es un código limpio:

• La legibilidad debe ser alta: el código debe ser tan elegante y fácil de leer como la prosa, consulte el código para comprenderlo.
• Denegar código duplicado
• Satisfacer los principios del patrón de diseño
• • única responsabilidad
  • Principio abierto y cerrado
  • Principio de sustitución de Liskov
  • Principio de inversión de dependencia
  • Principio de segregación de interfaz
  • Ley de Deméter
  • Reglas de multiplexación sintética

2. Denominación

Una buena denominación puede mejorar la legibilidad del código, hacer que las personas entiendan el código, reducir el costo de comprensión, mejorar la eficiencia y reducir las horas extra.

2.1 Mala denominación

1. denominación sin sentido

public interface Animal {
    void abc();
}
复制代码

Ahora tenemos una interfaz animal, que tiene un método abc(), que confunde a la gente, y la persona que llama a este método no tiene idea de lo que hace este método, porque su nombre no tiene sentido.

Nomenclatura significativa:

public interface Animal {
    void cry();
}
复制代码

Llamamos al método cry (llorar, gritar), y la persona que llama sabrá cuál es la función de este método.

Por lo tanto, la denominación debe ser significativa y permitir que las personas conozcan el código.

2. La inconsistencia en la denominación se refleja en el hecho de que obviamente es el mismo comportamiento, pero hay diferentes nombres, lo cual es incoherente y confuso.

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

    List<Student> queryAllStudent(
    );

}
复制代码

Los dos métodos anteriores son para consultar xxx, pero el nombre se llama consultar por un tiempo y encontrar por un tiempo. Esta situación debe estandarizarse y mantenerse consistente. Después de la modificación:

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

    List<Student> findAll(
    );

}
复制代码

3. 命名冗余 体现在命名有很多没必要的成分在里面, 并且这些"废话"并不能帮助区分它们的区别, 例如在变量命名中添加了 Variable 这个词, 在表名中添加了 Table 这个词.所以命名中不要出现冗余的单词 , 并且提前约定好命名的规范.

// 获取单个对象的方法用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();
}
复制代码

如果我们现在要新增查询的操作,就需要修改Sql这个类,没有做到面向修改关闭

重构后:

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 只做一件事

what? 函数的第一规则是短小 第二规则是更短小 短小到只做一件事情. (没错和类的原则很像)

why? 函数越短小,越能满足单一职责.

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

public class PicService {

    public String upload(){
        // 校验图片的方法 伪代码80行

        // 压缩图片的方法 伪代码50行

        // 返回成功或失败标识 0,1 伪代码5行
        return "0";
    }
}
复制代码

原有的upload方法做了很多的事情, 重构后只做了一件事情: 把大一些的概念(换言之,函数的名称)拆分为另一抽象层上的一系列步骤:

 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. 函数应该无副作用

函数应该无副作用， 意思就是函数应该只做一件事，但是做这件事的时候做了另一件有副作用的事情.

例如: 校验密码时会初始化 session，导致会话丢失。如果无法移除这种副作用，应该在方法名中展示出来，避免用户误用 checkPasswordasswordAndInitializeSession, 从命名上就要体现副作用.

4.3 参数

1. 参数越少越好

参数越少，越容易理解，参数超过三个可以将参数进行封装，要按参数的语义进行封装，不一定封装成一个大而全的参数，可以封装为多个，原则是按语义补充; 示例:

public List<Student> findStudent(int age, String name, String country, int gender);

//封装参数
public List<Student> findStudent(Student student);
复制代码

2. 不要使用标识参数

标识参数是参数为 Boolean 类型, 用户传递 true or false . 不要使用标识参数因为这意味着你的函数违背了单一职责(true false 两套逻辑). 正确的做法是拆分为两个方法:

//标识参数方法
render(Boolean isSuite);

//重构为两个方法
reanderForSuite();
renderForSingleTest();
复制代码

3. 不要使用输出参数

什么是输出参数?

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

public void findStudent(){
Student student = new Student();
doSomething(student);
return student;
}

int doSomething(Student student){
// 省略一些student逻辑
return student;
}
复制代码

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

因为增加了理解成本在里面,我们需要查看 doSomething到底对 student 做了什么. 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 怎样写出这样的函数?

没人能一开始就写出完美的代码, 先写出满足功能的代码,之后紧接着进行重构

为什么是紧接着? 因为 later equal never!

4.6 代码质量扫描工具

使用 SonarLint 可以帮助我们发现代码的问题,并且还提供了相应的解决方案. 对于每一个问题，SonarLint 都给出了示例，还有相应的解决方案，教我们怎么修改，极大的方便了我们的开发

比如，对于日期类型尽量用 LocalDate、LocalTime、LocalDateTime，还有重复代码、潜在的空指针异常、循环嵌套等等问题。

有了代码规范与质量检测工具以后，很多东西就可以量化了，比如 bug 率、代码重复率等.

5.测试

测试很重要,可以帮助我们验证写的代码是否没问题,同样的测试代码也应该保持整洁.

5.1 TDD

TDD es Test-Driven Development, una práctica y tecnología central en el desarrollo ágil y una metodología de diseño.

• Ventajas: en cualquier nodo de desarrollo, puede crear un producto que se puede usar, contiene algunos errores, tiene ciertas funciones y se puede lanzar.
• Desventajas: aumentar la cantidad de código. El código de prueba es dos veces o más que el código del sistema, pero al mismo tiempo ahorra tiempo para depurar y encontrar errores.

¿cómo?

1. Escribir pruebas antes de desarrollar código
2. Solo puede escribir pruebas unitarias que simplemente no pasan, y no compilan y no pasan
3. El código de desarrollo no puede exceder las pruebas

Explicación para 2: La prueba unitaria se realiza simultáneamente con el código de producción. Cuando se escribe una prueba unitaria que no se puede compilar, el código de producción comienza a escribirse. Este ciclo se repite y la prueba unitaria puede incluir todos los códigos de producción.

5.2 PRIMEROS principios

El principio FIRST es un principio que guía la redacción de pruebas unitarias.

• rápido La ejecución rápida de la prueba unitaria debe completarse rápidamente
• Las pruebas unitarias independientes son independientes entre sí.
• repetible prueba única repetible no depende del entorno y se puede ejecutar en cualquier lugar
• autovalidación El programa puede autovalidarse a través de la salida booleana sin validación manual (ver salida de registro, comparar dos archivos, etc.)
• las pruebas unitarias oportunas se escriben antes que el código de producción

Las pruebas unitarias son la prueba básica en las pruebas de código. FIRST es un principio importante para escribir buenas pruebas unitarias. Requiere que nuestras pruebas unitarias sean rápidas, independientes, repetibles, autocomprobables y oportunas/completas.

5.3 Patrón de código de prueba

El código de desarrollo y prueba puede usar el patrón dado-cuándo-entonces

• dado fabrica datos simulados
• cuando ejecuta código de prueba
• luego verifique los resultados de la prueba

ejemplo de código

/**
  * If an item is loaded from the repository, the name of that item should 
  * be transformed into uppercase.
  */
@Test
public 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"));
}
复制代码

Utilice el patrón dar-cuándo-entonces para mejorar la legibilidad del código de prueba.

5.4 Generar automáticamente una sola prueba

Introducir dos complementos para IDEA para generar automáticamente pruebas individuales

• Complemento Squaretest (pagado)
• Complemento TestMe (gratis)

6. Conclusión

Escribir código limpio nos permite  mejorar la legibilidad del código y hacerlo más escalable.

Fuente: www.cnblogs.com/liuboren/p/…