本系列代码地址:

Spring Boot 2.5.1官方文档

Spring Boot是在Spring框架上创建的一个全新的框架,其设计目的是简化Spring应用的搭建和开发过程。开启Spring Boot有许多种方法可供选择,这里仅介绍使用http://start.spring.io/来构建一个简单的Spring Boot项目。

生成项目文件

访问http://start.spring.io/,页面显示如下:

开启Spring Boot - 图1

这里选择以Maven构建,语言选择Java,Spring Boot版本为1.5.9。然后点击Switch to the full version,可看到更多的配置以及依赖选择:

开启Spring Boot - 图2

在项目信息里选择以jar包的方式部署,Java版本为7。在页面的下方还可以选择诸多的依赖,这里仅选择web进行演示:

开启Spring Boot - 图3

最后点击页面的generate project按钮生成项目文件。文件下载后是一个压缩包,进行解压然后使用eclipse以Maven项目的形式导入。导入后eclipse会自动编译项目并下载相应的依赖,项目目录如下所示:

Screen Shot 2021-09-22 at 3.51.38 PM.png

配置Maven标准settings.xml文件

配置目标

  1. 默认jdk采用java8
  2. 配置阿里云镜像和私服镜像, 并且先从阿里云下载, 下载不到的再去私服下载
  3. 配置mvnrepository
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
  3. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">
  4. <!-- 本地仓库的位置 -->
  5. <localRepository>${user.home}/.m2/repository</localRepository>
  6. <!-- Apache Maven 配置 -->
  7. <pluginGroups/>
  8. <proxies/>
  9. <!-- 私服发布的用户名密码 -->
  10. <servers>
  11. <server>
  12. <id>releases</id>
  13. <username>deployment</username>
  14. <password>He2019</password>
  15. </server>
  16. <server>
  17. <id>snapshots</id>
  18. <username>deployment</username>
  19. <password>He2019</password>
  20. </server>
  21. </servers>
  22. <!-- 阿里云镜像 -->
  23. <mirrors>
  24. <mirror>
  25. <id>alimaven</id>
  26. <name>aliyun maven</name>
  27. <!-- https://maven.aliyun.com/repository/public/ -->
  28. <url>http://maven.aliyun.com/nexus/content/groups/public/</url>
  29. <mirrorOf>central</mirrorOf>
  30. </mirror>
  31. </mirrors>
  32. <!-- 配置: java8, 先从阿里云下载, 没有再去私服下载 -->
  33. <!-- 20190929 hepengju 测试结果: 影响下载顺序的是profiles标签的配置顺序(后面配置的ali仓库先下载), 而不是activeProfiles的顺序 -->
  34. <profiles>
  35. <!-- 全局JDK1.8配置 -->
  36. <profile>
  37. <id>jdk1.8</id>
  38. <activation>
  39. <activeByDefault>true</activeByDefault>
  40. <jdk>1.8</jdk>
  41. </activation>
  42. <properties>
  43. <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  44. <maven.compiler.source>1.8</maven.compiler.source>
  45. <maven.compiler.target>1.8</maven.compiler.target>
  46. <maven.compiler.compilerVersion>1.8</maven.compiler.compilerVersion>
  47. </properties>
  48. </profile>
  49. <!-- Nexus私服配置: 第三方jar包下载, 比如oracle的jdbc驱动等 -->
  50. <profile>
  51. <id>dev</id>
  52. <repositories>
  53. <repository>
  54. <id>nexus</id>
  55. <url>http://nexus.hepengju.cn:8081/nexus/content/groups/public/</url>
  56. <releases>
  57. <enabled>true</enabled>
  58. </releases>
  59. <snapshots>
  60. <enabled>true</enabled>
  61. </snapshots>
  62. </repository>
  63. </repositories>
  64. <pluginRepositories>
  65. <pluginRepository>
  66. <id>public</id>
  67. <name>Public Repositories</name>
  68. <url>http://nexus.hepengju.cn:8081/nexus/content/groups/public/</url>
  69. </pluginRepository>
  70. </pluginRepositories>
  71. </profile>
  72. <!-- 阿里云配置: 提高国内的jar包下载速度 -->
  73. <profile>
  74. <id>ali</id>
  75. <repositories>
  76. <repository>
  77. <id>nexus-aliyun</id>
  78. <name>Nexus aliyun</name>
  79. <url>http://maven.aliyun.com/nexus/content/repositories/central</url>
  80. <releases>
  81. <enabled>true</enabled>
  82. </releases>
  83. <snapshots>
  84. <enabled>true</enabled>
  85. </snapshots>
  86. </repository>
  87. </repositories>
  88. <pluginRepositories>
  89. <pluginRepository>
  90. <id>nexus-aliyun</id>
  91. <name>Nexus aliyun</name>
  92. <url>http://maven.aliyun.com/nexus/content/repositories/central</url>
  93. </pluginRepository>
  94. </pluginRepositories>
  95. </profile>
  96. <!-- mvnrepository 中央仓库 -->
  97. <profile>
  98. <id>mvnrepository</id>
  99. <repositories>
  100. <repository>
  101. <id>mvnrepository</id>
  102. <url>http://repo1.maven.org/maven2/</url>
  103. <snapshots>
  104. <enabled>false</enabled>
  105. </snapshots>
  106. <releases>
  107. <enabled>true</enabled>
  108. </releases>
  109. </repository>
  110. </repositories>
  111. <pluginRepositories>
  112. <pluginRepository>
  113. <id>mvnrepository</id>
  114. <name>mvnrepository maven</name>
  115. <url>https://repo1.maven.org/maven2/</url>
  116. </pluginRepository>
  117. </pluginRepositories>
  118. </profile>
  119. </profiles>
  120. <!-- 激活配置 -->
  121. <activeProfiles>
  122. <activeProfile>jdk1.8</activeProfile>
  123. <activeProfile>dev</activeProfile>
  124. <activeProfile>ali</activeProfile>
  125. <activeProfile>mvnrepository</activeProfile>
  126. </activeProfiles>
  127. </settings>

可以配置国内阿里镜像:

  1. <mirror>
  2. <id>nexus-aliyun </id>
  3. <mirrorOf>central </mirrorOf>
  4. <name>Nexus aliyun </name>
  5. <url>http://maven.aliyun.com/nexus/content/repositories/central </url>
  6. </mirror>

配置完后使用命令mvn clean更新仓库。

简单演示

项目根目录下生成了一个artifactId+Application命名规则的入口类,为了演示简单,不再新建控制器,直接在入口类中编写代码:

  1. package com.springboot.demo;
  2. import org.springframework.boot.SpringApplication;
  3. import org.springframework.boot.autoconfigure.SpringBootApplication;
  4. import org.springframework.web.bind.annotation.RequestMapping;
  5. import org.springframework.web.bind.annotation.RestController;
  6. @RestController
  7. @SpringBootApplication
  8. public class DemoApplication {
  9. @RequestMapping("/")
  10. String index() {
  11. return "hello spring boot";
  12. }
  13. public static void main(String[] args) {
  14. SpringApplication.run(DemoApplication.class, args);
  15. }
  16. }

然后右键点击DemoAppliction,选择run as → Java Application:

开启Spring Boot - 图5

访问http://localhost:8080,页面显示如下:

开启Spring Boot - 图6

打包发布

在eclipse中右击项目,选择run as → Maven build…,如下图所示:

开启Spring Boot - 图7

在Goals中输入clean package命令,然后点击下方的run就将项目打包成jar包(初次打包会自动下载一些依赖)。打包完毕后可看到项目目录target文件夹下生成了一个jar文件:

开启Spring Boot - 图8

生成jar包后,cd到target目录下,执行以下命令:

开启Spring Boot - 图9

访问http://localhost:8080,效果如上。

聊聊pom.xml

打开pom.xml可看到配置如下:

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3. xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  4. <modelVersion>4.0.0</modelVersion>
  5. <groupId>com.springboot</groupId>
  6. <artifactId>demo</artifactId>
  7. <version>0.0.1-SNAPSHOT</version>
  8. <packaging>jar</packaging>
  9. <name>demo</name>
  10. <description>Demo project for Spring Boot</description>
  11. <parent>
  12. <groupId>org.springframework.boot</groupId>
  13. <artifactId>spring-boot-starter-parent</artifactId>
  14. <version>1.5.9.RELEASE</version>
  15. <relativePath/> <!-- lookup parent from repository -->
  16. </parent>
  17. <properties>
  18. <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  19. <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
  20. <java.version>1.7</java.version>
  21. </properties>
  22. <dependencies>
  23. <dependency>
  24. <groupId>org.springframework.boot</groupId>
  25. <artifactId>spring-boot-starter-web</artifactId>
  26. </dependency>
  27. <dependency>
  28. <groupId>org.springframework.boot</groupId>
  29. <artifactId>spring-boot-starter-test</artifactId>
  30. <scope>test</scope>
  31. </dependency>
  32. </dependencies>
  33. <build>
  34. <plugins>
  35. <plugin>
  36. <groupId>org.springframework.boot</groupId>
  37. <artifactId>spring-boot-maven-plugin</artifactId>
  38. </plugin>
  39. </plugins>
  40. </build>
  41. </project>

maven项目pom.xml中scope类型

scope的分类

  1. compile:默认值 他表示被依赖项目需要参与当前项目的编译,还有后续的测试,运行周期也参与其中,是一个比较强的依赖。打包的时候通常需要包含进去
  2. test:依赖项目仅仅参与测试相关的工作,包括测试代码的编译和执行,不会被打包,例如:junit
  3. runtime:表示被依赖项目无需参与项目的编译,不过后期的测试和运行周期需要其参与。与compile相比,跳过了编译而已。例如JDBC驱动,适用运行和测试阶段
  4. provided:打包的时候可以不用包进去,别的设施会提供。事实上该依赖理论上可以参与编译,测试,运行等周期。相当于compile,但是打包阶段做了exclude操作
  5. system:从参与度来说,和provided相同,不过被依赖项不会从maven仓库下载,而是从本地文件系统拿。需要添加systemPath的属性来定义路径

spring-boot-starter-parent

spring-boot-starter-parent指定了当前项目为一个Spring Boot项目,它提供了诸多的默认Maven依赖,具体可查看目录~/.m2/repository/org/springframework/boot/spring-boot-dependencies/1.5.9.RELEASE下的spring-boot-dependencies-1.5.9.RELEASE.pom文件,这里仅截取一小部分:

  1. <properties>
  2. ...
  3. <spring-security.version>4.2.3.RELEASE</spring-security.version>
  4. <spring-security-jwt.version>1.0.8.RELEASE</spring-security-jwt.version>
  5. <spring-security-oauth.version>2.0.14.RELEASE</spring-security-oauth.version>
  6. <spring-session.version>1.3.1.RELEASE</spring-session.version>
  7. <spring-social.version>1.1.4.RELEASE</spring-social.version>
  8. <spring-social-facebook.version>2.0.3.RELEASE</spring-social-facebook.version>
  9. <spring-social-linkedin.version>1.0.2.RELEASE</spring-social-linkedin.version>
  10. <spring-social-twitter.version>1.1.2.RELEASE</spring-social-twitter.version>
  11. <spring-ws.version>2.4.2.RELEASE</spring-ws.version>
  12. <sqlite-jdbc.version>3.15.1</sqlite-jdbc.version>
  13. <statsd-client.version>3.1.0</statsd-client.version>
  14. <sun-mail.version>${javax-mail.version}</sun-mail.version>
  15. <thymeleaf.version>2.1.6.RELEASE</thymeleaf.version>
  16. <thymeleaf-extras-springsecurity4.version>2.1.3.RELEASE</thymeleaf-extras-springsecurity4.version>
  17. <thymeleaf-extras-conditionalcomments.version>2.1.2.RELEASE</thymeleaf-extras-conditionalcomments.version>
  18. <thymeleaf-layout-dialect.version>1.4.0</thymeleaf-layout-dialect.version>
  19. <thymeleaf-extras-data-attribute.version>1.3</thymeleaf-extras-data-attribute.version>
  20. <thymeleaf-extras-java8time.version>2.1.0.RELEASE</thymeleaf-extras-java8time.version>
  21. <tomcat.version>8.5.23</tomcat.version>
  22. ...
  23. </properties>

需要说明的是,并非所有在<properties>标签中配置了版本号的依赖都有被启用,其启用与否取决于您是否配置了相应的starter。比如tomcat这个依赖就是spring-boot-starter-web的传递性依赖(下面将会描述到)。

当然,我们可以手动改变这些依赖的版本。比如我想把thymeleaf的版本改为3.0.0.RELEASE,我们可以在pom.xml中进行如下配置:

  1. <properties>
  2. <thymeleaf.version>3.0.0.RELEASE</thymeleaf.version>
  3. </properties>

spring-boot-starter-web

Spring Boot提供了许多开箱即用的依赖模块,这些模块都是以spring-boot-starter-XX命名的。比如要开启Spring Boot的web功能,只需要在pom.xml中配置spring-boot-starter-web即可:

  1. <dependency>
  2. <groupId>org.springframework.boot</groupId>
  3. <artifactId>spring-boot-starter-web</artifactId>
  4. </dependency>

因为其依赖于spring-boot-starter-parent,所以这里可以不用配置version。保存后Maven会自动帮我们下载spring-boot-starter-web模块所包含的jar文件。

如果需要修改服务根目录、监听端口等信息。可以在application.yml中对项目进行简单的配置:

  1. server:
  2. port: 8080
  3. servlet: #spring 2.x修改
  4. application-display-name: ProjectTemplate-Web
  5. context-path: /web

如果需要具体查看spring-boot-starter-web包含了哪些依赖,我们可以右键项目选择run as → Maven Build…,在Goals中输入命令dependency:tree,然后点击run即可在eclipse控制台查看到如下信息:

  1. [INFO] +- org.springframework.boot:spring-boot-starter-web:jar:1.5.9.RELEASE:compile
  2. [INFO] | +- org.springframework.boot:spring-boot-starter:jar:1.5.9.RELEASE:compile
  3. [INFO] | | +- org.springframework.boot:spring-boot:jar:1.5.9.RELEASE:compile
  4. [INFO] | | +- org.springframework.boot:spring-boot-autoconfigure:jar:1.5.9.RELEASE:compile
  5. [INFO] | | +- org.springframework.boot:spring-boot-starter-logging:jar:1.5.9.RELEASE:compile
  6. [INFO] | | | +- ch.qos.logback:logback-classic:jar:1.1.11:compile
  7. [INFO] | | | | \- ch.qos.logback:logback-core:jar:1.1.11:compile
  8. [INFO] | | | +- org.slf4j:jcl-over-slf4j:jar:1.7.25:compile
  9. [INFO] | | | +- org.slf4j:jul-to-slf4j:jar:1.7.25:compile
  10. [INFO] | | | \- org.slf4j:log4j-over-slf4j:jar:1.7.25:compile
  11. [INFO] | | \- org.yaml:snakeyaml:jar:1.17:runtime
  12. [INFO] | +- org.springframework.boot:spring-boot-starter-tomcat:jar:1.5.9.RELEASE:compile
  13. [INFO] | | +- org.apache.tomcat.embed:tomcat-embed-core:jar:8.5.23:compile
  14. [INFO] | | | \- org.apache.tomcat:tomcat-annotations-api:jar:8.5.23:compile
  15. [INFO] | | +- org.apache.tomcat.embed:tomcat-embed-el:jar:8.5.23:compile
  16. [INFO] | | \- org.apache.tomcat.embed:tomcat-embed-websocket:jar:8.5.23:compile
  17. [INFO] | +- org.hibernate:hibernate-validator:jar:5.3.6.Final:compile
  18. [INFO] | | +- javax.validation:validation-api:jar:1.1.0.Final:compile
  19. [INFO] | | +- org.jboss.logging:jboss-logging:jar:3.3.1.Final:compile
  20. [INFO] | | \- com.fasterxml:classmate:jar:1.3.4:compile
  21. [INFO] | +- com.fasterxml.jackson.core:jackson-databind:jar:2.8.10:compile
  22. [INFO] | | +- com.fasterxml.jackson.core:jackson-annotations:jar:2.8.0:compile
  23. [INFO] | | \- com.fasterxml.jackson.core:jackson-core:jar:2.8.10:compile
  24. [INFO] | +- org.springframework:spring-web:jar:4.3.13.RELEASE:compile
  25. [INFO] | | +- org.springframework:spring-aop:jar:4.3.13.RELEASE:compile
  26. [INFO] | | +- org.springframework:spring-beans:jar:4.3.13.RELEASE:compile
  27. [INFO] | | \- org.springframework:spring-context:jar:4.3.13.RELEASE:compile
  28. [INFO] | \- org.springframework:spring-webmvc:jar:4.3.13.RELEASE:compile
  29. [INFO] | \- org.springframework:spring-expression:jar:4.3.13.RELEASE:compile

上述这些依赖都是隐式依赖于spring-boot-starter-web,我们也可以手动排除一些我们不需要的依赖。

比如spring-boot-starter-web默认集成了tomcat,假如我们想把它换为jetty,可以在pom.xml中spring-boot-starter-web下排除tomcat依赖,然后手动引入jetty依赖:

  1. <dependencies>
  2. <dependency>
  3. <groupId>org.springframework.boot</groupId>
  4. <artifactId>spring-boot-starter-web</artifactId>
  5. <exclusions>
  6. <exclusion>
  7. <groupId>org.springframework.boot</groupId>
  8. <artifactId>spring-boot-starter-tomcat</artifactId>
  9. </exclusion>
  10. </exclusions>
  11. </dependency>
  12. <dependency>
  13. <groupId>org.springframework.boot</groupId>
  14. <artifactId>spring-boot-starter-jetty</artifactId>
  15. </dependency>
  16. </dependencies>

tips:依赖的坐标可以到上述的spring-boot-dependencies-1.5.9.RELEASE.pom文件里查找。再次运行dependency:tree

  1. [INFO] +- org.springframework.boot:spring-boot-starter-web:jar:1.5.9.RELEASE:compile
  2. ...
  3. [INFO] +- org.springframework.boot:spring-boot-starter-jetty:jar:1.5.9.RELEASE:compile
  4. [INFO] | +- org.eclipse.jetty:jetty-servlets:jar:9.4.7.v20170914:compile
  5. [INFO] | | +- org.eclipse.jetty:jetty-continuation:jar:9.4.7.v20170914:compile
  6. [INFO] | | +- org.eclipse.jetty:jetty-http:jar:9.4.7.v20170914:compile
  7. [INFO] | | +- org.eclipse.jetty:jetty-util:jar:9.4.7.v20170914:compile
  8. [INFO] | | \- org.eclipse.jetty:jetty-io:jar:9.4.7.v20170914:compile
  9. [INFO] | +- org.eclipse.jetty:jetty-webapp:jar:9.4.7.v20170914:compile
  10. [INFO] | | +- org.eclipse.jetty:jetty-xml:jar:9.4.7.v20170914:compile
  11. [INFO] | | \- org.eclipse.jetty:jetty-servlet:jar:9.4.7.v20170914:compile
  12. [INFO] | | \- org.eclipse.jetty:jetty-security:jar:9.4.7.v20170914:compile
  13. [INFO] | | \- org.eclipse.jetty:jetty-server:jar:9.4.7.v20170914:compile
  14. [INFO] | +- org.eclipse.jetty.websocket:websocket-server:jar:9.4.7.v20170914:compile
  15. [INFO] | | +- org.eclipse.jetty.websocket:websocket-common:jar:9.4.7.v20170914:compile
  16. [INFO] | | | \- org.eclipse.jetty.websocket:websocket-api:jar:9.4.7.v20170914:compile
  17. [INFO] | | +- org.eclipse.jetty.websocket:websocket-client:jar:9.4.7.v20170914:compile
  18. [INFO] | | | \- org.eclipse.jetty:jetty-client:jar:9.4.7.v20170914:compile
  19. [INFO] | | \- org.eclipse.jetty.websocket:websocket-servlet:jar:9.4.7.v20170914:compile
  20. [INFO] | | \- javax.servlet:javax.servlet-api:jar:3.1.0:compile
  21. [INFO] | +- org.eclipse.jetty.websocket:javax-websocket-server-impl:jar:9.4.7.v20170914:compile
  22. [INFO] | | +- org.eclipse.jetty:jetty-annotations:jar:9.4.7.v20170914:compile
  23. [INFO] | | | +- org.eclipse.jetty:jetty-plus:jar:9.4.7.v20170914:compile
  24. [INFO] | | | +- javax.annotation:javax.annotation-api:jar:1.2:compile
  25. [INFO] | | | +- org.ow2.asm:asm:jar:5.1:compile
  26. [INFO] | | | \- org.ow2.asm:asm-commons:jar:5.1:compile
  27. [INFO] | | | \- org.ow2.asm:asm-tree:jar:5.1:compile
  28. [INFO] | | +- org.eclipse.jetty.websocket:javax-websocket-client-impl:jar:9.4.7.v20170914:compile
  29. [INFO] | | \- javax.websocket:javax.websocket-api:jar:1.0:compile
  30. [INFO] | \- org.mortbay.jasper:apache-el:jar:8.0.33:compile

可看到tomcat已被替换为了jetty。

注意:spring-boot 2.5.4 以上版本默认网络服务器由tomcat变成了netty,这个时候配置根目录可以使用:

  1. spring:
  2. application:
  3. name: monitor-server
  4. webflux:
  5. base-path: /web

spring-boot-maven-plugin

spring-boot-maven-plugin为Spring Boot Maven插件,提供了:

  1. 把项目打包成一个可执行的超级JAR(uber-JAR),包括把应用程序的所有依赖打入JAR文件内,并为JAR添加一个描述文件,其中的内容能让你用java -jar来运行应用程序。
  2. 搜索public static void main()方法来标记为可运行类。

官方文档

全部文档:Spring Boot Reference Documentation

maven仓库:https://mvnrepository.com/

应用部署参考其中的 “How-to” Guides