上一节简单的介绍了一下Spring Cloud框架的子项目组成,这一篇介绍如何搭建一个最简单的Spring Boot应用,并实现一个简单的RESTful API,通过这个例子对Spring Boot有一个初步的了解,并体验其结构简单、开发迅速的特性。
系统及工具版本要求:
- Java 7及以上版本
- Spring Framework 4.2.7及以上版本
- Maven 3.2及以上版本
- IDEA 14及以上版本
(一)新建Maven项目
项目的结构如下图:
其中,src/main/java下面为主程序目录,存放Java代码;src/main/resources:配置目录,用于存放应用的配置信息;src/test:单元测试目录,后续会演示如何对RESTful API进行单元测试。
(二)Maven配置文件及解析
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>cn.badtom</groupId>
<artifactId>springboot-test</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>jar</packaging>
<name>springboot-first-application</name>
<description>Demo project for Spring Boot</description>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>1.5.2.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
spring-boot-starter-web:全栈web开发模块,包含嵌入式的Tomcat、Spring MVC,内嵌Tomcat可以直接以Jar包方式运行,方便快捷的部署。
spring-boot-starter-test:通用测试模块,包含Junit、Hamcrest、Mockito。
spring-boot-starter-actuator:监控和管理模块,可以实现通用的监控功能,可以不加。
(三)实现RESTFul API并通过浏览器访问
在Spring Boot中实现一个RESTFul API 的代码通Spring MVC一样,只不过不需要做很多的配置,而是直接开始写Controller的代码,在包cn.badtom.controller下新建HelloController类,内容如下所示:
package cn.badtom.controller;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@EnableAutoConfiguration
public class HelloController {
@RequestMapping("/hello")
public String index() {
return "Greetings from Spring Boot!";
}
public static void main(String[] args) {
SpringApplication.run(HelloController.class,args);
}
}
然后,通过Maven Build启动该应用,通过浏览器访问http://localhost:8080/hello,我们看到返回了预期的结果:Greetings from Spring Boot!
(四)编写单元测试
虽然刚刚我们已经跑完了Hello World,但是编写单元测试用例是一个好习惯。在src/test/下新建HelloControllerTests类,编写一个简单的测试来模拟HTTP请求,测试之前实现的/hello接口,该接口应该返回Greetings from Spring Boot!字符串。
package cn.badtom.controller;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.http.MediaType;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import org.springframework.test.context.web.WebAppConfiguration;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;
import org.springframework.test.web.servlet.setup.MockMvcBuilders;
import static org.hamcrest.Matchers.equalTo;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
@RunWith(SpringJUnit4ClassRunner.class)
@SpringBootTest(classes = HelloController.class)
@WebAppConfiguration
public class HelloControllerTests {
private MockMvc mvc;
@Before
public void setUp() throws Exception {
mvc = MockMvcBuilders.standaloneSetup(new HelloController()).build();
}
@Test
public void hello() throws Exception {
mvc.perform(MockMvcRequestBuilders.get("/hello").accept(MediaType.APPLICATION_JSON))
.andExpect(status().isOk()).andExpect(content().string(equalTo("Greetings from Spring Boot!")));
}
}
然后执行该单元测试,不出意外的话应该返回测试通过。
到这里这篇教程就结束了,仅仅实现了一个Spring Boot的Hello World应用,至于定制化配合和监控管理等内容,在后续教程中在展现吧。