SpringBoot指南|第一篇:构建第一个SpringBoot

2018-02-23  本文已影响29人  YClimb

Learn how to build an application with minimal configuration.

了解如何使用最少的配置构建应用程序。


目录

简介

本指南提供了Spring Boot如何帮助您加速和促进应用程序开发的示例。当您阅读更多的Spring入门指南时,您将看到更多的Spring引导用例。

Spring Boot 它的设计目的就是为了简化开发,开启了各种自动装配;如果你不想写各种配置文件,引入相关的依赖就能迅速搭建起一个web工程。它采用的是建立生产就绪的应用程序观点,优先于配置的惯例。
当你一旦使用了Spring Boot ,你会觉得一切变得简单了,配置变的简单了、编码变的简单了,部署变的简单了,感觉自己健步如飞,开发速度大大提高了。就好比,当你用了IDEA,你会觉得再也回不到Eclipse时代一样。

官方资料:Building an Application with Spring Boot

准备事项

你需要:

· 十五分钟左右(About 15 minutes)

· IntelliJ IDEA(A favorite text editor or IDE)

· JDK 1.8(JDK 1.8 or later)

· Maven 4.0(Gradle 2.3+ or Maven 3.0+)

了解您可以使用Spring Boot做什么

Spring Boot提供了一种快速构建应用程序的方法。它查看您的类路径和您已经配置的bean,对丢失的内容做出合理的假设,并添加它。使用Spring引导,您可以更加关注业务特性,而不是基础设施。

例如:

· Got Spring MVC? 您几乎总是需要几个特定的bean, Spring引导自动添加它们。Spring MVC应用程序还需要一个servlet容器,因此Spring引导会自动配置嵌入的Tomcat。

· Got Jetty? 如果是这样,您可能不需要Tomcat,而是要嵌入Jetty。Spring Boot为您处理这个问题。

· Got Thymeleaf? 有一些必须始终添加到应用程序上下文中的bean;Spring Boot为您添加了它们。

这些只是一些自动配置Spring引导提供的示例。与此同时,Spring Boot不会妨碍你。例如,如果Thymeleaf在您的路径上,Spring引导会自动为您的应用程序上下文添加一个SpringTemplateEngine。但是,如果您使用自己的设置定义自己的SpringTemplateEngine,那么Spring Boot不会添加一个。这让你在你的控制下几乎没有任何努力。

Spring Boot不会生成代码,也不会对文件进行编辑。相反,当启动应用程序时,Spring Boot会动态地连接bean和设置,并将它们应用到应用程序上下文。

构建一个Maven项目

打开Idea -> new Project ->Spring Initializr -> 填写group、artifact -> 钩上web(开启web功能)-> 点下一步就行了。

官方快速构建地址:http://start.spring.io/

创建完成之后的工程目录如下:

- src
    -main
        -java
            -package
                -SpringbootApplication.class
        -resouces
            - statics
            - templates
            - application.yml
    -test
- pom.xml

文件解析:

· pom.xml 文件为基本的依赖管理文件
· resouces 资源文件 
    · statics 静态资源
    · templates 模板资源
    · application.yml 配置文件
· SpringbootApplication.class 程序的入口。

pom.xml

<?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>com.yclimb</groupId>
    <artifactId>springboot-first-application</artifactId>
    <version>0.0.1-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.10.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>

其中spring-boot-starter-web不仅包含spring-boot-starter,还自动开启了web功能。

创建一个简单的Web应用程序

创建一个用于web访问的Controller:

package com.yclimb.hello;

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

@RestController
public class HelloController {

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

}

这个类被标记为@RestController,这意味着它已经准备好用于Spring MVC处理web请求。@RequestMapping映射/到index()方法。当从浏览器调用或在命令行上使用curl时,该方法返回纯文本。这是因为@RestController结合了@Controller和@ResponseBody,这两个注释导致web请求返回数据而不是视图。

启动SpringbootFirstApplication的main方法,打开浏览器localhost:8080,浏览器显示:

Greetings from Spring Boot!

这样一个Web应用程序就已经ok了。

和以前的Maven构建不同之处:

· 不需要任何的web.xml配置。
· 不需要任何的spring mvc的配置; spring boot为你做了。
· 不需要配置tomcat; spring boot内嵌tomcat.

创建一个应用程序类

创建一个用于显示展示所有注入Bean的应用类:

package com.yclimb.hello;

import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.Bean;

import java.util.Arrays;

@SpringBootApplication
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }

    @Bean
    public CommandLineRunner commandLineRunner(ApplicationContext ctx) {
        return args -> {

            System.out.println("Let's inspect the beans provided by Spring Boot:");

            String[] beanNames = ctx.getBeanDefinitionNames();
            Arrays.sort(beanNames);
            for (String beanName : beanNames) {
                System.out.println(beanName);
            }

        };
    }

}

@SpringBootApplication是一个方便的注释,它添加了以下所有内容:

· @Configuration将类标记为应用程序上下文的bean定义源。
· @EnableAutoConfiguration告诉Spring Boot开始添加基于类路径设置、其他bean和各种属性设置的bean。
· 通常情况下,您会为Spring MVC应用程序添加@EnableWebMvc,但是Spring Boot在类路径上看到Spring-webmvc时,会自动添加它。它将应用程序标记为web应用程序,并激活关键行为,如设置DispatcherServlet。
· @ComponentScan告诉Spring在hello程序包中查找其他组件、配置和服务,允许它找到控制器。

main()方法使用Spring Boot的SpringApplication.run()方法来启动应用程序。您是否注意到没有一行XML?没有web.xml文件。这个web应用程序是100%纯Java,您不必处理配置任何管道或基础设施。

还有一个CommandLineRunner方法,标记为@Bean,它在启动时运行。它将检索您的应用程序创建的所有bean,或者由于Spring Boot而自动添加。把它们分类并打印出来。

运行应用程序

启动springboot方式:

cd到项目主目录:

mvn clean  
mvn package  // 编译项目的jar

mvn spring-boot: run // 启动

cd 到target目录
java -jar 项目.jar

或者直接一行执行:
mvn package && java -jar target/项目.jar

输出结果:

Let's inspect the beans provided by Spring Boot:
application
beanNameHandlerMapping
defaultServletHandlerMapping
dispatcherServlet
embeddedServletContainerCustomizerBeanPostProcessor
handlerExceptionResolver
helloController
httpRequestHandlerAdapter
messageSource
mvcContentNegotiationManager
mvcConversionService
mvcValidator
org.springframework.boot.autoconfigure.MessageSourceAutoConfiguration
org.springframework.boot.autoconfigure.PropertyPlaceholderAutoConfiguration
org.springframework.boot.autoconfigure.web.EmbeddedServletContainerAutoConfiguration
org.springframework.boot.autoconfigure.web.EmbeddedServletContainerAutoConfiguration$DispatcherServletConfiguration
org.springframework.boot.autoconfigure.web.EmbeddedServletContainerAutoConfiguration$EmbeddedTomcat
org.springframework.boot.autoconfigure.web.ServerPropertiesAutoConfiguration
org.springframework.boot.context.embedded.properties.ServerProperties
org.springframework.context.annotation.ConfigurationClassPostProcessor.enhancedConfigurationProcessor
org.springframework.context.annotation.ConfigurationClassPostProcessor.importAwareProcessor
org.springframework.context.annotation.internalAutowiredAnnotationProcessor
org.springframework.context.annotation.internalCommonAnnotationProcessor
org.springframework.context.annotation.internalConfigurationAnnotationProcessor
org.springframework.context.annotation.internalRequiredAnnotationProcessor
org.springframework.web.servlet.config.annotation.DelegatingWebMvcConfiguration
propertySourcesBinder
propertySourcesPlaceholderConfigurer
requestMappingHandlerAdapter
requestMappingHandlerMapping
resourceHandlerMapping
simpleControllerHandlerAdapter
tomcatEmbeddedServletContainerFactory
viewControllerHandlerMapping
...

您可以清楚地看到org.springframework.boot.autoconfigure beans。还有一个tomcatEmbeddedServletContainerFactory。
检查服务:

$ curl localhost:8080
Greetings from Spring Boot!

或者
打开浏览器输入localhost:8080

单元测试

将下列依赖添加到您的依赖列表中:

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

下面编写一个简单的测试类:

package com.yclimb.hello;

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 static org.hamcrest.Matchers.equalTo;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

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

    @Autowired
    private MockMvc mvc;

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

MockMvc来自Spring Test,允许您通过一组方便的构建器类将HTTP请求发送到DispatcherServlet,并对结果做出断言。注意,使用@AutoConfigureMockMvc和@SpringBootTest来注入一个MockMvc实例。在使用@SpringBootTest之后,我们要求创建整个应用程序上下文。另一种方法是让Spring引导只使用@WebMvcTest来创建上下文的web层。Spring Boot会自动尝试定位应用程序的主应用程序类,但是您可以重写它,或者缩小它,如果您想构建一些不同的东西。

除了模仿HTTP请求周期外,我们还可以使用Spring Boot编写一个非常简单的全栈集成测试。例如,以下模拟测试,我们可以做到这一点:

package com.yclimb.hello;

import static org.hamcrest.Matchers.equalTo;
import static org.junit.Assert.assertThat;

import java.net.URL;

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.ResponseEntity;
import org.springframework.test.context.junit4.SpringRunner;

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

    @LocalServerPort
    private int port;

    private URL base;

    @Autowired
    private TestRestTemplate template;

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

    @Test
    public void getHello() throws Exception {
        ResponseEntity<String> response = template.getForEntity(base.toString(),
                String.class);
        assertThat(response.getBody(), equalTo("Greetings from Spring Boot!"));
    }
}

嵌入式服务器通过webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT在随机端口上启动,实际端口在运行时使用@LocalServerPort发现。

参考资料

本文官方文档:Building an Application with Spring Boot

快速创建项目:Spring Initializr

结语

本文是第一篇SpringBoot指南,主要是讲一下如何构建我们的第一个SpringBoot项目;其中还将SpringBoot为我们做了什么事情、如何启动Web应用、启动运行了什么Bean及单元测试都简单写了一下。

为什么要写这个系列呢?主要还是在于分享和提高自己,将英文文档翻译或者自己的理解分享给更多需要的人。

扫描下面二维码,关注我的公众号哦!!!


关注我的公众号
上一篇下一篇

猜你喜欢

热点阅读