[关闭]
@iamfox 2016-10-09T07:40:22.000000Z 字数 5045 阅读 1652

业务代码重构示例

学习

1.反面示例

这是知识库模块，修改试卷的实现。

  1. //选择和修改试卷试题
  2.     public void ModifyKBQuestionnaire(ModifyKBQuestionCommand command) throws KBQuestionException, KBResourceException{
  3.         KBQuestionnaire kbQuestionnaire = (KBQuestionnaire) get(command.getQuestionnaireId());
  4.         if(kbQuestionnaire == null){
  5.             throw new KBResourceException(KBResourceException.ENTITY_NOT_FOUND, "试卷不存在");
  6.         }
  7.         List<String> addList = command.getAddQuestionIds();
  8.         List<String> delList = command.getDelQuestionIds();
  9.         System.out.println(addList.size());
  10.         System.out.println(delList.size());
  14.             String a=addList.get(0);
  15.              String[] b = a.split(",");
  16.              System.out.println(b.length);
  17.              if (StringUtils.isNotBlank(b[0])) {
  19.              for (int j = 0; j < b.length; j++) {
  21.                  KBQuestion kbQuestion = kbQuestionService.get(b[j]);
  22.                     if(kbQuestion == null){
  23.                         throw new KBQuestionException(KBQuestionException.ENTITY_NOT_FOUND, "问题不存在");
  24.                     }
  25.                     KBQuestionnaireAndQuestionLink link = new KBQuestionnaireAndQuestionLink();
  26.                     link.create(kbQuestion, kbQuestionnaire);
  27.                     kbQuestionnaire.addQuestionNum(1);
  28.                     update(kbQuestionnaire);
  29.                     save(link);
  30.             }
  32.         }           
  34.             String c=delList.get(0);
  35.              String[] d = c.split(",");
  37.                 System.out.println(d.length);
  38.              if (StringUtils.isNotBlank(d[0]) ){
  41.              for (int j = 0; j < d.length; j++) {
  43.                  System.out.println(d[j]);
  44.                  KBQuestionQO kbQuestionQO=new KBQuestionQO();
  45.                  kbQuestionQO.setId(d[j]);
  46.                  KBQuestionnaireAndQuestionLinkQO kbQuestionnaireAndQuestionLinkQO=new KBQuestionnaireAndQuestionLinkQO();
  48.                  kbQuestionnaireAndQuestionLinkQO.setKbQuestionQO(kbQuestionQO);
  49.                  KBQuestionnaireAndQuestionLink link=kbQuestionnaireAndQuestionLinkService.queryUnique(kbQuestionnaireAndQuestionLinkQO);
  50.                     if(link != null){
  52.                         kbQuestionnaireAndQuestionLinkService.deleteById(link.getId());
  53.                         kbQuestionnaire.delQuestionNum(1);
  54.                         update(kbQuestionnaire);
  55.                     }
  61.         }}
  62.     }
  1. /**
  2.  * 修改试卷题目
  3.  */
  4. public class ModifyKBQuestionCommand extends BaseCommand {
  6.     private List<String> addQuestionIds;//问题id
  7.     private List<String> delQuestionIds;//问题id
  9.     private String questionnaireId;//试卷id
  10.     public List<String> getAddQuestionIds() {
  11.         return addQuestionIds;
  12.     }
  14.     public void setAddQuestionIds(List<String> addQuestionIds) {
  15.         this.addQuestionIds = addQuestionIds;
  16.     }
  18.     public List<String> getDelQuestionIds() {
  19.         return delQuestionIds;
  20.     }
  22.     public void setDelQuestionIds(List<String> delQuestionIds) {
  23.         this.delQuestionIds = delQuestionIds;
  24.     }
  30.     public String getQuestionnaireId() {
  31.         return questionnaireId;
  32.     }
  34.     public void setQuestionnaireId(String questionnaireId) {
  35.         this.questionnaireId = questionnaireId;
  36.     }

2.存在问题

  1. 方法名没有小写开头，基本规范。
  2. 修改KBQuestionnaire没在KBQuestionnareService操作而是写进了KBResourceService
  3. command表达和方法名不匹配。command是修改问题，方法实现的是修改试卷。
  4. system.out过多没有清理。
  5. 无意义的变量命名a b c d j，毫无可读性。
  6. 字符串切割split不属于业务逻辑，在外层做好转换再进来，影响逻辑阅读。
  7. 循环执行update(kbQuestionnaire);没有意义，如果不是hibernate自动优化这里update sql语句已经泛滥了。
  8. 在循环里一条一条按id查实体。要用in查询一次性查完，不要循环产生大量sql。
  9. 没有格式化代码，空格空行混乱。容易引起git冲突。
  10. command字段顺序和注释混乱，可读性差。

再次强调：
- 代码写给人看比跑起来更重要，不要为了省几秒钟时间随意乱写!节省的时间最后会在调试和扩展时十倍几十倍耗掉。
- 代码混乱一般不是因为逻辑复杂，也和技术水平无关，先规划，不要想到哪写到哪。

3.重构

3-1.调整command

要修改的command，实体id是最重要的参数，放最上面。变量名和注释都要表达准确含义。少用缩略英文写法，每个人缩略习惯不一样，大多数缩略只会降低整体阅读效率。

  1. /**
  2.  * 修改试卷题目
  3.  */
  4. @SuppressWarnings("serial")
  5. public class ModifyKBQuestionnaireCommand extends BaseCommand {
  7.     private String questionnaireId;// 试卷id
  9.     private List<String> addQuestionIds;// 要添加的问题id集合
  10.     private List<String> deleteQuestionIds;// 要删除的问题id集合
  12.     public List<String> getAddQuestionIds() {
  13.         return addQuestionIds;
  14.     }
  16.     public void setAddQuestionIds(List<String> addQuestionIds) {
  17.         this.addQuestionIds = addQuestionIds;
  18.     }
  20.     public List<String> getDeleteQuestionIds() {
  21.         return deleteQuestionIds;
  22.     }
  24.     public void setDeleteQuestionIds(List<String> deleteQuestionIds) {
  25.         this.deleteQuestionIds = deleteQuestionIds;
  26.     }
  28.     public String getQuestionnaireId() {
  29.         return questionnaireId;
  30.     }
  32.     public void setQuestionnaireId(String questionnaireId) {
  33.         this.questionnaireId = questionnaireId;
  34.     }
  36. }

3-2.先写注释

  1. public void modifyKBQuestionnaire(ModifyKBQuestionnaireCommand command) throws KBResourceException {
  3.         // 查出要修改的试卷
  5.         // 查出要添加的全部问题
  7.         // 遍历问题逐个创建和试卷的关联
  9.         // 查出要删除的全部试卷问题关联
  11.         // 循环删除关联
  13.         // 保存更新试卷问题数量统计
  14.     }

整个方法其实就几大步骤，用注释规划好步骤。

3-3.填充代码

  1.  public void modifyKBQuestionnaire(ModifyKBQuestionnaireCommand command) throws KBResourceException {
  3.         // 查出要修改的试卷
  4.         KBQuestionnaire questionnaire = get(command.getQuestionnaireId());
  5.         if (questionnaire == null) {
  6.             throw new KBResourceException(KBResourceException.ENTITY_NOT_FOUND, "试卷不存在");
  7.         }
  9.         // 查出要添加的全部问题
  10.         KBQuestionQO questionQO = new KBQuestionQO();
  11.         questionQO.setIds(new ArrayList<String>());
  13.         for (String addQuestionId : command.getAddQuestionIds()) {
  14.             questionQO.getIds().add(addQuestionId);
  15.         }
  17.         List<KBQuestion> questions = questionService.queryList(questionQO);
  19.         //  遍历问题逐个创建和试卷的关联
  20.         for (KBQuestion question : questions) {
  21.             KBQuestionnaireAndQuestionLink link = new KBQuestionnaireAndQuestionLink();
  22.             link.create(question, questionnaire);
  23.             save(link);
  25.             questionnaire.addQuestionNum(1);
  26.         }
  28.         // 查出要删除的试卷和问题关联
  29.         KBQuestionnaireAndQuestionLinkQO linkQO = new KBQuestionnaireAndQuestionLinkQO();
  30.         linkQO.setKbQuestionQO(new KBQuestionQO());
  31.         linkQO.getKbQuestionQO().setIds(new ArrayList<String>());
  33.         for (String deleteQuestionId : command.getDeleteQuestionIds()) {
  34.             linkQO.getKbQuestionQO().getIds().add(deleteQuestionId);
  35.         }
  37.         List<KBQuestionnaireAndQuestionLink> links = kbQuestionnaireAndQuestionLinkService.queryList(linkQO);
  39.         //  循环删除关联
  40.         for (KBQuestionnaireAndQuestionLink link : links) {
  41.             kbQuestionnaireAndQuestionLinkService.delete(link);
  43.             questionnaire.addQuestionNum(-1);
  44.         }
  46.         //  更新试卷问题计数
  47.         update(questionnaire);
  48.     }
添加新批注
在作者公开此批注前，只有你和作者可见。
回复批注