Spring Boot简略入门手册

摘要：事实上，的依赖包已经包含了，因此准确地说，只用即可。这个文件的内容初始是空的，表示全部使用的默认值。的自动刷新很久之前提到的依赖包终于派上用场了。修改任意文件后，按执行，浏览器就会在编译完成后自动刷新。

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

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

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

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

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

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

本文使用Java8（jdk1.8.0_60）。

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

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

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

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

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

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

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

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

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

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

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

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

    
    


Welcome to acgtofe!

放置于templates/welcome目录下。

参照前文的目录结构创建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里选择Run→Edit Configurations。

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

点击OK保存运行配置，最后选择Run→Run（或Debug）运行应用。此时控制台里可以看到Spring Boot的banner：

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

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

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

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

这段代码将更改服务器启动的端口为8001（默认8080）：

server.port = 8001

你可能会发现在默认配置下，thymeleaf对.html的内容要求很严格，比如，如果少最后的标签封闭符号/，就会报错而转到错误页。也比如你在使用Vue.js这样的库，然后有

因此，建议增加下面这段：

spring.thymeleaf.mode = LEGACYHTML5

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

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

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

然后运行一次Gradle刷新（有任何Gradle改动，都应该这样运行一次）：

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

相比.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

如何把数据从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：

    
    


id: mock id
value: mock value

这样可以得到：

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

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

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

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

Hello, Alice!

将输出为：

Hello, Rin!

是不是干净了许多？

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

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

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

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

    
    
    



public header

page main content

可以看到，共用元素，包括内的、

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

@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";
    }
}

@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);
    }
}

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

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

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

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

@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());
    }
}

spring.devtools.livereload.enabled = true