利用 Struts 拦截器限制上传图片的格式和大小
在这之前
Struts 的一个核心功能就是大量的拦截器,既然是框架,那么自然也就贴心地为我们准备好了各种常用的功能,比如这里即将讨论的如何限制上传图片的格式和大小。那么既然是使用 Struts 已经写好的拦截器,不需要我们去自定义了,那么这个拦截器的基本配置如何进行?在哪里进行配置?
以上,要弄懂基本原理的话,就要先了解 Struts 运行的大致流程。
Struts 的运行大致流程
核心运行流程:
Struts 的启动是依靠 StrutsPrepareAndExecuteFilter 过滤器来完成,当过滤器启动时会执行其 init() 方法,它会去读取 Struts 的配置信息,并将其封装到 JavaBean 中,然后执行过滤器的 doFilter() 来解析地址,实例化 Action 并根据 result 进行页面的跳转。在 Action 的执行前后,会执行各类功能不同的拦截器。
用一张图来说明以上的过程,就是:
很明显,init() 中读取的配置文件至关重要,这里有几个核心文件被读取,分别是 default.properties、struts-default.xml、struts-plugin.xml、struts.xml,并且按顺序读取,同样的变量和配置项,后读取的配置文件会覆盖已读取的配置文件。这也就是即使前几个文件是 Struts 配置好的我们没法改变,我们也依然可以通过在 struts.xml 中进行相关变量的配置来进行最终实现上的改变。
default.properties 中,定义了 Struts 中大量的常量,也就是许多设置的默认值。
而拦截器这部分的配置信息,在 struts-default.xml 中,它在 struts2-core-x.x.x 核心包的根目录下,它不仅包含了大量 bean 的定义,还有大量的拦截器、拦截器栈,同时还定义了 11 种不同类型的页面跳转方式(result-type)等等。(这也就是我们的 Action 在配置时候总要 extends struts-default.xml 的原因)
在 struts-default.xml 中,默认使用的是 defaultStack 这个拦截器栈,其中包含了一系列的拦截器(如下图)
可以看到,fileUpload 拦截器正是默认拦截器栈的一员,而我们,就要从这里入手,来实现我们对上传图片的限制功能。
如何使用拦截器限制上传图片
我们先来看看源码,在之前已经说过,fileUpload 这个拦截器是我们默认拦截器栈中的一员,我们同样在 default-struts.xml 中来找到该拦截器:
打开 Struts 文件上传的拦截器 org.apache.struts2.interceptor.FileUploadInterceptor,发现其包含三个重要属性
它们分别表示的是:
上传文件的最大长度(单位为字节)(在 default.properties 我们可以查到 struts.multipart.maxSize=2097152,即默认最大为 2M 大小的文件)
允许上传文件的类型
允许上传文件的文件扩展名。
而之前我们提到的,这些默认的配置可以在 struts.xml 中将其默认值覆盖,所以我们如果要限制上传为 jpg、png 类型的最大为 1M 的图片,那么:
(图例为使用限制文件扩展名的方式)
以上,叨叨了这么多,其实也就这么简单的几排,就完成了我们想要的功能。另外,还要提醒的是,虽然如此配置让 struts 帮我们完成了对文件上传的限制,但是假如我们上传了不符合条件的文件,会发生什么?
答案是,系统会报错,并使 Action 自动直接返回 “input” ,所以不需要在 action 中的方法出现一个 return "input",同时,我们还要对返回的 result name=“input” 进行配置,以便于即使上传了不符的文件,页面也能正常跳转:
(图例让其跳转到 mainAction 中执行 input() 方法)
也可以参考如下方式:
至此,我们就对 Struts 拦截器完成图片上传限制的功能进行了了解和使用。
参考链接和源码
参考链接
源码地址
功能实现前,commit id:11e893eea4baea2683d6083368c758a3afe1a0bf
功能实现后,commit id:2a6127d1d50eeeb98fa64e19b8d4321f9d61b360
附:struts.xml 概述和配置文件的思维导图
评论