CleanCode笔记---对象和数据结构

CleanCode

更多内容详见:CleanCode笔记

数据抽象

先看两段代码,都是表示笛卡尔坐标系的一个点.

代码一:

public class Point{
    public double x;
    public double y;
}

代码二:

public interface Point{
    double getX();
    double getY();
    void setCartesian(double x, double y);
    double getR();
    double getTheta();
    void setPolar(double r, double theta);
}

你觉得哪个代码更好些?是不是代码二?

首先,代码一没有封装!

代码一中的x和y是完全暴露的,任何都可以直接访问和设置新的值.
代码二中加了一层封装,你只能通过get方法获取坐标值和set方法设置原子坐标值.

其次,具象与抽象

代码一是具象的一个点,只表示在直角坐标系的一个点.
代码二是抽象的一个点,可以表示直角坐标系一个点,也可表示极坐标系中的一个点.

但是,两个都明确了一种数据结构

隐藏实现并非是在变量之上添加一个函数层那么简单,隐藏关乎抽象.

比如,我们现在需要知道手机还有多少电量.

代码三:

public interface Battery{
    //获取以mAh为单位的总电量,
    int getTotalInmAh();
    //获取以mAh为单位的剩余电量
    int getRemainingInmAh();
}

代码四

public interface Battery{
    //获取剩余电量的百分比
    double getRemainingPrecent();
}

以上两端代码,代码四最好.我们不愿意透露更多的细节,更愿意以抽象的形态表述数据.这并不只是用接口和赋值器取值器就能做好的事情.要以更好的方式呈现对象所包含的数据.

数据,对象的反对称性

从学java开始,书上就告诉我们java是面向对象语言.那么什么是面向对象什么是面向过程?

我们来看看下面的代码:
我们有正方形,长方形和圆形三种几何图形,最后要求出其面积.
代码一:

public class Square{
    public Point topLeft;
    public double side;
}
public class Rectangle{
    public Point topLeft;
    public double width;
    public double height;
}
public class Circle{
    public Point center;
    public double radius;
}
public class Geometry{
    public final double PI = 3.14159265358;
    public double area(Object shape) throws NoSuchShapeException{
        if(shape instanceof Square){
            Square square = (Square)shape;
            return square.side * square.side;
        } else if (shape instanceof Rectangle){
            Rectangle rec = (Rectangle)shape;
            return rec.width * rec.hight;
        } else if (shape instanceof Circle){
            Circle cir = (Circle)shape;
            return PI * cir.radius * cir.radius;
        }
        throw new NoSuchShapeException();
    }
}

代码二

public interface Shape{
    double area();
}
public class Square implements Shape{
    private Point topLeft;
    private double side;
    public double area(){
        return side*side;
    }
}
public class Rectangle implements Shape{
    private Point topLeft;
    private double width;
    private double height;
    public double area(){
        return width * height;
    }
}
public class Circle implements Shape{
    private static final double PI = 3.14159265358; 
    private Point topLeft;
    private double radius;
    public double area{
        return PI * radius * radius;
    }
}

从上面两端代码中我们可以看出,代码一每一个形状只负责存储数据,不具备行为.具体的计算行为放在了Geometry类中.每一个形状都是如何,形状之间没有任何联系.

而代码二中的三个类同属于集合图形Shape类,每种图形都有各自的计算面积的方法.这才是符合人类的世界观.

但是!!!
如果在代码一中添加计算周长的函数,每个形状都不会受到任何影响.而代码二中添加计算周长的函数,每一个函数都要有所变动.
如果在代码一种添加一个新的形状,既有的形状(数据结构)不会收到影响,但是计算的函数会收到影响.而在代码二中只需要添加一个新类而已,既有的类不会有任何影响.

过程式的代码便于在不改动既有代码数据结构的前提下添加新的函数,而面向对象式的代码便于在不改动既有 函数的前提下添加新类.
反过来讲也说的通:过程式的代码难以添加新的数据结构,因为必须修改所有的函数.而面向对象代码难以添加新函数,因为必须修改所有的类.

所以:

面向对象较难的事情,对于过程式代码却叫较容易,反之亦然.

这就是数据和对象的反对称性.

得墨忒耳定律

著名的得墨忒耳定律认为:模块不应该了解它所操作对象的内部的情形.

即类C的方法f只应该调用以下对象的方法:

• C
• 由f创建的对象
• 作为参数传给f的对象
• 有C的实体变量持有的对象

方法不应该调用任何函数返回的对象的方法.换言之,只跟朋友交谈,不与陌生人谈话.

以下代码明显违反了得墨忒耳定律:

final String outputDir = ctxt.getOptions().getScartchDir().getAbsolutePath();

这类代码常被作为火车失事,因为它就像一列火车,一旦出了问题,不知问题出在哪.最好做类如下的切分:

Options opts = ctxt.getOptions();
File scratchDir = opts.getScratchDir();
final String outputDir = scratchDir.getAbsolutePath();

以上代码是否违反得墨忒耳定律呢?
模块知道ctxt对象包含有多个选项,每个选项都有一个临时目录,而每个临时目录都有一个绝对路径.对于一个函数来讲,这些知识真是太丰富了.
这些代码是否违反得墨忒耳定律,就要看ctxt,Options,ScratchDir是对象还是数据结构.如果是对象,就违反了定律.如果是数据结构就没有违反.

如果是数据结构,就应该这样写代码:

final String outputDir = ctxt.options.scratchDir.absolutePath;

数据传送对象

最精简的数据结构是一个只有公共变量,没有函数的类.这种数据结构有时被称为数据传送对象,或DTO(Data Transfer Objects).DTO是非常有用的结构,尤其是在与数据库通信,或解析套接字传递信息之类的场景之中.在应用程序代码里一系列将原始数据转换为数据的翻译过程中,他们往往是排头兵.

比如我们也曾写过这样的类:

public class Address{
    private String street;
    private String city;
    private String state;
    private String province;
    public Address(String street, String city, String state, String province){
        this.street = street;
        this.city = city;
        this.state = state;
        this.province = province;
    }
    public String getStreet(){
        return stree;
    }
    public String getCity(){
        return city;
    }
    public String getState(){
        return state;
    }
    public String getProvince(){
        return province;
    }
}

为什么要写这些get方法???为什么不直接将这些变量置为公共的呢?

小结

对象暴露行为,封装数据.便于添加新对象类型而无需修改既有的行为,同时也难以在既有的对象中添加新的行为.数据结构暴露数据,没有明显的行为,便于向既有的数据结构添加新的行为,同时也难以向既有的函数中添加新的数据结构.