この記事の要点

ActionMapping は Struts1 の struts-config.xml 内 <action> 1 件分のメタ情報を保持するクラス <action path="/login" type="LoginAction" name="loginForm" input="/login.jsp" /> がリクエスト URL とアクションクラスの対応を決める execute() 内で mapping.findForward("success") を呼ぶと <forward name="success" path="/home.jsp" /> が解決される 入力検証失敗時は input 属性で指定した JSP に戻る（ActionForm.validate() が ActionErrors を返すと自動分岐） <global-forwards> は全アクション共通の遷移先、modules で機能単位に struts-config-xxx.xml を分割可能 Struts1 は 2013 年 EOL。新規開発は Spring MVC / Spring Boot 推奨

ActionMapping とは

org.apache.struts.action.ActionMapping は Struts1 のコアクラスで、struts-config.xml に書かれた <action> 要素 1 件分の情報を保持します。フレームワークはリクエスト URL に対応する ActionMapping を見つけ、それを Action#execute() の第 1 引数として渡します。

struts-config.xml の典型例

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE struts-config PUBLIC
  "-//Apache Software Foundation//DTD Struts Configuration 1.3//EN"
  "http://struts.apache.org/dtds/struts-config_1_3.dtd">
<struts-config>

  <!-- フォーム Bean 定義 -->
  <form-beans>
    <form-bean name="loginForm" type="com.example.form.LoginForm" />
  </form-beans>

  <!-- グローバル遷移先 -->
  <global-forwards>
    <forward name="error"     path="/error.jsp" />
    <forward name="sessionTimeout" path="/login.jsp" redirect="true" />
  </global-forwards>

  <!-- アクション定義 -->
  <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" redirect="true" />
      <forward name="failure" path="/login.jsp" />
    </action>
  </action-mappings>

</struts-config>

属性の意味

属性	意味	備考
path	リクエスト URL の論理名（拡張子前）	/login なら /login.do が来る
type	実行する Action クラス FQDN	必須
name	使用する ActionForm の論理名	form-beans 内の name と対応
scope	フォームのスコープ	request / session
input	検証失敗時の戻り先 JSP	validate="true" 時に必須
validate	フォーム検証を行うか	true で validate() が呼ばれる
parameter	サブメソッド指定（DispatchAction 用）	method 等

Action#execute() での使い方

package com.example.action;

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

public class LoginAction extends Action {

    @Override
    public ActionForward execute(ActionMapping mapping,
                                 ActionForm form,
                                 HttpServletRequest request,
                                 HttpServletResponse response) throws Exception {

        LoginForm lf = (LoginForm) form;

        // ビジネスロジック
        boolean ok = AuthService.login(lf.getUserId(), lf.getPassword());

        if (ok) {
            // <forward name="success" path="/home.jsp"/> へ
            return mapping.findForward("success");
        } else {
            // ActionErrors を積んで戻る
            ActionMessages errors = new ActionMessages();
            errors.add(ActionMessages.GLOBAL_MESSAGE,
                       new ActionMessage("error.login.failed"));
            saveErrors(request, errors);

            // <forward name="failure" path="/login.jsp"/> へ
            return mapping.findForward("failure");
        }
    }
}

findForward() の動作順

mapping.findForward("success") は次の順で ActionForward を探します:

1. その <action> 配下の <forward name="success">
2. 見つからなければ <global-forwards> 配下の <forward name="success">
3. それも無ければ null を返す（白画面 / NPE の元）

入力検証失敗時のフロー（input 属性）

validate="true" の場合、ActionForm#validate() が execute() より先に呼ばれます。ActionErrors が空でなければ execute() はスキップされ、input 属性の JSP に戻ります:

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

    @Override
    public ActionErrors validate(ActionMapping mapping, HttpServletRequest request) {
        ActionErrors errors = new ActionErrors();
        if (userId == null || userId.isEmpty()) {
            errors.add("userId", new ActionMessage("error.userId.required"));
        }
        if (password == null || password.length() < 8) {
            errors.add("password", new ActionMessage("error.password.length"));
        }
        return errors;  // 空でなければ input 属性の JSP へ
    }
    // getter/setter ...
}

modules による分割

大規模アプリでは機能単位に config を分けられます:

<!-- web.xml -->
<servlet>
  <servlet-name>action</servlet-name>
  <servlet-class>org.apache.struts.action.ActionServlet</servlet-class>
  <init-param>
    <param-name>config</param-name>
    <param-value>/WEB-INF/struts-config.xml</param-value>
  </init-param>
  <init-param>
    <param-name>config/order</param-name>
    <param-value>/WEB-INF/struts-config-order.xml</param-value>
  </init-param>
  <init-param>
    <param-name>config/admin</param-name>
    <param-value>/WEB-INF/struts-config-admin.xml</param-value>
  </init-param>
</servlet>

URL は /order/list.do, /admin/users.do のように module 名が prefix になります。

Spring MVC への移行

Struts1 は Apache 公式 2013 年 12 月 EOL。新規開発はもちろん、既存も計画的に Spring MVC / Spring Boot に移行すべきです。対応関係:

Struts1	Spring MVC
<action path="/login">	@RequestMapping("/login")
ActionForm	@ModelAttribute の DTO
ActionForward	return "home" (View 名)
findForward("success")	同上 / ModelAndView
validate()	@Valid + Bean Validation
struts-config.xml	Java Config / @Configuration

FAQ

Q: findForward() が null を返す
A: <forward name="..."> のスペルミスが多い。<global-forwards> にも無いか確認。

Q: input 属性が無いと？
A: validate="true" で検証失敗時に java.lang.IllegalStateException: No input attribute。input は必須。

Q: redirect="true" の意味
A: RequestDispatcher.forward() ではなく sendRedirect() を使う。request 属性は失われるので注意。