创建第一个SpringBoot程序

创建第一个SpringBoot程序

1. 创建POM

我们需要从创建一个 Mavenpom.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.6.6</version>
    </parent>

    <!-- Additional lines to be added here... -->

</project>

前面的清单应该给你一个工作构建。您可以通过运行对其进行测试mvn package(现在,您可以忽略“jar 将为空 - 没有内容被标记为包含!”警告)。

2. 添加类路径依赖项

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

其他“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``parent

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

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

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方法。注释告诉 Spring 将@RestController结果字符串直接呈现给调用者。

ps: @RestController 可以写成 @ResponseBody 和 @Controller

​ @RestController的实现:

package org.springframework.web.bind.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.springframework.core.annotation.AliasFor;
import org.springframework.stereotype.Controller;

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Controller
@ResponseBody
public @interface RestController {
    @AliasFor(
        annotation = Controller.class
    )
    String value() default "";
}
3.2 @EnableAutoConfiguration 注解

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

启动器和自动配置

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

3.3. “主要”方法

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

=================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================

以上是官方写法,还有一种

3.1 创建一个 Java 文件

​ Maven 从 编译源代码src/main/java,因此您需要创建该目录结构,然后添加一个名为src/main/java/MainApplication.java包含以下代码的文件:

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

/**
 * 主程序类
 * @SpringBootApplication: 这是一个SpringBoot应用
 */
@SpringBootApplication
public class MainApplication {

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

}
3.2 @SpringBootApplication注解源码
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(
    excludeFilters = {@Filter(
    type = FilterType.CUSTOM,
    classes = {TypeExcludeFilter.class}
), @Filter(
    type = FilterType.CUSTOM,
    classes = {AutoConfigurationExcludeFilter.class}
)}
)
public @interface SpringBootApplication {
    @AliasFor(
        annotation = EnableAutoConfiguration.class
    )
    Class<?>[] exclude() default {};

    @AliasFor(
        annotation = EnableAutoConfiguration.class
    )
    String[] excludeName() default {};

    @AliasFor(
        annotation = ComponentScan.class,
        attribute = "basePackages"
    )
    String[] scanBasePackages() default {};

    @AliasFor(
        annotation = ComponentScan.class,
        attribute = "basePackageClasses"
    )
    Class<?>[] scanBasePackageClasses() default {};

    @AliasFor(
        annotation = ComponentScan.class,
        attribute = "nameGenerator"
    )
    Class<? extends BeanNameGenerator> nameGenerator() default BeanNameGenerator.class;

    @AliasFor(
        annotation = Configuration.class
    )
    boolean proxyBeanMethods() default true;
}

虽然定义使用了多个Annotation进行了原信息标注,但实际上重要的只有三个Annotation:

  • @Configuration(@SpringBootConfiguration点开查看发现里面还是应用了@Configuration)

  • @EnableAutoConfiguration

  • @ComponentScan

    如果在启动类使用这个三个注解,整个SpringBoot应用依然可以与之前的启动类功能一样。但每次写这3个比较啰嗦,所以写一个**@SpringBootApplication**方便点。

这三个注解中**@Configuration@ComponentScan对我们来说并不陌生,今天我们的主角是@EnableAutoConfiguration**。

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import(AutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {
    String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";
Class<?>[] exclude() default {};

String[] excludeName() default {};
}

其中最关键的要属@Import(AutoConfigurationImportSelector.class),借助AutoConfigurationImportSelector,@EnableAutoConfiguration可以帮助SpringBoot应用将所有符合条件的@Configuration配置都加载到当前SpringBoot创建并使用的IoC容器。

借助于Spring框架原有的一个工具类:SpringFactoriesLoader的支持,@EnableAutoConfiguration可以智能的自动配置功效才得以大功告成!

在AutoConfigurationImportSelector类中可以看到通过 SpringFactoriesLoader.loadFactoryNames()
把 spring-boot-autoconfigure.jar/META-INF/spring.factories中每一个xxxAutoConfiguration文件都加载到容器中,spring.factories文件里每一个xxxAutoConfiguration文件一般都会有下面的条件注解:

  • @ConditionalOnClass : classpath中存在该类时起效

  • @ConditionalOnMissingClass : classpath中不存在该类时起效

  • @ConditionalOnBean : DI容器中存在该类型Bean时起效

  • @ConditionalOnMissingBean : DI容器中不存在该类型Bean时起效

  • @ConditionalOnSingleCandidate : DI容器中该类型Bean只有一个或@Primary的只有一个时起效

  • @ConditionalOnExpression : SpEL表达式结果为true时

  • @ConditionalOnProperty : 参数设置或者值一致时起效

  • @ConditionalOnResource : 指定的文件存在时起效

  • @ConditionalOnJndi : 指定的JNDI存在时起效

  • @ConditionalOnJava : 指定的Java版本存在时起效

  • @ConditionalOnWebApplication : Web应用环境下起效

  • @ConditionalOnNotWebApplication : 非Web应用环境下起效

3.3 创建一个Controller
//@Controller
//@ResponseBody
@RestController
public class HelloController {


    @RequestMapping
    public String hand01() {
        return "Hello SpringBoot2!";
    }
}
4. 运行示例

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

$ mvn spring-boot:run

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

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

你好世界!

要优雅地退出应用程序,请按ctrl-c

5. 创建可执行 Jar

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

可执行 jar 和 Java

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

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

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

spring-boot-maven-plugin要创建一个可执行的 jar,我们需要将pom.xml. 为此,请在该dependencies部分下方插入以下行:

<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
        </plugin>
    </plugins>
</build>
spring-boot-starter-parentPOM 包含<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:2.6.6: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您还应该在目录中看到一个小得多的文件target。这是Maven在被Spring Boot重新打包之前创建的原始jar文件。

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

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

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

和以前一样,要退出应用程序,请按ctrl-c

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值