Spring Boot简略入门手册

EdwardUp

引言

说起用Java语言来搭建Web项目,那么最令人熟知,也应用最广的框架就是Spring MVC了。不过,Spring MVC的Web项目搭建起来并不是一件简单的事,而如果你也像我这样之前没有接触过Spring生态系统,那多半会感觉到相当费劲。

时代是变化的,现在我们有了Spring Boot。

现代Java应用

Spring Boot是一个新的框架,但它并不生产新东西,而是作为一个统筹者,整理好Spring生态系统的一系列库,方便你快速搭建基于Spring的项目。

Spring Boot

相比传统的Spring MVC,Spring Boot基本无需配置即可使用。这一点使得Spring Boot像许多脚本语言的简洁框架(如PHP的Laravel,Node的Express)那样亲切友好。这就是现代Java 应用。

用Spring Boot搭建Web项目

接下来,本文将讲述用Spring Boot搭建一个简单Web项目的流程。

在本文的时间点,Spring Boot的推荐版本是1.4.0。

基本环境

本文使用Java8(jdk1.8.0_60)。

Spring Boot需要搭配MavenGradle任一构建工具使用。本文选择Gradle,安装版本为2.8。

Java项目需要搭配适当的IDE来开发,本文使用IntelliJ IDEA。

初始目录

到官方提供的Spring Initializer,生成符合自己需要的项目初始目录,比如我的情况:

Spring Initializer

一方面选择Gradle Project,另一方面在Dependencies位置输入并选择所需的依赖模块。这里选择WebThymeleaf就足够搭建一个简单的Web项目。其中,Thymeleaf是Spring Boot常用的模板引擎。附加的DevTools如名所示,是Spring Boot的开发工具,它可以提供自动刷新等有用功能。

事实上,Spring Boot的Thymeleaf依赖包已经包含了Web,因此准确地说,只用Thymeleaf即可。

创建项目

使用生成的初始目录,就可以创建好一个Spring Boot项目。在IntelliJ IDEA里选择FileNewProject from Existing Sources...

在打开的对话框里继续选择Import project from external model (Gradle)Use default gradle wrapper (recommended)

由初始目录创建项目

点击Finish后,Gradle会立即运行,下载项目需要的依赖包。如果遇到错误,有可能是网络状况不佳,这时候可以考虑到FileSettings里找到HTTP Proxy一栏设置适当的代理。

新创建的项目可能还需要到FileProject Structure里设置正确的language level

设置language level

目录结构规划

现在可以开始在项目里写东西了。参考官方的Code Structure建议,项目目录可以是这样(由初始目录演变得到):

目录结构

其中主应用类(这里是SpringBootAcgtofeApplication.java)建议放在图示位置,以符合Spring Boot的默认结构要求,免除额外的配置需要。

视图view

创建一个简单的视图文件welcome.html

<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8" />
    <title>spring boot for acgtofe</title>
</head>
<body>
Welcome to acgtofe!
</body>
</html>

放置于templates/welcome目录下。

控制器controller

参照前文的目录结构创建WelcomeController.java,它的代码也很简单:

@Controller
@RequestMapping("/welcome")
public class WelcomeController {

    @RequestMapping("")
    String index(){
        return "welcome/welcome";
    }

}

@Controller标识这是一个controller类。@RequestMapping用于指定访问路径,也就是路由。

index()方法返回一个字符串welcome/welcome,意思是返回路径templates/welcome/welcome.html的那个视图。

不需要再做其他任何配置,基于Spring Boot的简单Web项目到此就可以运行了。

启动运行

在IntelliJ IDEA里选择RunEdit Configurations

在弹出的对话框里点击左上的+选择Spring Boot。然后,在右边的Main class一栏点击...按钮选择主应用类:

运行配置

点击OK保存运行配置,最后选择RunRun(或Debug)运行应用。此时控制台里可以看到Spring Boot的banner:

默认banner

打开浏览器,访问localhost:8080/welcome,就可以看到刚才的视图页:

浏览器访问结果

到此,一个简单的Web项目就完成了。接下来,我们看看如何让这个Web项目更丰富,更符合实际项目的需要。

改变默认配置

在前面的流程中,尽可能使用了Spring Boot的默认配置,因此非常简单。如果要改变Spring Boot项目的配置,就可以修改初始提供的位于resources下的application.properties

这个文件的内容初始是空的,表示全部使用Spring Boot的默认值。简单按照.properties的内容格式来添加内容就可以了。下面是一些常用的例子。

端口号

这段代码将更改服务器启动的端口为8001(默认8080):

server.port = 8001

非严格的thymeleaf格式

你可能会发现在默认配置下,thymeleaf对.html的内容要求很严格,比如<meta charset="UTF-8" />,如果少最后的标签封闭符号/,就会报错而转到错误页。也比如你在使用Vue.js这样的库,然后有<div v-cloak></div>这样的html代码,也会被thymeleaf认为不符合要求而抛出错误。

因此,建议增加下面这段:

spring.thymeleaf.mode = LEGACYHTML5

spring.thymeleaf.mode的默认值是HTML5,其实是一个很严格的检查,改为LEGACYHTML5可以得到一个可能更友好亲切的格式要求。

需要注意的是,LEGACYHTML5需要搭配一个额外的库NekoHTML才可用。到项目根目录的build.gradle文件里这样添加它到dependencies

compile('net.sourceforge.nekohtml:nekohtml:1.9.22')

然后运行一次Gradle刷新(有任何Gradle改动,都应该这样运行一次):

Gradle刷新

最后重启项目就可以感受到不那么严格的thymeleaf了。

YAML格式的配置

相比.properties格式,可能YAML格式看起来条理更清晰,也更有层次感。Spring Boot本身就支持YAML格式的应用配置文件,因此,你可以创建文件application.yml

前面刚提到的两项配置,写成YAML是:

server:
    port: 8001

spring:
    thymeleaf:
        mode: LEGACYHTML5

应用配置文件application.[yml|properties]除了初始位置,新建目录resources/config来放置也比较常见。

配置参考

完整的配置参考请见官方的Common application properties

静态资源

css、js及图片属于静态资源。在resources目录下的以下几个位置的静态资源文件,都将在启动服务后可以被直接访问:

  • static

  • public

  • resources

  • META-INF/resources

数据传递与thymeleaf基础用法

如何把数据从controller传递到view呢?请看下面的例子。

model/Hoge.java

public class Hoge {

    public int id;
    public String value;

}

controller/WelcomeController.java

@Controller
@RequestMapping("/welcome")
public class WelcomeController {

    @RequestMapping("")
    String index(Model model){
        Hoge hoge = new Hoge();
        hoge.id = 10;
        hoge.value = "hoge";

        model.addAttribute("myData", hoge);
        
        return "welcome/welcome";
    }

}

templates/welcome/welcome.html

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8" />
    <title>spring boot for acgtofe</title>
</head>
<body>
<p>id: <span th:text="${myData.id}">mock id</span></p>
<p>value: <span th:text="${myData.value}">mock value</span></p>
</body>
</html>

这样可以得到:

传递数据

在视图文件中使用thymeleaf,首先用xmlns:th为thymeleaf定义好名空间,然后以th:名空间的自定属性,来使用thymeleaf的功能。

在这个例子中,th:text属性表示标签内部的文本,它会输出指定的值,替换掉原来的静态文本。而${...}的表达式,可以用于指定th:text的值,以获取controller传递过来的数据(通过model)。

插值技巧

在前面的例子中,我们好像为了让thymeleaf输出数据,额外增加了<span>标签。这个标签不是必须的,因此我们可能不想要它。

thymeleaf有一个非常有用的属性设置th:remove='tag'。比如现在有一个数据变量name的值是Rin,那么这段:

<p>Hello, <span th:remove="tag" th:text="${name}">Alice</span>!</p>

将输出为:

<p>Hello, Rin!</p>

是不是干净了许多?

详细的thymeleaf模板引擎的用法,请参考Using Thymeleaf

thymeleaf视图布局

搭建一个Web站点常会面临这样一个问题:有很多不同的页会有一些结构或内容是相同的,如何合理地管理它们以方便维护

Thymeleaf Layout Dialect可以帮助我们应对这个问题。spring-boot-starter-thymeleaf依赖包已经包含了它,可以直接使用。

现在,我们有一系列视图,它们都有页眉(header),页脚(footer),及公共的css(common.css)和js(common.js),而且网页标题有相同的后缀。那么,可以新建一个布局视图layout/default.html

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org"
      xmlns:layout="http://www.ultraq.net.nz/thymeleaf/layout">

<head>
    <meta charset="UTF-8" />
    <title layout:title-pattern="$CONTENT_TITLE - $DECORATOR_TITLE">acgtofe</title>
    <link rel="stylesheet"
          href="../../static/css/common/common.css"
          th:href="@{/css/common/common.css}" />
</head>
<body>

<header>public header</header>

<section layout:fragment="content">page main content</section>

<footer>public footer</footer>

<script src="../../static/js/common/common.js"
        th:src="@{/js/common/common.js}"></script>

</body>
</html>

可以看到,共用元素,包括<head>内的<meta><title>等信息,都写在了这个布局视图内。

然后修改之前的视图welcome/welcome.html如下:

<html xmlns:th="http://www.thymeleaf.org"
      xmlns:layout="http://www.ultraq.net.nz/thymeleaf/layout"
      layout:decorator="layout/default">

<head>
    <title>welcome</title>
    <link rel="stylesheet"
          href="../../static/css/welcome/welcome.css"
          th:href="@{/css/welcome/welcome.css}" />
</head>
<body>

<section layout:fragment="content">Welcome to acgtofe!</section>

</body>
</html>

其中layout:decorator="layout/default"是一个关键的属性标记,它的意思是按照继承的风格,取layout/default.html视图作为布局使用。

启动应用并访问,可以看到结果是这样:

布局视图的应用

thymeleaf-layout-dialect默认会像这样为<head>里的内容进行合并,而<body>里的内容会按layout:fragment分别进行覆盖。

属性layout:title-pattern用于指定布局视图的标题如何与页面视图的标题拼合在一起,这个例子也是用它实现了网页标题的共同后缀。

你可以查看thymeleaf-layout-dialect官方文档了解更多的使用方法。

前端库集成

如果想要为项目添加jQuery、Bootstrap这样的前端库,可以使用WebJars

例如,在build.gradle里添加这样的依赖:

compile 'org.webjars:jquery:3.1.0'
compile 'org.webjars:bootstrap:3.3.7'

运行Gradle刷新,然后就可以这样在视图文件里加入它们:

<link rel="stylesheet"
      href="http://cdn.jsdelivr.net/webjars/bootstrap/3.3.7/css/bootstrap.min.css"
      th:href="@{/webjars/bootstrap/3.3.7/css/bootstrap.min.css}" />
<script src="http://cdn.jsdelivr.net/webjars/jquery/3.1.0/jquery.min.js"
        th:src="@{/webjars/jquery/3.1.0/jquery.min.js}"></script>
<script src="http://cdn.jsdelivr.net/webjars/bootstrap/3.3.7/js/bootstrap.min.js"
        th:src="@{/webjars/bootstrap/3.3.7/js/bootstrap.min.js}"></script>

结合前面的布局视图,就可以让这些库在任何地方都可用。

和Spring MVC有关的用法笔记

Spring Boot的Web用的就是Spring MVC,因此Spring MVC的知识点在Spring Boot项目里是通用的。下面是一些常用功能。

返回一般数据的controller

@RestController
@RequestMapping("/hello")
public class HelloController {

    @RequestMapping(method=RequestMethod.GET)
    public String getMethod() {
        return "get";
    }

    @RequestMapping(value="/hey", method=RequestMethod.POST)
    public String postMethod2() {
        return "hey post";
    }
}

除了返回视图,某些controller可能是用来返回一般数据(例如json格式数据),比较像API。@RestController标记的类就是一个API风格的controller,其内部所有指定了访问地址的方法,都将返回一般数据。一般来说,Ajax请求很适合和这样的controller搭配。

如果在返回视图的@Controller标记的类里也希望某单个方法返回一般数据,在这个方法前一行单独添加注解@ResponseBody即可。

@RequestMappingvalue指定路径,method指定HTTP访问方法。

controller中获取请求参数

@RequestMapping可以在路径里设置参数,然后在方法中被取到:

@RestController
@RequestMapping("/hello")
public class HelloController {

    @RequestMapping(value="/{id}/{name}", method=RequestMethod.GET)
    public void getMethod(@PathVariable int id, @PathVariable String name) {
        System.out.println("id=" + id + ", name=" + name);
    }
}

这样@PathVariable搭配{...},就从路径分别获取了idname两个变量值。

此外, 一次请求的GET参数(位于URL的?后的内容)或POST参数(作为请求的Request Body),都可以用request.getParameter()取到:

@RestController
@RequestMapping("/hello")
public class HelloController {

    @RequestMapping(method=RequestMethod.POST)
    public void getMethod(HttpServletRequest request) {
        System.out.println("userName=" + request.getParameter("userName"));
    }
}

如果用Ajax向controller发送json字符串数据,controller这边获取起来要麻烦一些,大致像下面这样。

例如,Ajax发送的内容是(注意需要指定内容格式为json):

var person = {
    name: "Rin",
    age: 17
},
promise = $.ajax{
    url: "/hello/submit",
    type: "POST",
    contentType: "application/json; charset=utf-8",
    data: JSON.stringify(person)
};

然后接收的这边需要先准备好一个同样结构的类,如Person.java

public class Person {
  private String name;
  private int age;
  // getters & setters ...
}

然后controller里用带@RequestBody标记的参数就可以获取到:

@RestController
@RequestMapping("/hello")
public class HelloController {

    @RequestMapping(value="/submit", method=RequestMethod.POST)
    public void submit(@RequestBody Person person) {
        System.out.println("person.name=" + person.getName());
    }
}

如果json数据结构和数据类不能完全匹配,controller将返回415错误(不支持的媒体类型)。

DevTools的自动刷新

很久之前提到的依赖包DevTools终于派上用场了。DevTools提供了自动刷新功能,可以让开发更快捷。下面是结合IntelliJ IDEA的使用流程:

在应用配置文件内设置spring.devtools.livereload.enabled的值为true

spring.devtools.livereload.enabled = true

接下来,为浏览器安装LiveReload插件,比如Chrome的情况:

Chrome的LiveReload插件

然后运行项目,并在浏览器中确认LiveReload插件为运行状态(单击一下即可在运行状态与停止状态之间切换)。

修改任意文件后,按ctrl + F9执行Make Project,浏览器就会在编译完成后自动刷新。

结语

一路写下来,发现篇幅意外地长,不过这也总算是有一点“手册”的味道。如果你有考虑过Java语言来快速开发Web应用,相信本文和Spring Boot都会对你有所帮助。

(重新编辑自我的博客,原文地址:http://acgtofe.com/posts/2016...

阅读 4.4k

庭院茶
天津大学毕业生,从事前端开发。爱好动画,也喜欢做设计,现在画师学习中。个人博客 [链接]
5.8k 声望
202 粉丝
0 条评论
你知道吗?

5.8k 声望
202 粉丝
文章目录
宣传栏