struts2: config-browser-plugin 與 convention-plugin 學習

struts2被很多新手詬病的一個地方在於“配置過於復雜”，相信不少初學者因為這個直接改投Spring-MVC了。convention-plugin、 config-browser-plugin這二個插件的出現，很大程度改善了這個囧境。

簡言之：convention-plugin采用"約定大於配置”的思想，只要我們遵守約定，完全可以少寫配置甚至不寫配置；而config-browser-plugin則用於方便的瀏覽項目中的所有action及其與jsp view的映射。這二個插件結合起來學習，能很方便的搞定struts2中各種復雜的action-view映射需求。

一、config-browser-plugin使用

<dependency>
    <groupId>org.apache.struts</groupId>
    <artifactId>struts2-config-browser-plugin</artifactId>
    <version>2.3.16</version>
</dependency>

maven項目的pom.xml中加上這個即可，運行后，瀏覽 http://localhost:8080/{你的項目名稱}/config-browser/ 即可看到當前項目中的所有action 

注：以下內容中，凡有url的地方，項目名稱假設為struts2-helloworld

如果跑不起來，檢查服務器應用WEB-INF/lib/下是否有struts2-config-browser-plugin-2.3.16.jar 這個文件

 

二、convention-plugin 使用

<dependency>
    <groupId>org.apache.struts</groupId>
    <artifactId>struts2-convention-plugin</artifactId>
    <version>2.3.16</version>
</dependency>

pom.xml中加上這個后，可以把struts.xml配置文件給干掉了（或者改個名），部署App，如果啟動正常，則表示環境ok。如果提示缺少asm 啥類，檢查下面這幾個依賴項，是否也加進來了

<dependency>
    <groupId>asm</groupId>
    <artifactId>asm</artifactId>
    <version>3.3.1</version>
</dependency>

<dependency>
    <groupId>asm</groupId>
    <artifactId>asm</artifactId>
    <version>3.3.1</version>
</dependency>

<dependency>
    <groupId>asm</groupId>
    <artifactId>asm-commons</artifactId>
    <version>3.3.1</version>
</dependency>

<dependency>
    <groupId>asm</groupId>
    <artifactId>asm-tree</artifactId>
    <version>3.3.1</version>
</dependency>

 

2.1 零action的view

convention-plugin約定所有的jsp view都放在WEB-INF/content目錄下，在這個目錄下先隨便放一個名為"no-action.jsp"的jsp文件，里面隨便寫點啥

瀏覽 http://localhost:8080/struts2-helloworld/no-action

即：即使沒有對應的Action類，struts2也能按約定正常展現頁面。(當然，這只是開胃小菜，真正應用中，除了做一些純靜態的頁面原型之外，大部分場景，背后還是要有Action類來支撐的)

 

2.2 常規映射

建一個HelloWorld.action類

package com.cnblogs.yjmyzz.action;

import org.apache.struts2.convention.annotation.Action;
import org.apache.struts2.convention.annotation.Namespace;
import org.apache.struts2.convention.annotation.Result;

@Namespace("/home")
public class HelloWorldAction extends BaseAction {

    private static final long serialVersionUID = -8827776224243873974L;

    private String message;

    @Action("hello-world")
    public String execute() throws Exception {
        return SUCCESS;
    }

    @Action(value = "say-hi", results = { @Result(name = "success", location = "hello-world.jsp") })
    public String sayHi() throws Exception {
        message = "welcome to SSH!";
        return SUCCESS;
    }

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }

}

解釋一下：

第7行，在整個Action類上使用了@Namespace("/home")，表示整個Action最終瀏覽的url，是以 http://localhost:8080/{你的項目名稱}/home/ 打頭

第14行，通過注解@Action("hello-world")，把默認的/home/index.action路徑，改成了 /home/hello-world

至於execute方法，返回success后，對應的是哪個jsp文件，這個不用死記，通過config-browser-plugin看下便知

即：execute方法返回input/error/success中的任何一個，都會映射到/WEB-INF/content/home/hello-world.jsp 這個文件上

20行sayHI()方法上的注解有點意思，@Action(value = "say-hi", results = { @Result(name = "success", location = "hello-world.jsp") })，默認情況下，如果不指定location，返回success時，它應該對應 /WEB-INF/content/home/say-hi.jsp這個文件，但是通過location值，變成了hello-world.jsp，即與/home/hello-world共用同一個view.

 

3、攔截器問題

上一篇學習了通過攔截器來處理異常，采用convention插件后，會發現攔截器不起作用(struts.xml中配置了也一樣)

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

<struts>

    <constant name="struts.enable.DynamicMethodInvocation" value="false" />
    <constant name="struts.devMode" value="false" />

    <package name="default" namespace="/" extends="struts-default">

        <interceptors>
            <interceptor name="myinterceptor"
                class="com.cnblogs.yjmyzz.Interceptor.ExceptionInterceptor">
            </interceptor>

            <interceptor-stack name="myStack">
                <interceptor-ref name="myinterceptor" />
            </interceptor-stack>
        </interceptors>

        <default-interceptor-ref name="myStack" />
        <default-action-ref name="index" />

        <global-results>
            <result name="error">/WEB-INF/common/error.jsp</result>
        </global-results>

        <global-exception-mappings>
            <exception-mapping exception="java.lang.Exception"
                result="error" />
        </global-exception-mappings>

        <action name="index">
            <result type="redirectAction">
                <param name="actionName">hello-world</param>
                <param name="namespace">/home</param>
            </result>
        </action>

    </package>

<!-- 因為有Convention-plugin，就不再需要手動寫action-view的映射規則了 -->
<!--     <include file="struts-home.xml" />
    <include file="struts-mytatis.xml" />  -->

</struts>

原因在於convention-plugin使用后，所有Action不再繼承自默認defaultStack對應的package，為了解決這個問題，建議所有Action都繼承自一個自定義的BaseAction類，然后在BaseAction上加上@ParentPackage("default")，讓所有Action強制繼承自struts.xml中定義的default package

package com.cnblogs.yjmyzz.action;

import org.apache.struts2.convention.annotation.ParentPackage;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.opensymphony.xwork2.ActionSupport;

@ParentPackage("default")
public class BaseAction extends ActionSupport {

    private static final long serialVersionUID = -4320398837758540242L;
    protected Logger logger = LoggerFactory.getLogger(this.getClass());

}

 

基本用法就是這些，如果不清楚Action最終出來的url是啥，或者不清楚某個url最終會對應到哪個jsp文件，無需死記規則，只要善用config-browser-plugin，大多數下不用查閱文檔即可快速解決問題。