Struts2【开发Action】知识要点

灰太狼 2021-09-15 00:04 359阅读 0赞

# 前言 #

前面Struts博文基本把Struts的配置信息讲解完了…..**本博文主要讲解Struts对数据的处理**

# Action开发的三种方式 #

在第一次我们写开发步骤的时候，我们写的Action是继承着ActionSupport类的…为啥我们继承了ActionSupport类呢？下面我就会讲解到

## 继承ActionSupport类 ##

我们来看一下ActionSupport干了什么:

![这里写图片描述][SouthEast]

也就是说，如果我们**在Action类中需要用到Struts为我们提供的数据校验等Struts已经帮我们实现的功能，我们就继承着ActionSupport类..**

--------------------

## 实现Action接口 ##

我们再来看看Action接口干了什么：

![这里写图片描述][SouthEast 1]

当然啦，ActionSuppot也继承着Action接口，所以**ActionSuppot拥有Action接口的全部功能**….因此，这种开发方式我们是比较少用的…

--------------------

## 不继承任何类、不实现任何接口 ##

开发此类的Action，它是不继承任何类、不实现任何接口的…也就是说，**它就是一个普通的Java类….**

*  Action类

public class PrivilegeAction { 
    
    
        public String login() {
            System.out.println("我是普通的javaAction，不继承任何的类、不实现任何的接口");
    
            return "success";
        }
    }

*  在配置文件中配置：

<struts>
    <package name="privilige" extends="struts-default">
        <action name="login" class="privilegeaction.PrivilegeAction" method="login">
            <result name="success">/index.jsp</result>
        </action>
    </package>
    </struts>

*  效果：

![这里写图片描述][SouthEast 2]

--------------------

## 小总结 ##

*  **如果我们使用到了Struts2一些特用的功能，我们就需要继承ActionSupport**
 *  如果我们没用到Struts2的特殊功能，只要平凡写一个Java类行了。
 *  大多情况下，我们还是会继承ActionSupport的。

# 请求数据封装 #

一般地，我们使用Servlet的时候都是分为几个步骤的：

1.  得到web层的数据、封装数据
2.  调用service层的逻辑业务代码
3.  将数据保存在域对象中，跳转到对应的JSP页面

现在问题来了，我们自己编写的Action类是没有request、response、Session、application之类的对象的….我们是怎么得到web层的数据、再将数据存到域对象中的呢？？

前面已经说过了，**Struts预先帮我们完成了对数据封装的功能，它是通过params拦截器来实现数据封装的**

## register.jsp ##

首先，我们填写表单页面的数据，请求Action处理数据

--------------------

## Action封装基本信息 ##

**在Action设置与JSP页面相同的属性，并为它们编写setter方法**

private String username;
        private String psd;
        private int  age;
        private Date birthday;
    
        public void setUsername(String username) {
            this.username = username;
        }
    
        public void setPsd(String psd) {
            this.psd = psd;
        }
    
        public void setAge(int age) {
            this.age = age;
        }
    
        public void setBirthday(Date birthday) {
            this.birthday = birthday;
        }

我们直接在业务方法中访问这些变量，看是否能得到表单的值。

![这里写图片描述][SouthEast 3]

--------------------

## Action封装对象 ##

一般地，我们注册的时候，都是在Servlet上把基本信息封装到对象上…那么在Struts怎么做呢？

*  创建一个User类，基本的信息和JSP页面是相同的。

package qwer;
    
    import java.util.Date;
    
    /** * Created by ozc on 2017/4/27. */
    public class User { 
    
        private String username;
        private String psd;
        private int  age;
        private Date birthday;
    
        public String getUsername() {
            return username;
        }
    
        public void setUsername(String username) {
            this.username = username;
        }
    
        public String getPsd() {
            return psd;
        }
    
        public void setPsd(String psd) {
            this.psd = psd;
        }
    
        public int getAge() {
            return age;
        }
    
        public void setAge(int age) {
            this.age = age;
        }
    
        public Date getBirthday() {
            return birthday;
        }
    
        public void setBirthday(Date birthday) {
            this.birthday = birthday;
        }
    }

*  在Action中定义User对象出来，并给出setter和getter方法….值得注意的是：**基本信息只要setter就够了，封装到对象的话，需要setter和getter**

public class ccAction extends ActionSupport { 
    
        private User user;
    
        public User getUser() {
            return user;
        }
    
        public void setUser(User user) {
            this.user = user;
        }
    
        public String register() {
    
            System.out.println(user.getUsername());
            System.out.println(user.getPsd());
            System.out.println(user.getAge());
            System.out.println(user.getBirthday());
    
            return "success";
        }
    
    
    }

*  在JSP页面，提交的name要写成`user.username`之类的

![这里写图片描述][SouthEast 4]

# 得到域对象 #

Struts怎么把数据保存在域对象中呢？？？**Struts提供了三种方式**

## 一、得到Servlet API ##

我们可以**通过ServletActionContext得到Servlet API**

由于每个用户拥有一个Action对象，那么**底层为了维护用户拿到的是当前线程的request等对象，使用ThreadLocal**来维护当前线程下的request、response等对象…

//通过ServletActionContext得到Servlet API
            javax.servlet.ServletContext context = ServletActionContext.getServletContext();
            HttpServletRequest request = ServletActionContext.getRequest();
            HttpSession session = request.getSession();
            HttpServletResponse response = ServletActionContext.getResponse();

--------------------

## 二、ActionContext类 ##

我们还可以通过**ActionContext类**来得到**request、response、session、application被Struts封装的Map集合**

//得到ActionContext 对象
            ActionContext context = ActionContext.getContext();
            Map<String, Object> session = context.getSession();
            Map<String, Object> application = context.getApplication();
    
            //这是request的Map
            Map<String, Object> request = context.getContextMap();

--------------------

## 三、实现接口 ##

**当web容器发现该Action实现了Aware接口，会把相对应的资源通过Aware接口注射进去，实际上就是一种IOC。**

**Aware实际就是一种拦截器，拦截代码在执行Action之前执行、将资源注射到Action中**

实现SessionAware, RequestAware, ApplicationAware接口，它就要在程序中实现三个方法：

private Map<String, Object> request;
        private Map<String, Object> session;
        private Map<String, Object> application;
    
    
        @Override
        public void setApplication(Map<String, Object> map) {
            this.application = map;
        }
    
        @Override
        public void setRequest(Map<String, Object> map) {
    
            this.request = map;
        }
    
        @Override
        public void setSession(Map<String, Object> map) {
            this.session = map;
        }

通过这些方法，我们就可以**得到对应的Map对象**…..

## 小总结 ##

那么，我们有三种方法可以得到Servlet对应的对象，那么该使用哪一种呢？？？

分析：

*  第一种方法：**需要导入Servlet的包，与Struts耦合了**
 *  第二种方法：**只能在业务方法中使用ActionContext类得到对应的Map对象**，如果有多个方法，那么每个方法都需要写类似的代码
 *  第三种方法：可以在类上定义成员变量，以至于整个类都能使用。但是**需要实现类、实现对应的方法**

如果我们**需要使用到对象的其他方法，类似getContextPath()之类的，那么只能使用第一种**

如果我们**就按照平常的开发，我们就使用第二种【获取简单，没有耦合】**

至于第三种，当我们将来可能开发BaseAction的时候，就使用它！

--------------------

# 日期转换问题 #

前面博文已经讲解了，Struts2为我们实现了数据自动封装…由上篇的例子我们可以看出，表单提交过去的数据全都是String类型的，但是经过Struts自动封装，就改成是JavaBean对应成员变量的类型了。

但是呢，日期类型只支持是yyyy-MM-dd这种格式的，因为我们在上个例子中直接使用的是Struts支持的格式，因此没有报错…本篇博文就是讲解Struts如何对日期类型的格式更好地支持

当我们使用的是yyyyMMdd这种格式的时候，我们看看Struts的自动封装能不能解析出相对应的日期

![这里写图片描述][SouthEast 5]

直接抛出了异常

![这里写图片描述][SouthEast 6]

![这里写图片描述][SouthEast 7]

## 分析 ##

那么，我们怎么让Struts能够支持更多的日期格式呢？？比如，我想Struts在自动封装数据的时候支持yyyyMMdd,yyyy年MM月dd日这样的日期格式…..

Struts提供了转换器给我们使用，也就是，我们可以自定义转换器，**我们定义了什么格式，Struts就可以根据对应的格式进行自动封装**…

当我们写完自定义转换器，是需要向Struts说明我们写了，不然的话，Struts是不知道我们自定义了转换器类的…

也就是说，我们要想实现类型转换，**需要两步**：

*  **编写自定义转换器类**
 *  **告诉Struts我们写了转换器类**

## 自定义转换器类 ##

一般地，我们想要编写自定义转换器类，都是实现StrutsTypeConverter类的….

/** * Created by ozc on 2017/5/1. * 自定义异常转换器类 * * 我们要实现的就是：在Struts转换的时候， * */
    public class MyConvter extends StrutsTypeConverter { 
    
    
        //需求，当Struts自动封装数据时，也支持yyyyMMdd,yyyy年MM月dd日等格式的支持\
        SimpleDateFormat[] format = {
       new SimpleDateFormat("yyyy-MM-dd"), new SimpleDateFormat("yyyyMMdd"), new SimpleDateFormat("yyyy年MM月dd日")};
    
    
    
        /** * 把String转换为指定的类型 【String To Date】 * * * @param map * 当前上下文环境 * @param strings * jsp表单提交的字符串的值 * @param aClass * 要转换为的目标类型 */
        @Override
        public Object convertFromString(Map map, String[] strings, Class aClass) {
    
            //判断是否有值
            if (strings == null) {
                return null;
            }
            //判断是否是日期类型的
            if (Date.class != aClass) {
                return null;
            }
    
            //遍历循环
            for (SimpleDateFormat dateFormat : format) {
                try {
    
                    //解析传递进来的第一个就行啦
                    dateFormat.parse(strings[0]);
                } catch (ParseException e) {
                    //如果格式不对，那么就跳出当前的循环
                    continue;
                }
            }
            return null;
        }
        @Override
        public String convertToString(Map map, Object o) {
            return null;
        }
    }

## 告诉Struts，我写了转换器类 ##

告诉Struts我写了一个转换器类，也分两种方式

*  定义了局部转换器类，就**当前包下的Action类有效**
 *  定义了全局转换器类，**整个项目有效**

### **全局转换器** ###

步骤：

*  在src目录下创建一个名为`xwork-conversion.properties`的文件
 *  配置文件的内容：需要转换的类类型=转换器类的全名`java.util.Date=qwer.MyConvter`

--------------------

### **局部转换器类** ###

步骤：

*  在当前的Action包下创建名为`Action名-conversion.properties`的文件
 *  文件的内容为：需要转换的字段【如果是JavaBean里的字段，需要写上JavaBean的】=转换器类的全名`user.birthday=qwer.MyConvter`

--------------------

### **效果** ###

![这里写图片描述][SouthEast 8]![这里写图片描述][SouthEast 9]

--------------------

## 错误提示页面 ##

当发生了日期转换的异常时，Struts给出的页面是这样子的：

![这里写图片描述][SouthEast 7]

这个我们称之为input视图，我们要做的就是给出用户更友好的提示，于是在struts.xml文件中配置：**如果返回的是input视图，那么跳转到我们相对应的页面上**

<result name="input">/error.jsp</result>

![这里写图片描述][SouthEast 10]

# 文件上传和下载 #

在讲解开山篇的时候就已经说了，Struts2框架封装了文件上传的功能……..本博文主要讲解怎么使用Struts框架来完成文件上传和下载

## 回顾以前的文件上传 ##

首先，我们先来回顾一下以前，我们在web中上传文件是怎么做的….[http://blog.csdn.net/hon\_3y/article/details/66975268][http_blog.csdn.net_hon_3y_article_details_66975268]

可以使用FileUpload或者SmartUpload组件来完成文件上传的功能。但是呢，FileUpload组件使用起来是比较麻烦的…而SmartUPload解决中文的问题也非常麻烦

## 使用Struts进行文件上传 ##

从要导入的jar包我们就可以知道：**Struts内部还是使用fileUpload上传组件**….但是它极大的简化地我们的具体操作

那我们怎么用它呢？？看下面的图

![这里写图片描述][SouthEast 11]

*  **在Action中使用在表单中定义的name，就可以获取代表的上传文件的File对象**
 *  **在Action中使用在表单中定义的name+FileName，就得到上传文件的名字**

### JSP页面 ###

在注册页面上拥有两个上传文件控件

### Action ###

**得到相对应的File对象、上传文件名称、上传文件的类型**

package fileupload;
    
    import java.io.File;
    
    /** * Created by ozc on 2017/5/2. */
    public class FileUploadAction { 
    
        //上传文件对应的File对象
        private File photo;
        private File photo1;
    
        //得到上传文件的名称
        private String photoFileName;
        private String photo1FileName;
    
        //得到上传文件的类型
        private String photoContentType;
        private String photo1ContentType;
    
        //给出相对应的setter
        public void setPhoto(File photo) {
            this.photo = photo;
        }
    
        public void setPhoto1(File photo1) {
            this.photo1 = photo1;
        }
    
        public void setPhotoFileName(String photoFileName) {
            this.photoFileName = photoFileName;
        }
    
        public void setPhoto1FileName(String photo1FileName) {
            this.photo1FileName = photo1FileName;
        }
    
        public void setPhotoContentType(String photoContentType) {
            this.photoContentType = photoContentType;
        }
    
        public void setPhoto1ContentType(String photo1ContentType) {
            this.photo1ContentType = photo1ContentType;
        }
    
    
        public String register() {
    
            System.out.println(photo1FileName);
            System.out.println(photoFileName);
    
    
            return "success";
        }
    
    
    
    }

--------------------

成功得到数据：

![这里写图片描述][SouthEast 12]

![这里写图片描述][SouthEast 13]

--------------------

### Action业务代码： ###

public String register() throws IOException {
    
            //得到上传的路径
            String path = ServletActionContext.getServletContext().getRealPath("upload");
            System.out.println(path);
    
            //创建文件对象
            File destFile = new File(path,photoFileName);
    
            //调用工具类方法，将文件拷贝过去
            FileUtils.copyFile(photo, destFile);
    
            return "success";
        }

*  效果：

![这里写图片描述][SouthEast 14]

--------------------

## 文件下载 ##

我们以前是通过设置request消息头来实现文件下载的…..那么在Struts又如何实现文件下载呢？？

我们请求服务器处理都是通过Action类来完成的，但是呢，**Action类的业务方法都是返回字符串**。因此，Struts在`<result>`节点中**提供了类型为stream的type值。通过stream来配置相对应的信息，从而实现下载**！

### 列出所有可以下载的文件 ###

*  Action类的业务方法

public class downLoadAction { 
    
        //列出所有可以下载的文件
        public String list() {
    
            //得到upload文件夹
            String path = ServletActionContext.getServletContext().getRealPath("/upload");
    
            //创建file对象
            File file = new File(path);
    
            //列出文件下所有的文件
            File[] files = file.listFiles();
    
            //将这些文件存到request域中
            HttpServletRequest request = ServletActionContext.getRequest();
            request.setAttribute("files", files);
            return "list";
        }
    }

*  Struts配置文件

<action name="down_*" class="fileupload.downLoadAction" method="{1}">
                <result name="{1}">/list.jsp</result>
               
            </action>

*  JSP显示页面

<c:if test="${files==null}">
    
        对不起，没有下载的页面
    
    </c:if>
    
    <c:if test="${files!=null}">
    
        <table border="1px">
            <tr>
                <td>编号</td>
                <td>文件名称</td>
                <td>操作</td>
            </tr>
            <c:forEach items="${files}" varStatus="file" var="fileName">
                <tr>
    
                    <td>${file.count}</td>
    
                        <%--如果直接写fileName，输出的名字带有路径，使用EL方法库来截取--%>
                    <td>${fn:substringAfter(fileName, "upload\\")}</td>
                    <td>
    
                            <%--使用url标签来构建url，不然超链接带有中文，会出现乱码--%>
                        <c:url var="url" value="down_downLoad">
                            <c:param name="fileName">${fn:substringAfter(fileName, "upload\\")}</c:param>
                        </c:url>
    
                        <a href="${url}">下载</a>
    
                    </td>
                </tr>
            </c:forEach>
    
        </table>
    </c:if>

*  Action代码：

/** * 访问Action的业务方法仅仅返回的是字符串。因此Struts在result节点提供了stream类型的type， * 指定了stream就代表着我这是要下载的... * <p> * 既然要下载文件，那么肯定需要几样东西： * 1、文件名 * 2、代表文件的流 */
        public String downLoad() {
    
            return "downLoad";
        }
    
        //得到要下载的文件名，Struts提供了自动封装的功能
        private String fileName;
    
    
        //如果文件名是中文的，那么需要手动转换，因为超链接是get方法提交
        public void setFileName(String fileName) throws UnsupportedEncodingException {
            fileName = new String(fileName.getBytes("ISO8859-1"), "UTF-8");
            this.fileName = fileName;
            System.out.println(fileName);
        }
    
        //得到代表下载文件流，该方法由Struts调用
        public InputStream getAttrInputStream() {
            return ServletActionContext.getServletContext().getResourceAsStream("/upload/" + fileName);
        }
    
        //下载时，显示的名称【如果是中文，可能会乱码，因此要URLencode】---->在Struts.xml文件中通过${}可获取
        public String getDownFileName() throws UnsupportedEncodingException {
    
            fileName = URLEncoder.encode(fileName, "UTF-8");
            return fileName;
        }

*  Struts.xml

<action name="down_*" class="fileupload.downLoadAction" method="{1}">
                <result name="{1}">/list.jsp</result>
                <result name="downLoad" type="stream">
    
                    
                    <param name="contentType">application/octet-stream</param>
    
                    
                    <param name="inputName">attrInputStream</param>
    
                                   
                    <param name="contentDisposition">attachment;filename=${downFileName}</param>
    
                    
                    <param name="bufferSize">1024</param>
    
                </result>
            </action>

### 效果 ###

![这里写图片描述][SouthEast 15]

--------------------

# 模型驱动 #

## 什么是模型驱动 ##

在Struts2中模型驱动就是用来封装数据的..完成数据的自动封装.

## 为什么要使用模型驱动？ ##

我们之前就使用过Sturts2的数据自动封装功能，是用params拦截器完成的…既然有了params拦截器，为啥还要模型驱动？？

当我们使用params拦截器完成数据自动封装的时候，**如果要封装的是JavaBean对象，那么在web表单中就必须的name写上`javaBean.属性名`**….

这样的话，web层和Action层就耦合了…因为**在web层必须要知道封装的JavaBean对象是什么才能够实现自动封装**！

而**模型驱动**就解决了这个问题！**即时不知道Action层的JavaBean对象是什么，也能够完成数据自动封装！**

## 模型驱动的实现原理 ##

实现模型驱动功能也是由拦截器完成的，我们来看看拦截器到底做了什么吧….

拦截方法的源码是这样的：

public String intercept(ActionInvocation invocation) throws Exception {
    
            //得到当前要执行的Action对象
            Object action = invocation.getAction();
    
            //判断该Action对象是否实现了ModelDriven接口
            if(action instanceof ModelDriven) {
                ModelDriven modelDriven = (ModelDriven)action;
    
                //获取值栈对象
                ValueStack stack = invocation.getStack();
    
                //得到model的对象
                Object model = modelDriven.getModel();
    
                //把对象存到值栈对象中
                if(model != null) {
                    stack.push(model);
                }
                if(this.refreshModelBeforeResult) {
                    invocation.addPreResultListener(new ModelDrivenInterceptor.RefreshModelBeforeResult(modelDriven, model));
                }
            }
    
            return invocation.invoke();
        }

把model对象放到值栈对象之后，**Parameters 拦截器将把表单字段映射到 ValueStack 栈的栈顶对象的各个属性中.**

也就是说，**使用模型驱动是需要配合Params拦截器完成的！**

## 使用数据模型驱动 ##

## 实现ModelDriven接口 ##

*  实现ModelDriven接口，重写方法….**实现接口时，要封装的对象是什么，形参类型就给什么**

public class UserAction extends ActionSupport implements ModelDriven<User> { 
    
    
    
        public String login() {
    
            return SUCCESS;
        }
    
    
        @Override
        public User getModel() {
            return null;
        }
    }

## 对象实例化 ##

public class UserAction extends ActionSupport implements ModelDriven<User> { 
    
    
        //这里一定要实例化
        User user = new User();
    
        public User getUser() {
            return user;
        }
    
        public void setUser(User user) {
            this.user = user;
        }
    
        @Override
        public User getModel() {
            return user;
        }
    }

## 测试 ##

JSP提交页面，直接**写上JavaBean对象的属性就行了..不需要写上JavaBean对象的名称！**

*  在Action业务方法中输出User对象的数据

@Override
        public String execute() throws Exception {
    
            System.out.println(user);
            return SUCCESS;
        }

![这里写图片描述][SouthEast 16]

--------------------

> 如果文章有错的地方欢迎指正，大家互相交流。**习惯在微信看技术文章，想要获取更多的Java资源的同学，可以关注微信公众号:Java3y**

[SouthEast]: /images/20210827/0d06323164944ea3b3c7f7a6f8039675.png
[SouthEast 1]: /images/20210827/f209842b68654eab9486a1c6b5d7903a.png
[SouthEast 2]: /images/20210827/51dd34c3b896483aae057fc91adbeff8.png
[SouthEast 3]: /images/20210827/2570cfd24cf047deb59c037d633889f1.png
[SouthEast 4]: /images/20210827/98b00d811bc246c485bb5474d5f5f7a6.png
[SouthEast 5]: /images/20210827/bae82944792641f08e85d0dd4aa96460.png
[SouthEast 6]: /images/20210827/5186749ed93c492bb5872315eee50a5e.png
[SouthEast 7]: /images/20210827/739d5374811f4a598f1c5462f59f1470.png
[SouthEast 8]: https://img-blog.csdn.net/20170501194842456?watermark/2/text/aHR0cDovL2Jsb2cuY3Nkbi5uZXQvaG9uXzN5/font/5a6L5L2T/fontsize/400/fill/I0JBQkFCMA==/dissolve/70/gravity/SouthEast
[SouthEast 9]: /images/20210827/abe138628f4943d3bff6226150967727.png
[SouthEast 10]: /images/20210827/a3999675fdc04c1f8e7c765a82bad2e8.png
[http_blog.csdn.net_hon_3y_article_details_66975268]: http://blog.csdn.net/hon_3y/article/details/66975268
[SouthEast 11]: /images/20210827/07dcb7774a0e4798962460e152c37f80.png
[SouthEast 12]: /images/20210827/e24299220be746ec9db14d39ba9790c9.png
[SouthEast 13]: /images/20210827/146a21d5dbe14c368cd3c48b1e815e94.png
[SouthEast 14]: /images/20210827/f540cb5165894fd390e1fd3413d090d4.png
[SouthEast 15]: /images/20210827/26b079a1dcdb4f5aa8ac35ce12e6dd75.png
[SouthEast 16]: /images/20210827/7eab1915d0d44422a2ea08bc5626eb17.png