美文网首页
第二章 入门

第二章 入门

作者: 芥末味的冰淇淋 | 来源:发表于2020-04-02 01:21 被阅读0次

    全集

    如果您是从Spring Boot或“ Spring”开始的,请先阅读本节。 它回答基本的“what?”,“how?” 和“why?”的 问题。 它包括对Spring的介绍引导以及安装说明。 然后,我们将引导您完成第一个Spring Boot的构建应用程序,讨论我们遵守的一些核心原则。

    2.1 介绍Spring Boot

    Spring Boot使创建运行的独立,生产级的Spring应用变得更加容易。我们对Spring平台和第三方库持固执己见的观点,这样您就可以以最小的麻烦开始使用。 大多数Spring Boot应用程序只需要很少的Spring配置
    你可以使用Spring Boot创建可以使用Java -jar方式启动而不是传统war包部署的Java应用,我们同样提供一个命令行工具来运行“spring scripts”.
    我们的主要目标是:

    • 为所有Spring开发提供根本上更快且可广泛访问的入门经验
    • 开箱即用,但随着需求开始偏离默认值而迅速摆脱困境
    • 提供一系列大型项目通用的非功能性功能(例如嵌入式服务器,安全性,指标,运行状况检查和外部化配置)
    • 完全没有代码生成,也不需要XML配置

    2.2 系统要求

    Spring Boot 2.2.6.RELEASE要求Java8而且与Java13兼容,Spring Framework 5.2.5.RELEASE或以上也是必须的
    为以下构建工具提供了明确的构建支持:

    Build Tool Version
    Maven 3.3+
    Gradle 5.x and 6.x(4.10 is also supported but in a deprecated form)

    2.2.1 Servlet容器

    Spring Boot支持以下嵌入式servlet容器:

    Name Servlet Version
    Tomcat 9.0 4.0
    Jetty 9.4 3.1
    Undertow 2.0 4.0

    你也可以部署Spring Boot应用到任何兼容Servlet 3.1+的容器

    2.3 初始化Spring Boot

    Spring Boot可以与“经典” Java开发工具一起使用,也可以作为命令行工具安装。 无论哪种方式,都需要Java SDK v1.8或更高版本。 在开始之前,您应该使用以下命令检查当前的Java安装:

    $ java -version

    如果您不熟悉Java开发,或者想尝试使用Spring Boot,则可能要先尝试使用Spring Boot CLI(命令行界面)。 否则,请继续阅读“经典”安装说明。

    2.3.1Java开发人员的安装说明

    你可以以使用其它任何Java标准库的方式来使用Spring Boot.为此,请在类路径中包含相应的spring-boot-*.jar文件。Spring Boot不要求任何特殊的工具集成,因此你可以使用任何IDE或文本编辑器。另外,Spring Boot应用程序没有什么特别之处,因此您可以像运行其他Java程序一样运行和调试Spring Boot应用程序。

    尽管你可以复制Spring Boot的jar包,我们通常建议您使用支持依赖管理的构建工具(例如Maven和Gradle)。

    Maven安装
    Spring Boot与Apache Maven 3.3或更高版本兼容。 如果尚未安装Maven,则可以按照maven.apache.org中的说明进行操作。

    在许多操作系统上,Maven可以与程序包管理器一起安装。 如果您使用OSX Homebrew,请尝试brew install maven。 Ubuntu用户可以运行sudo apt-get install maven。 具有Chocolatey的Windows用户可以从提升的(管理员)提示符下运行choco install maven。

    Spring Boot依赖使用org.springframework.boot的groupId。通常,您的Maven POM文件继承自spring-boot-starter-parent项目,并声明对一个或多个“Starter”的依赖关系。 Spring Boot还提供了一个可选的Maven插件来创建可执行jar。
    下面列出了一个经典的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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
    
        <groupId>com.example</groupId>
        <artifactId>myproject</artifactId>
        <version>0.0.1-SNAPSHOT</version>
    
        <!-- Inherit defaults from Spring Boot -->
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.2.6.RELEASE</version>
        </parent>
    
        <!-- Override inherited settings -->
        <description/>
        <developers>
            <developer/>
        </developers>
        <licenses>
            <license/>
        </licenses>
        <scm>
            <url/>
        </scm>
        <url/>
    
        <!-- Add typical dependencies for a web application -->
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
        </dependencies>
    
        <!-- Package as an executable jar -->
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
    
    </project>
    

    spring-boot-starter-parent是使用Spring Boot的一种好方法,但可能并非始终适合。 有时您可能需要从其他父POM继承,或者您可能不喜欢我们的默认设置。 在这些情况下,请参阅使用不带父POM的Spring Boot以获得使用导入范围的替代解决方案。

    Gradle安装
    Spring Boot与5.x和6.x兼容。 还支持4.10,但不支持该支持,在将来的版本中将删除该支持。 如果尚未安装Gradle,则可以按照gradle.org上的说明进行操作。

    可以使用org.springframework.boot组声明Spring Boot依赖项。 通常,您的项目声明对一个或多个“Starter”的依赖。 Spring Boot提供了一个有用的Gradle插件,可用于简化依赖项声明和创建可执行jar。

    Gradle包装器
    当您需要构建项目时,Gradle包装器提供了一种“获取” Gradle的好方法。 它是一个小的脚本和库,您随代码一起提交以引导构建过程。 有关详细信息,请参见docs.gradle.org/current/userguide/gradle_wrapper.html

    2.3.2 安装Spring BootCLI

    Spring Boot CLI(命令行界面)是一个命令行工具,可用于快速使用Spring进行原型设计。 它使您可以运行Groovy脚本,这意味着您具有类似Java的熟悉语法,而没有太多样板代码。

    您无需使用CLI即可与Spring Boot一起使用,但这绝对是使Spring应用程序启动的最快方法。

    手动安装
    您可以从Spring软件库下载Spring CLI发行版:

    也提供最先进的快照分发。

    下载后,请按照解压缩后的存档中的INSTALL.txt说明进行操作。总之,.zip文件的bin /目录中有一个spring脚本(对于Windows是spring.bat)。 或者,您可以将Java -jar与.jar文件一起使用(脚本可帮助您确保正确设置了类路径)。

    使用SDKMAN安装!
    SDKMAN!(软件开发套件管理器)可用于管理各种二进制SDK的多个版本,包括Groovy和Spring Boot CLI。 获取SDKMAN! 从sdkman.io并使用以下命令安装Spring Boot:

       $ sdk install springboot
       $ spring --version
       Spring Boot v2.2.6.RELEASE
    

    如果您为CLI开发功能并希望轻松访问所构建的版本,请使用以下命令:

      $ sdk install springboot dev /path/to/spring-boot/spring-boot-cli/target/spring-boot-cli-2.2.6.RELEASE- 
        bin/spring-2.2.6.RELEASE/
      $ sdk default springboot dev
      $ spring --version
      Spring CLI v2.2.6.RELEASE
    

    前面的指导安装一个称为dev的spring的本地实例。它指向您的目标构建位置,因此,每次重新构建Spring Boot时,spring都是最新的。

    您可以通过运行以下命令来查看它:

    $ sdk ls springboot
    
    ================================================================================
    Available Springboot Versions
    ================================================================================
    > + dev
    * 2.2.6.RELEASE
    
    ================================================================================
    + - local version
    * - installed
    > - currently in use
    ================================================================================
    

    OSX Homebrew安装
    如果您使用的是Mac,并且使用Homebrew,则可以使用以下命令安装Spring Boot CLI:

    $ brew tap pivotal/tap
    $ brew install springboot
    

    Homebrew将spring安装到/ usr / local / bin。

    如果看不到该程序,则说明brew的安装可能已过期。 在这种情况下,请运行brew更新,然后重试。

    MacPorts安装
    如果您使用的是Mac,并且使用MacPorts,则可以使用以下命令安装Spring Boot CLI:

    $ sudo port install spring-boot-cli
    

    命令行补全
    Spring Boot CLI包括为BASH和zsh Shell提供命令补全的脚本。 您可以在任何外壳中获取脚本(也称为spring),也可以将其放入个人或系统范围的bash完成初始化中。 在Debian系统上,系统级脚本位于/ shell-completion / bash中,并且在启动新的Shell时将执行该目录中的所有脚本。 例如,如果您是使用SDKMAN!安装的,则要手动运行脚本,请使用以下命令:

    $ . ~/.sdkman/candidates/springboot/current/shell-completion/bash/spring
    $ spring <HIT TAB HERE>
      grab  help  jar  run  test  version
    

    如果使用Homebrew或MacPorts安装Spring Boot CLI,则命令行完成脚本会自动注册到您的Shell中。

    Windows Scoop Installation
    如果您在Windows上并使用Scoop,则可以使用以下命令安装Spring Boot CLI:

    > scoop bucket add extras
    > scoop install springboot
    

    Scoop将spring安装到~/ scoop / apps / spring boot / current / bin。

    如果您没有看到应用清单,则可能是因为安装的Scoop已过期。 在这种情况下,请运行scoop update,然后重试

    快速入门Spring CLI示例
    您可以使用以下Web应用程序来测试安装。 首先,创建一个名为app.groovy的文件,如下所示:

    @RestController
    class ThisWillActuallyRun {
    
        @RequestMapping("/")
        String home() {
            "Hello World!"
        }
    
    }
    

    然后从Shell运行它,如下所示:

    $ spring run app.groovy
    

    由于依赖项正在下载,因此您的应用程序的第一次运行很慢。 随后的运行要快得多。

    在您喜欢的Web浏览器中打开localhost:8080。 您应该看到以下输出:

    Hello World!
    

    2.3.3从较早版本的Spring Boot升级

    如果要从Spring Boot的1.x版本升级,请查看项目Wiki上的“迁移指南”,其中提供了详细的升级说明。 还请检查“发行说明”以获取每个发行版的“新功能和值得注意的功能”列表。

    升级到新功能版本时,某些属性可能已被重命名或删除。 Spring Boot提供了一种在启动时分析应用程序环境并打印诊断的方法,还可以在运行时为您临时迁移属性。 要启用该功能,请将以下依赖项添加到您的项目中:

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-properties-migrator</artifactId>
        <scope>runtime</scope>
    </dependency>
    

    较晚添加到环境的属性(例如使用@PropertySource时)将不被考虑。

    迁移完成后,请确保从项目的依赖项中删除此模块。

    要升级现有的CLI安装,请使用适当的程序包管理器命令(例如,brew upgrade)。 如果您手动安装了CLI,请遵循标准说明,并记住要更新PATH环境变量以删除所有较旧的引用。

    2.4 开发你的第一个Spring Boot应用

    本节介绍如何开发一个简单的" Hello World!" Web应用程序,突出显示了Spring Boot的一些关键功能。 我们使用Maven来构建该项目,因为大多数IDE都支持它。

    spring.io网站包含许多使用Spring Boot的“入门”指南。 如果您需要解决特定问题,请首先查看这里。
    通过转到start.spring.io并从依赖项搜索器中选择“ Web”Starter,可以简化以下步骤。 这样做会生成一个新的项目结构,以便您可以立即开始编码。 查看Spring Initializr文档以获取更多详细信息。

    在开始之前,请打开终端并运行以下命令,以确保安装了有效的Java和Maven版本:

    $ java -version
    java version "1.8.0_102"
    Java(TM) SE Runtime Environment (build 1.8.0_102-b14)
    Java HotSpot(TM) 64-Bit Server VM (build 25.102-b14, mixed mode)
    
    $ mvn -v
    Apache Maven 3.5.4 (1edded0938998edf8bf061f1ceb3cfdeccf443fe; 2018-06-17T14:33:14-04:00)
    Maven home: /usr/local/Cellar/maven/3.3.9/libexec
    Java version: 1.8.0_102, vendor: Oracle Corporation
    

    该示例需要在其自己的文件夹中创建。 随后的说明假定您已经创建了一个合适的文件夹,并且它是当前目录。

    2.4.1 创建POM文件

    我们需要先创建一个Maven 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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
    
        <groupId>com.example</groupId>
        <artifactId>myproject</artifactId>
        <version>0.0.1-SNAPSHOT</version>
    
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.2.6.RELEASE</version>
        </parent>
    
        <description/>
        <developers>
            <developer/>
        </developers>
        <licenses>
            <license/>
        </licenses>
        <scm>
            <url/>
        </scm>
        <url/>
    
        <!-- Additional lines to be added here... -->
    
    </project>
    

    上面的清单应为您提供有效的构建。 您可以通过运行mvn软件包进行测试(目前,您可以忽略“ jar将为空-没有内容被标记为包含!”警告)。

    此时,您可以将项目导入到IDE中(大多数现代Java IDE都包含对Maven的内置支持)。 为简单起见,在此示例中,我们继续使用纯文本编辑器。

    2.4.2 添加类路径依赖

    Spring Boot提供了许多“Starter”,使您可以将jar添加到类路径中。 我们的烟雾测试应用程序在POM的父部分中使用spring-boot-starter-parent。 spring-boot-starter-parent是一个特殊的Starter,提供有用的Maven默认值。 它还提供了一个依赖关系管理部分,以便您可以省略“继承”依赖关系的版本标签。

    其他“Starter”提供了开发特定类型的应用程序时可能需要的依赖项。 由于我们正在开发Web应用程序,因此我们添加了spring-boot-starter-web依赖项。 在此之前,我们可以通过运行以下命令来查看当前的状态:

    $ mvn dependency:tree
    
    [INFO] com.example:myproject:jar:0.0.1-SNAPSHOT
    

    mvndependency:tree命令显示项目依赖关系的树形表示。 您可以看到spring-boot-starter-parent本身不提供任何依赖关系。 要添加必要的依赖关系,请编辑pom.xml并在父部分的正下方添加spring-boot-starter-web依赖关系:

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
    </dependencies>
    

    如果再次运行mvndependency:tree,则会看到现在还有许多其他的依赖项,包括Tomcat Web服务器和Spring Boot本身。

    2.4.3 编写代码

    要完成我们的应用程序,我们需要创建一个Java文件。 默认情况下,Maven从src/main/java编译源代码,因此您需要创建该文件夹结构,然后添加一个名为src/main/java/Example.java的文件以包含以下代码:

    import org.springframework.boot.*;
    import org.springframework.boot.autoconfigure.*;
    import org.springframework.web.bind.annotation.*;
    
    @RestController
    @EnableAutoConfiguration
    public class Example {
    
        @RequestMapping("/")
        String home() {
            return "Hello World!";
        }
    
        public static void main(String[] args) {
            SpringApplication.run(Example.class, args);
        }
    
    }
    

    尽管这里没有太多代码,但正在进行很多工作。 我们将在接下来的几节中逐步介绍重要部分。

    @RestController和@RequestMapping注解

    在我们的示例类中第一个注解是@RestController,它被成为策略注解。它为阅读代码的人和Spring提供了提示,提示该类起特定的作用。 在这种情况下,我们的类是一个Web @Controller,因此Spring在处理传入的Web请求时会考虑使用它。

    @RequestMapping注解提供了路由解析,它告诉Spring任何“/”路径的Http请求应该被映射到home方法。@RestController注解告诉Spring直接将结果字符串呈现到调用方。

    @RestController和@RequestMapping是Spring MVC的注解(它们并不是Spring Boot特有的),查看Spring文档的MVC章节了解更多信息。

    @EnableAutoConfiguration注解
    第二个类级别的注解是@EnableAutoConfiguration。这个注解告诉Spring Boot去猜测怎么基于你添加的依赖配置Spring。由于spring-boot-starter-web添加了Tomcat和Spring MVC,因此自动配置假定您正在开发Web应用程序并相应地设置Spring。

    Starter和自动配置
    自动配置被设计用于和Starter一起工作,但是两者的概念并没有直接相连。你可以自由的选择在启动Starter以外的依赖,Spring Boot仍能很好的自动配置你的应用。

    Main方法
    我们应用程序的最后一部分是主要方法。 这只是遵循Java约定的应用程序入口点的标准方法。 我们的主要方法通过调用run来委托Spring Boot的SpringApplication类。 SpringApplication会引导我们的应用程序,并启动Spring,后者反过来又会启动自动配置的Tomcat Web服务器。 我们需要将Example.class作为参数传递给run方法,以告诉SpringApplication哪个是主要的Spring组件。 args数组也通过传递以公开任何命令行参数。

    2.4.4 运行示例

    此时,您的应用程序应该可以工作了。 由于您使用了spring-boot-starter-parent父POM,因此您具有一个有用的运行目标,可以用来启动该应用程序。 从根项目目录键入mvn spring-boot:run以启动应用程序。 您应该看到类似于以下内容的输出:

    $ mvn spring-boot:run
    
      .   ____          _            __ _ _
     /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
    ( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
     \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
      '  |____| .__|_| |_|_| |_\__, | / / / /
     =========|_|==============|___/=/_/_/_/
     :: Spring Boot ::  (v2.2.6.RELEASE)
    ....... . . .
    ....... . . . (log output here)
    ....... . . .
    ........ Started Example in 2.222 seconds (JVM running for 6.514)
    

    如果你用浏览器访问localhost:8080,应该可以看到如下输出

    Hello World!
    

    要正常退出该应用程序,请按ctrl-c。

    2.4.5 生成可执行文件

    通过创建一个可以在生产环境中运行的完全独立的可执行jar文件来结束示例。 可执行jar(有时称为“胖jar”)是包含您的已编译类以及代码需要运行的所有jar依赖项的归档文件。

    可执行 jars 和 Java
    Java没有提供加载嵌套jar文件(jar中本身包含的jar文件)的标准方法。 如果您要分发独立的应用程序,则可能会出现问题。
    为了解决这个问题,许多开发人员使用“超级”jars。 超级jar将来自应用程序所有依赖项的所有类打包到一个存档中。 这种方法的问题在于,很难查看应用程序中包含哪些库。 如果在多个jar中使用相同的文件名(但具有不同的内容),也可能会产生问题。
    Spring Boot采用了另一种方法,实际上允许您直接嵌套jar。

    要创建可执行jar,我们需要将spring-boot-maven-plugin添加到我们的pom.xml中。 为此,请在“ dependencies”部分下面插入以下行:

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

    spring-boot-starter-parent父POM包含<executions>配置以绑定重新打包目标。 如果不使用父POM,则需要自己声明此配置。 有关详细信息,请参见插件文档

    保存pom.xml文件并从命令行运行 mvn package命令,如下:

    $ mvn package
    
    [INFO] Scanning for projects...
    [INFO]
    [INFO] ------------------------------------------------------------------------
    [INFO] Building myproject 0.0.1-SNAPSHOT
    [INFO] ------------------------------------------------------------------------
    [INFO] .... ..
    [INFO] --- maven-jar-plugin:2.4:jar (default-jar) @ myproject ---
    [INFO] Building jar: /Users/developer/example/spring-boot-example/target/myproject-0.0.1-SNAPSHOT.jar
    [INFO]
    [INFO] --- spring-boot-maven-plugin:2.2.6.RELEASE:repackage (default) @ myproject ---
    [INFO] ------------------------------------------------------------------------
    [INFO] BUILD SUCCESS
    [INFO] ------------------------------------------------------------------------
    

    如果查看目标目录,则应该看到myproject-0.0.1-SNAPSHOT.jar。 该文件的大小应为10 MB左右。 如果想窥视内部,可以使用jar tvf,如下所示:

    $ jar tvf target/myproject-0.0.1-SNAPSHOT.jar
    

    您还将在目标目录中看到一个名为myproject-0.0.1-SNAPSHOT.jar.original的小得多的文件。 这是Maven在Spring Boot重新打包之前创建的原始jar文件。

    要运行该应用程序,请使用java -jar命令,如下所示:

    $ java -jar target/myproject-0.0.1-SNAPSHOT.jar
    
      .   ____          _            __ _ _
     /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
    ( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
     \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
      '  |____| .__|_| |_|_| |_\__, | / / / /
     =========|_|==============|___/=/_/_/_/
     :: Spring Boot ::  (v2.2.6.RELEASE)
    ....... . . .
    ....... . . . (log output here)
    ....... . . .
    ........ Started Example in 2.536 seconds (JVM running for 2.864)
    

    和之前一样,退出应用按 ctrl-c

    2.5 接下来阅读什么

    希望本节提供了一些Spring Boot基础知识,并带您开始编写自己的应用程序。 如果您是面向任务的开发人员,则可能要跳到spring.io并查看一些解决特定“我如何使用Spring进行操作”的入门指南。 我们也有特定于Spring Boot的“操作方法”参考文档.

    否则,下一个逻辑步骤是阅读[使用Spring Boot(https://docs.spring.io/springboot/docs/2.2.6.RELEASE/reference/htmlsingle/#using-boot)。 如果您真的不耐烦,还可以继续阅读有关Spring Boot功能的信息。

    相关文章

      网友评论

          本文标题:第二章 入门

          本文链接:https://www.haomeiwen.com/subject/jygzuhtx.html