定義
Represent an operation to be performed on the elements of an object structure. Visitor lets you define a new operation without changing the classes of the elements on which it operates.
訪問者代表的是在集合元素上執(zhí)行的某些操作朴爬。訪問者可以讓你不改變元素類的前提下,新增作用于這些元素的操作。
實列
想象一下前联,假如我們將博物館比做一個集合,那它里面陳列的各種文物便是元素。
程序中我們要操作或訪問集合中的元素一般是主動獲取元素列表然后進行遍歷操作籽懦,而生活中對于不熟悉博物館布局的訪客暴拄,他如何遍歷文物呢漓滔?
顯然,我們不能將文物搬出來乖篷,參觀完后再返回去响驴,而是進到博物館里,然后由導(dǎo)游依次向我們展示各種文物撕蔼。這就可以訪問各種文物了豁鲤,在程序中這種訪問方式被稱為訪問者模式——它由集合對象向訪問者開放入口,并向它依次展示其元素鲸沮。
故事
上周琳骡,我安排了一同事將公司員工信息中的管理者和普通員工的信息導(dǎo)出成Excel。
員工信息的結(jié)構(gòu)像一棵樹但只有兩層诉探,第一層是管理者日熬,第二成是普通員工棍厌,普通員工是管理者的下屬節(jié)點肾胯。
導(dǎo)出的Excel中管理者和普通員工的字段信息有所不同,管理者的信息字段要求有一個部門字段耘纱,而普通員工的信息字段要求有一個入職時間字段敬肚,其它字段姓名、年齡都相同束析。
我還特意告訴他注意程序的擴展性艳馒,該信息結(jié)構(gòu)以后會用于不同的場景,比如說下次可能要讓他計算每個人的薪資员寇。
但是弄慰,結(jié)果還是不符合我的期望。
偽代碼如下:
public class Company {
protected List<Staff> staffs = new LinkedList<>();
protected void exportExcel(){
for (Staff staff : staffs) {
if(staff instanceof Manager){
appendToExcel(((Manager) staff).getDepartment(),staff.getAge()+ staff.getName());
}else if(staff instanceof Employee){
appendToExcel(((Employee) staff).getEntryDate(),staff.getAge()+ staff.getName());
}
}
}
public void add(Staff staff) {
staffs.add(staff);
}
public void remove(Staff element) {
staffs.remove(element);
}
}
問題
從上面的代碼中我們可以看出蝶锋,導(dǎo)出集合元素信息的方式是在對象結(jié)構(gòu)Company中采用foreach來實現(xiàn)的陆爽,而且使用了instanceof來區(qū)分不同的元素。
但是扳缕,這樣實現(xiàn)會存在幾個問題慌闭。首先是耦合問題,Company直接耦合了具體的員工類型Manager和Employee以及導(dǎo)出操作躯舔。
其次是復(fù)雜度問題驴剔,如果該集合的結(jié)構(gòu)有很多層級,那么勢必增加功能實現(xiàn)時的復(fù)雜度粥庄。
最后是最重要的擴展性問題丧失,如果我們要將其導(dǎo)出成PDF亦或是根據(jù)同樣的結(jié)構(gòu)計算員工的薪資,那么不但遍歷的邏輯會重復(fù)惜互,而且我們要修改集合對象或其元素的代碼布讹。
所以科侈,有沒有一種方式可以不修改集合對象的前提下,便可以新增功能炒事?這便是訪問者模式臀栈。
方案
訪問者模式是一種行為型設(shè)計模式,它對操作集合元素的具體行為進行了抽象挠乳。
如果讓該模式來重構(gòu)上面的代碼 那么它會這樣實現(xiàn):首先权薯,它會將具體的行為如appendToExcel從集合對象中分離出去,只保留對元素的遍歷結(jié)構(gòu)睡扬;
然后盟蚣,會將這些具體的行為抽象成訪問者接口,用該接口中的方法替換遍歷中的具體行為卖怜;最后屎开,會將exportExcel重命名為accept(Visitor visitor)接受訪問者訪問該集合對象中的元素。
同樣马靠,如果元素本身也是集合對象的話奄抽,那么也是采用同樣的方式解藕與具體行為的依賴。
這樣甩鳄,新增新的訪問行為時逞度,便不需要修改集合對象,只需實現(xiàn)訪問者接口便可妙啃。
實現(xiàn)
接下來档泽,我們使用訪問者模式重新實現(xiàn)一下故事中的程序。
首先揖赴,我們將集合中操作元素的具體行為抽象成一個訪問者接口馆匿。
/**訪問者接口*/
public interface Visitor {
void visit(Manager manager);
void visit(Employee manager);
}
然后,讓集合對象實現(xiàn)可訪問者接口(Visitable)燥滑,接受訪問者訪問其內(nèi)部元素渐北。
public class Company implements Visitable{
protected List<Staff> staffs = new LinkedList<>();
@Override
public void accept(Visitor visitor){
for (Staff staff : staffs) {
if(staff instanceof Manager){
visitor.visit((Manager)staff);
}else if(staff instanceof Employee){
visitor.visit((Employee)staff);
}
}
}
public void add(Staff staff) {
staffs.add(staff);
}
public void remove(Staff element) {
staffs.remove(element);
}
}
接著,我們新建一個類繼承訪問者接口突倍,實現(xiàn)員工信息導(dǎo)出成Excel腔稀。當(dāng)然,如果我們也要導(dǎo)出成PDF也是同樣的方式羽历。
public class ExcelVisitor implements Visitor{
@Override
public void visit(Manager staff) {
appendToExcel(((Manager) staff).getDepartment(),staff.getAge()+ staff.getName());
}
@Override
public void visit(Employee staff) {
appendToExcel(((Employee) staff).getEntryDate(),staff.getAge()+ staff.getName());
}
}
最后焊虏,我們在來看看客戶端如何使用訪問者模式將集合對象中的數(shù)據(jù)導(dǎo)出。
public class Client {
public static void main(String[] args) {
Company company = new Company();
company.add(new Manager());
company.add(new Employee());
//導(dǎo)出Excel
ExcelVisitor visitor = new ExcelVisitor();
company.accept(visitor);
//導(dǎo)出PDF
PDFVisitor pdfVisitor = new PDFVisitor();
company.accept(pdfVisitor);
}
}
結(jié)構(gòu)
對象結(jié)構(gòu)(ObjectStructure):它可以是一個集合秕磷,也可以是由不同組成部分構(gòu)成的復(fù)合體诵闭,主要負(fù)責(zé)遍歷其結(jié)構(gòu)中的元素并將它傳遞給訪問者。
抽象訪問者角色(Visitor):該抽象類或接口是對元素操作行為的抽象,聲明了操作不同元素的方法疏尿。
具體訪問者角色(ConcreteVisitor):它實現(xiàn)自抽象訪問者瘟芝,會對元素進行某些操作。
抽象可訪問角色(Visitable):該接口聲明了一個操作褥琐,該操作可以接受訪問者的訪問锌俱,實現(xiàn)該接口的對象會將其內(nèi)部元素傳遞給訪問者。
具體可訪問角色(ConcreteVisitable):是一個集合對象或者集合中的元素敌呈,如果該元素也是一個集合的話贸宏。
總結(jié)
當(dāng)一個復(fù)合對象中的元素,有很多不同的應(yīng)用場景的時候磕洪,我們應(yīng)該將遍歷行為封裝在對象中并將具體的行為分離出去用抽象訪問者的方法將其替代吭练。
這樣,在我們擴展新功能時析显,便不需要修改該復(fù)合對象了鲫咽。
擴展閱讀
架構(gòu)設(shè)計思維篇之結(jié)構(gòu)
架構(gòu)設(shè)計事務(wù)篇之Mysql事務(wù)原理