第一步:打开官网 start.spring.io (用IDEA创建也行),创建项目
创建完毕后,项目会自动下载下来
下载下来的项目结构如下图
package com.manning.readinglist;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class ReadinglistApplication {
public static void main(String[] args) {
SpringApplication.run(ReadinglistApplication.class, args);
}
}
类文件及相关注解解析
ReadingListApplication.java:应用程序的启动引导类,也是主要的Spring配置类。
application.properties:用于配置应用程序和Spring Boot的属性。
ReadingListApplicationTests.java:一个基本的集成测试类。
在ReadingListApplication.java中@SpringBootApplication开启了Spring的组件扫描和Spring Boot的自动配置功能。实际上@SpringBootApplication将三个有用的注解组合在了一起。
- Spring的@Configuration:标明该类使用Spring基于java的配置。当然也可以用传统的XML配置替换。
- Spring的@ComponentScan:启用组件扫描,这样你写的Web控制器和其他组件才能被自动发现并注册为Spring应用程序上下文里的Bean。
- Spring Boot的@EnableAutoConfiguration:这个不起眼的小注解,就是这个注解开启了Spring Boot自动配置的魔力,让你不用再写成篇的配置了
在Spring Boot的早期版本中,你需要在ReadingListApplication类上同时标上这三个注解,但从Spring Boot 1.2.0开始,有@SpringBootApplication就行了。
第二步:写代码
GitHub源码地址:https://github.com/pocher/SpringBootDemo
定义领域模型
我们应用程序里的核心领域概念是读者阅读列表上的书。因此我们需要定义一个实体类来表示这个概念。
下图的Book类就是简单的Java对象,其中有些描述书的属性,还有必要的访问方法。@Entity注解表明他是一个JPA实体,id属性加了@id和@GeneratedValue注解,说明这个字段是实体的唯一标识,并且这个字段的值是自动生成的。
package com.manning.readinglist;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
/**
* @author pocher wyuzhan@163.com
* @date 2019/2/12 18:24
*/
@Entity
public class Book {
@Id
@GeneratedValue(strategy = GenerationType.AUTO)
private Long id;
private String reader;
private String isbn;
private String title;
private String author;
private String description;
public Long getId() {
return id;
}
public void setId(Long id) {
this.id = id;
}
public String getReader() {
return reader;
}
public void setReader(String reader) {
this.reader = reader;
}
public String getIsbn() {
return isbn;
}
public void setIsbn(String isbn) {
this.isbn = isbn;
}
public String getTitle() {
return title;
}
public void setTitle(String title) {
this.title = title;
}
public String getAuthor() {
return author;
}
public void setAuthor(String author) {
this.author = author;
}
public String getDescription() {
return description;
}
public void setDescription(String description) {
this.description = description;
}
}
定义仓库接口
接下来,我们就要定义用于把Book对象持久化到数据库的仓库了。因为用了SpringData JPA,所以我们要做的就是简单地定义一个接口,扩展一下SpringData JPA的JPARepository接口:
package com.manning.readinglist;
import org.springframework.data.jpa.repository.JpaRepository;
import java.util.List;
/**
* @author pocher wyuzhan@163.com
* @date 2019/2/12 18:27
*/
public interface ReadingListRepository extends JpaRepository<Book, Long> {
List<Book> findByReader(String reader);
}
通过扩展JpaRepository,ReadingListRepository直接继承了18个执行常用持久化操作的方法。JpaRepository是个泛型接口 ,有两个参数:仓库操作的领域对象类型,以及ID属性的类型。findByReader是我自己新加的,可以根据读者的用户名称来查找阅读列表。
如果你好奇谁来实现这个ReadingListRepository及其继承的18个方法,请不用担心,Spring Data提供了很神奇的魔法,只需要定义仓库接口,在应用程序启动后,该接口在运行时会自动实现。
创建Web界面
我们定义好了应用程序的领域模型,还有把领域对象持久化到数据库里的仓库接口,剩下的及时创建Web前端了。
下图便是 作为阅读列表应用程序前端的Spring MVC控制器
package com.manning.readinglist;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.*;
import java.util.List;
/**
* @author pocher wyuzhan@163.com
* @date 2019/2/12 18:28
*/
@Controller
@RequestMapping("/readingList")
public class ReadingListController {
private ReadingListRepository readingListRepository;
@Autowired
public ReadingListController(ReadingListRepository readingListRepository){
this.readingListRepository = readingListRepository;
}
@RequestMapping(value = "/{reader}", method = RequestMethod.GET)
public String readerBooks(
@PathVariable("reader") String reader, Model model){
List<Book> readingList = readingListRepository.findByReader(reader);
if(readingList != null){
model.addAttribute("books", readingList);
}
return "readingList";
}
@RequestMapping(value = "/{reader}", method = RequestMethod.POST)
public String addToReadingList(@PathVariable("reader") String reder, Book book){
book.setReader(reder);
readingListRepository.save(book);
return "redirect:/readingList/{reader}";
}
}
ReadingListController 使用了@Controller注解,这样组件扫描会自动将其注册为Spring应用程序上下文里的一个Bean。它还用了@RequestMapping注解,将其中所有的处理器方法都映射到了“/”这个URL路径上。
该控制器有两个方法。
- readerBooks():处理/{reader}上的HTTP GET请求,根据路径里指定的读者,从仓库获取Book列表。随后将这个列表塞入模型,用的键是books,最后返回readingList作为呈现模型的试图逻辑名称。
- addToReadingList():处理/{reader}上的HTTP POST请求,将请求正文里的数据绑定到一个Book对象上。该方法把Book对象的reader属性设置为读者的姓名,随后通过仓库的save()方法保存修改后的Book对象,最后重定向到/{reader}上(控制器中的另一个方法会处理该请求)
readerBooks()方法最后返回readingList作为逻辑视图名,为此必须创建该视图。因为在项目开始之初我就决定要用Thymeleaf来定义应用程序的视图,所以接下来就在src/main/resources/templates里创建一个名为readingList.html的文件
呈现阅读列表的Thymeleaf模板
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.springframework.org/schema/data/jaxb">
<head>
<title>Reading List</title>
<link rel = "stylesheet" th:href="@{/style.css}"/>
</head>
<body>
<h2>Your Reading List</h2>
<div th:unless = "${#lists.isEmpty(books)}">
<dl th:each="book : ${books}">
<dt class="bookHeadline">
<span th:text = "${book.title}">Title</span>
<span th:text = "${book.author}">Author</span>
(ISBN: <span th:text="${book.isbn}">ISBN</span>)
</dt>
<dd class="bookDescription">
<span th:if="${book.description}"
th:text="${book.description}" > Description</span>
<span th:if="${book.description eq null}"
th:text="${book.description}" > NO description available</span>
</dd>
</dl>
</div>
<div th:if="${#lists.isEmpty(books)}">
<p>You have no books in your book list</p>
</div>
<hr/>
<h3>Add a book</h3>
<form method="POST">
<label for="title">Title:</label>
<input type="text" name="title" size="50" /><br/>
<label for="author">Author:</label>
<input type="text" name="author" size="50" /><br/>
<label for="isbn">ISBN:</label>
<input type="text" name="isbn" size="15" /><br/>
<label for="description">Description:</label><br/>
<textarea type="text" name="description" cols="80" rows="5">
</textarea><br/>
<input type="submit" value="submit"/>
</form>
</body>
</html>
这个模板定义了一个HTML页面,该页面概念上分为两个部分:页面上方是读者的阅读列表中的图书清单,下方是一个表单,读者可以从这里添加新书。
为了美观,Thymeleaf模板引用了一个名为style.css的样式文件,该文件位于src/main/resources/static目录中,看起来是这样的:
body {
background-color: #cccccc;
font-family: Arial, helvetica, sans-serif;
}
.bookHeadline {
font-size: 12pt;
font-weight: bold;
}
.bookDescription {
font-size: 10pt;
}
label {
font-weight: bold;
}
不管你相不相信,以上就是一个完整的应用程序了,你看到什么配置了吗?实际上,除了ReadingListApplication.java中的@SpringBootApplication注解,你不用在写任何Spring配置了。虽然没什么Spring配置,但这已经是一个可以运行的完整的Spring应用程序了。让我们把它运行起来,看看会怎样。
如果一切正常,你的浏览器应该会展现一个空白的阅读列表,下方有一个用于向列表添加新书的表单。如下图
接下来,通过表单添加一些图书吧。随后你的阅读列表看起来就会像下图这样
以上GitHub源码地址:https://github.com/pocher/SpringBootDemo
自动配置分析
以上完毕,下面分析自动配置都做了那些工作
- 因为Classpath里有H2,所以自动化配置会创建一个嵌入式的H2数据库Bean,它的类型是javax.sql.DataSource,JPA实现(Hibernate)需要它来访问数据库。
- 因为Classpath里有Hibernate(Spring Data JPA 传递引入的)的实体管理器,所以自动配置会配置与Hibernate相关的Bean,包括Spring的LocalContainerEntityManagerFactoryBean和JpaVendorAdapter。
- 因为Classpath里有Spring Data JPA,所以他会自动配置为根据仓库的接口创建仓库实现。
- 因为Classpath里有Thymeleaf,所以Thymeleaf会配置为Spring MVC的视图,包括一个Thymeleaf的模板解析器、模板引擎及视图解析器。视图解析器会解析相对于Classpath根目录的/templates目录里的模板。
- 因为Classpath里有Spring MVC(归功于Web起步依赖),所以 会配置Spring的DispatcherServlet并启用Spring MVC。
- 因为这是一个Spring MVC Web应用程序,所以会注册一个资源处理器,把相对于Classpath根目录的/static目录里的静态内容提供出来。(这个资源处理器还能处理/publich、/resources、/META-INF/resources的静态内容。)
- 因为Classpath里有Tomcat(通过Web起步依赖传递引用),所以会启动一个嵌入式的Tomcat容器,监听8080端口。
由此可见,Spring Boot自动配置承担起了配置Spring的重任,因此你能专注于编写自己的应用程序。