Spring Boot框架学习 - Spring Boot入门程序

一、springboot 入门(Spring Boot 2.6.2)

1、检查环境

Spring Boot 2.6.2 需要 Java 8,并且兼容 Java 17(包括 Java 17)。还需要 Spring Framework 5.3.14 或更高版本。

为以下构建工具提供了显式构建支持:
Spring Boot框架学习 - Spring Boot入门程序_第1张图片
在我们开始之前,打开一个终端并运行以下命令以确保您安装了有效版本的 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、创建 pom.xml

我们需要从创建 Maven pom.xml 文件开始。 pom.xml 是用于构建项目的配方。 打开您最喜欢的文本编辑器并添加以下内容:


<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.0modelVersion>

    <groupId>com.examplegroupId>
    <artifactId>myprojectartifactId>
    <version>0.0.1-SNAPSHOTversion>

    <parent>
        <groupId>org.springframework.bootgroupId>
        <artifactId>spring-boot-starter-parentartifactId>
        <version>2.6.2version>
    parent>

    

project>

前面的清单应该为您提供了一个有效的构建。 您可以通过运行 mvn package 来测试它(现在,您可以忽略“jar 将为空 - 没有内容被标记为包含!”警告)。

Spring Boot 提供了许多“Starters”,可让您将 jars 添加到类路径中。 我们的烟雾测试应用程序在 POM 的父部分使用 spring-boot-starter-parentspring-boot-starter-parent 是一个特殊的启动器,提供有用的 Maven 默认值。 它还提供了一个依赖项管理部分,以便您可以省略“祝福”依赖项的版本标记。

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

$ mvn dependency:tree

[INFO] com.example:myproject:jar:0.0.1-SNAPSHOT

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

<dependencies>
    <dependency>
        <groupId>org.springframework.bootgroupId>
        <artifactId>spring-boot-starter-webartifactId>
    dependency>
dependencies>

如果您再次运行 mvn dependency:tree,您会看到现在有许多额外的依赖项,包括 Tomcat Web 服务器和 Spring Boot 本身。

[INFO] org.example:springboot-project:pom:1.0-SNAPSHOT
[INFO] \- org.springframework.boot:spring-boot-starter-web:jar:2.6.2:compile
[INFO]    +- org.springframework.boot:spring-boot-starter:jar:2.6.2:compile
[INFO]    |  +- org.springframework.boot:spring-boot:jar:2.6.2:compile
[INFO]    |  +- org.springframework.boot:spring-boot-autoconfigure:jar:2.6.2:compile
[INFO]    |  +- org.springframework.boot:spring-boot-starter-logging:jar:2.6.2:compile
[INFO]    |  |  +- ch.qos.logback:logback-classic:jar:1.2.9:compile
[INFO]    |  |  |  +- ch.qos.logback:logback-core:jar:1.2.9:compile
[INFO]    |  |  |  \- org.slf4j:slf4j-api:jar:1.7.32:compile
[INFO]    |  |  +- org.apache.logging.log4j:log4j-to-slf4j:jar:2.17.0:compile
[INFO]    |  |  |  \- org.apache.logging.log4j:log4j-api:jar:2.17.0:compile
[INFO]    |  |  \- org.slf4j:jul-to-slf4j:jar:1.7.32:compile
[INFO]    |  +- jakarta.annotation:jakarta.annotation-api:jar:1.3.5:compile
[INFO]    |  +- org.springframework:spring-core:jar:5.3.14:compile
[INFO]    |  |  \- org.springframework:spring-jcl:jar:5.3.14:compile
[INFO]    |  \- org.yaml:snakeyaml:jar:1.29:compile
[INFO]    +- org.springframework.boot:spring-boot-starter-json:jar:2.6.2:compile
[INFO]    |  +- com.fasterxml.jackson.core:jackson-databind:jar:2.13.1:compile
[INFO]    |  |  +- com.fasterxml.jackson.core:jackson-annotations:jar:2.13.1:compile
[INFO]    |  |  \- com.fasterxml.jackson.core:jackson-core:jar:2.13.1:compile
[INFO]    |  +- com.fasterxml.jackson.datatype:jackson-datatype-jdk8:jar:2.13.1:compile
[INFO]    |  +- com.fasterxml.jackson.datatype:jackson-datatype-jsr310:jar:2.13.1:compile
[INFO]    |  \- com.fasterxml.jackson.module:jackson-module-parameter-names:jar:2.13.1:compile
[INFO]    +- org.springframework.boot:spring-boot-starter-tomcat:jar:2.6.2:compile
[INFO]    |  +- org.apache.tomcat.embed:tomcat-embed-core:jar:9.0.56:compile
[INFO]    |  +- org.apache.tomcat.embed:tomcat-embed-el:jar:9.0.56:compile
[INFO]    |  \- org.apache.tomcat.embed:tomcat-embed-websocket:jar:9.0.56:compile
[INFO]    +- org.springframework:spring-web:jar:5.3.14:compile
[INFO]    |  \- org.springframework:spring-beans:jar:5.3.14:compile
[INFO]    \- org.springframework:spring-webmvc:jar:5.3.14:compile
[INFO]       +- org.springframework:spring-aop:jar:5.3.14:compile
[INFO]       +- org.springframework:spring-context:jar:5.3.14:compile
[INFO]       \- org.springframework:spring-expression:jar:5.3.14:compile

3、编写代码

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

@RestController
@EnableAutoConfiguration
public class MyApplication {

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

    public static void main(String[] args) {
        SpringApplication.run(MyApplication.class, args);
    }

}

虽然这里的代码不多,但是很多事情正在发生。 我们将在接下来的几节中逐步介绍重要部分。

3.1 @RestController 和 @RequestMapping 注解

MyApplication 类的第一个注解是 @RestController。 这称为构造型注解。 它为人们阅读代码和 Spring 提供了类扮演特定角色的提示。 在这种情况下,我们的类是一个 web @Controller,所以 Spring 在处理传入的 web 请求时会考虑它。

@RequestMapping 注解提供了“路由”信息。 它告诉 Spring 任何带有 / 路径的 HTTP 请求都应该映射到 home 方法。 @RestController 注解告诉 Spring 将结果字符串直接呈现给调用者。

@RestController 和 @RequestMapping 注解是 Spring MVC 注解(它们不是特定于 Spring Boot)。 有关更多详细信息,请参阅 Spring 参考文档中的 MVC 部分。

3.2 @EnableAutoConfiguration 注解

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

启动器和自动配置

自动配置旨在与“Starters”配合使用,但这两个概念并没有直接联系。 您可以自由选择 starters 之外的 jar 依赖项。 Spring Boot 仍然尽力自动配置您的应用程序。

3.3 main 方法

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

4、运行示例

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

$ mvn spring-boot:run

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::  (v2.6.2)
....... . . .
....... . . . (log output here)
....... . . .
........ Started MyApplication in 2.222 seconds (JVM running for 6.514)

如果您打开 Web 浏览器访问 localhost:8080,您应该会看到以下输出:

Hello World!

要正常退出应用程序,请按 ctrl+c

5、创建一个可执行的 Jar

我们通过创建一个完全独立的可执行 jar 文件来完成我们的示例,我们可以在生产中运行该文件。 可执行 jar(有时称为“fat jar”)是包含已编译类以及代码运行所需的所有 jar 依赖项的档案。

可执行的 jars 和 Java

  • Java 不提供加载嵌套 jar 文件(本身包含在 jar 中的 jar 文件)的标准方法。 如果您希望分发自包含的应用程序,这可能会出现问题。

  • 为了解决这个问题,许多开发人员使用“uber”jar。 一个 uber jar 将所有应用程序依赖项中的所有类打包到一个存档中。 这种方法的问题在于,很难看到应用程序中有哪些库。 如果在多个 jar 中使用相同的文件名(但具有不同的内容),也会出现问题。

  • Spring Boot 采用了不同的方法,让您实际上可以直接嵌套 jar。

要创建一个可执行的 jar,我们需要将 spring-boot-maven-plugin 添加到我们的 pom.xml 中。 为此,请在依赖项部分下方插入以下行:

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

spring-boot-starter-parent POM 包含 配置以绑定重新打包目标。 如果不使用父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.6.2:repackage (default) @ myproject ---
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------

如果您查看 target 目录,您应该会看到 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.6.2)
....... . . .
....... . . . (log output here)
....... . . .
........ Started MyApplication in 2.536 seconds (JVM running for 2.864)

与之前一样,要退出应用程序,请按 ctrl+c

文章内容参考:https://docs.spring.io/spring-boot/docs/2.6.2/reference/htmlsingle/#getting-started

你可能感兴趣的:(Spring,Boot,maven,java,spring,boot,spring,后端)