spring-boot入门篇

使用Spring Boot构建应用程序

本指南提供了Spring Boot如何帮助您加速和促进应用程序开发的示例。当您阅读更多Spring入门指南时,您将看到更多用于Spring Boot的用例。它旨在让您快速了解Spring Boot。如果您想创建自己的基于Spring Boot的项目,请访问Spring Initializr,填写项目详细信息,选择您的选项,然后您可以下载Maven构建文件或捆绑项目作为zip文件。

你要创建什么

您将使用Spring Boot构建一个简单的Web应用程序,并为其添加一些有用的服务。

你需要做什么

  • 大约15分钟
  • 最喜欢的文本编辑器或IDE
  • JDK 1.8或更高版本
  • Maven 3.2+
  • 您还可以将代码直接导入IDE:
    • 弹簧工具套件(STS)
    • IntelliJ IDEA

如何完成本指南

与大多数Spring 入门指南一样,您可以从头开始并完成每个步骤,或者您可以绕过您已熟悉的基本设置步骤。无论哪种方式,您最终都会使用工作代码。

从头开始,请继续使用Gradle构建。

跳过基础知识,请执行以下操作:

  • 下载并解压缩本指南的源存储库,或使用Git克隆它:git clone [https://github.com/spring-guides/gs-spring-boot.git](https://github.com/spring-guides/gs-spring-boot.git)

  • 进入 gs-spring-boot/initial

  • 跳到[初始]。

完成后,您可以根据代码检查结果gs-spring-boot/complete

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

Spring Boot提供了一种快速构建应用程序的方法。它会查看您的类路径以及您配置的bean,对您缺少的内容做出合理的假设,然后添加它。使用Spring Boot,您可以更专注于业务功能而不是基础架构。

例如:

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

  • 有码头?如果是这样,你可能不想要Tomcat,而是嵌入Jetty。Spring Boot为您处理。

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

这些只是Spring Boot提供的自动配置的几个示例。与此同时,Spring Boot不会妨碍你。例如,如果Thymeleaf在您的路径上,Spring Boot会SpringTemplateEngine自动为您的应用程序上下文添加一个。但是如果您SpringTemplateEngine使用自己的设置定义自己的设置,那么Spring Boot将不会添加一个。这样您就可以轻松掌控自己。

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

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

现在,您可以为简单的Web应用程序创建Web控制器。
src/main/java/hello/HelloController.java

package 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!";
    }
}

该类被标记为a @RestController,这意味着Spring MVC可以使用它来处理Web请求。@RequestMapping映射/index()方法。从浏览器调用或在命令行上使用curl时,该方法返回纯文本。这是因为@RestController组合@Controller@ResponseBody两个注释会导致Web请求返回数据而不是视图。

创建一个Application类

在这里,您创建一个Application包含组件的类:
src/main/java/hello/Application.java

package hello;

import java.util.Arrays;
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;

@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。

  • 通常你会添加@EnableWebMvc一个Spring MVC应用程序,但Spring Boot会在类路径上看到spring-webmvc时自动添加它。这会将应用程序标记为Web应用程序并激活关键行为,例如设置a DispatcherServlet

  • @ComponentScan告诉Spring在包中寻找其他组件,配置和服务hello,允许它找到控制器。

main()方法使用Spring Boot的SpringApplication.run()方法启动应用程序。您是否注意到没有一行XML?也没有web.xml文件。此Web应用程序是100%纯Java,您无需处理配置任何管道或基础结构。

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

运行该应用程序

要运行该应用程序,请执行:

./gradlew build && java -jar build / libs / gs-spring-boot-0.1.0.jar

如果您使用的是Maven,请执行:

mvn package && java -jar target / gs-spring-boot-0.1.0.jar

你应该看到这样的输出:

让我们检查一下Spring Boot提供的bean:
应用
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
来自Spring Boot的问候!

添加单元测试

您将需要为添加的端点添加测试,Spring Test已经为此提供了一些机制,并且很容易包含在您的项目中。

将其添加到构建文件的依赖项列表中:

    testCompile("org.springframework.boot:spring-boot-starter-test")

如果您使用的是Maven,请将其添加到依赖项列表中:

        
            org.springframework.boot
            spring-boot-starter-test
            test
        

现在编写一个简单的单元测试,通过端点模拟servlet请求和响应:
src/test/java/hello/HelloControllerTest.java

package hello;

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;

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;

@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来自弹簧试验,并允许您通过一组方便的建设者班,发送HTTP请求到DispatcherServlet并作出断言关于结果。注意@AutoConfigureMockMvc@SpringBootTest注入MockMvc实例一起使用。使用后,@SpringBootTest我们要求创建整个应用程序上下文。另一种方法是让Spring Boot使用@WebMvcTest。仅创建上下文的Web层。在任何一种情况下,Spring Boot都会自动尝试查找应用程序的主应用程序类,但是如果要构建不同的东西,可以覆盖它,或缩小范围。

除了模拟HTTP请求周期之外,我们还可以使用Spring Boot编写一个非常简单的全栈集成测试。例如,我们可以这样做,而不是(或以及)上面的模拟测试:

src/test/java/hello/HelloControllerIT.java

package hello;

import static org.hamcrest.Matchers.*;
import static org.junit.Assert.*;
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.test.context.SpringBootTest;
import org.springframework.boot.test.web.client.TestRestTemplate;
import org.springframework.boot.web.server.LocalServerPort;
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 response = template.getForEntity(base.toString(),
                String.class);
        assertThat(response.getBody(), equalTo("Greetings from Spring Boot!"));
    }
}

嵌入式服务器由随机端口启动,webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT并且在运行时发现实际端口@LocalServerPort

添加生产级服务

如果要为您的企业构建网站,则可能需要添加一些管理服务。Spring Boot提供了几个开箱即用的执行器模块,例如健康,审核,豆类等。

将其添加到构建文件的依赖项列表中:

    compile("org.springframework.boot:spring-boot-starter-actuator")

如果您使用的是Maven,请将其添加到依赖项列表中:

        
            org.springframework.boot
            spring-boot-starter-actuator
        

然后重启应用:

./gradlew build && java -jar build / libs / gs-spring-boot-0.1.0.jar

如果您使用的是Maven,请执行:

mvn package && java -jar target / gs-spring-boot-0.1.0.jar

您将看到一组新的RESTful端点添加到应用程序中。这些是Spring Boot提供的管理服务。

2018-03-17 15:42:20.088 ...:将“{[/ error],produce = [text / html]}”映射到公共组织...
2018-03-17 15:42:20.089 ...:将“{[/ error]}”映射到公共org.springframework.http.R ...
2018-03-17 15:42:20.121 ...:将URL路径[/ webjars / **]映射到[class]类型的处理程序上
2018-03-17 15:42:20.121 ...:将URL路径[/ **]映射到[class org.spri ...类型的处理程序上
2018-03-17 15:42:20.157 ...:将URL路径[/**/favicon.ico]映射到[cl ...类型的处理程序]
2018-03-17 15:42:20.488 ...:映射“{[/ actuator / health],methods = [GET],产生= [application / vnd ...
2018-03-17 15:42:20.490 ...:映射“{[/ actuator / info],methods=[GET],produces=[application/vnd.s ...
2018-03-17 15:42:20.491 ...:映射“{[/ actuator],methods = [GET],produces = [application / vnd.spring ...

它们包括:错误,执行器/健康,执行器/信息,执行器。

还有一个/actuator/shutdown端点,但它只能通过JMX默认显示。要将其作为HTTP端点启用,请添加management.endpoints.shutdown.enabled=true到您的application.properties文件中。 |

检查应用程序的运行状况很容易。

$ curl localhost:8080 /执行器/健康
{ “地位”: “UP”}

您可以尝试通过curl调用shutdown。

$ curl -X POST localhost:8080 /执行器/关机
{“timestamp”:1401820343710,“error”:“Method Not Allowed”,“status”:405,“message”:“不支持请求方法'POST'”}

因为我们没有启用它,所以请求被不存在的优点所阻止。

有关每个REST点以及如何使用application.properties文件(in src/main/resources)调整其设置的更多详细信息,您可以阅读有关端点的详细文档。

查看Spring Boot的初学者

你已经看到了一些Spring Boot的“初学者”。您可以在源代码中看到它们。

JAR支持和Groovy支持

最后一个示例显示了Spring Boot如何轻松地连接您可能不知道您需要的bean。它展示了如何开启便捷的管理服务。

但Spring Boot确实做得更多。它不仅支持传统的WAR文件部署,而且还可以通过Spring Boot的加载器模块轻松地将可执行JAR组合在一起。各种指南通过spring-boot-gradle-plugin和展示了这种双重支持spring-boot-maven-plugin

最重要的是,Spring Boot还支持Groovy,允许您使用一个文件构建Spring MVC Web应用程序。

创建一个名为app.groovy的新文件,并在其中添加以下代码:

@RestController
class ThisWillActuallyRun {

    @RequestMapping("/")
    String home() {
        return "Hello World!"
    }

}

文件的位置无关紧要。你甚至可以在一条推文中使用一个小的应用程序! |

接下来,安装Spring Boot的CLI。

运行如下:

$ spring run app.groovy

| | 这假设您关闭以前的应用程序,以避免端口冲突。 |

从不同的终端窗口:

$ curl localhost:8080
你好,世界!

Spring Boot通过动态地向代码添加关键注释并使用Groovy Grape来下载使应用程序运行所需的库来实现此目的。

摘要

恭喜!您使用Spring Boot构建了一个简单的Web应用程序,并了解它如何提高您的开发速度。您还开启了一些方便的生产服务。这只是Spring Boot可以做的一小部分。如果您想深入挖掘,请查看Spring Boot的在线文档。

也可以看看

以下指南也可能有所帮助:

  • 保护Web应用程序

  • 使用Spring MVC提供Web内容

想要撰写新指南或为现有指南做出贡献?查看我们的贡献指南。

你可能感兴趣的:(spring-boot入门篇)