Spring Boot应用程序开发入门(九)

冷不防 2022-05-16 01:28 180阅读 0赞

> 这篇博文主要用于新手学习Spring Boot，同时也记录自己学习的过程…  
> 文章内容主要来源于[易百教程][Link 1]

在本节中，我们来再Java中开发一个简单的”`Hello World!`”Web应用程序，突出一些**Spring Boot**的主要特性。在这里将使用Maven来构建这个项目，因为大多数IDE支持它。  
在开始之前，打开一个终端，检查是否安装了Java和Maven的有效版本。

C:\Users\nicoletang>java -version
    java version "1.8.0_60"
    Java(TM) SE Runtime Environment (build 1.8.0_60-b27)
    Java HotSpot(TM) 64-Bit Server VM (build 25.60-b23, mixed mode)
    
    C:\Users\nicoletang>mvn -v
    Apache Maven 3.5.0 (ff8f5e7444045639af65f6095c62210b5713f426; 2017-04-04T03:39:06+08:00)
    Maven home: D:\apache-maven-3.5.0-bin\bin\..
    Java version: 1.8.0_60, vendor: Oracle Corporation
    Java home: C:\Program Files\Java\jdk1.8.0_60\jre
    Default locale: en_US, platform encoding: Cp1252
    OS name: "windows 7", version: "6.1", arch: "amd64", family: "windows"

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

> 提示，如果还没有安装 Maven ，请参考安装教程 - [https://blog.csdn.net/ththcc/article/details/78650233][https_blog.csdn.net_ththcc_article_details_78650233]

**创建POM文件**

--------------------

我们需要从创建一个`Maven pom.xml`文件开始。`pom.xml`是将用于构建项目的配置，在这个示例中，把它放在`D:\spring-boot\pom.xml`。打开您喜欢的文本编辑器并添加以下内容：

它给出了一个工作构建，可以通过运行`mvn package` (可以忽略”**jar will be empty –no content was marked for inclusion!**”现在警告)测试它。  
执行结果如下-  
![这里写图片描述][20180803094840948]

> 此时，可以将项目导入到IDE中(最新的Java IDE包括对Maven的内置支持)。为了简单起见，这里将继续为此示例使用纯文本编辑器。

**添加类路径依赖**

--------------------

**Spring Boot**提供了一些”启动器”，使得容易添加**jar**到你的类路径。在我们的示例应用程序已经在POM的父部分中使用了`spring-boot-starter-parent`。`spring-boot-starter-parent`是一个特殊的启动器，提供了有用的**Maven**默认值。它还提供了一个依赖关系管理部分，以便您可以省略”`blessed`”依赖关系的`version`标签。  
其他”**Starters**”只是提供了在开发特定类型的应用程序时可能需要的依赖关系。由于我们正在开发一个web应用程序，将添加一个`spring-boot-starter-web`依赖关系。

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

执行结果如下 -  
![这里写图片描述][2018080309505253]  
`mvn dependency:tree`命令打印项目依赖关系的树表示。可以看到`spring-boot-starter-parent`本身不提供依赖关系。现在编辑`pom.xml`文件，并在`parent`部分的下面添加`spring-boot-starter-web`依赖关系：

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

完整的 `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>
    
        <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>1.4.3.RELEASE</version>
        </parent>
    
        
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
        </dependencies>
    
    </project>

如果再次运行`mvn dependency:tree`命令，将看到现在还有许多其他依赖项，包括`Tomcat Web`服务器和`Spring Boot`本身。

**编写代码**

--------------------

要完成上面的应用程序示例，我们需要创建一个单一的Java文件。Maven将默认从`src/main/java`编译源代码，所以需要创建该文件夹结构，然后添加一个名为`src/main/java/Example.java`的文件，完整的文件路径是 `D:/spring-boot/src/main/java/Example.java`，代码如下所示：

import org.springframework.boot.*;
    import org.springframework.boot.autoconfigure.*;
    import org.springframework.stereotype.*;
    import org.springframework.web.bind.annotation.*;
    
    @RestController
    @EnableAutoConfiguration
    public class Example { 
    
        @RequestMapping("/")
        String home() {
            return "Hello World!"; // Copyright: w w w . y i I b A i.c O m 
        }
    
        public static void main(String[] args) throws Exception {
            SpringApplication.run(Example.class, args);
        }
    
    }

虽然这里没有太多的代码，但背后有很多事情正在发生。让我们看看代码的重要部分。  
  
  
**@RestController和@RequestMapping注解**  
`Example`类的第一个注解是`@RestController`。这称为构造线注释，它为阅读代码的人提供了提示，对于Spring，该类扮演了一个特定的角色。在这种情况下，这个类是一个web`@Controller`，因此Spring会在处理传入的Web请求时考虑它。  
`@RequestMapping`注解提供了“路由”信息。它告诉Spring任何带有路径”`/`”到HTTP请求应该映射到`home`方法。`@RestController`注解告诉Spring将生成的字符串直接返回给调用者。

> @RestController和@RequestMapping注解是Spring MVC注释（它们不是Spring Boot特有的）。

**@EnableAutoConfiguration注解**  
这个类级别注解是`@EnableAutoConfiguration`。这个注解告诉`Spring Boot`”猜测”将如何配置Spring，它是基于添加的`jar`依赖。由于`spring-boot-starter-web`添加了`Tomcat`和Spring MVC，因此自动配置将假设正在开发一个Web应用程序并相应地设置Spring。

> 启动器和自动配置(Starters & Auto-Configuration)  
> 自动配置旨在与“Starters”配合使用，但这两个概念不直接绑定。可以自由选择和选择起始者以外的jar依赖，Spring Boot仍将尽力自动配置应用程序。

**“main”方法**  
应用程序的最后一部分是主(main)方法。这只是一个遵循Java约定的应用程序入口点得标准方法。`main`方法通过调用`run`来委托Spring Boot `SpringApplication`类。`SpringApplication`将引导应用程序，启动Spring，从而启动自动配置**Tomcat Web**服务器。需要传递`Example.class`作为`run`方法的参数来告诉`SpringApplication`，这是主要的Spring组件。`args`数组也被传递以暴露任何命令行参数。

**运行示例**  
现在，现在，我们的应用程序应该可以正常运行工作了。由于 POM 中使用了`spring-boot-starter-parent`，有一个有用的 `run` 目标，用它来启动应用程序。输入 `mvn spring-boot:run` 从根项目目录启动应用程序：

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

如果打开Web浏览器访问 [http://localhost:8080][http_localhost_8080] ， 应该会看到以下输出：  
![这里写图片描述][20180803095245471]  
要正常退出应用程序，请按`ctrl+c`。  
  
  
**创建可执行jar**

--------------------

现在，我们来完成一个例子，创建一个完全自包含的可执行`jar`文件，可以在生产中运行。可执行`jar`(有时称为“fat jar”)是包含编译的类以及需要运行的所有`jar`依赖性的代码存档。

> 可执行jar和Java  
> Java不提供任何标准方法来加载嵌套的`jar`文件(即包含在`jar`中的`jar`文件)。如果想要分发一个自包含的应用程序，这可能是有问题的。  
> 为了解决这个问题，许多开发人员使用“uber” jar。 一个uber jar简单地将所有类，从所有`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>

现在，`pom.xml`文件的完整内容如下：

`POM` 中 `spring-boot-starter-parent` 包括`<executions>`配置以绑定 `repackage` 目标。如果不使用父`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:1.4.3.RELEASE: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

应该在`target`目录中看到一个名为`myproject-0.0.1-SNAPSHOT.jar.original`的文件。这是Maven在Spring Boot重新打包之前创建的原始`jar`文件。  
要运行该应用程序，请使用`java -jar`命令：

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

如果打开Web浏览器访问 [http://localhost:8080][http_localhost_8080] ， 应该会看到以下输出：  
![这里写图片描述][20180803095245471]  
和之前一样，要正常退出应用程序，同时按住`ctrl+c`。  
到此，第一个 Spring Boot应用程序的开发就结束了。

**相关文章：**

*  [Spring Boot教程(一)][Spring Boot]
 *  [Spring Boot是什么？(二)][Spring Boot 1]
 *  [Spring Boot主要目标(三)][Spring Boot 2]
 *  [新项目为什么需要Spring Boot？(四)][Spring Boot 3]
 *  [Spring Boot核心和限制(五)][Spring Boot 4]
 *  [Spring Boot优点和缺点(六)][Spring Boot 5]
 *  [Spring Boot入门(七)][Spring Boot 6]
 *  [Spring Boot安装(八)][Spring Boot 7]
 *  [Spring Boot JSP应用实例(十)][Spring Boot JSP]
 *  [Spring Boot将WAR文件部署到Tomcat(十一)][Spring Boot_WAR_Tomcat]
 *  [Spring Boot Hello World(Thymeleaf)示例(十二)][Spring Boot Hello World_Thymeleaf]
 *  [Spring Boot非web应用程序实例(十三)][Spring Boot_web]
 *  [Spring Boot @ConfigurationProperties实例(十四)][Spring Boot _ConfigurationProperties]
 *  [Spring Boot SLF4J日志实例(十五)][Spring Boot SLF4J]
 *  [Spring Boot Ajax实例(十六)][Spring Boot Ajax]

[Link 1]: https://www.yiibai.com/spring-boot/
[https_blog.csdn.net_ththcc_article_details_78650233]: https://blog.csdn.net/ththcc/article/details/78650233
[20180803094840948]: /images/20220516/cdb677ba215f4cd8a9ecb511ed62af19.png
[2018080309505253]: /images/20220516/46c0c30240494e4ca2fb43a14c6624fb.png
[http_localhost_8080]: http://localhost:8080
[20180803095245471]: /images/20220516/a65e30bfe06841089629635a4fc26c2c.png
[Spring Boot]: https://blog.csdn.net/ththcc/article/details/81631532
[Spring Boot 1]: https://blog.csdn.net/ththcc/article/details/81632203
[Spring Boot 2]: https://blog.csdn.net/ththcc/article/details/81632326
[Spring Boot 3]: https://blog.csdn.net/ththcc/article/details/81632670
[Spring Boot 4]: https://blog.csdn.net/ththcc/article/details/81632792
[Spring Boot 5]: https://blog.csdn.net/ththcc/article/details/81632923
[Spring Boot 6]: https://blog.csdn.net/ththcc/article/details/81632964
[Spring Boot 7]: https://blog.csdn.net/ththcc/article/details/81633063
[Spring Boot JSP]: https://blog.csdn.net/ththcc/article/details/81660830
[Spring Boot_WAR_Tomcat]: https://blog.csdn.net/ththcc/article/details/81660865
[Spring Boot Hello World_Thymeleaf]: https://blog.csdn.net/ththcc/article/details/81660896
[Spring Boot_web]: https://blog.csdn.net/ththcc/article/details/81660975
[Spring Boot _ConfigurationProperties]: https://blog.csdn.net/ththcc/article/details/81661208
[Spring Boot SLF4J]: https://blog.csdn.net/ththcc/article/details/81661266
[Spring Boot Ajax]: https://blog.csdn.net/ththcc/article/details/81870702