一、解析 pom.xml 文件
(1)让我们来看看默认生成的 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>
<!--springboot版本的控制-->
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.5.7</version> <!--如果未来你要升级springboot修改此处的版本就可以了-->
<relativePath/>
</parent>
<!--项目的maven的坐标骨架,把当前项目生成在本地仓库的目录-->
<groupId>com.kuangstudy</groupId>
<artifactId>springboot</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>springboot</name>
<description>springboot</description>
<!--maven属性配置,一般用来做version控制居多-->
<properties>
<java.version>1.8</java.version>
</properties>
<!--项目依赖-->
<dependencies>
<!--springboot的web的starter-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!--lombok-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<!--springboot的test的starter-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<!--springboto的插件,用来打包和构建使用-->
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<excludes>
<exclude>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</exclude>
</excludes>
</configuration>
</plugin>
</plugins>
</build>
</project>
(2)我们可以看到一个比较陌生一些的标签 ,这个标签是在配置 Spring Boot 的父级依赖:
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.5.8</version>
<relativePath/>
</parent>
有了这个,当前的项目才是 Spring Boot 项目,spring-boot-starter-parent 是一个特殊的 starter ,它用来提供相关的 Maven 默认依赖,使用它之后,常用的包依赖就可以省去 version 标签。
下面的版本为什么不加version号:
<!--springboot的web的starter-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
因为:spring-boot-starter-parent 是一个父工程,spring-boot-starter-web和spring-boot-starter-test等都是子工程,而子工程的版本都已经由父工程已经管理起来了。所以在项目开发中我们就不需要指定版本号。那到底parent工程管理了多少呢?点击进去查看一下呗:其实马上要讲的 starter。
<activemq.version>5.16.3</activemq.version>
<antlr2.version>2.7.7</antlr2.version>
<appengine-sdk.version>1.9.91</appengine-sdk.version>
<artemis.version>2.17.0</artemis.version>
<aspectj.version>1.9.7</aspectj.version>
<assertj.version>3.19.0</assertj.version>
<atomikos.version>4.0.6</atomikos.version>
<awaitility.version>4.0.3</awaitility.version>
<build-helper-maven-plugin.version>3.2.0</build-helper-maven-plugin.version>
<byte-buddy.version>1.10.22</byte-buddy.version>
<caffeine.version>2.9.2</caffeine.version>
<cassandra-driver.version>4.11.3</cassandra-driver.version>
<classmate.version>1.5.1</classmate.version>
<commons-codec.version>1.15</commons-codec.version>
<commons-dbcp2.version>2.8.0</commons-dbcp2.version>
<commons-lang3.version>3.12.0</commons-lang3.version>
<commons-pool.version>1.6</commons-pool.version>
<commons-pool2.version>2.9.0</commons-pool2.version>
<couchbase-client.version>3.1.7</couchbase-client.version>
<db2-jdbc.version>11.5.6.0</db2-jdbc.version>
<dependency-management-plugin.version>1.0.11.RELEASE</dependency-management-plugin.version>
<derby.version>10.14.2.0</derby.version>
<dropwizard-metrics.version>4.1.25</dropwizard-metrics.version>
<ehcache.version>2.10.9.2</ehcache.version>
<ehcache3.version>3.9.5</ehcache3.version>
<elasticsearch.version>7.12.1</elasticsearch.version>
<embedded-mongo.version>3.0.0</embedded-mongo.version>
<flyway.version>7.7.3</flyway.version>
<freemarker.version>2.3.31</freemarker.version>
<git-commit-id-plugin.version>4.0.5</git-commit-id-plugin.version>
<glassfish-el.version>3.0.3</glassfish-el.version>
<glassfish-jaxb.version>2.3.5</glassfish-jaxb.version>
<groovy.version>3.0.8</groovy.version>
<gson.version>2.8.7</gson.version>
<h2.version>1.4.200</h2.version>
<hamcrest.version>2.2</hamcrest.version>
<hazelcast.version>4.1.5</hazelcast.version>
<hazelcast-hibernate5.version>2.2.1</hazelcast-hibernate5.version>
<hibernate.version>5.4.32.Final</hibernate.version>
<hibernate-validator.version>6.2.0.Final</hibernate-validator.version>
<hikaricp.version>4.0.3</hikaricp.version>
<hsqldb.version>2.5.2</hsqldb.version>
<htmlunit.version>2.49.1</htmlunit.version>
<httpasyncclient.version>4.1.4</httpasyncclient.version>
<httpclient.version>4.5.13</httpclient.version>
<httpclient5.version>5.0.4</httpclient5.version>
<httpcore.version>4.4.14</httpcore.version>
<httpcore5.version>5.1.1</httpcore5.version>
<infinispan.version>12.1.7.Final</infinispan.version>
<influxdb-java.version>2.21</influxdb-java.version>
<jackson-bom.version>2.12.4</jackson-bom.version>
<jakarta-activation.version>1.2.2</jakarta-activation.version>
<jakarta-annotation.version>1.3.5</jakarta-annotation.version>
<jakarta-jms.version>2.0.3</jakarta-jms.version>
<jakarta-json.version>1.1.6</jakarta-json.version>
<jakarta-json-bind.version>1.0.2</jakarta-json-bind.version>
<jakarta-mail.version>1.6.7</jakarta-mail.version>
<jakarta-persistence.version>2.2.3</jakarta-persistence.version>
<jakarta-servlet.version>4.0.4</jakarta-servlet.version>
<jakarta-servlet-jsp-jstl.version>1.2.7</jakarta-servlet-jsp-jstl.version>
<jakarta-transaction.version>1.3.3</jakarta-transaction.version>
<jakarta-validation.version>2.0.2</jakarta-validation.version>
<jakarta-websocket.version>1.1.2</jakarta-websocket.version>
<jakarta-ws-rs.version>2.1.6</jakarta-ws-rs.version>
<jakarta-xml-bind.version>2.3.3</jakarta-xml-bind.version>
<jakarta-xml-soap.version>1.4.2</jakarta-xml-soap.version>
<jakarta-xml-ws.version>2.3.3</jakarta-xml-ws.version>
<janino.version>3.1.6</janino.version>
<javax-activation.version>1.2.0</javax-activation.version>
<javax-annotation.version>1.3.2</javax-annotation.version>
<javax-cache.version>1.1.1</javax-cache.version>
<javax-jaxb.version>2.3.1</javax-jaxb.version>
<javax-jaxws.version>2.3.1</javax-jaxws.version>
<javax-jms.version>2.0.1</javax-jms.version>
<javax-json.version>1.1.4</javax-json.version>
<javax-jsonb.version>1.0</javax-jsonb.version>
<javax-mail.version>1.6.2</javax-mail.version>
<javax-money.version>1.1</javax-money.version>
<javax-persistence.version>2.2</javax-persistence.version>
<javax-transaction.version>1.3</javax-transaction.version>
<javax-validation.version>2.0.1.Final</javax-validation.version>
<javax-websocket.version>1.1</javax-websocket.version>
<jaxen.version>1.2.0</jaxen.version>
<jaybird.version>4.0.3.java8</jaybird.version>
<jboss-logging.version>3.4.2.Final</jboss-logging.version>
<jboss-transaction-spi.version>7.6.1.Final</jboss-transaction-spi.version>
<jdom2.version>2.0.6</jdom2.version>
<jedis.version>3.6.3</jedis.version>
<jersey.version>2.33</jersey.version>
<jetty-el.version>9.0.48</jetty-el.version>
<jetty-jsp.version>2.2.0.v201112011158</jetty-jsp.version>
<jetty-reactive-httpclient.version>1.1.10</jetty-reactive-httpclient.version>
<jetty.version>9.4.43.v20210629</jetty.version>
<jmustache.version>1.15</jmustache.version>
<johnzon.version>1.2.14</johnzon.version>
<jolokia.version>1.6.2</jolokia.version>
<jooq.version>3.14.13</jooq.version>
<json-path.version>2.5.0</json-path.version>
<json-smart.version>2.4.7</json-smart.version>
<jsonassert.version>1.5.0</jsonassert.version>
<jstl.version>1.2</jstl.version>
<jtds.version>1.3.1</jtds.version>
<junit.version>4.13.2</junit.version>
<junit-jupiter.version>5.7.2</junit-jupiter.version>
<kafka.version>2.7.1</kafka.version>
<kotlin.version>1.5.21</kotlin.version>
<kotlin-coroutines.version>1.5.1</kotlin-coroutines.version>
<lettuce.version>6.1.4.RELEASE</lettuce.version>
<liquibase.version>4.3.5</liquibase.version>
<log4j2.version>2.14.1</log4j2.version>
<logback.version>1.2.5</logback.version>
<lombok.version>1.18.20</lombok.version>
<mariadb.version>2.7.4</mariadb.version>
<maven-antrun-plugin.version>1.8</maven-antrun-plugin.version>
<maven-assembly-plugin.version>3.3.0</maven-assembly-plugin.version>
<maven-clean-plugin.version>3.1.0</maven-clean-plugin.version>
<maven-compiler-plugin.version>3.8.1</maven-compiler-plugin.version>
<maven-dependency-plugin.version>3.1.2</maven-dependency-plugin.version>
<maven-deploy-plugin.version>2.8.2</maven-deploy-plugin.version>
<maven-enforcer-plugin.version>3.0.0</maven-enforcer-plugin.version>
<maven-failsafe-plugin.version>2.22.2</maven-failsafe-plugin.version>
<maven-help-plugin.version>3.2.0</maven-help-plugin.version>
<maven-install-plugin.version>2.5.2</maven-install-plugin.version>
<maven-invoker-plugin.version>3.2.2</maven-invoker-plugin.version>
<maven-jar-plugin.version>3.2.0</maven-jar-plugin.version>
<maven-javadoc-plugin.version>3.2.0</maven-javadoc-plugin.version>
<maven-resources-plugin.version>3.2.0</maven-resources-plugin.version>
<maven-shade-plugin.version>3.2.4</maven-shade-plugin.version>
<maven-source-plugin.version>3.2.1</maven-source-plugin.version>
<maven-surefire-plugin.version>2.22.2</maven-surefire-plugin.version>
<maven-war-plugin.version>3.3.1</maven-war-plugin.version>
<micrometer.version>1.7.3</micrometer.version>
<mimepull.version>1.9.15</mimepull.version>
<mockito.version>3.9.0</mockito.version>
<mongodb.version>4.2.3</mongodb.version>
<mssql-jdbc.version>9.2.1.jre8</mssql-jdbc.version>
<mysql.version>8.0.26</mysql.version>
<nekohtml.version>1.9.22</nekohtml.version>
<neo4j-java-driver.version>4.2.7</neo4j-java-driver.version>
<netty.version>4.1.67.Final</netty.version>
<netty-tcnative.version>2.0.40.Final</netty-tcnative.version>
<oauth2-oidc-sdk.version>9.9.1</oauth2-oidc-sdk.version>
<nimbus-jose-jwt.version>9.10.1</nimbus-jose-jwt.version>
<ojdbc.version>19.3.0.0</ojdbc.version>
<okhttp3.version>3.14.9</okhttp3.version>
<oracle-database.version>21.1.0.0</oracle-database.version>
<pooled-jms.version>1.2.2</pooled-jms.version>
<postgresql.version>42.2.23</postgresql.version>
<prometheus-pushgateway.version>0.10.0</prometheus-pushgateway.version>
<quartz.version>2.3.2</quartz.version>
<querydsl.version>4.4.0</querydsl.version>
<r2dbc-bom.version>Arabba-SR10</r2dbc-bom.version>
<rabbit-amqp-client.version>5.12.0</rabbit-amqp-client.version>
<reactive-streams.version>1.0.3</reactive-streams.version>
<reactor-bom.version>2020.0.10</reactor-bom.version>
<rest-assured.version>4.3.3</rest-assured.version>
<rsocket.version>1.1.1</rsocket.version>
<rxjava.version>1.3.8</rxjava.version>
<rxjava-adapter.version>1.2.1</rxjava-adapter.version>
<rxjava2.version>2.2.21</rxjava2.version>
<saaj-impl.version>1.5.3</saaj-impl.version>
<selenium.version>3.141.59</selenium.version>
<selenium-htmlunit.version>2.49.1</selenium-htmlunit.version>
<sendgrid.version>4.7.4</sendgrid.version>
<servlet-api.version>4.0.1</servlet-api.version>
<slf4j.version>1.7.32</slf4j.version>
<snakeyaml.version>1.28</snakeyaml.version>
<solr.version>8.8.2</solr.version>
<spring-amqp.version>2.3.10</spring-amqp.version>
<spring-batch.version>4.3.3</spring-batch.version>
<spring-data-bom.version>2021.0.4</spring-data-bom.version>
<spring-framework.version>5.3.9</spring-framework.version>
<spring-hateoas.version>1.3.3</spring-hateoas.version>
<spring-integration.version>5.5.3</spring-integration.version>
<spring-kafka.version>2.7.6</spring-kafka.version>
<spring-ldap.version>2.3.4.RELEASE</spring-ldap.version>
<spring-restdocs.version>2.0.5.RELEASE</spring-restdocs.version>
<spring-retry.version>1.3.1</spring-retry.version>
<spring-security.version>5.5.2</spring-security.version>
<spring-session-bom.version>2021.0.2</spring-session-bom.version>
<spring-ws.version>3.1.1</spring-ws.version>
<sqlite-jdbc.version>3.34.0</sqlite-jdbc.version>
<sun-mail.version>1.6.7</sun-mail.version>
<thymeleaf.version>3.0.12.RELEASE</thymeleaf.version>
<thymeleaf-extras-data-attribute.version>2.0.1</thymeleaf-extras-data-attribute.version>
<thymeleaf-extras-java8time.version>3.0.4.RELEASE</thymeleaf-extras-java8time.version>
<thymeleaf-extras-springsecurity.version>3.0.4.RELEASE</thymeleaf-extras-springsecurity.version>
<thymeleaf-layout-dialect.version>2.5.3</thymeleaf-layout-dialect.version>
<tomcat.version>9.0.52</tomcat.version>
<unboundid-ldapsdk.version>4.0.14</unboundid-ldapsdk.version>
<undertow.version>2.2.10.Final</undertow.version>
<versions-maven-plugin.version>2.8.1</versions-maven-plugin.version>
<webjars-hal-browser.version>3325375</webjars-hal-browser.version>
<webjars-locator-core.version>0.46</webjars-locator-core.version>
<wsdl4j.version>1.6.3</wsdl4j.version>
那什么情况下的依赖需要去指定版本号呢?
-
不想用这个版本号的时候
-
第三方开发的starter就必须指定版本号。
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.4.2</version>
</dependency>
-
上面没有提供的就必须指定版本号
- 首先我不加版本号,看能不能下载,如果能拿忽略
- 如果不加下载不下例子啊,我就就指定版本号。
-
可能版本出来冲突,也可能会指定版本号。
关于具体 Spring Boot 提供了哪些 jar 包的依赖,我们可spring-boot-starter-web以查看本地 Maven 仓库下:\repository\org\springframework\boot\spring-boot-dependencies\2.5.7RELEASE\spring-boot-dependencies-2.5.7.RELEASE.pom 文件来查看,挺长的…
二、应用入口类 SpringbootApplication&核心注解
官网:https://docs.spring.io/spring-boot/docs/2.5.8-SNAPSHOT/reference/htmlsingle/#getting-started.installing
许多 Spring Boot 开发人员喜欢他们的应用程序使用自动配置、组件扫描并能够在他们的“应用程序类”上定义额外的配置。@SpringBootApplication
可以使用单个注释来启用这三个功能,即:
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan
@EnableAutoConfiguration
: 启用Spring Boot 的自动配置机制 其实告诉为什么项目里能够自动把各种starter依赖进来以后就能够使用和生效。就是这个注解来完成。
@ComponentScan
:@Component
在应用程序所在的包上启用扫描(查看最佳实践)在传统的spring开发中,我们如果要进行包的扫描,就必须去在配置文件xml指定。如下:
<component-scan base-package="com.xxx.service"></component-scan>
<component-scan base-package="com.xxx.dao"></component-scan>
<component-scan base-package="com.xxx.web"></component-scan>
上面的方式是传统的加载bean到springioc容器的方式,目的是告诉spring容器在启动的时候会去扫描上面的三个目录,然后找到这个包下所有的类,并且加了@Service ,@Conpoment、@Controller、@Repository等,会加入ioc容器,其它不会加载。
springboot的默认加载机制:是以当前启动的类包作为component-scan默认扫描的包。
@SpringBootConfiguration
: 启用在上下文中注册额外的 bean 或导入额外的配置类。Spring 标准的替代方案@Configuration
,可帮助您在集成测试中检测配置。
@SpringBootApplication // same as @SpringBootConfiguration @EnableAutoConfiguration @ComponentScan
public class MyApplication {
public static void main(String[] args) {
SpringApplication.run(MyApplication.class, args);
}
}
- 配置类必须加注解@Configuration 或者@SpringBootConfiguration
- 和@ComponentScan 的作用是一样的。
总结
springboot核心注解:@SpringBootApplication ,它是由
- @ComponentScan
- @SpringConguration
- @EnableAutoConfiguration
三个注解的复合。三个注解的作用:都是把项目中bean,第三容器的bean,把官方提供starter的配置类的bean加载springioc容器的作用:
-
@ComponentScan:是把你项目中,自己编写的那些bean加载ioc容器中,比如:UserService,UserMapper.UserConntroller
-
@EnableAutoConfiguration :是把官方提供starter里面,内置的配置类的bean加载ioc容器冲
- 内部提供的配置类:xxxxAutoConfiguration 比如:
- RedisAutoConfiguration 这些都配置类
-
@SpringConfiguration:+@Bean (避免重复造轮子)
-
如果你对官方的starter提供的配置不满意,你可以考虑用这个放去覆盖内部的配置。
-
或者未来你要自己去扩展starter机制,就必须自己去定义配置类。(自定义starter)
- 方便扩展,可以便于后续去开发的依赖公共模板
- 或者未来你想自定义starter你就可以用配置类完成。
-
传统的方式的扩展,通过xml去配置,配置类就是xml的替代。
-
@SpringConfiguration+@Bean 更深层次含义:就说官方没提供的你自己去扩展把。
-
==@Bean必须要配置配置,或者@Component组件或者其子组件都有用。否则无意义。==但是还推荐:配置注解
-
最后:无论上面那种方式,其目的都是把项目中,其他人写好的,或官方的提供的bean记载到ioc容器中。
三、SpringBoot的全局配置文件
查看官网地址:https://docs.spring.io/spring-boot/docs/2.5.8-SNAPSHOT/reference/htmlsingle/#application-properties
Spring Boot 使用一个全局的配置文件 application.properties 或 application.yml,放置在【src/main/resources】目录或者类路径的 /config 下。Spring Boot 不仅支持常规的 properties 配置文件,还支持 yaml 语言的配置文件。yaml 是以数据为中心的语言,在配置数据的时候具有面向对象的特征。Spring Boot 的全局配置文件的作用是对一些默认配置的配置值进行修改。
写法:
server:
port: 8081
上方的:value
的时候,一定至少要有一个空格。
修改 properties 配置文件实例:
(1)打开 resources 下的 application.yml
(2)在这里我们可以设置访问的端口,将 Tomcat 默认端口设置为 8080 (默认的不修改) ,并将默认的访问路径从 “/” 修改为 “/cn” 时,再访问 http://localhost:8080/ 是什么都没有的,此时要访问 hello 是要使用 http://localhost:8080/cn/hello
(3)使用 yml 文件作为配置文件,我们直接把 .properties 后缀的文件删掉,使用 .yml 文件来进行简单的配置
(4)在然后使用在我们的 HelloController.java 类中使用 @Value 来获取配置属性,代码(请看注释):
package com.xpwi.springboot;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/**
* 测试控制器
*
* @author: @肖朋伟CSDN
* @create: 2018-11-18
*/
@RestController
public class HelloController {
// 获取.yml 文件中值
@Value("${name}")
private String name;
// 获取 age
@Value("${csdnUrl}")
private String csdnUrl;
//路径映射,对应浏览器访问的地址,访问该路径则执行下面函数
@RequestMapping("/hello")
public String hello() {
return name + " CSDN 博客:"+ csdnUrl;
}
}
(5)重启 Spring Boot ,输入地址:http://localhost:8080/hello 能看到正确的结果:
总结
大家可能会有疑虑,springboot不是说没有xml配置文件吗?那application.yml是什么东西?
传统的所谓spring的xml文件是指,用初始化bean的文件,而application.yml它仅仅只是一个属性配置文件。因为官方提供了很多的starter(我官方提供很多的配置类),但是这个配置的信息我是不可能写死的,所以我提供配置属性类,让你进行扩展和覆盖。所以这个application.yml是一个全局属性配置文件,在这里配置的信息是覆盖starter中提供配置的类的信息。
RedisAutoConfiguration.java + RedisProerpties.java
RedisProerpties.java : 属性配置类。它的配置就是application.yml去配置信息,
*如果没有这个机制。你思考这个问题吗?我们指定连接redis需要指定ip和端口,和密码? 假设你提供的ip:152.150.47.5 port:6378 pwd:154545 .。思考我如何把这ip、端口、 密码等让RedisAutoConfiguration.java去知晓。你不可能说去改源码重新编译。如果是这样的话,我还不自己去写一个RedisConfiguration.java。所以官方已经想的很清楚了。每个配置类如果未来需要动态配置和修改里面的参数,就必须提供属性配置类:xxxProperties. 而我们在application.yml配置的属性都是给xxxProperties.java类的属性进行赋值。原理就是:
-
第一步:读取你项目的applicaiton.yml文件内容到内存中
-
第二步:然后通过前缀 spring.redis ,找到你的类xxxProperties。
@ConfigurationProperties(prefix="spring.redis")
public class RedisProperties(){
private String ip;
}
spring:
redis:
ip: 127.0.0.1
- 第三步:通过反射把对应配置文件的值,映射到xxxProperties的属性中去
总结
application.yml会把这个文件称之为:全职属性配置文件
【注意】:此时如果你第一次使用 idea 出现中文乱码,解决办法:
- 然后在修改idea的encoding统一成:UTF-8
- 如果遇到yml文件保存,先把里面中文全部剔除
- 如果实在不行,把文件删除,重新创建,然后复制和粘贴。