Introduction to WebJars – WebJars简介

最后修改: 2016年 10月 16日

中文/混合/英文(键盘快捷键：t)

1. Overview

1.概述

This tutorial introduces WebJars and how to use them in a Java application.

本教程介绍了WebJars以及如何在Java应用程序中使用它们。

Simply put, WebJars are client side dependencies packaged into JAR archive files. They work with most JVM containers and web frameworks.

简单地说，WebJars是被打包成JAR归档文件的客户端依赖项。它们与大多数JVM容器和网络框架一起工作。

Here’s a few popular WebJars: Twitter Bootstrap, jQuery, Angular JS, Chart.js etc; a full list is available on the official website.

这里有几个流行的WebJars。Twitter Bootstrap, jQuery, Angular JS, Chart.js等；完整的列表可在官方网站找到。

2. Why Use WebJars?

2.为什么使用WebJars？

This question has a very simple answer – because it’s easy.

这个问题有一个非常简单的答案–因为它很容易。

Manually adding and managing client side dependencies often results in difficult to maintain codebases.

手动添加和管理客户端的依赖关系往往导致代码库难以维护。

Also, most Java developers prefer to use Maven and Gradle as build and dependency management tools.

另外，大多数Java开发者喜欢使用Maven和Gradle作为构建和依赖管理工具。

The main problem WebJars solves is making client side dependencies available on Maven Central and usable in any standard Maven project.

WebJars解决的主要问题是使客户端的依赖性在Maven中心可用，并可用于任何标准的Maven项目。

Here are a few interesting advantages of WebJars:

下面是WebJars的几个有趣的优点。

  1. We can explicitly and easily manage the client-side dependencies in JVM-based web applications
  2. We can use them with any commonly used build tool, eg: Maven, Gradle, etc
  3. WebJars behave like any other Maven dependency – which means that we get transitive dependencies as well

3. The Maven Dependency

3.Maven的依赖性

Let’s jump right into it and add Twitter Bootstrap and jQuery to pom.xml:

让我们直接跳进去，把Twitter Bootstrap和jQuery添加到pom.xml：

<dependency>
    <groupId>org.webjars</groupId>
    <artifactId>bootstrap</artifactId>
    <version>3.3.7-1</version>
</dependency>
<dependency>
    <groupId>org.webjars</groupId>
    <artifactId>jquery</artifactId>
    <version>3.1.1</version>
</dependency>

Now Twitter Bootstrap and jQuery are available on the project classpath; we can simply reference them and use them in our application.

现在Twitter Bootstrap和jQuery在项目的classpath中可用；我们可以简单地引用它们并在我们的应用程序中使用它们。

Note: You can check the latest version of the Twitter Bootstrap and the jQuery dependencies on Maven Central.

注意：您可以在Maven中心查看最新版本的Twitter Bootstrap和jQuery依赖项。

4. The Simple App

4.简单的应用程序

With these two WebJar dependencies defined, let’s now set up a simple Spring MVC project to be able to use the client-side dependencies.

在定义了这两个WebJar依赖项之后，我们现在来设置一个简单的Spring MVC项目，以便能够使用客户端依赖项。

Before we get to that however, it’s important to understand that WebJars have nothing to do with Spring, and we’re only using Spring here because it’s a very quick and simple way to set up an MVC project.

在我们讨论这个问题之前，重要的是要了解WebJars与Spring无关，我们在这里使用Spring只是因为它是建立MVC项目的一个非常快速和简单的方法。

Here’s a good place to start to set up the Spring MVC and Spring Boot project.

这里是设置Spring MVC和Spring Boot项目的一个好地方。

And, with the simple projet set up, we’ll define a some mappings for our new client dependencies:

有了这个简单的项目，我们将为我们新的客户依赖关系定义一些映射。

@Configuration
@EnableWebMvc
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry
          .addResourceHandler("/webjars/**")
          .addResourceLocations("/webjars/");
    }
}

We can of course do that via XML as well:

我们当然也可以通过XML做到这一点。

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

5. Version-Agnostic Dependencies

5.版本无关的依赖性

When using Spring Framework version 4.2 or higher, it will automatically detect the webjars-locator library on the classpath and use it to automatically resolve the version of any WebJars assets.

当使用Spring Framework 4.2或更高版本时，它将自动检测classpath上的webjars-locator库，并使用它来自动解析任何WebJars资产的版本。

In order to enable this feature, we’ll add the webjars-locator library as a dependency of the application:

为了启用这一功能，我们将添加webjars-locator库作为应用程序的依赖项。

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

In this case, we can reference the WebJars assets without using the version; see next section for a couple actual examples.

在这种情况下，我们可以不使用版本来引用WebJars的资产；请看下一节的几个实际例子。

6. WebJars on the Client

6.客户端上的WebJars

Let’s add a simple plain HTML welcome page to our application (this is index.html):

让我们为我们的应用程序添加一个简单的普通HTML欢迎页（这是index.html）。

<html>
    <head>
        <title>WebJars Demo</title>
    </head>
    <body> 
    </body>
</html>

Now we can use Twitter Bootstrap and jQuery in the project – let’s use both in our welcome page, starting with Bootstrap:

现在我们可以在项目中使用Twitter Bootstrap和jQuery–让我们在欢迎页面中使用这两种工具，首先是Bootstrap。

<script src="/webjars/bootstrap/3.3.7-1/js/bootstrap.min.js"></script>

For a version-agnostic approach:

对于一个版本无关的方法。

<script src="/webjars/bootstrap/js/bootstrap.min.js"></script>

Add jQuery:

添加jQuery。

<script src="/webjars/jquery/3.1.1/jquery.min.js"></script>

And the version-agnostic approach:

和版本无关的方法。

<script src="/webjars/jquery/jquery.min.js"></script>

7. Testing

7.测试

Now that we’ve added Twitter Bootstrap and jQuery in our HTML page, let’s test them.

现在我们已经在HTML页面中加入了Twitter Bootstrap和jQuery，让我们来测试一下它们。

We’ll add a bootstrap alert into our page:

我们将在我们的页面中添加一个bootstrap的alert。

<div class="container"><br/>
    <div class="alert alert-success">         
        <strong>Success!> It is working as we expected.
    </div>
</div>

Note that some basic understanding of Twitter Bootstrap is assumed here; here’s the getting started guides on the official.

请注意，这里假定对Twitter Bootstrap有一些基本了解；这里有官方的入门指南。

This will show an alert as shown below, which means we have successfully added Twitter Bootstrap to our classpath.

这将显示一个警报，如下所示，这意味着我们已经成功地将Twitter Bootstrap添加到我们的classpath。

Let’s use jQuery now. We’ll add a close button to this alert:

现在让我们使用jQuery。我们将为这个警报添加一个关闭按钮。

<a href="#" class="close" data-dismiss="alert" aria-label="close">×</a>

Now we need to add jQuery and bootstrap.min.js for the close button functionality, so add them inside body tag of index.html, as below:

现在我们需要添加jQuery和bootstrap.min.js来实现关闭按钮的功能，所以要在index.html的body标签内添加它们，如下。

<script src="/webjars/jquery/3.1.1/jquery.min.js"></script>
<script src="/webjars/bootstrap/3.3.7-1/js/bootstrap.min.js"></script>

Note: If you are using version-agnostic approach, be sure to remove only the version from the path, otherwise, relative imports may not work:

注意：如果你使用的是版本无关的方法，请确保只从路径中删除版本，否则，相对导入可能无法工作。

<script src="/webjars/jquery/jquery.min.js"></script>
<script src="/webjars/bootstrap/js/bootstrap.min.js"></script>

This is how our final welcome page should look like:

这就是我们最终的欢迎页面应该有的样子。

<html>
    <head>
        <script src="/webjars/jquery/3.1.1/jquery.min.js"></script>
        <script src="/webjars/bootstrap/3.3.7-1/js/bootstrap.min.js"></script>
        <title>WebJars Demo</title>
        <link rel="stylesheet" 
          href="/webjars/bootstrap/3.3.7-1/css/bootstrap.min.css" />
    </head>
    <body>
        <div class="container"><br/>
            <div class="alert alert-success">
                <a href="#" class="close" data-dismiss="alert" 
                  aria-label="close">×</a>
                <strong>Success!> It is working as we expected.
            </div>
        </div>
    </body>
</html>

This is how the application should look like. (And the alert should disappear when clicking the close button.)

这就是应用程序应该有的样子。(点击关闭按钮时，警报应该消失)。

webjarsdemo

8. Conclusion

8.结论

In this quick article, we focused on the basics of using WebJars in a JVM-based project, which makes development and maintenance a lot easier.

在这篇快速文章中，我们着重介绍了在基于JVM的项目中使用WebJars的基本知识，这使得开发和维护变得更加容易。

We implemented a Spring Boot backed project and used Twitter Bootstrap and jQuery in our project using WebJars.

我们实现了一个支持Spring Boot的项目，并在项目中使用了WebJars的Twitter Bootstrap和jQuery。

The source code of the above-used example can be found in the Github project – this is a Maven project, so it should be easy to import and build.

上述例子的源代码可以在Github项目中找到 – 这是一个Maven项目，所以应该很容易导入和构建。