過去バージョン

ActionForm とは

org.apache.struts.action.ActionForm は Struts1 でフォーム入力値を保持する Java Beanの基底クラスです。HTML フォームの name 属性と Bean のプロパティ名を一致させると、Struts が自動的に setter を呼んでフィールドに値を詰めてくれます。

定義の例

package com.example.form;

import org.apache.struts.action.*;
import javax.servlet.http.HttpServletRequest;

public class LoginForm extends ActionForm {
    private String userId;
    private String password;
    private boolean rememberMe;

    @Override
    public void reset(ActionMapping mapping, HttpServletRequest request) {
        // チェックボックスは送信されないと値が来ないので明示初期化
        this.rememberMe = false;
    }

    @Override
    public ActionErrors validate(ActionMapping mapping, HttpServletRequest request) {
        ActionErrors errors = new ActionErrors();
        if (userId == null || userId.trim().isEmpty()) {
            errors.add("userId",
                new ActionMessage("error.userId.required"));
        }
        if (password == null || password.length() < 8) {
            errors.add("password",
                new ActionMessage("error.password.length", "8"));
        }
        return errors;
    }

    // --- getter / setter ---
    public String getUserId() { return userId; }
    public void setUserId(String v) { this.userId = v; }
    public String getPassword() { return password; }
    public void setPassword(String v) { this.password = v; }
    public boolean isRememberMe() { return rememberMe; }
    public void setRememberMe(boolean v) { this.rememberMe = v; }
}

JSP からのバインディング

<%@ taglib uri="http://struts.apache.org/tags-html" prefix="html" %>

<html:form action="/login" focus="userId">
  <p>ユーザ ID: <html:text property="userId" size="20" /></p>
  <p>パスワード: <html:password property="password" size="20" /></p>
  <p><html:checkbox property="rememberMe" /> ログインを記憶</p>
  <p><html:submit value="ログイン" /></p>
</html:form>

<%-- エラー表示 --%>
<html:errors />

HTML タグの property 属性が Bean のプロパティ名（getter/setter）と一致している必要があります。

struts-config.xml での宣言

<form-beans>
  <form-bean name="loginForm"
             type="com.example.form.LoginForm" />
</form-beans>

<action-mappings>
  <action path="/login"
          type="com.example.action.LoginAction"
          name="loginForm"
          scope="request"
          input="/login.jsp"
          validate="true">
    <forward name="success" path="/home.jsp" />
  </action>
</action-mappings>

ライフサイクル

DynaActionForm: Bean クラスを書かない方法

フォーム項目が多いと Bean を書くのが面倒。DynaActionForm は xml だけで定義できます:

<form-beans>
  <form-bean name="userForm"
             type="org.apache.struts.action.DynaActionForm">
    <form-property name="userId"   type="java.lang.String" />
    <form-property name="age"      type="java.lang.Integer" initial="0" />
    <form-property name="email"    type="java.lang.String" />
    <form-property name="hobbies"  type="java.lang.String[]" />
  </form-bean>
</form-beans>

Action 側でのアクセス:

public ActionForward execute(ActionMapping mapping, ActionForm form, ...) {
    DynaActionForm df = (DynaActionForm) form;
    String userId = (String)  df.get("userId");
    Integer age   = (Integer) df.get("age");
    String[] hobbies = (String[]) df.get("hobbies");
    // ...
}

DynaValidatorForm + Validator フレームワーク

DynaValidatorForm + Commons Validator なら xml で検証ルールも宣言できます:

<!-- validation.xml -->
<form-validation>
  <formset>
    <form name="userForm">
      <field property="userId" depends="required,minlength">
        <arg position="0" key="label.userId" />
        <var><var-name>minlength</var-name><var-value>4</var-value></var>
      </field>
      <field property="age" depends="required,integer,intRange">
        <arg position="0" key="label.age" />
        <var><var-name>min</var-name><var-value>0</var-value></var>
        <var><var-name>max</var-name><var-value>150</var-value></var>
      </field>
    </form>
  </formset>
</form-validation>

使い分け

Spring MVC との比較

// Spring MVC 版 (Struts1 ActionForm + validate に相当)
public class LoginDto {
    @NotBlank
    private String userId;
    @Size(min = 8)
    private String password;
    private boolean rememberMe;
    // getter/setter ...
}

@Controller
public class LoginController {
    @PostMapping("/login")
    public String login(@Valid @ModelAttribute LoginDto dto,
                        BindingResult br,
                        Model model) {
        if (br.hasErrors()) {
            return "login";  // input 属性に相当
        }
        // ...
        return "redirect:/home";
    }
}

FAQ

Q: チェックボックスの値が消える
A: 未チェック時はパラメータ自体が送信されません。reset() で false 初期化するのが Struts1 の定型パターン。

Q: validate() が呼ばれない
A: <action validate="true"> になっているか、input 属性が指定されているか確認。

Q: 入れ子の Bean をマッピングできる？
A: html:text property="address.zip" のようにドット記法可。ただし Bean 側で getAddress().setZip() の経路が必要。