访问者模式(Visitor)

访问者模式(Visitor)

1.意图

表示一个作用于某对象结构中的各元素的操作。它使你可以在不改变各元素的类的前提下定义作用于这些元素的新操作。
在下列情况下使用 Visitor模式:
• 一个对象结构包含很多类对象,它们有不同的接口,而你想对这些对象实施一些依赖于其具体类的操作。
• 需要对一个对象结构中的对象进行很多不同的并且不相关的操作,而你想避免让这些操作“污染”这些对象的类。 Visitor使得你可以将相关的操作集中起来定义在一个类中。当该对象结构被很多应用共享时,用 Visitor模式让每个应用仅包含需要用到的操作。
• 定义对象结构的类很少改变,但经常需要在此结构上定义新的操作。改变对象结构类需要重定义对所有访问者的接口,这可能需要很大的代价。如果对象结构类经常改变,那么可能还是在这些类中定义这些操作较好。

2.特点

• Vi s i t o r(访问者)
— 为该对象结构中 ConcreteElement的每一个类声明一个 Visit操作。该操作的名字和特征标识了发送 Vi s i t请求给该访问者的那个类。这使得访问者可以确定正被访问元素的具体的类。这样访问者就可以通过该元素的特定接口直接访问它。
• ConcreteVisitor(具体访问者)
— 实现每个由 Visitor声明的操作。每个操作实现本算法的一部分,而该算法片断乃是对应于结构中对象的类。ConcreteVisitor为该算法提供了上下文并存储它的局部状态。这一状态常常在遍历该结构的过程中累积结果。
• Element(元素)
— 定义一个Accept操作,它以一个访问者为参数。
• ConcreteElement(具体元素)
— 实现Accept操作,该操作以一个访问者为参数。
• ObjectStructure(对象结构)
— 能枚举它的元素。
— 可以提供一个高层的接口以允许该访问者访问它的元素。
— 可以是一个复合或是一个集合,如一个列表或一个无序集
合。

3.UML类图

4.代码

/**
 * Element(元素)
 — 定义一个Accept操作,它以一个访问者为参数。
 */
public interface Element {
    void accept(Visitor visitor);
}

/**
 * ConcreteElement(具体元素)
 — 实现Accept操作,该操作以一个访问者为参数。
 */
public class ConsumerElement implements Element {
    private String name;

    public ConsumerElement(String name) {
        this.name = name;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    @Override
    public void accept(Visitor visitor) {
        visitor.view(this);
    }
}

/**
 * ConcreteElement(具体元素)
 — 实现Accept操作,该操作以一个访问者为参数。
 */
public class IncomeElement implements Element {
    private String name;

    public IncomeElement(String name) {
        this.name = name;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    @Override
    public void accept(Visitor visitor) {
        visitor.view(this);
    }
}

/**
 * Vi s i t o r(访问者)
 — 为该对象结构中 ConcreteElement的每一个类声明一个 Visit操作。
 该操作的名字和特征标识了发送 Vi s i t请求给该访问者的那个类。
 这使得访问者可以确定正被访问元素的具体的类。这样访问者就可以通过该元素的特定接口直接访问它。
 */
public interface Visitor {
    void view(ConsumerElement element);
    void view(IncomeElement element);
}

public class BossVisitor implements Visitor {
    private String name;

    public BossVisitor(String name) {
        this.name = name;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    @Override
    public void view(ConsumerElement element) {
        System.out.println("Boss:"+this.name +"浏览了 Consumer"+element.getName());
    }

    @Override
    public void view(IncomeElement element) {
        System.out.println("Boss:"+this.name +"浏览了 Income"+element.getName());
    }
}

/**
 * Created by lyy on 18-3-29.
 */
public class CPAVisitor implements Visitor {
    private String name;

    public CPAVisitor(String name) {
        this.name = name;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    @Override
    public void view(ConsumerElement element) {
        System.out.println("CPA:"+this.name +"浏览了 Consumer"+element.getName());
    }

    @Override
    public void view(IncomeElement element) {
        System.out.println("CPA:"+this.name +"浏览了 Income"+element.getName());
    }
}

/**
 * CObjectStructure(对象结构)
 — 能枚举它的元素。
 — 可以提供一个高层的接口以允许该访问者访问它的元素。
 — 可以是一个复合或是一个集合,如一个列表或一个无序集
 */
public class ObjectStructure {
    List<Element> list = new ArrayList<Element>();

    public void addElement(Element element){
        list.add(element);
    }

    public void accept(Visitor visitor){
        for(Element e: list){
            e.accept(visitor);
        }
    }
}

public class VisitorTest {
    public static void main(String[] args) {
        ObjectStructure os = new ObjectStructure();
        os.addElement(new ConsumerElement("支出1"));
        os.addElement(new ConsumerElement("支出2"));
        os.addElement(new IncomeElement("收入1"));
        os.addElement(new IncomeElement("收入2"));
        Visitor v1 = new BossVisitor("张总");
        Visitor v2 = new CPAVisitor("刘会计");

        os.accept(v1);
        os.accept(v2);

    }
}