构建第一个 Spring Boot 工程

目录

• Spring Boot概述
  • 什么是Spring Boot
  • Spring Boot的核心特点
• Spring Boot项目搭建
  • pom.xml 依赖
  • 主函数入口
  • 编写我们的Controller
• 认识Spring Boot主配置文件
• 相关知识
  • Spring Boot的spring-boot-starter
• Java Config 自动配置

Spring Boot概述

什么是Spring Boot

随着动态语言的流行，java的开发显得格外笨重，繁多的配置文件编写，低下的开发效率，复杂的部署流程以及第三方技术集成难度大。

在上述环境下Spring Boot应运而生，Spring Boot设计的目的是用来简化Spring应用的搭建、开发、调试、部署等一系列问题，我们在使用Spring开发应用的时候能够明显感到配置的繁杂，Spring Boot充分利用了JavaConfig的配置模式以及"约定优于配置"的理念，能够极大的简化基于Spring MVC的Web应用和REST服务开发，更简单快捷地构建Spring应用。

Spring Boot的核心特点

• 可以以jar包的形式独立运行，运行一个SpringBoot项目只需要通过java -jar xx.jar来运行。
• 内置Servlet容器，Spring Boot可以选择Tomcat,Jetty,这样我们无需以war包的形式部署项目
• 简化Maven配置，Spring Boot提供了一系列的starter pom来简化Maven的依赖加载。
• Spring Boot会根据在类路径中的jar包，类，为jar包中的类自动配置bean.这样就极大的减少我们要使用的配置。
• Spring Boot提供了基于http,ssh，telnet对运行时的项目进行监控。
• 不借助于代码生成来实现，而是通过条件注解来实现。这也是Spring 4.x的新特性。不需要任何的xml配置就可以实现Spring的所有配置。　　

Spring Boot项目搭建

通过 Spring Boot创建新的Spring应用变得非常容易，只需要简单的几个步骤就可以创建出一个应用。

创建项目的时候使用Spring Initializr(IDEA)，创建完成的的项目结构如下

- src
    -main
        -java
            -package
                #启动类
                -SpringbootApplication    
        -resouces
            #存放静态资源如 js/css/images 等
            - statics
            #存放 html 模板文件
            - templates
            #主要的配置文件,SpringBoot启动时候会自动加载application.yml/application.properties        
            - application.yml
    #测试文件存放目录        
    -test
 # pom.xml文件是Maven构建的基础，里面包含了我们所依赖JAR和Plugin的信息
- pom.xml

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>

    <name>spring-boot-web</name>
    <description>Demo project for Spring Boot</description>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.1.RELEASE</version>
        <relativePath/>
    </parent>

    <groupId>com.winner</groupId>
    <artifactId>spring-boot-web</artifactId>
    <version>1.0</version>
    <packaging>jar</packaging>

    <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>
        <!--默认内嵌Tomcat容器，可以根据需要进行替换-->
        <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-devtools</artifactId>
            <optional>true</optional>
        </dependency>

    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <fork>true</fork>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

主函数入口

一个项目中切记不要出现多个main函数，否则在打包的时候spring-boot-maven-plugin将找不到主函数！

package com.winner;

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;

/**
 * 主函数启动类
 * @author winner_0715
 * @date 2018/11/28
 */
@SpringBootApplication
public class Application {

    public static void main(String[] args) {
        System.out.println(" springApplication run !");
        SpringApplication.run(Application.class, args);
    }

    @Bean
    public CommandLineRunner commandLineRunner(ApplicationContext ctx) {
        return args -> {
            System.out.println("SpringBoot默认为我们提供的Bean：");
            String[] beanNames = ctx.getBeanDefinitionNames();
            Arrays.sort(beanNames);
            Arrays.stream(beanNames).forEach(System.out::println);
        };
    }
}

编写我们的Controller

package com.winner.web;

import com.winner.domain.User;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author winner_0715
 * @description  HelloController
 * @date 2018/11/28
 */
@RestController
public class HelloController {

    @RequestMapping("/hello/string")
    public String helloString(){
        return "hello world";
    }

    /**
     * 因为使用了@RestController
     * 所以不需要加@ResponseBody注解
     * @RestController=@Controller+@ResponseBody
     * @return
     */
    @RequestMapping("/hello/model")
    public User helloModel(){
        return new User.Builder()
                .userName("name")
                .email("email")
                .build();
    }
}

直接运行启动类，或者可以通过"mvn spring-boot:run"在命令行启动该应用。会启动一个内嵌的 Tomcat 服务器运行在 8080 端口。访问http://localhost:8080可以看到页面上显示"Hello World!"。

此外，在 POM 文件添加插件。

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

在添加了插件后，当运行"mvn clean package"进行打包时，会打包成一个可以直接运行的jar包，使用"java -jar"命令就可以直接运行。

认识Spring Boot主配置文件

application.properties

从启动日志中可以发现，SpringBoot默认的端口是8080，如果端口被占用我们可以通过修改配置文件来解决！

Tomcat started on port(s): 8080 (http) with context path ''

修改默认的配置(还带提示的，很给力，配置了热部署的话修改配置文件就会重启生效)

# 修改默认的端口8080
server.port=8888
# 定义上下文路径
server.servlet.context-path=/spring-boot-web

看下此时控制台的输出

Tomcat started on port(s): 8888 (http) with context path '/spring-boot-web'

这样的话访问就需要带上项目名了！

相关知识

Spring Boot的spring-boot-starter

Spring Boot提供了很多"开箱即用"的依赖模块，这些模块都是按照spring-boot-starter-{xx}的方式命名的。下面列举一些常用的模块。

• spring-boot-starter-logging ：使用Spring Boot默认的日志框架logback。
• spring-boot-starter-log4j ：添加 log4j 的支持。
• spring-boot-starter-web ：支持 Web 应用开发，包含 Tomcat 和 spring-mvc。
• spring-boot-starter-tomcat ：使用 Spring Boot 默认的 Tomcat 作为应用服务器。
• spring-boot-starter-jetty ：使用 Jetty作为应用服务器。
• spring-boot-starter-test ：包含常用的测试所需的依赖，如 JUnit、Hamcrest、Mockito 和 spring-test 等。
• spring-boot-starter-aop ：包含 spring-aop 和 AspectJ 来支持面向切面编程（AOP）。
• spring-boot-starter-security ：包含 spring-security。
• spring-boot-starter-jdbc ：支持使用 JDBC 访问数据库。
• spring-boot-starter-redis ：支持使用 Redis。
• spring-boot-starter-data-mongodb ：包含 spring-data-mongodb 来支持 MongoDB。
• spring-boot-starter-data-jpa ：包含 spring-data-jpa、spring-orm 和 Hibernate 来支持 JPA。
• spring-boot-starter-amqp ：通过 spring-rabbit 支持 AMQP。
• spring-boot-starter-actuator ： 添加适用于生产环境的功能，如性能指标和监测等功能。

Java Config 自动配置

Spring Boot推荐采用基于Java Config(也就是注解)的配置方式，而不是传统的XML。例如，@Configuration、@Bean、@EnableAutoConfiguration、@CompomentScan、@PropertySource、@Repository、@Service、@RestController等。

• Spring Boot概述
  • 什么是Spring Boot
  • Spring Boot的核心特点
• Spring Boot项目搭建
  • pom.xml 依赖
  • 主函数入口
  • 编写我们的Controller
• 认识Spring Boot主配置文件
• 相关知识
  • Spring Boot的spring-boot-starter
• Java Config 自动配置

Spring Boot概述

什么是Spring Boot

随着动态语言的流行，java的开发显得格外笨重，繁多的配置文件编写，低下的开发效率，复杂的部署流程以及第三方技术集成难度大。

在上述环境下Spring Boot应运而生，Spring Boot设计的目的是用来简化Spring应用的搭建、开发、调试、部署等一系列问题，我们在使用Spring开发应用的时候能够明显感到配置的繁杂，Spring Boot充分利用了JavaConfig的配置模式以及"约定优于配置"的理念，能够极大的简化基于Spring MVC的Web应用和REST服务开发，更简单快捷地构建Spring应用。

Spring Boot的核心特点

• 可以以jar包的形式独立运行，运行一个SpringBoot项目只需要通过java -jar xx.jar来运行。
• 内置Servlet容器，Spring Boot可以选择Tomcat,Jetty,这样我们无需以war包的形式部署项目
• 简化Maven配置，Spring Boot提供了一系列的starter pom来简化Maven的依赖加载。
• Spring Boot会根据在类路径中的jar包，类，为jar包中的类自动配置bean.这样就极大的减少我们要使用的配置。
• Spring Boot提供了基于http,ssh，telnet对运行时的项目进行监控。
• 不借助于代码生成来实现，而是通过条件注解来实现。这也是Spring 4.x的新特性。不需要任何的xml配置就可以实现Spring的所有配置。　　

Spring Boot项目搭建

通过 Spring Boot创建新的Spring应用变得非常容易，只需要简单的几个步骤就可以创建出一个应用。

创建项目的时候使用Spring Initializr(IDEA)，创建完成的的项目结构如下

- src
    -main
        -java
            -package
                #启动类
                -SpringbootApplication    
        -resouces
            #存放静态资源如 js/css/images 等
            - statics
            #存放 html 模板文件
            - templates
            #主要的配置文件,SpringBoot启动时候会自动加载application.yml/application.properties        
            - application.yml
    #测试文件存放目录        
    -test
 # pom.xml文件是Maven构建的基础，里面包含了我们所依赖JAR和Plugin的信息
- pom.xml

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>

    <name>spring-boot-web</name>
    <description>Demo project for Spring Boot</description>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.1.RELEASE</version>
        <relativePath/>
    </parent>

    <groupId>com.winner</groupId>
    <artifactId>spring-boot-web</artifactId>
    <version>1.0</version>
    <packaging>jar</packaging>

    <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>
        <!--默认内嵌Tomcat容器，可以根据需要进行替换-->
        <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-devtools</artifactId>
            <optional>true</optional>
        </dependency>

    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <fork>true</fork>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

主函数入口

一个项目中切记不要出现多个main函数，否则在打包的时候spring-boot-maven-plugin将找不到主函数！

package com.winner;

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;

/**
 * 主函数启动类
 * @author winner_0715
 * @date 2018/11/28
 */
@SpringBootApplication
public class Application {

    public static void main(String[] args) {
        System.out.println(" springApplication run !");
        SpringApplication.run(Application.class, args);
    }

    @Bean
    public CommandLineRunner commandLineRunner(ApplicationContext ctx) {
        return args -> {
            System.out.println("SpringBoot默认为我们提供的Bean：");
            String[] beanNames = ctx.getBeanDefinitionNames();
            Arrays.sort(beanNames);
            Arrays.stream(beanNames).forEach(System.out::println);
        };
    }
}

编写我们的Controller

package com.winner.web;

import com.winner.domain.User;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author winner_0715
 * @description  HelloController
 * @date 2018/11/28
 */
@RestController
public class HelloController {

    @RequestMapping("/hello/string")
    public String helloString(){
        return "hello world";
    }

    /**
     * 因为使用了@RestController
     * 所以不需要加@ResponseBody注解
     * @RestController=@Controller+@ResponseBody
     * @return
     */
    @RequestMapping("/hello/model")
    public User helloModel(){
        return new User.Builder()
                .userName("name")
                .email("email")
                .build();
    }
}

直接运行启动类，或者可以通过"mvn spring-boot:run"在命令行启动该应用。会启动一个内嵌的 Tomcat 服务器运行在 8080 端口。访问http://localhost:8080可以看到页面上显示"Hello World!"。

此外，在 POM 文件添加插件。

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

在添加了插件后，当运行"mvn clean package"进行打包时，会打包成一个可以直接运行的jar包，使用"java -jar"命令就可以直接运行。

认识Spring Boot主配置文件

application.properties

从启动日志中可以发现，SpringBoot默认的端口是8080，如果端口被占用我们可以通过修改配置文件来解决！

Tomcat started on port(s): 8080 (http) with context path ''

修改默认的配置(还带提示的，很给力，配置了热部署的话修改配置文件就会重启生效)

# 修改默认的端口8080
server.port=8888
# 定义上下文路径
server.servlet.context-path=/spring-boot-web

看下此时控制台的输出

Tomcat started on port(s): 8888 (http) with context path '/spring-boot-web'

这样的话访问就需要带上项目名了！

相关知识

Spring Boot的spring-boot-starter

Spring Boot提供了很多"开箱即用"的依赖模块，这些模块都是按照spring-boot-starter-{xx}的方式命名的。下面列举一些常用的模块。

• spring-boot-starter-logging ：使用Spring Boot默认的日志框架logback。
• spring-boot-starter-log4j ：添加 log4j 的支持。
• spring-boot-starter-web ：支持 Web 应用开发，包含 Tomcat 和 spring-mvc。
• spring-boot-starter-tomcat ：使用 Spring Boot 默认的 Tomcat 作为应用服务器。
• spring-boot-starter-jetty ：使用 Jetty作为应用服务器。
• spring-boot-starter-test ：包含常用的测试所需的依赖，如 JUnit、Hamcrest、Mockito 和 spring-test 等。
• spring-boot-starter-aop ：包含 spring-aop 和 AspectJ 来支持面向切面编程（AOP）。
• spring-boot-starter-security ：包含 spring-security。
• spring-boot-starter-jdbc ：支持使用 JDBC 访问数据库。
• spring-boot-starter-redis ：支持使用 Redis。
• spring-boot-starter-data-mongodb ：包含 spring-data-mongodb 来支持 MongoDB。
• spring-boot-starter-data-jpa ：包含 spring-data-jpa、spring-orm 和 Hibernate 来支持 JPA。
• spring-boot-starter-amqp ：通过 spring-rabbit 支持 AMQP。
• spring-boot-starter-actuator ： 添加适用于生产环境的功能，如性能指标和监测等功能。

Java Config 自动配置

Spring Boot推荐采用基于Java Config(也就是注解)的配置方式，而不是传统的XML。例如，@Configuration、@Bean、@EnableAutoConfiguration、@CompomentScan、@PropertySource、@Repository、@Service、@RestController等。