后端思维专栏：通过层层代码去重，我又搞了一个通用模板

来源：捡田螺的小男孩

后端思维

大家好,我是田螺。

最近工作中,我通过层层优化重复代码,最后抽出个通用模板.因此跟大家分享一下优化以及思考的过程。我会先造一个相似的例子,然后一步步带大家如何优化哈,看完一定会有帮助的。

• 优化前的例子
• 第一步优化：抽取公用方法
• 第二步优化：反射对比字段
• 第三步优化：泛型+ lambda函数式
• 第四步优化：继承多态
• 第五步优化：模板方法成型
• 大功告成:  策略模式+工厂模式+模板方法模式

1. 优化前的例子

在这里,我先给大家模拟一个业务场景哈,并给出些简化版的代码

假设你有个对账需求:你要把文件服务器中,两个A、B不同端，上送的余额明细和转账明细,下载下来,对比每个字段是否一致.

明细和余额的对比类似,代码整体流程:

• 读取A、B端文件到内存的两个list
• 两个list通过某个唯一key转化为map
• 两个map字段逐个对比

我们先看明细对比哈，可以写出类似酱紫的代码:

//对比明细
private void checkDetail(String detailPathOfA,String detailPathOfB )throws IOException{

   //读取A端的文件
   List<DetailDTO> resultListOfA = new ArrayList<>();
   try (BufferedReader reader1 = new BufferedReader(new FileReader(detailPathOfA))) {
            String line;
            while ((line = reader1.readLine()) != null) { 
                resultListOfA.add(DetailDTO.convert(line));
            }
        }
    
   //读取B端的文件
   List<DetailDTO> resultListOfB = new ArrayList<>();
   try (BufferedReader reader1 = new BufferedReader(new FileReader(detailPathOfB))) {
            String line;
            while ((line = reader1.readLine()) != null) { 
                resultListOfB.add(DetailDTO.convert(line));
            }
        }
    
    //A列表转化为Map
    Map<String,DetailDTO> resultMapOfA = new HashMap<>();
    for(DetailDTO detail:resultListOfA){
        resultMapOfA.put(detail.getBizSeq(),detail);
    }
    
     //B列表转化为Map
    Map<String,DetailDTO> resultMapOfB = new HashMap<>()
    for(DetailDTO detail:resultListOfB){
        resultMapOfB.put(detail.getBizSeq(),detail);
    }
    
    //明细逐个对比
    for (Map.Entry<String, DetailDTO> temp : resultMapOfA.entrySet()) {
        if (resultMapOfB.containsKey(temp.getKey())) {
            DetailDTO detailOfA = temp.getValue();
            DetailDTO detailOfB = resultMapOfB.get(temp.getKey());

            if (!detailOfA.getAmt().equals(detailOfB.getAmt())) {
                  log.warn("amt is different,key:{}", temp.getKey());
            }
            if (!detailOfA.getDate().equals(detailOfB.getDate())) {
                log.warn("date is different,key:{}", temp.getKey());
            }

            if (!detailOfA.getStatus().equals(detailOfB.getStatus())) {
                log.warn("status is different,key:{}", temp.getKey());
            }
            ......
        }
  }
}

2. 抽取公用方法去重

大家仔细看以上明细对比的例子,发现了重复代码:

我们可以抽取一个公用方法去优化它,比如抽取个读取文件的公用方法 readFile:

//对比明细
private void checkDetail(String detailPathOfA,String detailPathOfB )throws IOException{

   //读取A端的文件
    List<DetailDTO> resultListOfA = readFile(detailPathOfA);
   //读取B端的文件
   List<DetailDTO> resultListOfB = readFile(detailPathOfB);
   ......
}

//抽取公用方法
 private List<DetailDTO> readFile(String detailPath) throws IOException {
        List<DetailDTO> resultList = new ArrayList<>();
        try (BufferedReader reader1 = new BufferedReader(new FileReader(detailPath))) {
            String line;
            while ((line = reader1.readLine()) != null) {
                resultList.add(DetailDTO.convert(line));
            }
        }
        return resultList;
    }

同理，这块代码也是重复了:

我们也可以抽个公用方法:convertListToMap

//对比明细
private void checkDetail(String detailPathOfA,String detailPathOfB ){

   //读取A端的文件
    List<DetailDTO> resultListOfA = readFile(detailPathOfA);
   //读取B端的文件
   List<DetailDTO> resultListOfB = readFile(detailPathOfB);
   
   //A列表转化为Map
   Map<String,DetailDTO> resultMapOfA = convertListToMap(resultListOfA);
   //B列表转化为Map
   Map<String,DetailDTO> resultMapOfB = convertListToMap(resultListOfB);
   ......
}

//抽取公用方法
private Map<String,DetailDTO> convertListToMap(List<DetailDTO> list){
    Map<String,DetailDTO> map = new HashMap<>()
    for(DetailDTO detail:list){
        map.add(detail.getBizSeq(),detail);
    }
    return map;
}

通过抽取公用方法后，已经优雅很多啦~

3. 反射对比字段

我们再来看下字段对比的逻辑，如下：

以上代码会取两个对象的每个字段对比，如果明细对象的属性字段特别多的话，这块代码也会显得重复冗余。我们可以通过反射去对比两个对象的属性，如下：

  public static List<String> compareObjects(Object obj1, Object obj2) {
        List<String> list = new ArrayList<>();

        Class<?> clazz = obj1.getClass();
        Field[] fields = clazz.getDeclaredFields();

        for (Field field : fields) {
            String fieldName = field.getName();
            field.setAccessible(true);
            try {
                Object value1 = field.get(obj1);
                Object value2 = field.get(obj2);

                if ((value1 == null && value2 != null) || (value1 != null && !value1.equals(value2))) {
                    list.add(fieldName);
                }
            } catch (IllegalAccessException e) {
                e.printStackTrace();
            }
        }
        return list;
        }

有了这个反射对比方法，原来的代码就可以优化成这样啦，是不是优雅了很多:

//对比明细
private void checkDetail(String detailPathOfA,String detailPathOfB ){

   //读取A端的文件
    List<DetailDTO> resultListOfA = readFile(detailPathOfA);
   //读取B端的文件
   List<DetailDTO> resultListOfB = readFile(detailPathOfB);
   
   //A列表转化为Map
   Map<String,DetailDTO> resultMapOfA = convertListToMap(resultListOfA);
   //B列表转化为Map
   Map<String,DetailDTO> resultMapOfB = convertListToMap(resultListOfB);
   
    //明细逐个对比
    for (Map.Entry<String, DetailDTO> temp : resultMapOfA) {
          if(resultMapOfB.containsKey(temp.getKey()){
             DetailDTO detailOfA = temp.getValue();
             DetailDTO detailOfB = resultMapOfB.get(temp.getKey());
             
             List<String> resultList=compareObjects(detailOfA,detailOfB);
             for(String temp:resultList){
                log.warn("{} is different,key:{}",temp,detailOfA.getKey()); 
             }
            ......
          }
      }
}

4.Lambda函数式+泛型

实现完明细文件的对比,我们还需要余额文件的对比:

同样的,也是先读取文件,如下:

//对比明细
private void checkBalance(String balancePathOfA,String balancePathOfB ){

   //读取A端的文件
   List<BalanceDTO> resultListOfA = new ArrayList<>();
   try (BufferedReader reader1 = new BufferedReader(new FileReader(balancePathOfA))) {
            String line;
            while ((line = reader1.readLine()) != null) { 
                resultListOfA.add(BalanceDTO.convert(line));
            }
        }
        
   List<DetailDTO> resultListOfB = new ArrayList<>();
   try (BufferedReader reader1 = new BufferedReader(new FileReader(detailPathOfB))) {
            String line;
            while ((line = reader1.readLine()) != null) { 
                resultListOfB.add(DetailDTO.convert(line));
            }
        }
    ......
    }

大家可以发现,读取余额文件和刚刚的读取明细文件很像,有一部分代码是重复的,但是不能直接一下子抽个共同函数出来:

对了,convert方法是酱紫的哈:

   public static BalanceDTO convert(String line){
        BalanceDTO dto = new BalanceDTO();
        String[] dataLine = line.split(",",-1);
        dto.setBalance(dataLine[1]);
        dto.setType(dataLine[2]);
        ......
        return dto;
    }

大家可以发现,就是一个返回类型,以及这个对应类型的一个静态convert方法不一致而已,如果是类型不一样,我们可以使用泛型替代,如果是一个小的静态方法不一致,我们则可以使用lambda函数式接口提取,因此可以抽这个这么一个公用方法吧:

public <T> List<T> readDataFromFile(String filePath, Function<String, T> converter) throws IOException {
    List<T> result = new ArrayList<>();
    try (BufferedReader reader = new BufferedReader(new FileReader(filePath))) {
        String line;
        while ((line = reader.readLine()) != null) { 
            result.add(converter.apply(line));
        }
    }
    return result;
}

//余额读取调用
List<BalanceDTO> resultListOfA = readDataFromFile(balancePathOfA, BalanceDTO::convert);
//明细读取调用
List<DetailDTO> resultList = readDataFromFile(detailPath, DetailDTO::convert);

平时我们用泛型+ Lambda表达式结合，去抽取公用方法，代码就显得高端大气很多，对吧~

5. 继承多态.

在余额对比文件中，读取完文件到内存后，我们需要把通过某个唯一key关联起来，即把List转为Map，如下：

//对比明细
private void checkBalance(String balancePathOfA,String balancePathOfB ){

  //读取A端的文件
  List<BalanceDTO> resultListOfA = readDataFromFile(balancePathOfA, BalanceDTO::convert);
   //读取B端的文件
  List<BalanceDTO> resultListOfB = readDataFromFile(balancePathOfB, BalanceDTO::convert);
   
  //A列表list转化为Map
  Map<String,BalanceDTO> resultMapOfA = new HashMap<>()
  for(BalanceDTO balance:resultListOfA){
    resultMapOfA.add(balance.getType()+balance.getAccountNo(),balance);
  }

一般来说，把两个list转化为Map，抽一个公用方法是不是就好了？比如说酱紫：

private Map<String,BalanceDTO> convertListToMap(List<BalanceDTO> list){
    Map<String,BalanceDTO> map = new HashMap<>()
    for(BalanceDTO balance:list){
        resultMapOfA.add(balance.getType()+balance.getAccountNo(),balance);
    }
    return map;
}

其实也行，但是其实可以更抽象一点。因为余额和明细对比都有list转map的需求，而且也是有共性的，只不过是转化map的key和value的类型不一致而已

我们仔细思考一下，value类型是不同类型（分别是BalanceDTO和DetailDTO），而key则是对应对象的一个或者某几个属性连接起来的。对于不同类型，我们可以考虑泛型。对于余额和明细对象不同的key的话，我们则可以考虑继承和多态，让它们实现同一个接口就好啦。

我们可以使用继承和多态，定义一个抽象类BaseKeyDTO，里面有个getKey的抽象方法,然后BalanceDTO 和DetailDTO都继承它，实现各自getKey的方法，如下：

public abstract class BaseDTO {
    abstract String getKey();
} 

public class BalanceDTO extends BaseDTO {
    @Override
    String getKey() {
        return type + accountNo;
    }
}

public class DetailDTO extends BaseDTO {
    @Override
    String getKey() {
        return bizSeq;
  }

最后，我们应用继承多态+扩展泛型（<T extends BaseDTO>），就可以把余额和明细对比的convertListToMap方法抽成一个啦:

    private static <T extends BaseDTO> Map<String, T> convertListToMap(List<T> list) {
        Map<String, T> map = new HashMap<>();
        for (T item : list) {
            map.put(item.getKey(), item);
        }
        return map;
    }

最后明细和余额对比，可以优化成这样，其实看起来已经比较优雅啦：

   //对比明细
    private void checkDetail(String detailPathOfA, String detailPathOfB) throws IOException {

        //读取A端明细的文件
        List<DetailDTO> resultListOfA = readDataFromFile(detailPathOfA, DetailDTO::convert);
        //读取B端明细的文件
        List<DetailDTO> resultListOfB = readDataFromFile(detailPathOfB, DetailDTO::convert);

        //A列表转化为Map
        Map<String, DetailDTO> resultMapOfA = convertListToMap(resultListOfA);
        //B列表转化为Map
        Map<String, DetailDTO> resultMapOfB = convertListToMap(resultListOfB);

        //明细逐个对比
        compareDifferent(resultMapOfA,resultMapOfB);
    }
    

   //对比余额
    private void checkBalance(String balancePathOfA,String detailPathOfB) throws IOException {

        //读取A端余额的文件
        List<BalanceDTO> resultListOfA = readDataFromFile(balancePathOfA,BalanceDTO::convert);
        //读取B端余额的文件
        List<BalanceDTO> resultListOfB = readDataFromFile(detailPathOfB,BalanceDTO::convert);

        //A余额列表转化为Map
        Map<String,BalanceDTO> resultMapOfA = convertListToMap(resultListOfA);
        //B余额列表转化为Map
        Map<String,BalanceDTO> resultMapOfB = convertListToMap(resultListOfB);

        //余额逐个对比
        compareDifferent(resultMapOfA,resultMapOfB);
    }
    
    //对比也用泛型，抽一个公用的方法哈
    private void compareDifferent(Map<String, T> mapA, Map<String, T> mapB) {
        for (Map.Entry<String, T> temp : mapA.entrySet()) {
            if (mapB.containsKey(temp.getKey())) {
                T dtoA = temp.getValue();
                T dtoB = mapB.get(temp.getKey());

                List<String> resultList = compareObjects(dtoA, dtoB);
                for (String tempStr : resultList) {
                    log.warn("{} is different,key:{}", tempStr, dtoA.getKey());
                }
            }
        }
    }
}

6. 模板方法

大家回头细看，可以发现不管是明细还是余额对比，两个方法很像，都是一个骨架流程来的：

• 读取A、B端文件到内存的两个list
• 两个list通过某个唯一key转化为map
• 两个map字段逐个对比

大家先回想一下模板方法模式：

定义了一个算法的骨架，将一些步骤延迟到子类中实现。这有助于避免在不同类中重复编写相似的代码。

顿时是不是就觉得这块代码还有优化空间~~

6.1 定义对比模板的骨架

我们可以尝试这两块代码再合并，用模板方法优化它。我们先定义一个模板，然后模板内定义它们骨架的流程，如下:

//声明对比抽象模板
public abstract class AbstractCheckTemplate<T extends BaseDTO> {

    public void checkTemplate(String filePathA, String filePathB) throws IOException {

        //从文件读取为List
        readDataFromFile(filePathA, filePathB);
        //list转化为Map
        covertListToMap(resultListOfA, resultListOfB);
        //比较
        compareDifferent(mapA, mapB);
    }

6.2 模板的方法逐步细化

因为readDataFromFile需要输出两个list，所以我们可以定义返回类型为Pair，代码如下：

    private Pair<List<T>, List<T>> readDataFromFile(String filePathA, String filePathB, Function<String, T> converter) throws IOException {
        //读取A端余额的文件
        List<T> resultListOfA = readDataFromFile(filePathA, converter);
        //读取B端余额的文件
        List<T> resultListOfB = readDataFromFile(filePathB, converter);
        return new Pair<>(resultListOfA, resultListOfB);
    }

又因为这个函数式的转化，是不同子类才能定下来的，我们就可以声明个抽象方法convertLineToDTD，让子类去实现。因此模板就变成这样啦：

public abstract class AbstractCheckTemplate<T extends BaseDTO> {

    public void checkTemplate(String filePathA, String filePathB) throws IOException {

        //从文件读取为List
        Pair<List<T>, List<T>> resultListPair = readDataFromFile(filePathA, filePathB, this::convertLineToDTD);
        List<T> resultListOfA = resultListPair.getKey();
        List<T> resultListOfB = resultListPair.getValue();

        //list转化为Map
        covertListToMap(resultListOfA, resultListOfB);
        //比较
        compareDifferent(mapA, mapB);
    }
    
    //延迟到子类实现转换为不同的DTO
    protected abstract T convertLineToDTD(String line);

同理，还有两个list转化为两个map再对比，我们可以声明为这样：

    private Pair<Map<String, T>, Map<String, T>> covertListToMap(List<T> listA, List<T> listB) {
        return new Pair<>(convertListToMap(listA), convertListToMap(listB));
    }

因此最终模板就是这样啦：

@Slf4j
public abstract class AbstractCheckTemplate<T extends BaseDTO> {

    public void checkTemplate(String filePathA, String filePathB) throws IOException {

        //从文件读取为List
        Pair<List<T>, List<T>> resultListPair = readDataFromFile(filePathA, filePathB, this::convertLineToDTD);
        List<T> resultListOfA = resultListPair.getKey();
        List<T> resultListOfB = resultListPair.getValue();

        //list转化为Map
        Pair<Map<String, T>, Map<String, T>> resultMapPair = covertListToMap(resultListOfA, resultListOfB);
        Map<String, T> mapA = resultMapPair.getKey();
        Map<String, T> mapB = resultMapPair.getValue();

        //比较
        compareDifferent(mapA, mapB);
    }
    
    protected abstract T convertLineToDTD(String line);
    ......此处省略公用的私有方法
}

6.3 不同对比子类

如果你是余额对比，那你声明一个CheckBalanceStrategyServiceImpl去继承抽象模板

/**
 * 余额对比策略
 * 公众号: 捡田螺的小男孩
 */
@Service
public class CheckBalanceStrategyServiceImpl extends AbstractCheckTemplate<BalanceDTO> {

    @Override
    protected BalanceDTO convertLineToDTD(String line) {
        return BalanceDTO.convert(line);
    }
}

如果你是明细对比，那你声明一个CheckDetailStrategyServiceImpl去继承抽象模板

/**
 * 明细对比策略
 * 关注公众号: 捡田螺的小男孩
 */
@Service
public class CheckDetailStrategyServiceImpl extends AbstractCheckTemplate<DetailDTO> {
    @Override
    protected DetailDTO convertLineToDTD(String line) {
        return DetailDTO.convert(line);
    }
}

这两个不同的子类，就像不同的策略，我们应该都能嗅到策略模式的味道啦~

7. 工厂模式+ 模板方法 + 策略模式全家桶

有了明细对比、余额对比的模板，为了更方便调用，我们还可以定义一个校验策略接口，然后交给spring工厂类，这样更方便调用。其实日常开发中，这三种设计模式一般一起出现，非常实用:

我们先声明一个校验ICheckStrategy接口:

/**
 * 关注公众号: 捡田螺的小男孩
 */
public interface ICheckStrategy {

    /**
     * 对比校验逻辑
     * @param filePathA
     * @param filePathB
     * @throws IOException
     */
    void check(String filePathA, String filePathB) throws IOException;

    /**
     * 校验的类型，明细/余额
     * @return
     */
    CheckEnum getCheckEnum();
}

然后模板AbstractCheckTemplate实现ICheckStrategy接口

public abstract class AbstractCheckTemplate<T extends BaseDTO> implements ICheckStrategy {

接着，不同对比策略类CheckDetailStrategyServiceImpl 和CheckDetailStrategyServiceImpl映射对应的对比校验类型:

/**
 * 明细对比策略
 * 关注公众号: 捡田螺的小男孩
 */
@Service
public class CheckDetailStrategyServiceImpl extends AbstractCheckTemplate<DetailDTO> {

     @Override
    protected DetailDTO convertLineToDTD(String line) {
        return DetailDTO.convert(line);
    }
  
    @Override
    public void check(String filePathA, String filePathB) throws IOException {
        checkTemplate(filePathA, filePathB);
    }

    //对比校验类型为：明细
    @Override
    public CheckEnum getCheckEnum() {
        return CheckEnum.DETAIL_CHECK;
    }
}

/**
 * 余额对比策略
 * 关注公众号: 捡田螺的小男孩
 */
@Service
public class CheckBalanceStrategyServiceImpl extends AbstractCheckTemplate<BalanceDTO> {

    @Override
    public void check(String filePathA, String filePathB) throws IOException {
        checkTemplate(filePathA, filePathB);
    }
     //对比校验类型为：余额
    @Override
    public CheckEnum getCheckEnum() {
        return CheckEnum.BALANCE_CHECK;
    }

    @Override
    protected BalanceDTO convertLineToDTD(String line) {
        return BalanceDTO.convert(line);
    }
}

最后一步，我们借助spring的生命周期，使用ApplicationContextAware接口，把对用的策略，初始化到map里面。然后对外提供checkCompare方法即可。让调用者决定用哪一种对比，其实这算工厂模式思想，大家可以自己思考一下~

@Component
public class CheckCompareFactory implements ApplicationContextAware {

    private final Map<CheckEnum, ICheckStrategy> checkStrategyMap = new ConcurrentHashMap<>();
    
    //把不同策略放到map
    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        Map<String, ICheckStrategy> tmepMap = applicationContext.getBeansOfType(ICheckStrategy.class);
        tmepMap.values().forEach(strategyService -> checkStrategyMap.put(strategyService.getCheckEnum(), strategyService));
    }

    /**
     * 直接调用这个方法即可
     */
    public void checkCompare(CheckEnum checkEnum, String filePathA, String filePathB) throws IOException {
        ICheckStrategy checkStrategy = checkStrategyMap.get(checkEnum);
        checkStrategy.check(filePathA, filePathB);
    }
}

最后

我是捡田螺的小男孩。本文介绍了：如何将一些通用的、用于优化重复冗余代码的技巧应用到开发中。最终，我通过这些技巧将代码优化成一个通用模板。很有实践的意义~