代码重构:代码的坏味道

简介:

原文如下:

1. [代码]students.xml     

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
<? xml version = "1.0" ?>
< students >
     < student >
         < name >John</ name >
         < grade >B</ grade >
         < age >12</ age >
     </ student >
     < student >
         < name >Mary</ name >
         < grade >A</ grade >
         < age >11</ age >
     </ student >
     < student >
         < name >Simon</ name >
         < grade >A</ grade >
         < age >18</ age >
     </ student >
</ students >

2. [代码]XMLParser.java     

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
package net.viralpatel.java.xmlparser;
   
import java.io.File;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
   
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
    
public class XMLParser {
    
     public void getAllUserNames(String fileName) {
         try {
             DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
             DocumentBuilder db = dbf.newDocumentBuilder();
             File file = new File(fileName);
             if (file.exists()) {
                 Document doc = db.parse(file);
                 Element docEle = doc.getDocumentElement();
    
                 // Print root element of the document
                 System.out.println( "Root element of the document: "
                         + docEle.getNodeName());
    
                 NodeList studentList = docEle.getElementsByTagName( "student" );
    
                 // Print total student elements in document
                 System.out.println( "Total students: " + studentList.getLength());
 
                 if (studentList != null && studentList.getLength() > 0 ) {
                     for ( int i = 0 ; i < studentList.getLength(); i++) {
   
                         Node node = studentList.item(i);
    
                         if (node.getNodeType() == Node.ELEMENT_NODE) {
    
                             System.out.println( "=====================" );
 
                             Element e = (Element) node;
                             NodeList nodeList = e.getElementsByTagName( "name" );
                             System.out.println( "Name: "
                                     + nodeList.item( 0 ).getChildNodes().item( 0 )
                                             .getNodeValue());
   
                             nodeList = e.getElementsByTagName( "grade" );
                             System.out.println( "Grade: "
                                     + nodeList.item( 0 ).getChildNodes().item( 0 )
                                             .getNodeValue());
    
                             nodeList = e.getElementsByTagName( "age" );
                             System.out.println( "Age: "
                                     + nodeList.item( 0 ).getChildNodes().item( 0 )
                                             .getNodeValue());
                         }
                     }
                 } else {
                     System.exit( 1 );
                 }
             }
         } catch (Exception e) {
             System.out.println(e);
         }
     }
     public static void main(String[] args) {
  
         XMLParser parser = new XMLParser();
         parser.getAllUserNames( "c:\\students.xml" );
     }
}

类中存在的问题有:

1.类名起得不好--给人的感觉你这个解析的类,结果是个测试解析的类 
2.方法名起得不好--给人的感觉是有返回值的,结果是个没有返回值的 
3.方法内容写得太乱,把解析及数据获取啥的都放在一个方法里了。 
4.代码逻辑性不好,前面写了System.out.println("Total students: "  + studentList.getLength());后面还在写studentList != null,如果前面不出异常,这里就没有用;如果前面出异常,这里检查点根本就过不来。 
5.中间用了System.exit,显然这不是一个好的处理,人家调你个参数,你给悄无声息的把整个应用停止了。 
6.代码重复率太高 

?
1
2
3
4
5
6
7
8
9
10
11
12
13
NodeList nodeList = e.getElementsByTagName( "name" );
 
                             System.out.println( "Name: "
                                     + nodeList.item( 0 ).getChildNodes().item( 0 )
                                             .getNodeValue());
                             nodeList = e.getElementsByTagName( "grade" );
                             System.out.println( "Grade: "
                                     + nodeList.item( 0 ).getChildNodes().item( 0 )
                                             .getNodeValue());
                             nodeList = e.getElementsByTagName( "age" );
                             System.out.println( "Age: "
                                     + nodeList.item( 0 ).getChildNodes().item( 0 )
                                             .getNodeValue());

这个太难看了。 

小结:这段代码把许多不良编程习惯都带出来了。

当然也可能是@老枪 当时只是随便写写的。

当然有人或许会问,你怎么写?换我写,我的写法是这样的,当然类名我这里只是用来测试一下,因此写个TestXmlParser ,实际上应该是两个类的:一个功能类,一个测试的类:

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
public class TestXmlParser {
     public static void main(String[] args) throws Throwable {
         File file = new File( "E:/test/students.xml " );
         XmlStringParser parser = new XmlStringParser();
         XmlDocument document = parser.parse(IOUtils.readFromInputStream(
                 new FileInputStream(file), "utf-8" ));
         printStudents(document.getRoot());
     }
     private static void printStudents(XmlNode studentsNode) {
         for (XmlNode studentNode:studentsNode.getSubNodes( "student" )){
             printStuent(studentNode);
         }
     }
     private static void printStuent(XmlNode studentNode) {
         printSubTagByName(studentNode, "name" );
         printSubTagByName(studentNode, "grade" );
         printSubTagByName(studentNode, "age" );
     }
     private static void printSubTagByName(XmlNode studentNode,String tagName) {
         System.out.println( studentNode.getSubNode(tagName).getContent());
     }
}

当然了,上面没有做边界检查,仅是为了说明例子而已,但是执行结果与@老枪 的是一样的。。


相关文章
|
3月前
|
设计模式 程序员
故意把代码写得很烂,这样的 “防御性编程“ 可取吗?
故意把代码写得很烂,这样的 “防御性编程“ 可取吗?
|
程序员 开发者
对程序员来说最重要的小事——整洁代码
对程序员来说最重要的小事——整洁代码
132 0
|
设计模式 测试技术
重构·改善既有代码的设计.02之代码的“坏味道”
之前在《重构·改善既有代码的设计.01》中初步了解了重构的基本前提,基础原则等入门知识。今天我们继续第二更......
207 1
重构·改善既有代码的设计.02之代码的“坏味道”
|
数据库
代码坏味道
代码坏味道
119 0
消除代码坏味道
读完本章的收获:代码规范、代码可读性、鲁棒性的代码好坏案例,写出好代码的能力。
消除代码坏味道
|
数据库
我又写了一堆烂代码
“我又写了一堆烂代码!” 这句话我经常对自己说,目的是为了督促自己不断地思考所写的代码是否足够可靠。
65 0
|
消息中间件 JavaScript 小程序
用1个月重构了同事写的烂代码,我总结出了15条重写烂代码的经验!
用1个月重构了同事写的烂代码,我总结出了15条重写烂代码的经验!
|
JSON Java 测试技术
如何写出让人抓狂的代码?
如何写出让人抓狂的代码?
如何写出让人抓狂的代码?
SonarQube的代码坏味道详解
SonarQube的代码坏味道
1480 0
|
Java 数据库 容器
项目重构,我是如何优化大量屎一样的 if else 代码的?
  目录:   if else策略模式1、首先抽象业务处理器2、将业务处理器和其支持处理的类型放到一个容器中,java里Map就是最常用的容器之一3、定义不同的处理器4、测试类   前段时间,我将公司系统中的批量审单的功能进行了重构,用到了java的并发编程进行异步化处理,数据库的乐观锁机制处理多线程并发更新数据。   其中批量审单的业务处理涉及到多种任务类型,对应不同的业务方法进行处理,比如转仓,转快递,添加赠品,删除赠品,拆分订单,批量驳回,批量作废等等,其中就用到了策略模式。
262 0