SpringBoot | 第十八章:web應(yīng)用開發(fā)之WebJars使用

第十八章:web應(yīng)用開發(fā)之WebJars使用

前言

前面一章節(jié)我們主要講解了關(guān)于文件上傳的兩種方式。本章節(jié)繼續(xù)web開發(fā)的相關(guān)知識點。通常對于web開發(fā)而言,像js、cssimages等靜態(tài)資源版本管理是比較混亂的,比如JqueryBootstrap、Vue.js可能各個前端框架所依賴的自個組件的版本都不盡相同,一不注意就可能引起不同版本的沖突問題。所以,是否有一種像后端管理jar包一樣的解決方案呢?答案當(dāng)然是有的,今天我們就來重點介紹下關(guān)于WebJars的使用。前面我們介紹的Swagger2也是基于webJars進行頁面集成的。

一點知識

原本我們在進行web開發(fā)時,一般上都是講靜態(tài)資源文件放置在webapp目錄下,在SpringBoot里面,一般是將資源文件放置在src/main/resources/static目錄下。而在Servlet3中,允許我們直接訪問WEB-INF/lib下的jar包中的/META-INF/resources目錄資源,即WEB-INF/lib/{*.jar}/META-INF/resources下的資源可以直接訪問。

Servlet3靜態(tài)文件處理-轉(zhuǎn)自網(wǎng)絡(luò)

所以其實,WebJars也是利用了此功能,將所有前端的靜態(tài)文件打包成一個jar包,這樣對于引用放而言,和普通的jar引入是一樣的,還能很好的對前端靜態(tài)資源進行管理。

WebJars使用

WebJars是將web前端資源(如jQuery & Bootstrap)打成jar包文件。借助版本管理工具(Maven、gradle等)進行版本管理,保證這些Web資源版本唯一性。避免了文件混亂、版本不一致等問題。

官網(wǎng)介紹

WebJar結(jié)構(gòu)

開始使用前,我們看下Jquerywebjars,借此來了解下webjars包的目錄結(jié)構(gòu)。以下是基于jquery-3.3.1.jar:

META-INF
    └─maven
        └─org.webjars.bower
            └─jquery
                └─pom.properties
                └─pom.xml
    └─resources
        └─webjars
            └─jquery
                └─3.3.1
                       └─(靜態(tài)文件及源碼)
jquery-3.3.1目錄結(jié)構(gòu)

所以可以看出,靜態(tài)文件存放規(guī)則:META-INF/resources/webjars/${name}/${version}。這點官網(wǎng)也有說明的:

webjar目錄官網(wǎng)說明

WebJars實踐

接下來我們以一個簡單的示例,對webjars進行簡單的實踐下。

0.在src/main/resouces路徑下創(chuàng)建META-INF/resources/webjars/0.0.1目錄,同時為了演示效果,拷貝一個圖片到此目錄下。

新建目錄

1.編寫一個簡單的html頁面,放在在src/main/resources/static下(當(dāng)然也可以直接放在webjar下了,只需要后面加個映射關(guān)系即可),內(nèi)容如下:

<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>Hello,WebJars</title>
</head>
<body>
  <h1>Hello,WebJars</h1>
  <img alt="sprinboot" src="webjars/demo/0.0.1/springboot.jpg">
</body>
</html>

2.編寫配置類,添加一個資源映射關(guān)系.其實也可以不寫,因為第十五章節(jié)也有說過,springboot默認(rèn)的四個資源路徑里面就包含了/META-INF/resources/了。

默認(rèn)不配置時,從控制臺啟動項也是可以獲悉的:

2018-08-08 23:26:54.874  INFO 5900 --- [           main] o.s.w.s.handler.SimpleUrlHandlerMapping  : Mapped URL path [/webjars/**] onto handler of type [class org.springframework.web.servlet.resource.ResourceHttpRequestHandler]
2018-08-08 23:26:54.874  INFO 5900 --- [           main] o.s.w.s.handler.SimpleUrlHandlerMapping  : Mapped URL path [/**] onto handler of type [class org.springframework.web.servlet.resource.ResourceHttpRequestHandler]
2018-08-08 23:26:54.917  INFO 5900 --- [           main] o.s.w.s.handler.SimpleUrlHandlerMapping  : Mapped URL path [/**/favicon.ico] onto handler of type [class org.springframework.web.servlet.resource.ResourceHttpRequestHandler]
2018-08-08 23:26:54.941  INFO 5900 --- [           main] oConfiguration$WelcomePageHandlerMapping : Adding welcome page: class path resource [static/index.html]

這里為了演示下可通過此方法,自定義一些其他路徑的靜態(tài)資源目錄:

@Configuration
public class WebConfig extends WebMvcConfigurerAdapter{

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        //配置映射關(guān)系
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
    }
}

3.編寫控制層,返回此頁面地址。

/**
 * webjar示例
 * @author oKong
 *
 */
@Controller
public class WebJarsDemoController {
    
    @GetMapping("/")
    public String index() {
        return "index.html";
    }

}

4.啟動應(yīng)用,訪問地址即可:

image

可以看見圖片已經(jīng)正確顯示出來了。

5.現(xiàn)在直接將META-INF下打成一個jar,然后加入依賴進入。在來測試下。
這里直接創(chuàng)建一個新的工程,存在靜態(tài)資源信息,工程結(jié)果如下:

靜態(tài)資源工程

然后對應(yīng)的pom配置主要就加入一個資源拷貝動作:

<build>
    <resources>
        <resource>
            <directory>${project.basedir}/src/main/resources</directory>
            <targetPath>${project.build.outputDirectory}/META-INF/resources/webjars</targetPath>
        </resource>
    </resources>
</build>

之后利用maven打包后,就可以看見其目錄結(jié)構(gòu)了:

資源包目錄結(jié)構(gòu)

然后我們刪除了我們原先的資源文件或者圖片重命名下,并引入依賴:

    <!-- 靜態(tài)資源依賴 -->
    <dependency>
        <groupId>cn.lqdev.learning</groupId>
        <artifactId>springboot-webjars</artifactId>
        <version>0.0.1-SNAPSHOT</version>
    </dependency>

最后重新啟動應(yīng)用,再次訪問下,依舊是正常顯示的:

image

一點技巧

我們可以看見,我們在index.html中訪問圖片是這么訪問的:webjars/demo/0.0.1/springboot.jpg。咋一看,可能覺得沒問題。但當(dāng)我們靜態(tài)資源版本有更新時,我們不是又需要去改下這個靜態(tài)資源的引入路徑,那何來的優(yōu)雅!所以官方提供了一個webjars-locator包,就是來解決此問題的。

0.pom文件中,加入依賴(這里注意,Springboot(1.5.15.RELEASE)父類pom文件中已經(jīng)指定了此版本為:0.32-1,所以我們可以不需要去添加版本了):

    <dependency>
        <groupId>org.webjars</groupId>
        <artifactId>webjars-locator</artifactId>
    </dependency>

1.修改index.html中的圖片路徑
原來:

<img alt="sprinboot" src="webjars/demo/0.0.1/springboot.jpg">

現(xiàn)在:

<img alt="sprinboot" src="webjars/demo/springboot.jpg">

2.修改配置類,加入resourceChain屬性,不然還是去除了版本時路徑找不到的,這里需要注意。

@Configuration
public class WebConfig extends WebMvcConfigurerAdapter{

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        //配置映射關(guān)系
        //即:/webjars/** 映射到 classpath:/META-INF/resources/webjars/ 
        registry.addResourceHandler("/webjars/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/")
                //新增 resourceChain 配置即開啟緩存配置。
                //不知道為何不加這個配置 設(shè)置了 webjars-locator 未生效。。沒過多糾結(jié)。。
                .resourceChain(true);//生產(chǎn)時建議開啟緩存(只是緩存了資源路徑而不是資源內(nèi)容),開發(fā)是可以設(shè)置為false
    }
}

這樣之后,我們只需要修改依賴包即可,前端都不需要重新改了。

相關(guān)資料

  1. https://www.webjars.org/contributing
  2. 靜態(tài)文件處理這篇講的不錯,可以看看:https://blog.csdn.net/xichenguan/article/details/52794862

總結(jié)

本章節(jié)主要是講解了webjars的使用。使用是相對來說比較簡單了,有了這個后,我們之后去管理前端的靜態(tài)資源就很方便了,也能引用已經(jīng)打好jar的第三方庫了,是不是很方便!

最后

目前互聯(lián)網(wǎng)上很多大佬都有SpringBoot系列教程,如有雷同,請多多包涵了。本文是作者在電腦前一字一句敲的,每一步都是實踐的。若文中有所錯誤之處,還望提出,謝謝。

老生常談

  • 個人QQ:499452441
  • 微信公眾號:lqdevOps
公眾號

個人博客:http://blog.lqdev.cn

原文地址:http://blog.lqdev.cn/2018/08/09/springboot/chapter-eighteen/

完整示例:https://github.com/xie19900123/spring-boot-learning/tree/master/chapter-18

靜態(tài)文件工程:https://github.com/xie19900123/spring-boot-learning/tree/master/springboot-webjars

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理,服務(wù)發(fā)現(xiàn),斷路器,智...
    卡卡羅2017閱讀 136,711評論 19 139
  • Spring Boot 參考指南 介紹 轉(zhuǎn)載自:https://www.gitbook.com/book/qbgb...
    毛宇鵬閱讀 47,290評論 6 342
  • SpringBoot靜態(tài)資源的訪問 在我們開發(fā)Web應(yīng)用的時候,會用到大量的js、css、image、html等靜...
    lavor閱讀 47,857評論 0 11
  • 一個Web應(yīng)用是一個Web服務(wù)器上眾多資源的集合,它包括了servlets,HTML頁面,類,和其它組成一個完整應(yīng)...
    Lucky_Micky閱讀 1,849評論 0 2
  • 一、Spring Boot 入門 1、Spring Boot 簡介 簡化Spring應(yīng)用開發(fā)的一個框架;整個Spr...
    Y了個J閱讀 6,791評論 1 6

友情鏈接更多精彩內(nèi)容