不灭的焱

革命尚未成功,同志仍须努力下载JDK17

作者:Albert.Wen  添加时间:2018-05-27 15:50:35  修改时间:2024-03-26 12:31:29  分类:Java框架/系统  编辑

文摘(一):【Spring MVC】如何访问静态资源(JS/CSS/Image等)?

优雅REST风格的资源URL不希望带 .html 或 .do 等后缀.由于早期的Spring MVC不能很好地处理静态资源,所以在web.xml中配置DispatcherServlet的请求映射,往往使用 *.do 、 *.html 等方式。这就决定了请求URL必须是一个带后缀的URL,而无法采用真正的REST风格的URL。

如果将DispatcherServlet请求映射配置为"/",则Spring MVC将捕获Web容器(如:Tomcat)所有的请求,包括静态资源(js/css/image)的请求,Spring MVC会将它们当成一个普通请求处理,因此找不到对应处理器将导致错误。

如何让Spring框架能够捕获所有URL的请求,同时又将静态资源的请求转由Web容器处理,是可将DispatcherServlet的请求映射配置为"/"的前提。由于REST是Spring3.0最重要的功能之一,所以Spring团队很看重静态资源处理这项任务,给出了堪称经典的两种解决方案。

先调整web.xml中的DispatcherServlet的配置,使其可以捕获所有的请求:

<servlet>
    <servlet-name>springMVC</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
    <servlet-name>springMVC</servlet-name>
    <url-pattern>/</url-pattern>
</servlet-mapping>

通过上面url-pattern的配置,所有URL请求都将被Spring MVC的DispatcherServlet截获。

方法1:采用<mvc:default-servlet-handler />

<mvc:default-servlet-handler />

springMVC-servlet.xml中配置<mvc:default-servlet-handler />后,会在Spring MVC上下文中定义一个org.springframework.web.servlet.resource.DefaultServletHttpRequestHandler,它会像一个检查员,对进入DispatcherServlet的URL进行筛查,如果发现是静态资源(js/css/image)的请求,就将该请求转由Web应用服务器(如:Tomcat)默认的Servlet处理,如果不是静态资源的请求,才由DispatcherServlet继续处理。

一般Web应用服务器默认的Servlet名称是"default",因此DefaultServletHttpRequestHandler可以找到它。如果你所有的Web应用服务器的默认Servlet名称不是"default",则需要通过default-servlet-name属性显示指定:

<mvc:default-servlet-handler default-servlet-name="所使用的Web容器默认使用的Servlet名称" />

方法2:采用<mvc:resources />

<mvc:default-servlet-handler />将静态资源的处理经由Spring MVC框架交回Web应用服务器(如:Tomcat)处理。而<mvc:resources />更进一步,由Spring MVC框架自己处理静态资源,并添加一些有用的附加值功能。

首先,<mvc:resources />允许静态资源放在任何地方,如:WEB-INF目录下classpath类路径下等,你甚至可以将JavaScript等静态文件打到JAR包中。通过location属性指定静态资源的位置,由于location属性是Resources类型,因此可以使用诸如"classpath:"等的资源前缀指定资源位置。传统Web容器的静态资源只能放在Web容器的根路径下<mvc:resources />完全打破了这个限制。

其次,<mvc:resources />依据当前著名的Page Speed、YSlow等浏览器优化原则对静态资源提供优化。你可以通过cacheSeconds属性指定静态资源在浏览器端的缓存时间,一般可将该时间设置为一年,以充分利用浏览器端的缓存。在输出静态资源时,会根据配置设置好响应报文头的Expires 和 Cache-Control值。

在接收到静态资源的获取请求时,会检查请求头的Last-Modified值,如果静态资源没有发生变化,则直接返回303相应状态码,提示客户端使用浏览器缓存的数据,而非将静态资源的内容输出到客户端,以充分节省带宽,提高程序性能。

springMVC-servlet中添加如下配置:

<mvc:resources mapping="/resources/**" location="/,classpath:/META-INF/publicResources/" />

以上配置将Web根路径"/"及类路径下 /META-INF/publicResources/ 的目录映射为/resources路径。假设Web根路径下拥有images、js这两个资源目录,在images下面有bg.gif图片,在js下面有test.js文件,则可以通过 /resources/images/bg.gif 和 /resources/js/test.js 访问这二个静态资源。

假设WebRoot还拥有images/bg1.gif 及 js/test1.js,则也可以在网页中通过 /resources/images/bg1.gif 及 /resources/js/test1.js 进行引用。

 

 

文摘(二):SpringMVC访问静态资源 <mvc:resources/>

SpringMVC提供<mvc:resources/>来设置静态资源

<mvc:resources mapping="" location=""/>

说明:

  • location元素:表示相对于webapp目录下存放的文件
  • mapping元素:表示不会拦截该配置的路径

该配置的作用是:DispatcherServlet不会拦截mapping配置的请求地址,并会到location配置中查找访问的文件

<mvc:resources mapping="/static/**" location="/static/"/>

上面配置表示,不拦截/static/开头的URL地址,并将/static/后的URL文件到location配置的static文件夹下查询。

 

例如:一个名为demo的SpringMVC项目,我们在webapp目录下建一个static文件夹,并在static文件夹中创建styles.css文件。

我们访问下面URL地址:

http://localhost:8080/demo/static/styles.css

这个URL不会被拦截,服务器会到webapp目录的static文件夹中查找styles.css文件。

如果我们这样配置:

<mvc:resources mapping="/static/**" location="/abc/"/>

我们同样访问上面的URL地址,该URL同样不会被拦截,但是找不到styles.css文件,它相当于访问

http://localhost:8080/demo/abc/styles.css

但是abc路径不存在,所依找不到styles.css文件。

我们将location改为"/",配置如下:

<mvc:resources mapping="/static/**" location="/"/>

访问http://localhost:8080/demo/static/styles.css地址仍然找不到styles.css文件,在该配置下相当于访问http://localhost:8080/demo/styles.css,所以找不到。

我们访问http://localhost:8080/demo/static/static/styles.css,就会找到styles.css文件,它相当于访问http://localhost:8080/demo/static/styles.css。

我们开发中.js,.css等文件是静态文件,不需要拦截,通过mvc:resources也可以配置不要拦截某些后缀的文件

<mvc:resources mapping="/static/**/*.css" location="/static"/>

上面配置表示不拦截以static开头以.css结尾的URL。

 

 

参考文章:

<mvc:default-servlet-handler/>的作用

SpringMVC访问静态资源 <mvc:resources />

mvc:resources mapping location关系

<mvc:default-servlet-handler/>不拦截静态资源的前提条件

<mvc:default-servlet-handler/>标签的作用

了解<mvc:default-servlet-handler/>

 

最后的总结:

针对静态资源目录(js/css/image),

(1). 如果它们是在 webapp 根目录下,如:/webapp/static/css/base.css,直接配置默认处理器标签即可,即增加如下标签:

<mvc:default-servlet-handler/>

当然,也可以用配置 <mvc:resources /> 标签来代替配置这个默认处理器标签,如:

<mvc:resources mapping="/static/**" location="/static/"/>

(2). 如果不在 webapp 根目录下,比如在目录 /webapp/WEB-INF/webapp/WEB-INF/classes 下,则需要配置 <mvc:resources /> 标签。

我习惯的项目目录结构:

  • /src/main/resources/static/css
  • /src/main/resources/static/js
  • /src/main/resources/static/image

Maven打包后,最终会部署到目录 /webapp/WEB-INF/classes 下,即路径为:

  • /webapp/WEB-INF/classes/static/css
  • /webapp/WEB-INF/classes/static/js
  • /webapp/WEB-INF/classes/static/image

此时,需要配置 <mvc:resources /> 标签的静态资源映射:

<!-- 静态资源映射 -->
<mvc:resources mapping="/static/css/**" location="classpath:/static/css/"/>
<mvc:resources mapping="/static/js/**" location="classpath:/static/js/"/>
<mvc:resources mapping="/static/image/**" location="classpath:/static/image/"/>

(3). 另外,不管静态资源目录是否在 webapp 根目录下,都建议加上这个 默认处理器标签,因为它不只用于处理静态资源,针对 Spring MVC UrlMapping 未找到的控制器链接,可直接转发给Web容器(如:Tomcat),然后(Tomcat)给出 404 错误页面!

(4). 在大流量的网站系统中,应该让 Nginx 来接管对 静态资源的访问,应该它才是最专业、最高性能的静态资源处理器!