Wicket PropertyModel で、WebPage と データ を分離する

目次

FrontPage
・Windows11
・Chromebook
・Random
・機械学習
・さくらVPS
・Fedora13
・SuSe10
・Docker
・Ansible
・Java
・Scala
・Python
・Ruby
・Lisp
・Computer
・GIS
・HTML
・Culture
・Link

訪問者

total: 16978
today: 4
yesterday: 5
now: 20

更新

最新の10件

人気の10件

MenuBar

ここでは、「Wicket とりあえず画面遷移とフォームデータの受け取りをする 」で作った、日記アプリケーションを改造して、「まともな」プログラム構造にする。

はじめに †

• 「Wicket とりあえず画面遷移とフォームデータの受け取りをする」では、Web Page クラスが、データ(モデル）を保持していた。
• しかし、この程度のアプリケーションでも、かなりコードがごちゃごちゃしていて、これ以上複雑なアプリケーションになると破綻しそう・・・
• Wicket では、Property Model を使うことにより、Model (データ) と View (ユーザインタフェース) を分離することができる。

画面に対応する DiaryVO(Value Object) をつくる。 †

• まずは、画面のデータを保持する DiaryVO を Web Page クラスから切り出す。
• DiaryVO の要件
  • データ項目を保持する フィールド変数 と アクセサ(getter / setter) を作る。
  • 変数名を表す定数を定義しておくと、後々 Web Page を作るとき に便利。
  • Serializable を実装する*1
• 画面
  
• Value Object

  package com.snail;
  
  import java.io.Serializable;
  import java.util.ArrayList;
  import java.util.Date;
  import java.util.List;
  
  public final class DiaryVO implements Serializable {
  
    private static final long serialVersionUID = -4270110566844001704L;
    
    public static String SUBJECT = "subject";
    public static String TYPE = "type";
    public static String DATE = "date";
    public static String ARTICLE = "article";
    
    private List<String> typeList;
    private String subject = null;
    private String type = null;
    private Date date = new Date();
    private String article = null;
  
    public DiaryVO() {
      typeList = new ArrayList<String>();
      typeList.add("Diary");
      typeList.add("Book Review");
      typeList.add("Tech Memo");
      typeList.add("Diet");
    }
  
    public String getSubject() {
      return subject;
    }
  
    public void setSubject(String subject) {
      this.subject = subject;
    }
  
    public String getType() {
      return type;
    }
  
    public void setType(String type) {
      this.type = type;
    }
  
    public Date getDate() {
      return date;
    }
  
    public void setDate(Date date) {
      this.date = date;
    }
  
    public String getArtcle() {
      return article;
    }
  
    public void setArtcle(String artcle) {
      this.article = artcle;
    }
  
    public List<String> getTypeList() {
      return typeList;
    }
  
    public void setTypeList(List<String> typeList) {
      this.typeList = typeList;
    }
  }
  

HomePageの改修 †

• 改修点
  • データは、フィールド変数の private DiaryVO diary に保持する。
    • 改修前

      private Model mSubject = new Model();
      private Model mType = new Model();
      private Model mDate = new Model(new Date());
      private Model mArticle = new Model(); 

    • 改修後

      private DiaryVO diary;

  • User Interface (TextField? や DropDownChoice? )への割り付けは、PropertyModel? を介して行う
    • 改修前

      TextField txtSubject = new TextField("subject",mSubject); 

    • 改修後

      TextField txtSubject = new TextField("subject",new PropertyModel(diary, DiaryVO.SUBJECT));

    • PropertyModel?(オブジェクト,プロパティ名*2) のプロパティ名を DiaryVO.SUBJECT のように定数で定義しておくと間違えが少ない
  • 次画面遷移時に渡すオブジェクトを、HomePage クラスから DiaryVO に変更
    • 改修前

       private Form form = new Form("f") {
         private static final long serialVersionUID = -1700095884500348972L;
      
         @Override
         protected void onSubmit() {
           ResultPage result = new ResultPage((HomePage) this.getParent());
           setResponsePage(result);
         }
       };

    • 改修後

      private Form form = new Form("f") {
         private static final long serialVersionUID = -1700095884500348972L;
         
         @Override
         protected void onSubmit() {
           ResultPage result = new ResultPage(diary);
           setResponsePage(result);
         }
      };

  • 引数に Diary を取るコンストラクタを作った。(この改修の意味については「前の画面に戻れるようにするには」で述べる）
• 改修後のHomePage

  package com.snail;
  
  import org.apache.wicket.PageParameters;
  import org.apache.wicket.markup.html.WebPage;
  import org.apache.wicket.markup.html.form.DropDownChoice;
  import org.apache.wicket.markup.html.form.Form;
  import org.apache.wicket.markup.html.form.TextArea;
  import org.apache.wicket.markup.html.form.TextField;
  import org.apache.wicket.markup.html.panel.FeedbackPanel;
  import org.apache.wicket.model.PropertyModel;
  
  public class HomePage extends WebPage {
  
    private static final long serialVersionUID = 3598788934381254916L;
  
    private Form form = new Form("f") {
      private static final long serialVersionUID = -1700095884500348972L;
  
      @Override
      protected void onSubmit() {
        ResultPage result = new ResultPage(diary);
        setResponsePage(result);
      }
    };
  
    private DiaryVO diary;
  
    private FeedbackPanel feedback = new FeedbackPanel("msg");
  
    public HomePage(final PageParameters parameters) {
      this(new DiaryVO());
    }
  
    public HomePage(final DiaryVO pDiary) {
      this.diary = pDiary;
  
      add(feedback);
  
      add(form);
  
      TextField txtSubject = new TextField("subject", 
          new PropertyModel(diary, DiaryVO.SUBJECT));
      txtSubject.setRequired(true);
      form.add(txtSubject);
  
      DropDownChoice cmbType = new DropDownChoice("type",
          new PropertyModel(diary, DiaryVO.TYPE), diary.getTypeList());
      cmbType.setRequired(true);
      form.add(cmbType);
  
      TextField txtDate = new TextField("date",
          new PropertyModel(diary, DiaryVO.DATE));
      txtDate.setRequired(true);
      form.add(txtDate);
  
      TextArea txtArticle = new TextArea("article", new PropertyModel(diary,
          DiaryVO.ARTICLE));
      txtArticle.setRequired(true);
      form.add(txtArticle);
    }
  }
  

前の画面に戻れるようにするには †

• 訂正: setResponsePage?() に WebPage? の class を渡してやると、初回はインスタンスが作られ、二回目以降は初回にインスタンスされた WebPage? が使われるようだ。
  • Wicket WebPageのインスタンス(画面遷移時の情報の受け渡し)?
• ResultPage? のコンストラクタの引数を DiaryVO にして、内部的に保持するようにした。
• HomePage に戻るときには、 保持している DiaryVO を引数にして HomePage のコンストラクタを呼び出してインスタンス化する。
• 改修後の ResultPage?

  package com.snail;
  
  import org.apache.wicket.markup.html.WebPage;
  import org.apache.wicket.markup.html.basic.Label;
  import org.apache.wicket.markup.html.form.Form;
  import org.apache.wicket.markup.html.form.TextArea;
  import org.apache.wicket.model.PropertyModel;
  
  public class ResultPage extends WebPage {
    private static final long serialVersionUID = -8680953158566804713L;
    private DiaryVO diary;
    private Form form = new Form("f") {
  
      private static final long serialVersionUID = 5522440160951241211L;
  
      @Override
      protected void onSubmit() {
        setResponsePage(new HomePage(diary));
      }
    };
  
    public ResultPage(DiaryVO pDiary) {
      this.diary = pDiary;
      add(new Label("subject", new PropertyModel(diary, DiaryVO.SUBJECT)));
      add(new Label("type", new PropertyModel(diary, DiaryVO.TYPE)));
      add(new Label("date", new PropertyModel(diary, DiaryVO.DATE)));
      add(new TextArea("article", new PropertyModel(diary, DiaryVO.ARTICLE)));
      add(form);
    }
  }
  

もっと簡略化する方法もあるが・・・ †

• VO のフィールド名と、HTMLの wicket:id が同じ時、CompoundPropertyModel? を使うと、TextArea? や Label に VOのフィールドを自動的に割り付けてくれる。
• さすがにココまでやると、一度作るといじれないプログラムになるので、PropertyModel? を使うのが適当では？
• 追記 : と思ったけど、実はこれが最適解のような気もしてきた・・・

  public class HomePage extends WebPage {
   
    private DiaryVO diary;
   
    private FeedbackPanel feedback = new FeedbackPanel("msg");
   
    public HomePage(final PageParameters parameters) {
      this(new DiaryVO());
    }
   
    public HomePage(final DiaryVO pDiary) {
      this.diary = pDiary;
   
      add(feedback);
   
      Form form = new Form("f", new CompoundPropertyModel(diary)) {
        @Override
        protected void onSubmit() {
          ResultPage result = new ResultPage(diary);
          setResponsePage(result);
        }
      });
      
      add(form);
   
      TextField txtSubject = new TextField("subject");
      txtSubject.setRequired(true);
      form.add(txtSubject);
   
      DropDownChoice cmbType = new DropDownChoice("type", diary.getTypeList());
      cmbType.setRequired(true);
      form.add(cmbType);
   
      TextField txtDate = new TextField("date");
      txtDate.setRequired(true);
      form.add(txtDate);
   
      TextArea txtArticle = new TextArea("article");
      txtArticle.setRequired(true);
      form.add(txtArticle);
    }
  }
  

Java#Wicket