클래스 디자인 패턴 18. Visitor Pattern

1. 개념
  1) 의미
     방문자 는 데이터 구조와 처리를 분리하여 처리부분을
       방문자 라고 불리우는 형태의 구현부분에 집중하는
       형태입니다.
     예제는 Composite 패턴을 기본으로 확장합니다.


2. 소스

  1) Visitor 및 Acceptor 인터페이스

public abstract class Visitor {
    public abstract void visit(File file);
    public abstract void visit(Directory directory);
}

public interface Acceptor {

    public abstract void accept(Visitor v);

}

  2) Entry는 Acceptor를 implement 합니다.
      이외에는 기존과 같습니다.

import java.util.Iterator;

public abstract class Entry implements Acceptor {
    public abstract String getName();                                   // 이름을 얻는다.
    public abstract int getSize();                                      // 사이즈를 얻는다.
    public Entry add(Entry entry) throws FileTreatmentException {       // 엔트리를 추가
        throw new FileTreatmentException();
    }
    public Iterator iterator() throws FileTreatmentException {    // Iterator의 생성
        throw new FileTreatmentException();
    }
    public String toString() {                                          // 문자열 표현
        return getName() + " (" + getSize() + ")";
    }
}

  3) Entry를 상속하여 구현한 구현체 2개 클래스를 작성하는데
      기존에 비해 Accept 를 구현해주면됩니다.
public class File extends Entry {
    private String name;
    private int size;
    public File(String name, int size) {
        this.name = name;
        this.size = size;
    }
    public String getName() {
        return name;
    }
    public int getSize() {
        return size;
    }
    public void accept(Visitor v) {
        v.visit(this);
    }
}

import java.util.Iterator;

import java.util.Vector;

public class Directory extends Entry {

    private String name;                    // 디렉토리의 이름

    private Vector dir = new Vector();      // 디렉토리 엔트리의 집합

    public Directory(String name) {         // 생성자

        this.name = name;

    }

    public String getName() {               // 이름을 얻는다.

        return name;

    }

    public int getSize() {                  // 사이즈를 얻는다.

        int size = 0;

        Iterator it = dir.iterator();

        while (it.hasNext()) {

            Entry entry = (Entry)it.next();

            size += entry.getSize();

        }

        return size;

    }

    public Entry add(Entry entry) {         // 엔트리의 추가

        dir.add(entry);

        return this;

    }

    public Iterator iterator() {      // Iterator의 생성

        return dir.iterator();

    }

    public void accept(Visitor v) {         // 방문자를 받아들임

        v.visit(this);

    }

}

  4) Visitor 를 상속한 ListVisitor를 구현합니다.
import java.util.Iterator;

public class ListVisitor extends Visitor {
    private String currentdir = "";                         // 현재 주목하고 있는 디렉토리명
    public void visit(File file) {                  // 파일을 방문했을 때 호출된다.
        System.out.println(currentdir + "/" + file);
    }
    public void visit(Directory directory) {   // 디렉토리를 방문했을 때 호출된다.
        System.out.println(currentdir + "/" + directory);
        String savedir = currentdir;
        currentdir = currentdir + "/" + directory.getName();
        Iterator it = directory.iterator();
        while (it.hasNext()) {
            Entry entry = (Entry)it.next();
            entry.accept(this);
        }
        currentdir = savedir;
    }
}

5) 예외처리 클래스와 테스트 클래스를 작성합니다.

public class FileTreatmentException extends RuntimeException {

    public FileTreatmentException() {

    }

    public FileTreatmentException(String msg) {

        super(msg);

    }

}

public class Main {

    public static void main(String[] args) {

        try {

            System.out.println("Making root entries...");

            Directory rootdir = new Directory("root");

            Directory bindir = new Directory("bin");

            Directory tmpdir = new Directory("tmp");

            Directory usrdir = new Directory("usr");

            rootdir.add(bindir);

            rootdir.add(tmpdir);

            rootdir.add(usrdir);

            bindir.add(new File("vi", 10000));

            bindir.add(new File("latex", 20000));

            rootdir.accept(new ListVisitor());              

            System.out.println("");

            System.out.println("Making user entries...");

            Directory Kim = new Directory("Kim");

            Directory Lee = new Directory("Lee");

            Directory Kang = new Directory("Kang");

            usrdir.add(Kim);

            usrdir.add(Lee);

            usrdir.add(Kang);

            Kim.add(new File("diary.html", 100));

            Kim.add(new File("Composite.java", 200));

            Lee.add(new File("memo.tex", 300));

            Kang.add(new File("game.doc", 400));

            Kang.add(new File("junk.mail", 500));

            rootdir.accept(new ListVisitor());             

        } catch (FileTreatmentException e) {

            e.printStackTrace();

        }

    }

}

결과 :
Making root entries...
/root (30000)
/root/bin (30000)
/root/bin/vi (10000)
/root/bin/latex (20000)
/root/tmp (0)
/root/usr (0)

Making user entries...
/root (31500)
/root/bin (30000)
/root/bin/vi (10000)
/root/bin/latex (20000)
/root/tmp (0)
/root/usr (1500)
/root/usr/Kim (300)
/root/usr/Kim/diary.html (100)
/root/usr/Kim/Composite.java (200)
/root/usr/Lee (300)
/root/usr/Lee/memo.tex (300)
/root/usr/Kang (900)
/root/usr/Kang/game.doc (400)
/root/usr/Kang/junk.mail (500)

3. 다이어그램

https://ko.wikipedia.org/wiki/%EB%B9%84%EC%A7%80%ED%84%B0_%ED%8C%A8%ED%84%B4

4. 관련패턴
  1) Iterator 패턴

  2) Composite 패턴

  3) Interpreter 패턴