每日一课 | Spring Boot 项目入门实例

爱被打了一巴掌 2022-10-09 04:54 189阅读 0赞

![7b07791e81c200dc2c3f38b13548efcf.png][]

**01.**

Spring Boot入门

大家好，我是营长，上期分享的**《SQL从入门到精通》**专栏七天打卡结束了，如果忘记的小伙伴可以进入公号查看往期文章哦~

本期营长邀请的是李熠老师（某大型互联网公司系统架构师）为我们分享《Spring Cloud快速入门》专栏。

**Spring Cloud优缺点**

**优点：**

*  集大成者，Spring Cloud 包含了微服务架构的方方面面。
 *  约定优于配置，基于注解，没有配置文件。
 *  轻量级组件，Spring Cloud 整合的组件大多比较轻量级，且都是各自领域的佼佼者。
 *  开发简便，Spring Cloud 对各个组件进行了大量的封装，从而简化了开发。
 *  开发灵活，Spring Cloud 的组件都是解耦的，开发人员可以灵活按需选择组件。

**缺点：**

*  项目结构复杂，每一个组件或者每一个服务都需要创建一个项目。
 *  部署门槛高，项目部署需要配合 Docker 等容器技术进行集群部署，而要想深入了解 Docker，学习成本高。

Spring Cloud 的优势是显而易见的。因此对于想研究微服务架构的同学来说，学习 Spring Cloud 是一个不错的选择。

**Spring  Cloud**

**Spring Boot项目**

Spring Cloud 基于 Spring Boot，因此在研究 Spring Cloud 之前，本课程会首先介绍 Spring Boot 的用法，方便后续 Spring Cloud 的学习。

### ** Spring Boot 项目** ###

大多数教程都是以 Hello World 入门，本教程也不例外，接下来，我们就来搭建一个最简单的 Spring Boot 项目。

**1.创建一个 Maven 工程，请看下图：**

![1c35708a7a9654b329726d991461f5d6.png][]

**2.在 pom.xml 加入 Spring Boot 依赖：**

<parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.3.RELEASE</version>
    </parent>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
    </dependencies>

**3.创建应用程序启动类 DemoApplication，并编写以下代码：**

import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    @SpringBootApplication
    public class DemoApplication {
    
        public static void main(String[] args) {
            SpringApplication.run(DemoApplication.class, args);
        }
    }

**4.创建一个 Controller 类 HelloController，用以测试我们的第一个基于 Spring Boot 的 Web 应用：**

import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    @RestController
    public class HelloController {
    
        @RequestMapping("hello")
        String hello() {
            return "Hello World!";
        }
    
    }

**5.运行 DemoApplication 类中的 main 方法，看到下图所示内容说明应用启动成功：**

![fc80d276256b366b2902940e5f66f053.png][]

**6.浏览器访问：http://localhost:8080/hello，则会看到下图所示界面：**

![f560d29590c89f08f2c9083de43dd614.png][]

我们可以注意到，没有写任何的配置文件，更没有显示使用任何容器，只需要启动 Main 方法即可开启 Web 服务，从而访问到 HelloController 类里定义的路由地址。

这就是 Spring Boot 的强大之处，它默认集成了 Tomcat 容器，通过 Main 方法编写的 SpringApplication.run 方法即可启动内置 Tomcat。

它是如何启动的，内部又是如何运行的呢？具体原理我将在《第03课：Spring Boot 启动原理》一节中具体分析。

在上面的示例中，我们没有定义应用程序启动端口，可以看到控制台，它开启了 8080 端口，这是 Spring Boot 默认的启动端口。Spring Boot 提供了默认的配置，我们也可以改变这些配置，具体方法将在后面介绍。

我们在启动类里加入 @SpringBootApplication 注解，则这个类就是整个应用程序的启动类。如果不加这个注解，启动程序将会报错，读者可以尝试一下。

Spring Boot 还有一个特点是利用注解代码繁琐的 XML 配置，整个应用程序只有一个入口配置文件，那就是 application.yml 或 application.properties。接下来，我将介绍其配置文件的用法。

### **properties 和 yaml** ###

在前面的示例代码中，我们并没有看到该配置文件，那是因为 Spring Boot 对每个配置项都有默认值。当然，我们也可以添加配置文件，用以覆盖其默认值，这里以 .properties 文件为例，首先在 resources 下新建一个名为 application.properties（注意：文件名必须是 application）的文件，键入内容为：

server.port=8081
    server.servlet.context-path=/api

并且启动 Main 方法，这时程序请求地址则变成了：http://localhost:8081/api/hello。

Spring Boot 支持 properties 和 yaml 两种格式的文件，文件名分别对应 application.properties 和 application.yml，下面贴出 yaml 文件格式供大家参考：

server:
      port: 8080
      servlet:
        context-path: /api

可以看出 properties 是以逗号隔开，而 yaml 则换行+ 两个空格 隔开，这里需要注意的是冒号后面必须空格，否则会报错。yaml 文件格式更清晰，更易读，这里作者建议大家都采用 yaml 文件来配置。

以上示例只是小试牛刀，更多的配置将在后面的课程中讲解。

本教程的所有配置均采用 yaml 文件。

### **打包、运行** ###

Spring Boot 打包分为 war 和 jar 两个格式，下面将分别演示如何构建这两种格式的启动包。

在 pom.xml 加入如下配置：

<packaging>war</packaging>
    <build>
        <finalName>api</finalName>
        <resources>
            <resource>
                <directory>src/main/resources</directory>
                <filtering>true</filtering>
            </resource>
        </resources>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
            <plugin>
                <artifactId>maven-resources-plugin</artifactId>
                <version>2.5</version>
                <configuration>
                    <encoding>UTF-8</encoding>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-surefire-plugin</artifactId>
                <version>2.18.1</version>
                <configuration>
                    <skipTests>true</skipTests>
                </configuration>
            </plugin>
        </plugins>
    </build>

这个时候运行 mvn package 就会生成 war 包，然后放到 Tomcat 当中就能启动，但是我们单纯这样配置在 Tomcat 是不能成功运行的，会报错，需要通过编码指定 Tomcat 容器启动，修改 DemoApplication 类：

import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.boot.builder.SpringApplicationBuilder;
    import org.springframework.boot.web.servlet.support.SpringBootServletInitializer;
    
    @SpringBootApplication
    public class DemoApplication extends SpringBootServletInitializer {
    
        public static void main(String[] args) {
            SpringApplication.run(DemoApplication.class, args);
        }
    
        @Override
        protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {
            return application.sources(DemoApplication.class);
        }
    }

这时再打包放到 Tomcat，启动就不会报错了。

在上述代码中，DemoApplication 类继承了 SpringBootServletInitializer，并重写 configure 方法，目的是告诉外部 Tomcat，启动时执行该方法，然后在该方法体内指定应用程序入口为 DemoApplication 类，如果通过外部 Tomcat 启动 Spring Boot 应用，则其配置文件设置的端口和 contextPath 是无效的。这时，应用程序的启动端口即是 Tomcat 的启动端口，contextPath 和 war 包的文件名相同。

接下来我们继续看如果打成 jar 包，在 pom.xml 加入如下配置：

<packaging>jar</packaging>
    <build>
        <finalName>api</finalName>
        <resources>
            <resource>
                <directory>src/main/resources</directory>
                <filtering>true</filtering>
            </resource>
        </resources>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <fork>true</fork>
                    
                    <mainClass>com.lynn.DemoApplication</mainClass>
                </configuration>
                <executions>
                    <execution>
                        <goals>
                            <goal>repackage</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
            <plugin>
                <artifactId>maven-resources-plugin</artifactId>
                <version>2.5</version>
                <configuration>
                    <encoding>UTF-8</encoding>
                    <useDefaultDelimiters>true</useDefaultDelimiters>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-surefire-plugin</artifactId>
                <version>2.18.1</version>
                <configuration>
                    <skipTests>true</skipTests>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>2.3.2</version>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                </configuration>
            </plugin>
        </plugins>
    </build>

然后通过 mvn package 打包，最后通过 java 命令启动：

java -jar api.jar

如果是 Linux 服务器，上述命令是前台进程，点击 Ctrl+C 进程就会停止，可以考虑用 nohup 命令开启守护进程，这样应用程序才不会自动停止。

这样，最简单的 Spring Boot 就完成了，但是对于一个大型项目，这是远远不够的，Spring Boot 的详细操作可以参照官网。

下面展示一个最基础的企业级 Spring Boot 项目的结构：

![b701e9a7a1864890fd9382f56413605c.png][]

其中，Application.java 是程序的启动类，Startup.java 是程序启动完成前执行的类，WebConfig.java 是配置类，所有 Bean 注入、配置、拦截器注入等都放在这个类里面。

以上实例只是最简单的 Spring Boot 项目入门实例，后面会深入研究 Spring Boot。

今日内容有get吗，欢迎各位留言讨论！

**下期预告：Spring Boot 搭建复杂的系统框架-01**

以上专栏均来自CSDN GitChat专栏**《Spring Cloud快速入门》，**作者**李熠**，专栏详情可识别下方二维码查看哦！

**了解更多详情**

**可识别下方二维码**

![fc5be4aa6b7b2e9dd519fb10d8217e91.png][]

[7b07791e81c200dc2c3f38b13548efcf.png]: /images/20221005/95bf45886d9240e6868bf1c909d91016.png
[1c35708a7a9654b329726d991461f5d6.png]: /images/20221005/5d1145962c0d418ba8838e20cc4612db.png
[fc80d276256b366b2902940e5f66f053.png]: /images/20221005/99014ed3d39548d7a034ba9bea590d8b.png
[f560d29590c89f08f2c9083de43dd614.png]: /images/20221005/ce593fbb250e4fe39ef912538c1d30f4.png
[b701e9a7a1864890fd9382f56413605c.png]: /images/20221005/8d81f129fe734c5a85c83c4ba69ac253.png
[fc5be4aa6b7b2e9dd519fb10d8217e91.png]: /images/20221005/30c5df8dcfab40f2ae39b5d905aed793.png