消除ifelse/switch语句块来聚合模型的设计与实现

    写在最前头的话:请不要理解为不再需要if-else/switch。写在最前头的结论:使用Enum。

 

1, 前言

     if/switch这样的分支语句在实际开发中的使用自然是不可避免，但是我们必须承认使用这种分支判断语句实现的代码不仅可读性差(转来转去的绕晕)，而且维护代价极高。导致维护代价上升，个人认为地并不是说是由于在开发软件时，开发人员基础不够好或者问题考虑不周全导致的各种漏洞和缺陷，主要原因是没有很好的遵循我们听烂了的软件开发基本原则-高内聚低耦合。在业务系统的开发过程中，大多业务需求都不可能是完全在一条分支完成的，而如果系统核心业务是要完成多个渠道、机构或者系统的对接，这时候应该怎么设计业务系统使得业务逻辑高度聚合呢？初始拿到这个需求的时候，脑子里可能会这样一个换面：你手持if/switch牧羊棍，驱使着千万头草尼玛。既然你的核心业务是要对接多个系统、而这些系统又是异构的，没有统一规范，if/switch是可以解决你的问题，但是它们很可能把你引入一个混乱的系统，因为它们已经把你的业务逻辑散落各处，到后面你的任何一个修改都可能是牵一发而动全身。

    文字表述费劲、也不能具体说明问题，下面还是show my code吧。

 

2，问题描述

   在这儿，设定一个业务场景。假定要开发一套对接渠道和交易所(或银行或登记结算中心，无论是渠道还是交易所都可以统一抽象为机构)的清算系统，对于清算系统的业务功能，具体可以拿我们大家都熟悉的支付宝这样的第三方支付为例来说明。渠道指的就是使用支付宝作为支付的商家，商家每天或者固定一个周期，会生成在其名下的交易流水信息文件(文件在不同场景的清算系统里文件种类多样)，并将这些流水信息文件发给支付宝，然后支付宝接收并处理渠道端发送过来的流水信息文件，同时支付宝也要和背后的真正的资金管理方(银行)进行相关的文件交互（这里通常是和多家银行，每家银行有各自不同的文件交互规范）。因此，在这个清算系统里，一个问题是解决各类渠道和各个银行之间的文件交互问题(作为第三方系统，通常你无法让所有接入方都遵照你的一套规范来做)。抛开一些文件交互的实现细节问题，我们从业务角度分析其中的基本问题：文件类型多样、文件命名各异、文件存放路径各异。然后假定和交易所交互的文件模式形如transaction_000_product_(\d{8})_(\d{3}).req.txt(多类文件中的一类)，和渠道交互的文件模式形如OFI_(\d{4})_8888_(\d{8}).TXT(多类文件中的一类)。

 

  于是很可能会有如下代码场景:

/**
* 根据机构给定文件名模式，按照批次日期生成对应机构的交互文件名
* @param institution
* @param fileNamePattern
* @param batchDate
*/
public String fetchFileName(String institution, String fileNamePattern, Date batchDate) {
        String fileName = null;
        if(institution.equal("TA")) {
            //交易所文件,8位日期,3位批次号
            String fileKeyPatternWithDate = String
                    .format(fileKeyPattern.replace("(\\d{8})", "%1$tY%1$tm%1$td"), new Date());
            int seq = sequenceDAO.fetchSequence(fileKeyPatternWithDate);
            fileName = fileKeyPatternWithDate.replace("(\\d{3})", String.format("%03d", seq));
            fileName = fileName.substring(fileName.lastIndexOf(File.separator)+1);
        } else if(institution.equal("Com")){
            //渠道文件,8位日期,4位渠道号
            fileName = String.format(fileKeyPattern.replace("(\\d{8})", "%1$tY%1$tm%1$td"), new Date());
            fileName.replace("(\\d{4})", InstitutionCode.Com.code());
        }
        return fileName;
}
 
/**
 * 可能有各种原因，公司没有为所有应用部署集中的ftp服务器或者纯粹只是建立一个临时方案，导致你需要针对不同的机构配置不同的ftp交互策略。
 * 于是你可能有如下两个获取ftp download和upload目录的方法。
*/
public String getDownloadFileDir(String institution, Date batchDate){
   String date = new SimpleDateFormat("yyyyMMdd").format(batchDate);
   //sftpBaseDir是使用map存放的关于各个机构交互文件的sftp父级目录
   if(institution.equal("TA")){
       return sftpBaseDir.get(institution) + "/" + date;
    } else if(institution.equal("Com")){
       return sftpBaseDir.get(institution) + "/download/" + date;
    }
  
   return null;
}
public String getUploadFileDir(String institution, Date batchDate){
   String date = new SimpleDateFormat("yyyyMMdd").format(batchDate);
   //sftpBaseDir是使用map存放的关于各个机构交互文件的sftp父级目录
   if(institution.equal("TA")){
       return sftpBaseDir.get(institution) + "/" + date;
    } else if(institution.equal("Com")){
       return sftpBaseDir.get(institution) + "/upload/" + date;
    }
    return null;
}
 
/**
* 由于文件模式固定,你的业务需求里很可能期望能通过对应机构的文件名就能推断该文件的一些详细信息.
*/
public InstitutionFile inferFileInfoByFilename(String institution, String filename){
 String filepattern = null;
 if(institution.equal("TA")){
　　String patterns[] = fileName.split("\\d{8}",2);
　　String tmpPattern = patterns[0] + "(\\d{8})" + patterns[1];
　　patterns = tmpPattern.split("\\d{3}[.]", 2);
　　filepattern = patterns[0] + "(\\d{3})." + patterns[1];
  } else if(institutuion.equal("Com")){
　　String patterns[] = fileName.split("\\d{8}", 2);
　　String tmpPattern = patterns[0] + "(\\d{8})" + patterns[1];
　　patterns = tmpPattern.split("\\d{4}", 2);
　　filepattern = patterns[0] + "(\\d{4})" + patterns[1];  
  }
  InstitutionFile institutionFile = institutionRepository.
         findFileByIdentity(institution.filePattern(file.getName()), institution);
  return institutionFile;
}

 代码段 1

  如从上面列举的零散代码片段来看，可读性非常差。到处都是令人厌烦的分支判断(接入机构增多之后，情况会更糟)，散落各处的业务处理规则和硬编码，完全没有拓展性可言。因此，我们有必要去认真地抽象和设计模型，使得业务逻辑更加聚合，代码更易维护和拓展。

 

3，抽象模型

图1 机构交互文件抽象模型

  图1展示的领域模型的核心是Institution，对应的实现是enum类。Institution中针对每一个机构都定义了一份系统唯一的单例对象，所以每一个Institution对象也有在IFile中定义的，自己独立的文件交互业务的空间。InstitutionFile是作为系统内所有相关的机构文件的顶层抽象。

 

4，代码重构

下面看一下Institution核心实现，代码实际也很简单，基本都是提取自代码片段1中的代码。

Institution.java

public enum Institution implements IInstitution, IFile {
 
    TA("交易所"){
        @Override
        public Type type() {
            return Type.TA;
        }
 
        @Override
        public String fileNameWithoutSeq(String filePattern, Date batchDate) {
            return String.format(filePattern.replace("(\\d{8})", "%1$tY%1$tm%1$td"), batchDate);
        }
 
        @Override
        public String filePattern(String fileName) {
            String patterns[] = fileName.split("\\d{8}",2);
            String filePattern = patterns[0] + "(\\d{8})" + patterns[1];
            patterns = filePattern.split("\\d{3}[.]", 2);
            return patterns[0] + "(\\d{3})." + patterns[1];
        }
 
        @Override
        public String downloadFilePath(String basePath, Date batchDate) {
            String date = new SimpleDateFormat("yyyyMMdd").format(batchDate);
            return basePath + "/" + date;
        }
 
        @Override
        public String uploadFilePath(String basePath, Date batchDate) {
            String date = new SimpleDateFormat("yyyyMMdd").format(batchDate);
            return basePath + "/" + date;
        }
 
        @Override
        public boolean multiBatch() {
            return true;
        }
 
        @Override
        public String fileNameWithSeq(String fileNamePatternWithDate, int seq) {
            if(!multiBatch())
                throw new UnsupportedOperationException("该机构不支持一天多批次文件");
            return fileNamePatternWithDate.replace("(\\d{3})", String.format("%03d", seq));
        }
    },
    Com("渠道") {
        @Override
        public Type type() {
            return Type.Channel;
        }
 
        @Override
        public String fileNameWithoutSeq(String filePattern, Date batchDate) {
            String fileKeyPatternWithDate = String.format(filePattern.replace("(\\d{8})", "%1$tY%1$tm%1$td"),
                    batchDate);
            return fileKeyPatternWithDate.replace("(\\d{4})", ChannelCode.typeOf(this).getCode());
        }
 
        @Override
        public String filePattern(String fileName) {
            String patterns[] = fileName.split("\\d{8}", 2);
            String filePattern = patterns[0] + "(\\d{8})" + patterns[1];
            patterns = filePattern.split("\\d{4}", 2);
            return patterns[0] + "(\\d{4})" + patterns[1];
        }
 
        @Override
        public String fileNameWithSeq(String fileNamePatternWithDate, int seq) {
            throw new UnsupportedOperationException("该机构不支持一天多批次文件");
        }
    };
 
    private String text;
    Institution(String text){
        this.text = text;
    }
    public String getText(){
        return this.text;
    }
    public String getAbbr(){
        return this.toString().toLowerCase();
    }
 
    @Override
    public Institution type() {
        return this;
    }
 
    @Override
    public InstitutionCode institutionCode() {
        return InstitutionCode.typeOf(this);
    }
 
    public static Institution codeOf(String institution){
        for(Institution ins : Institution.values()){
            if(ins.getAbbr().equals(institution.toLowerCase())){
                return ins;
            }
        }
        throw new IllegalArgumentException("不支持机构");
    }
 
    @Override
    public DateFormat fileNameDateFormat() {
        return new SimpleDateFormat("yyyyMMdd");
    }
 
    @Override
    public boolean multiBatch() {
        return false;
    }
 
    @Override
    public String downloadFilePath(String basePath, Date batchDate) {
        String date = new SimpleDateFormat("yyyyMMdd").format(batchDate);
        return basePath + "/download/" + date;
    }
 
    @Override
    public String uploadFilePath(String basePath, Date batchDate) {
        String date = new SimpleDateFormat("yyyyMMdd").format(batchDate);
        return basePath + "/upload/" + date;
    }
 
}

  在Institution.java中，工作就是针对文件交互业务的抽象IFile，实现了根据不同的Institution来配置相对应的独立或者共享的文件交互策略。

 

  最后，按照图1描述建立的领域模型，代码段1中的实现都将重构为对应的代码段2所示。对比代码片段1和2，重构后的代码变得更加简洁，我们也得到了聚合在一起的核心领域对象Institution。

public String fetchFileName(Institution institution, String fileKeyPattern, Date batchDate) {
    String fileNamePatternWithDate = institution.fileNameWithoutSeq(fileKeyPattern, batchDate);
    if(institution.multiBatch()) {
        int seq = sequenceDAO.fetchSequence(institution + File.separator + fileNamePatternWithDate);
        return institution.fileNameWithSeq(fileNamePatternWithDate, seq);
    }
    return fileNamePatternWithDate;
}
 
public String getUploadFileDir(Institution institution, Date batchDate){
    return institution.uploadFilePath(sftpBaseDir.get(institution.getAbbr()), batchDate);
}
public String getDownloadFileDir(Institution institution, Date batchDate){
    return institution.downloadFilePath(sftpBaseDir.get(institution.getAbbr()), batchDate);
}
 
public InstitutionFile inferFileInfoByFilename(Institution institution, String filename){
    InstitutionFile institutionFile = institutionRepository.
                findFileByIdentity(institution.filePattern(filename), institution);
    return institutionFile;
}

代码段 2