Model View Controler

Das Entwurfsmuster „Model View Controller“ kurz MVC kommt von der Programmiersprache Smalltalk, hat aber seine Anfänge schon in Assembler.

Mit dem MVC Pattern ist eine klare Trennung von der View (der Darstellungsschicht) über Model (Datenmodel) und dem Controller (der Businesslogik) geschaffen worden.
Zusammen mit dem Observable Pattern ist dieses ein sehr gutes und vor allem bewährtes Muster um grafische Benutzer Schnittstellen zu entwerfen.

Der Vorteil ist, dass wenn einmal die View ausgetauscht werden soll, nur eine Klasse im Refactoring involviert ist und dass, das Datenmodel (Model) mit dem Observable Pattern mehrere Views bedienen kann.

Folgende Grafik zeigt an einem kleinen Beispiel wie das genau funktioniert:

An diesem Beispiel sieht man auch wie das Observable Pattern implementiert wird.
Der Controller mit seiner Businesslogik erweitert (extends) die Klasse Observable und somit enthält dieser alle Methodem zum Halten und aufrufen aller angemeldeten Observer in diesem Falle sind es die View und das Model.

Im folgenden Beispiel wollen wir eine einfache kleine Anwendung schreiben welche als Struktur das MVC Pattern verwendet.

Aufgabe: Es soll eine Uhrzeit angezeigt werden und dabei soll der Benutzer die Möglichkeit haben die Zeitzone selber zu wählen.

Klasse MVCModel.java

package de.stefandraegersoftware.mvc.model;

import java.util.Observable;
import java.util.Observer;
import java.util.TimeZone;

public class MVCModel implements Observer {

    private String timeValue;

    private String[] availableTimezones = TimeZone.getAvailableIDs();

    private String selectedTimezone = "Europe/Berlin";

    public String getTimeValue() {
        return this.timeValue;
    }

    public void setTimeValue(String timeValue) {
        this.timeValue = timeValue;
    }

    public String[] getAvailableTimezones() {
        return this.availableTimezones;
    }

    public void setAvailableTimezones(String[] availableTimezones) {
        this.availableTimezones = availableTimezones;
    }

    public String getSelectedTimezone() {
        return selectedTimezone;
    }

    public void setSelectedTimezone(String selectedTimezone) {
        this.selectedTimezone = selectedTimezone;
    }

    @Override
    public void update(Observable o, Object arg) {
        this.timeValue = (String) arg;
    }

}

Klasse MVCView.java

package de.stefandraegersoftware.mvc.view;

import java.awt.FlowLayout;
import java.awt.event.ItemEvent;
import java.awt.event.ItemListener;
import java.util.Observable;
import java.util.Observer;

import javax.swing.JComboBox;
import javax.swing.JFrame;
import javax.swing.JLabel;

import de.stefandraegersoftware.mvc.MVCStatics;
import de.stefandraegersoftware.mvc.model.MVCModel;

public class MVCView extends JFrame implements Observer {

    private static final long serialVersionUID = -4193527672673911621L;

    private JLabel textLbl;
    private JComboBox<String> availableTimezonesCmbBox;

    private MVCModel model;

    public MVCView(MVCModel model) {
        this.model = model;
        this.setTitle("MVC Beispiel");
        this.setBounds(0, 0, 390, 80);
        this.setLayout(new FlowLayout(FlowLayout.LEFT));
        this.setResizable(false);
        this.textLbl = new JLabel();
        this.availableTimezonesCmbBox = new JComboBox<String>(this.model.getAvailableTimezones());
        this.availableTimezonesCmbBox.setActionCommand(MVCStatics.ACTION_TIMEZONE);
        this.availableTimezonesCmbBox.addItemListener(new ItemListener() {

            @Override
            public void itemStateChanged(ItemEvent e) {
                model.setSelectedTimezone(e.getItem().toString());
            }
        });
        this.add(this.textLbl);
        this.add(this.availableTimezonesCmbBox);
        this.setLocationRelativeTo(null);
        this.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
        this.setVisible(true);
    }

    @Override
    public void update(Observable o, Object arg) {
        this.textLbl.setText(this.model.getTimeValue());
    }

}

Klasse MVCController.java

package de.stefandraegersoftware.mvc.controler;

import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.text.SimpleDateFormat;
import java.util.Calendar;
import java.util.Date;
import java.util.Observable;
import java.util.TimeZone;

import javax.swing.Timer;

import de.stefandraegersoftware.mvc.model.MVCModel;

public class MVCControler extends Observable implements ActionListener {

    private Timer timer;
    private MVCModel model;
    private SimpleDateFormat dateFormat = new SimpleDateFormat("MM.dd.yyyy - HH:mm:ss");

    public MVCControler(MVCModel model) {
        this.model = model;
        this.timer = new Timer(1000, this);
        this.timer.start();
    }

    public void start() {
        setChanged();
        notifyObservers();
    }

    @Override
    public void actionPerformed(ActionEvent e) {
        setChanged();
        Date time = Calendar.getInstance().getTime();
        dateFormat.setTimeZone(TimeZone.getTimeZone(this.model.getSelectedTimezone()));
        this.model.setTimeValue(dateFormat.format(time));
        notifyObservers();
    }
}

und zur vollständigkeit die Main Klasse

package de.stefandraegersoftware.mvc;

import de.stefandraegersoftware.mvc.controler.MVCControler;
import de.stefandraegersoftware.mvc.model.MVCModel;
import de.stefandraegersoftware.mvc.view.MVCView;

public class Main {

    public static void main(String[] args) {
        MVCModel model = new MVCModel();

        MVCControler controler = new MVCControler(model);
        controler.start();

        MVCView view = new MVCView(model);
        controler.addObserver(model);
        controler.addObserver(view);
    }

}

die Klasse MVCStatics mit den statischen Variablen für die Anwendung

package de.stefandraegersoftware.mvc;

public class MVCStatics {

    public static final String ACTION_TIMEZONE = "action_timezone";
}

So nun wird folgendes Fenster angezeigt :

Die Zeit wird durch die Methode „actionPerformed(ActionEvent e)“ im Controler durch den java.swing.Timer im Interval von 1 sek. Aufgerufen und im Model gesetzt. Des Weiteren erzeugt der Controler ein „setChanged()“ und „notifyObservers();“ Event welcher alle angemeldeten Observer darauf hinweist das Objekte im Model geändert wurden.

Wenn jetzt der Benutzer in der Auswahlliste (JComboBox) eine andere Zeitzone wählt, wird diese neue Zeitzone im Model gespeichert und der Controler verwendet diese dann.

Jetzt haben wir eine View welche eine GUI (ein Grafisches Benutzer Interface) anzeigt, eine weitere View könnte zbsp. ein Ausdruck auf der Konsole sein wie zbsp.

Klasse MVCViewConsole.java

package de.stefandraegersoftware.mvc.view;

import java.util.Observable;
import java.util.Observer;

import de.stefandraegersoftware.mvc.model.MVCModel;

public class MVCViewConsole implements Observer {

    private MVCModel model;

    public MVCViewConsole(MVCModel model) {
        this.model = model;
    }

    @Override
    public void update(Observable o, Object arg) {
        System.out.println(this.model.getTimeValue());
    }
}

Nun noch die neue View am Controller anmelden

MVCViewConsole viewConsole = new MVCViewConsole(model);
controler.addObserver(viewConsole);

und schon wird auch die „ConsolenView“ aufgerufen und automatisch aktualisiert.

Und wie gewohnt zum Schluss das fertige Eclipse Projekt zum download.