Spring Boot 系列 | 第一篇:快速创建一个简单的应用

前言

本人由一个Android开发者转向学习后端的第一个学习的内容就是Spring Boot,虽然有系统了解过Spring/Spring MVC 相关的知识, 但是在学习Spring Boot的过程中会出现各种各样的问题,在学习Spring Boot的时候会出现一个现象:当你遇到问题的时候,上网百度,然后出现了几种方案,有一些是可以的,有一些是不行的,出现这个原因有可能是因为别人的问题解决方案是基于某个版本的,但是版本更新之后又不一样了。或者有时候配置一些东西的时候又会有一些疑惑,有些东西配不配都可以,有些不配置又会报错,这种现象我觉得很可怕,因为不了解一样东西。你不知道它做了什么。你只知道这样配置了就可以了,上网想找一些官方的文档,又不知道在哪里找,这么多starter到底帮你做了什么事。完全一头雾水,所以想自己做一个系列的笔记,把每一个知识点记录一下。

本文不算原创(参考了网上相关博客资料),也不做任何声明,仅仅是作为笔者的笔记记录。

环境

  • Mac 系统
  • IDEA
  • Maven 3
  • JAVA 8

使用IDEA创建项目

  • 菜单选择:File -> New -> Project
  • 选中Spring Initializr
  • 点击Next,到了工程信息界面,在这个界面可以配置工程名称,类型(Maven或者Gradle)打包方式(jar或者war)还有一些其他基本信息,可以根据自己需要进行改动。目前什么都不改动。
  • 再次点击Next,就会进入Spring Boot的版本号和相关依赖,我的Spring Boot 版本为1.5.9

    什么都不用选择,点击Next 进入设置项目名称和项目存储位置的页面

    点击Finish,等待一会儿就会进入项目

编写Hello World

项目结构如下:

打开pom.xml之后显示如下内容:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache/POM/4.0.0" xmlns:xsi="http://www.w3/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache/POM/4.0.0 http://maven.apache/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.example</groupId>
    <artifactId>demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>

    <name>demo</name>
    <description>Demo project for Spring Boot</description>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.5.9.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</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

可以看到项目会默认依赖了spring-boot-startersrping-boot-starter-test,这两个依赖一个是启动Spring Boot的依赖,一个是Junit的相关依赖,为了开发一个HelloWorld程序。在dependencies节点用spring-boot-start-web替换spring-boot-starter依赖以便提供Web服务。

<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

修改后的pom.xml如下:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache/POM/4.0.0" xmlns:xsi="http://www.w3/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache/POM/4.0.0 http://maven.apache/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.example</groupId>
    <artifactId>demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>

    <name>demo</name>
    <description>Demo project for Spring Boot</description>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.5.9.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>

    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

修改了pom文件之后maven会下载相关依赖,需要等待一段时间.

然后新建一个HelloController

package com.example.demo.controller;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestCon


@RestController
public class HelloController {

    @RequestMapping("/")
    public String index() {
        return "Greetings from Spring Boot!";
    }

}

这个类里面用了2个注解,@RestController结合了@Controller@ResponseBody用于标识Web请求返回的是数据而不是视图,@RequestMapper标识了访问的路径,将“/”映射到了index方法中.

运行

然后将鼠标放到DemoApplication类点击右键选择 run DemoApplication即可把应用启动,我们查看控制台输出:

Tomcat started on port(s): 8080 (http)
Started DemoApplication in 2.965 seconds (JVM running for 3.582)
Initializing Spring FrameworkServlet 'dispatcherServlet'

可以看到Tomcat启动绑定了8080端口,所以我们在浏览器输入http://localhost:8080即可看到输出 Greetings from Spring Boot!

至此已经使用Spring Boot写了一个Hello world程序,并且把它启动起来。

测试接口

默认情况下,新建的Spring Boot程序会帮我们加入了Spring Test,在pom.xml中可以看到以下内容

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <scope>test</scope>
</dependency>

如果没有,请自行添加。

下面开始编写一个简单的测试程序:

在src->test包目录下新建一个HelloControllerTest类:

使用Mock框架测试:

package com.example.demo;

import org.hamcrest.Matchers;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.http.MediaType;
import org.springframework.test.context.junit4.SpringRunner;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;
import org.springframework.test.web.servlet.result.MockMvcResultMatchers;

@RunWith(SpringRunner.class)
@SpringBootTest
@AutoConfigureMockMvc
public class HelloControllerTest {

    @Autowired
    private MockMvc mvc;

    @Test
    public void hello() throws Exception {
        mvc.perform(MockMvcRequestBuilders.get("/").accept(MediaType.APPLICATION_JSON))
                .andExpect(MockMvcResultMatchers.status().isOk())
                .andExpect(MockMvcResultMatchers.content().string(Matchers.equalTo("Greetings from Spring Boot!")));

    }
}

运行hello方法就可以对HelloController进行断言测试

或者不使用Mock框架测试:

package com.example.demo;

import org.hamcrest.Matchers;
import org.junit.Assert;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.context.embedded.LocalServerPort;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.web.client.TestRestTemplate;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.test.context.junit4.SpringRunner;
import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;
import org.springframework.test.web.servlet.result.MockMvcResultMatchers;

import java.MalformedURLException;
import java.URL;

@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
public class HelloControllerTest {

    @LocalServerPort
    private int port;

    private URL base;

    @Autowired
    TestRestTemplate testRestTemplate;

    @Before
    public void setUp() throws MalformedURLException {
        this.base = new URL("http://localhost:" + port + "/");
    }

    @Test
    public void hello() throws Exception {
        ResponseEntity<String> respons = testRestTemplate.getForEntity(base.toString(), String.class);
        Assert.assertThat(respons.getBody(),Matchers.equalTo("Greetings from Spring Boot!"));
    }
}

通过webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT让内嵌服务器跑在任意一个端口,实际上的端口通过@LocalServerPort获取。

总结

此篇记录了使用IDEA快速创建一个Spring Boot的程序,并实现了Hello World接口,对接口测试方式进行介绍。

更多推荐

Spring Boot 系列 | 第一篇:快速创建一个简单的应用