Design is there to enable you to keep changing the software easily in the long term. -- Kent Beck.
設計是什么
正如Kent Beck
所說协屡,軟件設計是為了「長期」更加容易地適應未來的變化哎垦。正確的軟件設計方法是為了長期地牍帚、更好更快、更容易地實現(xiàn)軟件價值的交付狰挡。
軟件設計的目標
軟件設計就是為了完成如下目標泽西,其可驗證性九串、重要程度依次減低囤官。
- 實現(xiàn)功能
- 易于重用
- 易于理解
- 沒有冗余
實現(xiàn)功能
實現(xiàn)功能的目標壓倒一起,這也是軟件設計的首要標準颤霎。如何判定系統(tǒng)功能的完備性呢媳谁?通過所有測試用例涂滴。
從TDD
的角度看,測試用例就是對需求的闡述晴音,是一個閉環(huán)的反饋系統(tǒng)柔纵,保證其系統(tǒng)的正確性;及其保證設計的合理性锤躁,恰如其分首量,不多不少;當然也是理解系統(tǒng)行為最重要的依據(jù)进苍。
易于理解
好的設計應該能讓其他人也能容易地理解,包括系統(tǒng)的行為鸭叙,業(yè)務的規(guī)則觉啊。那么,什么樣的設計才算得上易于理解的呢沈贝?
Clean Code
Implement Patterns
Idioms
沒有冗余
沒有冗余的系統(tǒng)是最簡單的系統(tǒng)杠人,恰如其分的系統(tǒng),不做任何過度設計的系統(tǒng)宋下。
Dead Code
YAGNI: You Ain't Gonna Need It
KISS: Keep it Simple, Stupid
易于重用
易于重用的軟件結構嗡善,使得其應對變化更具彈性;可被容易地修改学歧,具有更加適應變化的能力罩引。
最理想的情況下,所有的軟件修改都具有局部性枝笨。但現(xiàn)實并非如此袁铐,軟件設計往往需要花費很大的精力用于依賴的管理,讓組件之間的關系變得清晰横浑、一致剔桨、漂亮。
那么軟件設計的最高準則是什么呢徙融?「高內聚洒缀、低耦合」原則是提高可重用性的最高原則。為了實現(xiàn)高內聚欺冀,低耦合的軟件設計树绩,袁英杰提出了「正交設計」的方法論。
正交設計
「正交」是一個數(shù)學概念:所謂正交脚猾,就是指兩個向量的內積為零葱峡。簡單的說,就是這兩個向量是垂直的龙助。在一個正交系統(tǒng)里砰奕,沿著一個方向的變化蛛芥,其另外一個方向不會發(fā)生變化。為此军援,Bob
大叔將「職責」定義為「變化的原因」仅淑。
「正交性」,意味著更高的內聚胸哥,更低的耦合涯竟。為此,正交性可以用于衡量系統(tǒng)的可重用性空厌。那么庐船,如何保證設計的正交性呢?袁英杰提出了「正交設計的四個基本原則」嘲更,簡明扼要筐钟,道破了軟件設計的精髓所在。
正交設計原則
- 消除重復
- 分離關注點
- 縮小依賴范圍
- 向穩(wěn)定的方向依賴
實戰(zhàn)
需求1: 存在一個學生的列表赋朦,查找一個年齡等于
18
歲的學生
快速實現(xiàn)
public static Student findByAge(Student[] students) {
for (int i=0; i<students.length; i++)
if (students[i].getAge() == 18)
return students[i];
return null;
}
上述實現(xiàn)存在很多設計的「壞味道」:
- 缺乏彈性參數(shù)類型:只支持數(shù)組類型篓冲,
List, Set
都被拒之門外; - 容易出錯:操作數(shù)組下標宠哄,往往引入不經意的錯誤壹将;
- 幻數(shù):硬編碼,將算法與配置高度耦合毛嫉;
- 返回
null
:再次給用戶打開了犯錯的大門诽俯;
使用for-each
按照「最小依賴原則」,先隱藏數(shù)組下標的實現(xiàn)細節(jié)狱庇,使用for-each
降低錯誤發(fā)生的可能性惊畏。
public static Student findByAge(Student[] students) {
for (Student s : students)
if (s.getAge() == 18)
return s;
return null;
}
需求2: 查找一個名字為
horance
的學生
重復設計
Copy-Paste
是最快的實現(xiàn)方法,但會產生「重復設計」密任。
public static Student findByName(Student[] students) {
for (Student s : students)
if (s.getName().equals("horance"))
return s;
return null;
}
為了消除重復颜启,可以將「查找算法」與「比較準則」這兩個「變化方向」進行分離。
抽象準則
首先將比較的準則進行抽象化浪讳,讓其獨立變化缰盏。
public interface StudentPredicate {
boolean test(Student s);
}
將各個「變化原因」對象化,為此建立了兩個簡單的算子淹遵。
public class AgePredicate implements StudentPredicate {
private int age;
public AgePredicate(int age) {
this.age = age;
}
@Override
public boolean test(Student s) {
return s.getAge() == age;
}
}
public class NamePredicate implements StudentPredicate {
private String name;
public NamePredicate(String name) {
this.name = name;
}
@Override
public boolean test(Student s) {
return s.getName().equals(name);
}
}
此刻口猜,查找算法的方法名也應該被「重命名」,使其保持在同一個「抽象層次」上透揣。
public static Student find(Student[] students, StudentPredicate p) {
for (Student s : students)
if (p.test(s))
return s;
return null;
}
客戶端的調用根據(jù)場景济炎,提供算法的配置。
assertThat(find(students, new AgePredicate(18)), notNullValue());
assertThat(find(students, new NamePredicate("horance")), notNullValue());
結構性重復
AgePredicate
和NamePredicate
存在「結構型重復」辐真,需要進一步消除重復须尚。經分析兩個類的存在無非是為了實現(xiàn)「閉包」的能力崖堤,可以使用lambda
表達式,「Code As Data
」耐床,簡明扼要密幔。
assertThat(find(students, s -> s.getAge() == 18), notNullValue());
assertThat(find(students, s -> s.getName().equals("horance")), notNullValue());
引入Iterable
按照「向穩(wěn)定的方向依賴」的原則,為了適應諸如List, Set
等多種數(shù)據(jù)結構撩轰,甚至包括原生的數(shù)組類型胯甩,可以將入?yún)⒅貥嫗橹貥嫗楦映橄蟮?code>Iterable類型。
public static Student find(Iterable<Student> students, StudentPredicate p) {
for (Student s : students)
if (p.test(s))
return s;
return null;
}
需求3: 存在一個老師列表堪嫂,查找第一個女老師
類型重復
按照既有的代碼結構偎箫,可以通過Copy Paste
快速地實現(xiàn)這個功能。
public interface TeacherPredicate {
boolean test(Teacher t);
}
public static Teacher find(Iterable<Teacher> teachers, TeacherPredicate p) {
for (Teacher t : teachers)
if (p.test(t))
return t;
return null;
}
用戶接口依然可以使用Lambda
表達式皆串。
assertThat(find(teachers, t -> t.female()), notNullValue());
如果使用Method Reference
镜廉,可以進一步地改善表達力。
assertThat(find(teachers, Teacher::female), notNullValue());
類型參數(shù)化
分析StudentMacher/TeacherPredicate
, find(Iterable<Student>)/find(Iterable<Teacher>)
的重復愚战,為此引入「類型參數(shù)化」的設計。
首先消除StudentPredicate
和TeacherPredicate
的重復設計齐遵。
public interface Predicate<E> {
boolean test(E e);
}
再對find
進行類型參數(shù)化設計寂玲。
public static <E> E find(Iterable<E> c, Predicate<E> p) {
for (E e : c)
if (p.test(e))
return e;
return null;
}
型變
但find
的類型參數(shù)缺乏「型變」的能力,為此引入「型變」能力的支持梗摇,接口更加具有可復用性拓哟。
public static <E> E find(Iterable<? extends E> c, Predicate<? super E> p) {
for (E e : c)
if (p.test(e))
return e;
return null;
}
復用lambda
Parameterize all the things.
觀察如下兩個測試用例,如果做到極致伶授,可認為兩個lambda
表達式也是重復的断序。從「分離變化的方向」的角度分析,此lambda
表達式承載的「比較算法」與「參數(shù)配置」兩個職責糜烹,應該對其進行分離违诗。
assertThat(find(students, s -> s.getName().equals("Horance")), notNullValue());
assertThat(find(students, s -> s.getName().equals("Tomas")), notNullValue());
可以通過「Static Factory Method」
生產lambda
表達式,將比較算法封裝起來疮蹦;而配置參數(shù)通過引入「參數(shù)化」設計诸迟,將「邏輯」與「配置」分離,從而達到最大化的代碼復用愕乎。
public final class StudentPredicates {
private StudentPredicates() {
}
public static Predicate<Student> age(int age) {
return s -> s.getAge() == age;
}
public static Predicate<Student> name(String name) {
return s -> s.getName().equals(name);
}
}
import static StudentPredicates.*;
assertThat(find(students, name("horance")), notNullValue());
assertThat(find(students, age(10)), notNullValue());
組合查詢
但是阵苇,上述將lambda
表達式封裝在Factory
的設計是及其脆弱的。例如感论,增加如下的需求:
需求4: 查找年齡不等于18歲的女生
最簡單的方法就是往StudentPredicates
不停地增加「Static Factory Method」
绅项,但這樣的設計嚴重違反了「OCP」(開放封閉)
原則。
public final class StudentPredicates {
......
public static Predicate<Student> ageEq(int age) {
return s -> s.getAge() == age;
}
public static Predicate<Student> ageNe(int age) {
return s -> s.getAge() != age;
}
}
從需求看比肄,比較準則增加了眾多的語義快耿,再次運用「分離變化方向」的原則囊陡,可發(fā)現(xiàn)存在兩類運算的規(guī)則:
- 比較運算:
==, !=
- 邏輯運算:
&&, ||
比較語義
先處理比較運算的變化方向,為此建立一個Matcher
的抽象:
public interface Matcher<T> {
boolean matches(T actual);
static <T> Matcher<T> eq(T expected) {
return actual -> expected.equals(actual);
}
static <T> Matcher<T> ne(T expected) {
return actual -> !expected.equals(actual);
}
}
Composition everywhere.
此刻润努,age
的設計運用了「函數(shù)式」的思維关斜,其行為表現(xiàn)為「高階函數(shù)」的特性,通過函數(shù)的「組合式設計」完成功能的自由拼裝組合铺浇,簡單痢畜、直接、漂亮鳍侣。
public final class StudentPredicates {
......
public static Predicate<Student> age(Matcher<Integer> m) {
return s -> m.matches(s.getAge());
}
}
查找年齡不等于18歲的學生丁稀,可以如此描述。
assertThat(find(students, age(ne(18))), notNullValue());
邏輯語義
為了使得邏輯「謂詞」變得更加人性化倚聚,可以引入「流式接口」的「DSL」
設計线衫,增強表達力。
public interface Predicate<E> {
boolean test(E e);
default Predicate<E> and(Predicate<? super E> other) {
return e -> test(e) && other.test(e);
}
}
查找年齡不等于18歲的女生惑折,可以表述為:
assertThat(find(students, age(ne(18)).and(Student::female)), notNullValue());
重復再現(xiàn)
仔細的讀者可能已經發(fā)現(xiàn)了授账,Student
和Teacher
兩個類也存在「結構型重復」的問題。
public class Student {
public Student(String name, int age, boolean male) {
this.name = name;
this.age = age;
this.male = male;
}
......
private String name;
private int age;
private boolean male;
}
public class Teacher {
public Teacher(String name, int age, boolean male) {
this.name = name;
this.age = age;
this.male = male;
}
......
private String name;
private int age;
private boolean male;
}
級聯(lián)反應
Student
與Teacher
的結構性重復惨驶,導致StudentPredicates
與TeacherPredicates
也存在「結構性重復」白热。
public final class StudentPredicates {
......
public static Predicate<Student> age(Matcher<Integer> m) {
return s -> m.matches(s.getAge());
}
}
public final class TeacherPredicates {
......
public static Predicate<Teacher> age(Matcher<Integer> m) {
return t -> m.matches(t.getAge());
}
}
為此需要進一步消除重復。
提取基類
第一個直覺粗卜,通過「提取基類」的重構方法屋确,消除Student
和Teacher
的重復設計。
class Human {
protected Human(String name, int age, boolean male) {
this.name = name;
this.age = age;
this.male = male;
}
...
private String name;
private int age;
private boolean male;
}
從而實現(xiàn)了進一步消除了Student
和Teacher
之間的重復設計续扔。
public class Student extends Human {
public Student(String name, int age, boolean male) {
super(name, age, male);
}
}
public class Teacher extends Human {
public Teacher(String name, int age, boolean male) {
super(name, age, male);
}
}
類型界定
此時攻臀,可以通過引入「類型界定」的泛型設計,使得StudentPredicates
與TeacherPredicates
合二為一纱昧,進一步消除重復設計刨啸。
public final class HumanPredicates {
......
public static <E extends Human>
Predicate<E> age(Matcher<Integer> m) {
return s -> m.matches(s.getAge());
}
}
消滅繼承關系
Student
和Teacher
依然存在「結構型重復」的問題,可以通過Static Factory Method
的設計方法识脆,并讓Human
的構造函數(shù)「私有化」呜投,刪除Student
和Teacher
兩個子類,徹底消除兩者之間的「重復設計」存璃。
public class Human {
private Human(String name, int age, boolean male) {
this.name = name;
this.age = age;
this.male = male;
}
public static Human student(String name, int age, boolean male) {
return new Human(name, age, male);
}
public static Human teacher(String name, int age, boolean male) {
return new Human(name, age, male);
}
......
}
消滅類型界定
Human
的重構仑荐,使得HumanPredicates
的「類型界定」變得多余,從而進一步簡化了設計纵东。
public final class HumanPredicates {
......
public static Predicate<Human> age(Matcher<Integer> m) {
return s -> m.matches(s.getAge());
}
}
絕不返回null
Billion-Dollar Mistake
在最開始粘招,我們遺留了一個問題:find
返回了null
。用戶調用返回null
的接口時偎球,常常忘記null
的檢查洒扎,導致在運行時發(fā)生NullPointerException
異常辑甜。
按照「向穩(wěn)定的方向依賴」的原則,find
的返回值應該設計為Optional<E>
袍冷,使用「類型系統(tǒng)」的特長磷醋,取得如下方面的優(yōu)勢:
- 顯式地表達了不存在的語義;
- 編譯時保證錯誤的發(fā)生胡诗;
import java.util.Optional;
public <E> Optional<E> find(Iterable<? extends E> c, Predicate<? super E> p) {
for (E e : c) {
if (p.test(e)) {
return Optional.of(e);
}
}
return Optional.empty();
}
回顧
通過4
個需求的迭代和演進邓线,通過運用「正交設計」和「組合式設計」的基本思想,加深對「正交設計基本原則」的理解煌恢。
鳴謝
「正交設計」的理論骇陈、原則、及其方法論出自前ThoughtWorks
軟件大師「袁英杰」先生瑰抵。英杰既是我的老師你雌,也是我的摯友;他高深莫測的軟件設計的修為二汛,及其對軟件設計獨特的哲學思維方式婿崭,是我等后輩學習的楷模。