Struts2简介及入门

Posted 2020-11-29 爱吃兔肉的保尔

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Struts2简介及入门相关的知识，希望对你有一定的参考价值。

一、概述
二、Struts2 快速入门程序
三、对入门程序进行流程分析
四、Struts2配置
五、Action

一、概述

问题:什么是框架，框架有什么用?
- 框架是实现部分功能的代码（半成品），使用框架简化企业级软件开发 ,提高开发效率。
- 学习框架，要清楚的知道框架能做什么，还有哪些工作需要自己编码实现
问题:什么是Struts2框架，它有什么用?
- Struts2 是Struts的下一代产品，是在 Struts1 和 WebWork 的技术基础上进行了合并的全新的Struts2框架。其全新的Struts2的体系结构与Struts1的体系结构差别巨大。Struts2以WebWork为核心,Struts2=Struts1+Webwork
- Struts2框架是Apache产品。
- Struts2是一个标准的MVC框架。
- JavaWeb中的 Model2 模式就是一个mvc模式
- Model2=Servlet+Jsp+JavaBean
- Struts2框架是在Javaweb开发中使用的。
- 使用Struts2框架，可以简化我们的web开发，并且降低程序的耦合度。
类似于struts2框架的产品 :
- Struts1 Webwork Jsf Springmvc
- SSH --- Struts2 + Spring + Hibernate
- SSM --- SpringMVC + Spring + Mbatis
XWork --- 它是WebWork核心
- Xwork提供了很多核心功能：前端拦截机（interceptor），运行时表单属性验证，类型转换，强大的表达式语言（OGNL – the Object Graph Navigation Language），IoC（Inversion of Control反转控制）容器等

二、Struts2 快速入门程序

2.1 开发流程比较

Web开发流程：index.jsp------>HelloServlet-------->hello.jsp
Struts2流程：index.jsp------>HelloAction--------->hello.jsp

2.2 引入依赖

<!-- https://mvnrepository.com/artifact/org.apache.struts/struts2-core -->
<dependency>
    <groupId>org.apache.struts</groupId>
    <artifactId>struts2-core</artifactId>
    <version>2.3.16.3</version>
</dependency>

2.2 创建jsp页面

创建index.jsp页面(后面修改)
创建hello.jsp页面(内容如下)

<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
  <head> 
    <title>My JSP 'index.jsp' starting page</title>
  </head>
  
  <body>
    <h1>hello Struts2</h1>
  </body>
</html>

2.3 在web.xml中配置前端控制器

在web.xml文件中配置前端控制器(核心控制器)-----就是一个Filter

<filter>
    <filter-name>struts2</filter-name>
    <filter-class>org.apache.struts2.dispatcher.ng.filter.StrutsPrepareAndExecuteFilter</filter-class>
</filter>
<filter-mapping>
    <filter-name>struts2</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

2.4 创建struts.xml配置文件

在src下(classes下)创建一个struts.xml配置文件 ,这个是struts2框架配置文件。

2.4 创建一个HelloAction类

要求，在HelloAction类中创建一个返回值是String类型的方法，注意，无参数。

public class HelloAction {
    
    public String say() {
        return "good";
    }
}

2.5 在struts.xml文件中配置HelloAction

<?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>

    <package name="default" namespace="/" extends="struts-default">
        <action name="hello" class="com.hao.action.HelloAction"
            method="say">
            <result name="good">/hello.jsp</result>
        </action>
    </package>
    
</struts>

2.6 在index.jsp中添加连接，测试

<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
  <head>  
    <title>My JSP 'index.jsp' starting page</title>
  </head>
  <body>
    <a href="${pageContext.request.contextPath}/hello">第一次使用struts2</a>
  </body>
</html>

2.7 测试

在地址栏中输入:http://localhost:8080/Struts2-001-EntryP/index.jsp 访问连接，就可以看到 HelloAction类中的say方法执行了，也跳转到了hello.jsp.

三、对入门程序进行流程分析

模仿struts2流程完成入门程序:

3.1 创建项目，引入Maven依赖

<dependency>
    <groupId>org.apache.struts</groupId>
    <artifactId>struts2-core</artifactId>
    <version>2.3.16.3</version>
</dependency>

<dependency>
    <groupId>javax.servlet</groupId>
    <artifactId>servlet-api</artifactId>
    <version>3.0-alpha-1</version>
    <scope>provided</scope>
</dependency>

<!-- https://mvnrepository.com/artifact/dom4j/dom4j -->
<dependency>
    <groupId>dom4j</groupId>
    <artifactId>dom4j</artifactId>
    <version>1.6.1</version>
</dependency>
<!-- https://mvnrepository.com/artifact/commons-beanutils/commons-beanutils -->
<dependency>
    <groupId>commons-beanutils</groupId>
    <artifactId>commons-beanutils</artifactId>
    <version>1.9.3</version>
</dependency>

3.2 自定义StrusFilter 过滤器

1.创建一个Filter----StrutsFilter
2.在web.xml文件中配置StrutsFilter

<!DOCTYPE web-app PUBLIC
 "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
 "http://java.sun.com/dtd/web-app_2_3.dtd" >

<web-app>
  <display-name>Archetype Created Web Application</display-name>
  <filter>
    <filter-name>StrutsFilter</filter-name>
    <display-name>StrutsFilter</display-name>
    <description></description>
    <filter-class>com.hao.filter.StrutsFilter</filter-class>
  </filter>
  <filter-mapping>
    <filter-name>StrutsFilter</filter-name>
    <url-pattern>/*</url-pattern>
  </filter-mapping>
</web-app>

3.在StrutsFilter中完成拦截操作，并访问Action中的方法，跳转到hello.jsp页面操作.

public class StrutsFilter implements Filter {

    public void init(FilterConfig filterConfig) throws ServletException {

    }

    public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain)
            throws IOException, ServletException {

        // 1.强转
        HttpServletRequest request = (HttpServletRequest) req;
        HttpServletResponse response = (HttpServletResponse) resp;

        // 2.操作

        // 2.1 得到请求资源路径
        String uri = request.getRequestURI();
        String contextPath = request.getContextPath();
        String path = uri.substring(contextPath.length() + 1);

        // System.out.println(path); // hello

        // 2.2 使用path去struts.xml文件中查找某一个<action name=path>这个标签
        SAXReader reader = new SAXReader();

        try {
            // 得到struts.xml文件的document对象。
            Document document = reader.read(new File(this.getClass().getResource("/struts.xml").getPath()));

            Element actionElement = (Element) document.selectSingleNode("//action[@name='" + path + "']"); // 查找<action
                                                                                                            // name='hello'>这样的标签

            if (actionElement != null) {
                // 得到<action>标签上的class属性以及method属性
                String className = actionElement.attributeValue("class"); // 得到了action类的名称
                String methodName = actionElement.attributeValue("method");// 得到action类中的方法名称。

                // 2.3通过反射，得到Class字节码对象，得到Method对象
                Class<?> actionClass = Class.forName(className);
                Method method = actionClass.getDeclaredMethod(methodName);

                // 处理请求参数封装:

                Object actionObj = actionClass.newInstance();

                // 2.模型驱动
                if (actionObj instanceof MyModelDriven) {
                    MyModelDriven mmd = (MyModelDriven) actionObj;

                    BeanUtils.populate(mmd.getModel(), request.getParameterMap());
                } else {
                    // 1.属性驱动
                    BeanUtils.populate(actionObj, request.getParameterMap());//
                }

                // 2.4 让method执行.
                String returnValue = (String) method.invoke(actionObj); // 是让action类中的方法执行，并获取方法的返回值。

                // 2.5
                // 使用returnValue去action下查找其子元素result的name属性值，与returnValue做对比。
                Element resultElement = actionElement.element("result");
                String nameValue = resultElement.attributeValue("name");

                if (returnValue.equals(nameValue)) {
                    // 2.6得到了要跳转的路径。
                    String skipPath = resultElement.getText();

                    // System.out.println(skipPath);

                    request.getRequestDispatcher(skipPath).forward(request, response);
                    return;
                }
            }

        } catch (DocumentException e) {
            e.printStackTrace();
        } catch (ClassNotFoundException e) {
            e.printStackTrace();
        } catch (NoSuchMethodException e) {
            e.printStackTrace();
        } catch (SecurityException e) {
            e.printStackTrace();
        } catch (IllegalAccessException e) {
            e.printStackTrace();
        } catch (IllegalArgumentException e) {
            e.printStackTrace();
        } catch (InvocationTargetException e) {
            e.printStackTrace();
        } catch (InstantiationException e) {
            e.printStackTrace();
        }

        // 3.放行
        chain.doFilter(request, response);

    }

    public void destroy() {
    }

}

3.3 流程分析

请求 ---- StrutsPrepareAndExecuteFilter 核心控制器 ----- Interceptors 拦截器（实现代码功能） ----- Action 的execute --- 结果页面 Result

四、Struts2配置

4.1 Struts2 配置文件加载顺序

Struts2框架要能执行，必须先加载StrutsPrepareAndExecuteFilter.
在StrutsPrepareAndExecuteFilter的init方法中对Dispatcher进行了初始化.
在Dispatcher类中定义的init方法内就描述了struts2配置文件加载的顺序

// [1]   org/apache/struts2/default.properties 
init_DefaultProperties();
// [2]  struts-default.xml,struts-plugin.xml,struts.xml 
init_TraditionalXmlConfigurations(); 
// [3] --- 自定义struts.properties  (源码中的注释没有[4])
init_LegacyStrutsProperties(); 
// [5]  ----- 自定义配置提供
init_CustomConfigurationProviders(); 
// [6] ----- web.xml 
init_FilterInitParameters() ; 
// [7] ---- Bean加载 
init_AliasStandardObjects() ;

1.default.properties文件
    作用:定义了struts2框架中所有常量
    位置: org/apache/struts2/default.properties ,struts2-core.jar包下
    
2.struts-default.xml
    作用:配置了bean,interceptor,result等。
    位置:在struts的core核心jar包.
    
  struts-plugin.xml
    它是struts2框架中所使用的插件的配置文件。
  struts.xml              
    我们使struts2所使用的配置文件。
        
3.自定义的struts.properties
    我们可以自定义常量。
    
4.web.xml
    
在开发中，后加载文件中的配置会将先加载文件中的配置覆盖。我们一般要记住如下顺序即可：
default.properties
struts-default.xml
struts.xml

4.2 关于Action的配置

<package> 作用:是用于声明一个包。用于管理action。它的常用属性如下
- name: 它用于声明一个包名，包名不能重复，也就是它是唯一的。
- namespace: 它与action标签的name属性合并确定了一个唯一访问action的路径。
- extends: 它代表继承的包名。
- abstrace: 它可以取值为true/false,如果为true,代表这个包是用于被继承的。
<action> 用于声明一个action，它的常用属性如下：
- name: 就是action的一个名称，它是唯一的(在同包内) 它与package中的namespace确定了访问action的路径。
- class: Action类的全名
- method: 要访问的Action类中的方法的名称,方法无参数，返回值为String.
<result> 用于确定返回结果类型,它的常用属性如下：
- name 它与action中的方法返回值做对比，确定跳转路径。

4.3 关于action配置其它细节：

关于默认值问题
- <package namespace="默认值"> -- namespace的默认值是 ""
- <action class="默认值" method="默认值"> -- class的默认值是 "com.opensymphony.xwork2.ActionSupport" ，method的默认值是execute
- <result name="默认值"> name的默认值是 "success"
关于访问action的路径问题 ,现在的action的配置是:
```
<package name="default" namespace="/" extends="struts-default">
<action name="hello" class="com.hao.action.DefaultAction">

    <result>/hello.jsp</result>

</action>

</package>
```
- 当我们输入: http://localhost/Struts2-003-ExerConfig/a/b/c/hello, 也可以访问到了action。
- 原因:struts2中的action被访问时，它会首先查找
- txt 1.namespace="/a/b/c" action的name=hello 没有. 2.namespace="/a/b action的name=hello 没有 3.namespace="/a" action的name=hello 没有 4.namespace="/" action的name=hello 查找到了.
- 如果最后也查找不到，会报404错误.
默认的action。
- 作用:处理其它action处理不了的路径。
- <default-action-ref name="action的名称" /> ，配置了这个，当访问的路径，其它的action处理不了时，就会执行name指定的名称的action。
action的默认处理类
- 在action配置时，如果class不写。默认情况下是com.opensymphony.xwork2.ActionSupport
- <default-class-ref class="com.hao.action.DefaultAction"/>,如果设置这个了，那么在当前包下，默认处理action请的的处理类就为class指定的类。

4.4 关于常量配置

default.properties 它声明了struts中的常量。
问题:人为设置常量，可以在哪些位置设置？
- 1.struts.xml(应用最多)，<constant name="常量名称" value="常量值"></constant>
- 2.struts.properties（基本不使用）
- 3.web.xml(了解)，配置常量，是使用StrutsPrepareAndExecuteFilter的初始化参数来配置的.
```
<init-param>
    <param-name>struts.action.extension</param-name>

    <param-value>do,,</param-value>

</init-param>
```
常用常量
- struts.action.extension=action,, -- 这个常量用于指定strus2框架默认拦截的后缀名.
- <constant name="struts.i18n.encoding" value="UTF-8"/> -- 相当于request.setCharacterEncoding("UTF-8"); 解决post请求乱码
- <constant name="struts.serve.static.browserCache" value="false"/> -- false不缓存，true浏览器会缓存静态内容，生产环境设置true、开发环境设置false
- <constant name="struts.devMode" value="true" /> ，提供详细报错页面，修改struts.xml后不需要重启服务器

3.5 struts.xml文件的分离:

目的:就是为了阅读方便。可以让一个模块一个配置文件，在struts.xml文件中通过<include file="test.xml"/> 导入其它的配置文件。

五、Action

5.1 Action类的创建方式

三种创建方式

创建一个POJO类.
- 简单的Java对象(Plain Old Java Objects)
- 指的是没有实现任何接口，没有继承任何父类(除了Object)
- 优点:无耦合。
- 缺点：所有工作都要自己实现。
- 在struts2框架底层是通过反射来操作:
  - struts2框架读取struts.xml 获得完整Action类名
  - obj = Class.forName("完整类名").newInstance();
  - Method m = Class.forName("完整类名").getMethod("execute"); m.invoke(obj); 通过反射执行 execute方法

创建一个类，实现Action接口.(com.opensymphony.xwork2.Action)

优点:耦合低。提供了五种结果视图，定义了一个行为方法。
缺点:所有工作都要自己实现。

public static final String SUCCESS = "success";  // 数据处理成功 （成功页面）
public static final String NONE = "none";  // 页面不跳转  return null; 效果一样

public static final String ERROR = "error";  // 数据处理发送错误 (错误页面)

public static final String INPUT = "input"; // 用户输入数据有误，通常用于表单数据校验 （输入页面）

public static final String LOGIN = "login"; // 主要权限认证 (登陆页面)

创建一个类，继承自ActionSupport类. (com.opensymphony.xwork2.ActionSupport)
- ActionSupport类实现了Action接口。
- 优点:表单校验、错误信息设置、读取国际化信息三个功能都支持.
- 缺点:耦合度高。
- 在开发中，第三种会使用的比较多.

5.2 关于action的访问

1.通过设置method的值，来确定访问action类中的哪一个方法.
- <action name="book_add" class="com.hao.action.BookAction" method="add"></action>
- 当访问的是book_add,这时就会调用BookAction类中的add方法。
- <action name="book_update" class="com.hao.action.BookAction" method="update"></action>
- 当访问的是book_update,这时就会调用BookAction类中的update方法。

2.使用通配符来简化配置

在struts.xml文件中配置
<action name="*_*" class="com.hao.action.{1}Action" method="{2}"></action>
jsp页面
book.jsp

<a href="${pageContext.request.contextPath}/Book_add">book add</a><br>
<a href="${pageContext.request.contextPath}/Book_update">book update</a><br>

<a href="${pageContext.request.contextPath}/Book_delete">book delete</a><br>

<a href="${pageContext.request.contextPath}/Book_search">book search</a><br>

product.jsp

<a href="${pageContext.request.contextPath}/Product_add">product add</a><br>
<a href="${pageContext.request.contextPath}/Product_update">product update</a><br>

<a href="${pageContext.request.contextPath}/Product_delete">product delete</a><br>

<a href="${pageContext.request.contextPath}/Product_search">product search</a><br>

当访问book add时，这时的路径是 Book_add,那么对于struts.xml文件中.
第一个 * 就是 Book
第二个 * 就是 add
对于{1}Action---->BookAction
对于method={2}--->method=add
使用通配符来配置注意事项:
1.必须定义一个统一的命名规范。
2.不建议使用过多的通配符，阅读不方便。

3.动态方法调用 (了解)
- 在struts.xml文件中
- <action name="book" class="com.hao.action.BookAction"></action> 访问时路径: http://localhost/Struts2-003-ExerConfig/book!add
  就访问到了BookAction类中的add方法。
- 对于book!add 这就是动态方法调用。
- 注意：struts2框架支持动态方法调用，是因为在default.properties配置文件中设置了,动态方法调用为true. struts.enable.DynamicMethodInvocation = true

5.3 在struts2框架中获取servlet api

对于struts2框架，不建议直接使用servlet api;
在struts2中获取servlet api有三种方式:
1.通过ActionContext来获取
- 获取一个ActionContext对象。 ActionContext context=ActionContext.getContext()
- 获取servlet api
- 注意:通过ActionContext获取的不是真正的Servlet api,而是一个Map集合。
```
1.context.getApplication()
2.context.getSession()

3.context.getParameter();---得到的就相当于request.getParameterMap()

4.context.put(String,Object) 相当于request.setAttribute(String,String);
```

2.注入方式获取(这种方式是真正的获取到了servlet api)

要求action类必须实现提定接口。
ServletContextAware ：注入ServletContext对象
ServletRequestAware ：注入 request对象
ServletResponseAware ：注入response对象
重写接口中的方法。
声明一个web对象，使用接口中的方法的参数对声明的web对象赋值.

//获取servlet api  通过注入方式
public class ServletDemo2Action extends ActionSupport implements

    ServletRequestAware {

private HttpServletRequest request;

@Override

public String execute() throws Exception {

    System.out.println(request.getParameter("username"));

    return null;

}

public void setServletRequest(HttpServletRequest request) {

    this.request = request;

}

}

扩展:分析其实现,是使用struts2中的一个interceptor完成的.（ struts-default.xml中的拦截器）

<interceptor name="servletConfig" class="org.apache.struts2.interceptor.ServletConfigInterceptor"/>

     if (action instanceof ServletRequestAware) { //判断action是否实现了ServletRequestAware接口
        HttpServletRequest request = (HttpServletRequest) context.get(HTTP_REQUEST); //得到request对象.

        ((ServletRequestAware) action).setServletRequest(request);//将request对象通过action中重写的方法注入。

    }

3.通过ServletActionContext获取.在ServletActionContext中方法都是static。

//获取servlet api  通过ServletActionContext获取
public class ServletDemo3Action extends ActionSupport {

    @Override
    public String execute() throws Exception {
        HttpServletRequest request = ServletActionContext.getRequest();

        System.out.println(request.getParameter("username"));
        return SUCCESS;
    }

}

5.4 Result结果类型

标签
1.name 与action中的method的返回值匹配，进行跳转.
2.type 作用:是用于定义跳转方式
对于type属性它的值有以下几种:在struts-default.xml文件中定义了type可以取的值

<result-type name="chain" class="com.opensymphony.xwork2.ActionChainResult"/>
<result-type name="dispatcher" class="org.apache.struts2.dispatcher.ServletDispatcherResult" default="true"/>
<result-type name="freemarker" class="org.apache.struts2.views.freemarker.FreemarkerResult"/>
<result-type name="httpheader" class="org.apache.struts2.dispatcher.HttpHeaderResult"/>
<result-type name="redirect" class="org.apache.struts2.dispatcher.ServletRedirectResult"/>
<result-type name="redirectAction" class="org.apache.struts2.dispatcher.ServletActionRedirectResult"/>
<result-type name="stream" class="org.apache.struts2.dispatcher.StreamResult"/>
<result-type name="velocity" class="org.apache.struts2.dispatcher.VelocityResult"/>
<result-type name="xslt" class="org.apache.struts2.views.xslt.XSLTResult"/>
<result-type name="plainText" class="org.apache.struts2.dispatcher.PlainTextResult" />

必会: chain dispatcher redirect redirectAction stream
dispatcher:它代表的是请求转发，也是默认值。它一般用于从action跳转到页面。
chain:它也相当于请求转发。它一般情况下用于从一个action跳转到另一个action。
redirect:它代表的是重定向它一般用于从action跳转到页面
redirectAction: 它代表的是重定向它一般用于从action跳转另一个action。
stream:代表的是服务器端返回的是一个流，一般用于下载。
局部结果页面与全局结果页面

<package name="default" namespace="/" extends="struts-default">
    <!-- 全局结果页面 -->
    <global-results>
        <result>/demo1_success.jsp</result>
    </global-results>

    <action name="demo1" class="com.hao.action.ServletDemo1Action">
        <!-- 局部结果页面 -->
    </action>

    <action name="demo2" class="com.hao.action.ServletDemo2Action">
        <!-- <result>/demo1_success.jsp</result> -->
    </action>

    <action name="demo3" class="com.hao.action.ServletDemo3Action">
        <!-- <result type="redirect">/demo1_success.jsp</result> -->
    </action>

</package>

以上是关于Struts2简介及入门的主要内容，如果未能解决你的问题，请参考以下文章

Struts2入门及工作原理

Struts2工作原理及xml配置文件简介

Java学习之01Struts2-01简介及环境搭建

Struts简单入门

关于idea maven工程创建struts2入门配置及案例

Struts2 入门篇