SpringBoot加载静态资源的方式

程序员文章站 2024-03-02 14:41:28

在springboot中加载静态资源和在普通的web应用中不太一样。默认情况下，spring boot从classpath下一个叫/static（/public，/reso...

在springboot中加载静态资源和在普通的web应用中不太一样。默认情况下，spring boot从classpath下一个叫/static（/public，/resources或/meta-inf/resources）的文件夹或从servletcontext根目录提供静态内容。下面我们来写个例子看一下就会一目了然了：首先看一下项目的目录结构：

SpringBoot加载静态资源的方式

我们在resources下面的templates目录下建一个home.html的文件，完整目录为：src/main/resources/templates/home.html。内容如下：

<!doctype html> 
<html xmlns:th="http://www.thymeleaf.org"> 
<head> 
  <meta charset="utf-8"/> 
  <title>conanzhang的首页</title> 
</head> 
<body> 
我是首页： 
<!--<image th:src="@{/image/267862-1212151z12099.jpg}"/> --> 
</body> 
</html>

如果我们想要访问home.html应该怎么做呢？我们先来看第一种方式：

1、我们在web.controller这个包下面建一个controller类：thymeleaftestcontroller.代码内容如下：

package com.zkn.learnspringboot.web.controller; 
 
import org.springframework.stereotype.controller; 
import org.springframework.web.bind.annotation.requestmapping; 
 
/** 
 * created by wb-zhangkenan on 2016/11/30. 
 */ 
@controller 
@requestmapping("thymeleaf") 
public class thymeleaftestcontroller { 
 
  @requestmapping("home") 
  public string gethome(){ 
 
    return "home"; 
  } 
}

写到这里你一定非常眼熟，这不就是springmvc的写法吗？没错就是springmvc的写法：下面我们来访问一下：http://localhost:8003/thymeleaf/home。结果如图所示：

SpringBoot加载静态资源的方式

因为springboot集成了thymeleaf，所以它会默认查找resources下面的templates这个目录下的文件。templates这个目录的名字不要写错了。接着我又有了这样的需求，假设我想在我的home.html中引入一些其他的静态资源文件，比如我想在home.html中引入一张图片：那我们应该怎么做呢？

首先，我们需要在resources下面建一个static或者public的目录，你不建立目录也行，直接放到resources下面，接着我们再建立一个image的目录，最终的目录结构如图所示：

SpringBoot加载静态资源的方式

我们在image这个目录下放入一张图片，然后我们在home.html中引入一下这张图片，最终的代码如下：

<!doctype html> 
<html xmlns:th="http://www.thymeleaf.org"> 
<head>webmvcconfigureradapter 
  <meta charset="utf-8"/> 
  <title>conanzhang的首页</title> 
</head> 
  <body> 
我是首页： 
  <image th:src="@{/image/267862-1212151z12099.jpg}" width="100px" height="50px" /> 
  </body> 
</html>

看到上面的写法你可能会有些奇怪，th:src和@{}这都是什么鬼。其实这是thymeleaf的语法。@{}是引入外部资源用的。下面我们再来访问一下，结果如下图所示：

SpringBoot加载静态资源的方式

这样我们就访问到了image目录下的图片了。

可能会有人说难道我只能放到static、public或者直接放到resources下面吗？我换个目录就不行了吗？那当然不是这样的，下面我们来换另外一种写法：

在我现在的这个项目中前台是用react-redux写的，后台springboot只是用来提供接口的，我只需要一个首页来把编译后的react-redux引入到项目中就可以了，如果我想直接访问这个首页那我应该怎么做呢？springmvc为我们提供了这样的一个类：webmvcconfigureradapter。我们就是借助于这个类来实现我们需要的功能的。我们写一个类来继承这个类，代码如下：

package com.zkn.learnspringboot.config; 
 
import org.springframework.context.annotation.configuration; 
import org.springframework.util.resourceutils; 
import org.springframework.web.servlet.config.annotation.enablewebmvc; 
import org.springframework.web.servlet.config.annotation.resourcehandlerregistry; 
import org.springframework.web.servlet.config.annotation.webmvcconfigureradapter; 
 
/** 
 * created by wb-zhangkenan on 2016/11/30. 
 */ 
@enablewebmvc 
@configuration 
public class webconfig extends webmvcconfigureradapter { 
 
  @override 
  public void addresourcehandlers(resourcehandlerregistry registry) { 
 
    registry.addresourcehandler("/templates/**").addresourcelocations(resourceutils.classpath_url_prefix+"/templates/",resourceutils.classpath_url_prefix+"/image/"); 
    super.addresourcehandlers(registry); 
  } 
   
}

我们重写了addresourcehandlers这个方法来重新注册了一个资源处理器。接着我们在来访问一下看看：http://localhost:8003/templates/home.html。结果如下图所示：

SpringBoot加载静态资源的方式

注意了这里我们是直接访问的home.html这个文件。和我们预期的效果是一样的。接着可能会有人说：如果我也想在home.html中引入静态资源要怎么办呢？比如说上面的那个例子，我要引入一个一张图片。也简单，那我们就再注册一个资源处理器就ok了。java代码如下：

package com.zkn.learnspringboot.config; 
 
import org.springframework.context.annotation.configuration; 
import org.springframework.util.resourceutils; 
import org.springframework.web.servlet.config.annotation.enablewebmvc; 
import org.springframework.web.servlet.config.annotation.resourcehandlerregistry; 
import org.springframework.web.servlet.config.annotation.webmvcconfigureradapter; 
 
/** 
 * created by wb-zhangkenan on 2016/11/30. 
 */ 
@enablewebmvc 
@configuration 
public class webconfig extends webmvcconfigureradapter { 
 
  @override 
  public void addresourcehandlers(resourcehandlerregistry registry) { 
 
    registry.addresourcehandler("/templates/**").addresourcelocations(resourceutils.classpath_url_prefix+"/templates/"); 
    registry.addresourcehandler("/static/**").addresourcelocations(resourceutils.classpath_url_prefix+"/static/"); 
    super.addresourcehandlers(registry); 
  } 
 
}

home.html中的内容如下所示：

<!doctype html> 
<html xmlns:th="http://www.thymeleaf.org"> 
<head> 
  <meta charset="utf-8"/> 
  <title>conanzhang的首页</title> 
</head> 
  <body> 
我是首页： 
  <image src="/static/image/267862-1212151z12099.jpg" width="100px" height="50px" /> 
  </body> 
</html>

接着我们再访问以下看看什么效果：http://localhost:8003/templates/home.html

SpringBoot加载静态资源的方式