Java 编程技巧之样板代码

前言

北宋科学家沈括在《梦溪笔谈》第十八卷《技艺》中这样描述”活字印刷术“：

庆历中，有布衣毕昇，又为活版。其法用胶泥刻字，薄如钱唇，每字为一印，火烧令坚……若止印三、二本，未为简易；若印数十百千本，则极为神速。

在日常编码的过程中，我们可以总结出很多”样板代码“，就像”活字印刷术“中的”活字“一样。当我们编写新的代码时，需要用到这些”活字“，就把”样板代码“拷贝过来，修改替换一下就可以了，写起代码来”极为神速“。”样板代码“其实就是一种样例、一种模式、一种经验……总结的”样板代码“越多，编写代码的格式越规范、质量越高、速度越快。

1. 样板代码简介

1.1. 什么是样板代码？

样板代码（Boilerplate Code），通常是指一堆具有固定模式的代码块，可以被广泛地应用到各个程序模块。

例如，读取文件就是典型的样板代码：

try (BufferedReader reader = new BufferedReader(new FileReader(fileName))) {    String line;    while (Objects.nonNull(line = reader.readLine())) {        // 处理一行        ...    }} catch (IOException e) {    String message = String.format("读取文件(%s)异常", fileName);    log.error(message, e);    throw new ExampleException(message, e);}

1.2. 样板代码有什么用？

样板（Boilerplate ），可以拆分为样例（Example）和模式（Pattern）两个单词进行理解——样例（Example）指可以当成一种标准范例，模式（Pattern）指可以作为一种解决方案。当遇到类似的案例时，就把样板代码拷贝过去，根据实际情况进行修改，该案例就被轻松解决了。

样板代码的主要作用：

1. 提供一种标准样例：可以用于新人学习，能够快速上手并使用；
2. 提供一种解决方案：遇到类似案例时，可以快速利用该方案进行解决；
3. 有助于不断积累经验：当发现一种样例代码时，都会不断地进行优化，力求达到最佳样例；
4. 有助于提高代码质量：样板代码必然通过了时间考验，存在BUG和出错的几率相对比较低；
5. 有助于提高编码速度：利用样板代码编码，只是复制粘贴修改代码，编码速度大幅提高；
6. 有助于统一代码样式：心中有了样板代码，就能保证每次都写出统一样式的代码。

1.3. 如何编写样板代码？

1. 复制粘贴生成代码利用复制粘贴样板代码，用好了编码会事半功倍。
2. 用文本替换生成代码利用文本替换生成代码，可以很快生成一段新代码。
3. 用Excel公式生成代码把样板代码先公式化，传入不同的参数，生成不同的代码。
4. 用工具或插件生成代码很多开发工具或插件都提供一些工具生成代码，比如：生成构造方法、重载基类/接口方法、生成Getter/Setter方法、生成toString方法、生成数据库访问方法……能够避免很多手敲代码。
5. 用代码生成代码用代码生成代码，就是自己编写代码，按照自己的样板代码格式生成代码。

1.4. 如何减少样板代码？

样板代码(Boilerplate Code)具有很大的重复性，通常被认为是一种冗余而又不得不写的代码。其实不然，有些样板代码不能减少，只是我们还没有遇到合适的解决方案而已。通常情况下，我们可以通过以下几种方式减少样板代码：

1.4.1. 利用注解减少样板代码

比如，JavaBean模型类中的Getter/Setter就是样板代码，我们可以通过Lombok的@Getter/@Setter注解来减少这样的样板代码。

原始代码：

public class User {    private Long id;    ...    public Long getId() {        return id;    }    public void setId(Long id) {        this.id = id;    }    ...}

优化代码：

@Getter@Setterpublic class User {    private Long id;    ...}

1.4.2. 利用框架减少样板代码

比如，MyBatis 是一款优秀的持久层框架，封装了获取数据库连接和声明、设置参数、获取结果集等所有JDBC操作。MyBatis 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO（Plain Old Java Objects，普通老式 Java 对象）为数据库中的记录。

原始代码：

/** 查询公司员工 */public List< EmployeeDO> queryEmployee(Long companyId) {    try (Connection connection = tddlDataSource.getConnection();        PreparedStatement statement = connection.prepareStatement(QUERY_EMPLOYEE_SQL)) {        statement.setLong(1, companyId);        try (ResultSet result = statement.executeQuery()) {            List< EmployeeDO> employeeList = new ArrayList<>();            while (result.next()) {                EmployeeDO employee = new EmployeeDO();                employee.setId(result.getLong(1));                employee.setName(result.getString(2));                ...                employeeList.add(employee);            }            return employeeList;        }    } catch (SQLException e) {        String message = String.format("查询公司(%s)用户异常", companyId);        log.error(message, e);        throw new ExampleException(message, e);    }}

优化代码：

UserDAO.java：

@Mapperpublic interface UserDAO {    List< EmployeeDO> queryEmployee(@Param("companyId") Long companyId);}

UserDAO.xml：

< mapper namespace="com.example.repository.UserDAO">    < select id="queryEmployee" resultType="com.example.repository.UserDO">        select id        , name        ...        from t_user        where company_id = #{companyId}    < /select>< /mapper>

1.4.3. 利用设计模式减少样板代码

利用设计模式，可以把一些重复性代码进行封装。比如，上面的读取文件行模式代码，就可以用模板方法进行封装。

原始代码：

try (BufferedReader reader = new BufferedReader(new FileReader(fileName))) {    String line;    while (Objects.nonNull(line = reader.readLine())) {        // 处理一行        ...    }} catch (IOException e) {    String message = String.format("读取文件(%s)异常", fileName);    log.error(message, e);    throw new ExampleException(message, e);}

优化代码：

/** 定义方法 */public static void readLine(String fileName, Consumer< String> lineConsumer) {    try (BufferedReader reader = new BufferedReader(new FileReader(fileName))) {        String line;        while (Objects.nonNull(line = reader.readLine())) {            lineConsumer.accept(line);        }    } catch (IOException e) {        String message = String.format("读取文件(%s)异常", fileName);        log.error(message, e);        throw new ExampleException(message, e);    }}// 使用代码readLine("example.txt", line -> {    // 处理一行    ...});

1.5. 消灭不了的样板代码

如果样板代码可以被消灭，那么世界上就不存在样板代码了。即便是上一节提供的减少样板代码方法，也不能完全的消灭样板代码，因为这些样板代码依旧存在于框架和模式的实现中。所以，样板代码是消灭不了的。

既然不能消灭样板代码，那就应该合理地利用样板代码。提炼一段样板代码，若只用二三次，未为简便；若用数十百千次，则极为神速。下面，列举了几种常见Java的样板代码，描述了样板代码在日常编程中如何提炼和使用。

2. 定义工具类

2.1. 常用定义方式

通常，我们会如下定义工具类：

/** 例子工具类 */public class ExampleHelper {    /** 常量值 */    public final static int CONST_VALUE = 123;    /** 求和方法 */    public static int sum(int a, int b) {        return a + b;    }}

2.2. 存在一些问题

2.2.1. 修饰符顺序不规范

通过SonarLint插件扫描，会出现以下问题：

Java语言规范建议使用”static final”，而不是”final static”。请记住这么一条规则：静态常量，静态（static）在前，常量（final）在后。

2.2.2. 工具类可以被继承覆盖

如果我们定义一个MyExampleHelper来继承ExampleHelper：

public class MyExampleHelper extends ExampleHelper {    /** 常量值 */    public static final int CONST_VALUE = 321;    /** 求和方法 */    public static int sum(int a, int b) {        return a * b;    }}

会发现，MyExampleHelper会对ExampleHelper中的常量和方法进行覆盖，导致我们不知道是不是使用了ExampleHelper中的常量和方法。

对于Apache提供的工具类，很多同学都喜欢定义相同名称的工具类，并让这个工具类继承Apache的工具类，并在这个类中添加自己的实现方法。其实，我是非常不推荐这种做法的，因为你不知道——你调用的是Apache工具类提供的常量和方法，还是被覆盖的常量和方法。最好的办法，就是对工具类添加final关键字，让这个工具类不能被继承和覆盖。

2.2.3. 工具类可以被实例化

对于ExampleHelper工具类，我们可以这样使用：

int value = ExampleHelper.CONST_VALUE;int sum = ExampleHelper.sum(1, 2);

也可以被这样使用：

ExampleHelper exampleHelper = new ExampleHelper();int value = exampleHelper.CONST_VALUE;int sum = exampleHelper.sum(1, 2);

对于工具类来说，没有必要进行实例化。所以，我们建议添加私有构造方法，并在方法中抛出
UnsupportedOperationException（不支持的操作异常）。

2.3. 最佳定义方式

根据以上存在问题及其解决方法，最佳定义的ExampleHelper工具类如下：

/** 例子工具类 */public final class ExampleHelper {    /** 常量值 */    public static final int CONST_VALUE = 123;    /** 构造方法 */    private ExampleHelper() {        throw new UnsupportedOperationException();    }    /** 求和方法 */    public static int sum(int a, int b) {        return a + b;    }}

3. 定义枚举类

3.1. 常用定义方式

通常，我们会如下定义枚举类：

/** 例子枚举类 */public enum ExampleEnum {    /** 枚举相关 */    ONE(1, "one(1)"),    TWO(2, "two(2)"),    THREE(3, "two(3)");    /** 属性相关 */    private Integer value;    private String desc;    /** 构造方法 */    private ExampleEnum(Integer value, String desc) {        this.value = value;        this.desc = desc;    }    /** 获取取值 */    public Integer getValue() {        return value;    }    /** 获取描述 */    public String getDesc() {        return desc;    }}

3.2. 一些优化建议

3.2.1. 修饰符private可缺省

通过SonarLint插件扫描，会出现以下问题：

根据建议，应该删除构造方法前多余的private修饰符。

3.2.2. 建议使用基础类型

用包装类型Integer保存枚举取值，本身并没有什么问题。但是，本着能用基础类型就用基础类型的规则，所以建议使用基础类型int。

3.2.3. 建议使用final字段

假设，我们要实现一个静态方法，可能一不小心就把枚举值给修改了：

/** 修改取值 */public static void modifyValue() {    for (ExampleEnum value : values()) {        value.value++;    }}

如果调用了modifyValue方法，就会把枚举值修改，导致应用程序出错。为了避免这样的情况出现，我们建议对字段添加final修饰符，从而避免字段值被恶意篡改。

3.3. 最佳定义方式