Spring Boot 学习笔记1---初体验之3分钟启动你的Web应用

2022-10-27 17:30:39

前言

早在去年就简单的使用了一下Spring Boot，当时就被其便捷的功能所震惊。但是那是也没有深入的研究，随着其在业界被应用的越来越广泛，因此决定好好地深入学习一下，将自己的学习心得在此记录，本文主要围绕以下几点进行说明：

Spring Boot 简介
使用Spring Boot快速搭建一个Web应用
如有不对的地方，请指正。

1. Spring Boot简介

Spring Boot是一个基于Spring的衍生框架，其主要的目的是帮助我们快速构建独立、生产级别的Spring的应用,其崇尚的理念是“约定优于配置”。
其主要有如下的特点:

创建一个单独的Spring应用
内置Web容器(默认使用Tomcat,如果你想换成Jetty只需简单修改配置即可)，以Java Application的方式就可以完成Web应用的启动。
提供了大量maven模版配置(通常被称为Starter POMs)，通过使用其提供的maven配置，它将我们日常开发所使用到的依赖都集成了，因此可以大大减少我们对于maven的pom文件的配置的工作量。
自动化地对Spring进行配置，它可以根据你当前classpath路径下的jar包来推断出你当前的运行环境，自动的帮助我们创建出一些应该用必须使用的对象，并且根据对应的环境以其对应的方式进行启动。
提供了生产环境下的一些特性：如指标统计、健康检查。
无需冗余的代码与XML配置。
提供了现成的maven插件，可以更加方便地使用maven进行打包。

2. Spring Boot初体验

在简单了解完Spring Boot之后，下面让我们快速地使用Spring Boot搭建一个Web应用，来快速地感受一下Spring Boot其强大的功能。

2.1 快速搭建一个Web应用

引入的maven依赖:

    <!--

          这里使用官方最新的版本，官方推荐建议继承默认的springboot配置

          继承后，项目的编译级别会自动变为jdk1.6版本。

    -->

    <parent>

        <groupId>org.springframework.boot</groupId>

        <artifactId>spring-boot-starter-parent</artifactId>

        <version>1.3.3.RELEASE</version>

    </parent>

    <!--

          添加一个web应用所需要的依赖,它会自动引入tomcat内置容器、log4j、jackson等通用的依赖

    -->

    <dependencies>

        <dependency>

            <groupId>org.springframework.boot</groupId>

            <artifactId>spring-boot-starter-web</artifactId>

        </dependency>

    </dependencies>

我们可以通过mvn dependency:tree来查看项目的依赖结构树

项目的依赖结构树

编写一个简单的Controller

package com.panlingxiao.springboot.web.controller;

import org.springframework.beans.factory.annotation.Value;

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

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

/**

 * RestController是Spring 4.0推出的新特性,

 * 使用其标注表示当前类为一个@Controller,并且

 * 使用@RequestMapping所标注的方法的返回值默认会被认为使用

 * 了@ResponseBody进行标注，因此不再使用视图解析的方式进行处理，

 * 而是将内容通过HTTP响应体返回给客户端。

 */

@RestController

public class HelloController {

    /**

     * spring boot会自动读取application.properties,

     * 并且将其作为系统参数进行注入,用户也可以在启动应用的时候

     * 通过-Dname=xxx来手动注入，手动注入会覆盖配置文件中的参数

         * 如果没有指定值，那么name的默认值就是World。

     */

    @Value("${name:World}")

    private String name;

    /**

     * 由于使用了@RestControlelr,因此无需在使用@ResponseBody来标注返回的结果

     */

    @RequestMapping("/hello")

    public String sayHello(){

        return String.format("hello:%s", name);

    }

}

编写Spring Boot的启动类

package com.panlingxiao.springboot.web;

import org.springframework.boot.SpringApplication;

import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication

public class WebApp{

    public static void main(String[] args) {

        SpringApplication.run(WebApp.class, args);

    }

}

至此，我们的Web应用已经搭建完毕，只需启动WebApp即可。启动应用之后，会输出如下的信息。

启动日志.png

在浏览器中请求所返回的结果如下：

响应结果.png

这个Hello World的例子虽然简单，但是我们应该能够看到Spring Boot的强大之处。我们无需再在web.xml中编写DispatcherServlet，无需再写对应的Spring配置文件，无需再去找对应的maven依赖等，这一切的一切只需几个简单的注解就搞定一切了。

2.2 在命令行下启动应用

我们除了可以通过在IDE中启动Spring Boot应用的启动，Spring Boot官方还提供了另外一个种方式，可以让我们在命令行下完成应用的启动。
通过输入mvn spring-boot run

命令行启动结果.png

2.3 创建一个可运行的jar

以上命令行的方式虽然可以完成了Web应用的启动，但是其启动依赖于maven。我们在部署应用到服务器的时候，通常不会在服务器上去单独的安装maven，而只是希望它能够以单独的一个JAR包的形式启动。在此之前，如果我们希望一个服务单独地打成一个JAR包来运行的经历，那么我需要通过在POM文件中引入大量的插件，比如资源文件拷贝、将项目依赖的JAR单独地创建一个目录、生成运行的主程序等等，这一系列操作都需要基于Maven的插件来完成。而现在，Spring Boot为我们提供了一个打包执行的JAR的插件，我们只需引入，然后使用mvn clean package就可以搞定一切了。
在原来的POM文件中加入如下内容:

<build>

        <plugins>

            <plugin>

         <!--

        Spring Boot提供的打包插件,会自动生成运行的类,  同时将项目依赖的JAR一起和JAR包绑定在一切输出。

         -->

                <groupId>org.springframework.boot</groupId>

                <artifactId>spring-boot-maven-plugin</artifactId>

            </plugin>

        </plugins>

    </build>

打包输出结果.png

MENIFEST结果.png

现在我们就可以通过java -jar xxx.jar来完成一个Web的启动。

以Java Application方式启动结果.png

2.4 简单理解Spring Boot的Hello World

上面的程序虽然简单，但是我们并没有分析为什么使用这么几行代码就可以一个Web应用的启动，如果不理解原因，个人感觉一切都是白搭，因为你只是知道如何做，而不是知道为什么这么做。下面就来简单的分析一下我们所编写的WebApp这个类为什么它就可以被完成一个Web应用的启动。

@SpringBootApplication

public class WebApp{

    public static void main(String[] args) {

        SpringApplication.run(WebApp.class, args);

    }

}

首先我们看到该类使用了@SpringBootApplication这个注解来进行标识。该注解其实又是由其他3个注解来标识,它们分别是@Configuration、@EnableAutoConfiguration、@ComponentScan。

SpringBootApplication源码.png

(1). @Configuration：其作用是标识当前类是一个Bean定义信息的来源，它可以被Spring的ApplicationContext进行加载处理；其作用等同于我们之前使用的xml文件，只是我们以前将Bean的定义配置在xml中，而现在是将Bean的定义全部基于代码写在了使用@Configuration所标识的这个类中。
下面我们通过一个例子更加清楚地说明@Configuration的作用。

public class User {

    private String name;

    public String getName() {

        return name;

    }

    public void setName(String name) {

        this.name = name;

    }

}

通过@Configuration标识的类，可以完成对Bean信息的定义：

/**

 * 使用@Configuration标识

 * 在当前类中通过@Bean标注的方式

 * 之后都由Spring的AppplicationContext来进行调用

 * 从而生成Bean对象。

 */

@Configuration

public class AppConfig {

    @Bean

    public User getUser(){

        User user = new User();

        return user;

    }

}

public class App {

    public static void main(String[] args) {

        /*

         * 将@Configuraion所标识的类通过Spring的上下问进行加载,从而实现Bean的创建。

          */

        AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext();

        ctx.register(AppConfig.class);

        ctx.refresh();

        User user = ctx.getBean("user", User.class);

        String value = user.sayHello();

    }

}

通过上面的例子，我们应该可以看到@Configuration与xml几乎是一个等价的关系，其作用如出一辙，在我们上面的例子中，其实WebApp这个类可以不使用@Configuration来标准，也不会影响程序的正常启动。

(2). @EnableAutoConfiguration：该注解是让Spring根据当前classpath中所存在的类，自动推断出当前运行的环境(判断是否一个Web应用还是一个普通的Java应用)，然后根据具体的环境去创建对应的bean，将其添加的Spring的ApplicationContext中。比如:我们在classpath中添加了tomcat-embedded.jar，因此它会去自动帮助我们自动地创建一个EmbeddedServletContainerFactory。如果没有这个对象，那么我们的Tomcat是无法启动的。我们将WebApp改成如下结果:

//不再设置EnableAutoConfiguration会导致应用启动失败

@Configuration

@ComponentScan

public class WebApp {

    public static void main(String[] args) {

        SpringApplication.run(WebApp.class, args);

    }

}

缺少EnableAutoConfiguration启动结果.png

从上面的分析结果我们可以，@EnableAutoConfiguration对应配置Spring Boot应用非常重要，如果缺少这个注解，就非常可能由于缺少需要的Bean而导致应用的启动失败。

(3). @ComponentScan：该注解就是让Spring容器自动根据指定的包以及子包中进行组件的查找然后创建，如果没有指定具体到哪个包中进行查找，那么就以当前使用该注解的类所在的包作为查找的根，进行查找。即在WebApp这个类所在的包及其子包中进行查找。注意:这里我将HelloController定义在了WebApp所在的包的子包中，如果它们所在的包不具有上面所描述的查找关系，那么Controller是不会被创建的，即使应用可以启动，但是最终响应的结果将是404。

我们在main方法中使用了SpringApplication这个类完成了应用的启动，该类是一个Spring应用启动的引导工具类，它底层维护着Spring容器。由于篇幅有限，SpingApplication具体引导的过程不再这里细说，我会在后面的笔记中记录分析SpringApplication的具体如何完成Spring容器的创建、如何完成Web应用的启动。

2.5 补充

SpringBoot除了提供强大的功能外，官方还提供了非常人性化的支持，我们可以访问https://start.spring.io/ ，在该网站上根据我们应用的特点，自动其对应的生成spring boot的模版文件。

至此，Spring Boot的入门笔记就先写到这里，下一节会去分析SpringApplication这个神奇的东西，看看它到底是如何工作的。

码农公寓

前言