了解spring-boot-starter

2022-12-01 21:29:08 浏览数 (2)

SpringBoot提供了针对日常企业应用研发各种场景的spring-boot-starter自动配置 依赖模块，如此多“开箱即用”的依赖模块，使得开发各种场景的Spring应用 更加快速和高效，本文会就几个常见的通用spring-boot-starter模块进行了解

一、约定优先于配置

所有的spring-boot-starter都有约定俗成的默认配置，但允许我们调整这些配置以改变默认的配置行为，即“约定优先于配置”。

简单来讲，我们可以将对SpringBoot的行为可以进行干预的配置方式划分 为几类：

  1. 命令行参数(Command Line Args)
  2. 系统环境变量(Environment Variables)
  3. 位于文件系统中的配置文件。
  4. 位于classpath中的配置文件。
  5. 固化到代码中的配置项。

以上几种方式按照优先级从高到低排列，高优先级方式提供的配置项可以覆盖或者 优先生效

不管是位于文件系统还是classpath, SpringBoot应用默认的配置文件名叫 作application.properties,可以直接放在当前项目的根目录下或者名称为config 的子目录下

二、应用日志和 spring-boot-starter-logging

Java的日志系统多种多样，从java.util默认提供的日志支持，到log4j、 Iog4j2、commons logging等,复杂繁多，所以，应用日志系统的配置就会比较特殊，从而spring-boot-starter-logging也比较特殊一些

假如 maven 依赖中添加了 spring-boot-starter-logging:

代码语言：javascript复制
<dependency>
	<groupId>org.spring.framework.boot</groupId>
	<artifactId>spring-boot-starter-logging</artifactId>
</dependency>

那么，我们的SpringBoot应用将自动使用logback作为应用日志框架， SpringBoot 启 动的时候，由 org.sprmgframework.boot.logging.Logging-Application- Listener根据情况初始化并使用。

SpringBoot为我们提供了很多默认的日志配置，所以，只要将spring-boot- starter-logging 作为依赖加入到当前应用的classpath,则"开箱即用”，不需要 做任何多余的配置，但假设我们要对默认SpringBoot提供的应用日志设定做调 整，则可以通过几种方式进行配置调整：

遵循logback的约定，在classpath中使用自己定制的logback.xml配置文件。

在文件系统中任何一个位置提供自己的logback.xml配置文件，然后通过logging.config配置项指向这个配置文件来启用它，比如在 application.properties中指定如下的配置。

代码语言：javascript复制
logging.config=/(some.path.you.defined}/any-logfile-name-1-like.log

SpringBoot默认允许我们通过在配置文件或者命令行等方式使用 logging.file和logging.path来自定义日志文件的名称和存放路径，不过， 这只是允许我们在SpringBoot框架预先定义的默认日志系统设定的基 础上做有限的设置，如果我们希望更灵活的配置，最好通过框架特定的 配置方式提供相应的配置文件，然后通过logging.config来启用

如果使用log4j或者Iog4j2,那么也可以釆用类似的方式将它们对应的spring-boot-starter依赖模块加到Maven依赖中即可：

代码语言：javascript复制
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-log4j </artifactId>
</dependency>

或者

代码语言：javascript复制
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-log4j2 </artifactId>
</dependency>

但一定不要将这些完成同一目的的spring-boot-starter都加到依赖中

三、快速Web应用开发与 spring-boot-starter-web

在这个互联网时代，使用Spring框架除了开发少数的独立应用，大部分 情况下实际上在使用SpringMVC开发web应用，为了帮我们简化快速搭建并 开发一个Web项目，SpringBoot为我们提供了 spring-boot-starter-web自动配 置模块。

只要将spring-boot-starter-web加入项目的maven依赖：

代码语言：javascript复制
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-web</artifactId>
</dependency>

我们就得到了一个直接可执行的Web应用，当前项目下运行mvn spring-boot:run就可以直接启动一个使用了嵌入式tomcat服务请求的Web 应用，只不过，我们还没有提供任何服务Web请求的Controller

接下来我们可以在当前项目下新建一个服务根路径Web请 求的Controller实现：

代码语言：javascript复制
@RestController
public class Indexcontroller{
	@RequestMapping("/")
	public String index(){
		return "hello, there";
	}
}

运行 mvn spring-boot:run 并访问 http://localhost:8080，我们的Controller返回消息，一个简单的Web应用就这样完成了。

但是，简单的背后，其实却有很多“潜规则”(约定)，我们只有充分了解 了这些"潜规则”，才能更好地应用spring-boot-starter-web

1、项目结构层面的约定

项目结构层面与传统打包为war的Java Web应用的差异在于，静态文件和 页面模板的存放位置变了，原来是放在src/main/webapp目录下的一系列资源, 现在都统一放在src/main/resources相应子目录下，比如：

  • src/main/resources/static用于存放各类静态资源，比如css, js等。
  • src/main/resources/templates 用于存放模板文件，比如 *.vm。

2、 SpringMVC框架层面的约定和定制

spring-boot-starter-web默认将为我们自动配置如下一些SpringMVC必要组件：

  • 必要的 ViewResolver,比如 ContentNegotiatingViewResolver 和 Bean- NameViewResolvero
  • 将必要的 Converter、GenericConverter 和 Formatter 等 bean 注册到 IoC 容器。
  • 添加一系列的HttpMessageConverter以便支持对Web请求和相应的类型 转换。
  • 自动配置和注册 MessageCodesResolvero
  • 其他

任何时候，如果我们对默认提供的SpringMVC组件设定不满意，都可 以在IoC容器中注册新的同类型的bean定义来替换，或者直接提供一个基于 WebMvcConfigurerAdapter类型的bean定义来定制，甚至直接提供一个标注了 @EnableWebMvc的©Configuration配置类完全接管所有SpringMVC的相关配 置，自己完全重新配置。

3、嵌入式Web容器层面的约定和定制

spring-boot-starter-web默认使用嵌入式tomcat作为web容器对外提供 HTTP服务，默认将使用8080端口对外监听和提供服务：

假设我们不想使用默认的嵌入式tomcat ( spring-boot-starter-tomcat自动配置模块)，那么可以引入 spring-boot-starter-jetty 或者 spring-boot-starter- undertow 作为替代方案。

假设我们不想使用默认的8080端口，那么我们可以通过更改配置项 server.port使用自己指定的端口，比如：server.port=9000

spring-boot-starter-web提供了很多以server.为前缀的配置项用于对嵌入式 Web容器提供配置，比如：

  • server.port
  • server, address
  • server, ssl.*
  • server, tomcat.*

此外SpringBoot甚至允许我们直接对嵌入式的 Web容器实例进行定制，但这里不过多赘述了

四、数据访问与 spring-boot-starter-jdbc

大部分Java应用都需要访问数据库，尤其是服务层，所以，SpringBoot会为我们自动配置相应的数据访问设施。

想SpringBoot为我们自动配置数据访问的基础设施，那么，我们需要 直接或者间接地依赖spring-jdbc, 一旦spring-jdbc位于我们SpringBoot应用 的classpath,即会触发数据访问相关的自动配置行为，最简单的做法就是把 spring-boot-starter-jdbc 加为应用的依赖。

代码语言：javascript复制
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>

默认情况下，如果我们没有配置任何DataSource,那么，SpringBoot会 为我们自动配置一个基于嵌入式数据库的DataSource,这种自动配置行为其 实很适合于测试场景，但对实际的开发帮助不大，基本上我们会自己配置一个 DataSource实例

假设我们的SpringBoot应用只依赖一个数据库，那么，使用DataSource 自动配置模块提供的配置参数是最方便的：

代码语言：javascript复制
spring.datasource.url=jdbc:mysql://(database host):3306/(databaseName)
spring.datasource.username=(database username}
spring.datasource.password={database password}

当然，自己配置一个DataSource也是可以的，SpringBoot也会智能地选择 我们自己配置的这个DataSource实例

另外，SpringBoot还提供了很多其他数据访问相关的自动配置模块，比如 spring-boot-starter-data-jpa`spring-boot-starter-data-mongodb `等，大家可以根据 自己数据访问的具体场景选择使用这些自动配置模块。

五、常见spring-boot-starter模块及功能

spring-boot-starter 这是Spring Boot的核心启动器，包含了自动配置、日志和YAML。

spring-boot-starter-amqp 通过spring-rabbit来支持AMQP协议（Advanced Message Queuing Protocol.）。

spring-boot-starter-aop 支持面向方面的编程即AOP，包括spring-aop和AspectJ。

spring-boot-starter-artemis 通过Apache Artemis支持JMS的API（Java Message Service API. 。

spring-boot-starter-batch 支持Spring Batch，包括HSQLDB数据库。

spring-boot-starter-cache 支持Spring的Cache抽象。

spring-boot-starter-cloud-connectors 支持Spring Cloud Connectors，简化了在像Cloud Foundry或Heroku这样的云平台上连接服务。

spring-boot-starter-data-elasticsearch 支持ElasticSearch搜索和分析引擎，包括spring-data-elasticsearch。

spring-boot-starter-data-gemfire 支持GemFire分布式数据存储，包括spring-data-gemfire。

spring-boot-starter-data-jpa 支持JPA（Java Persistence API. ，包括spring-data-jpa、spring-orm、Hibernate）。

spring-boot-starter-data-mongodb 支持MongoDB数据，包括spring-data-mongodb。

spring-boot-starter-data-rest 通过spring-data-rest-webmvc，支持通过REST暴露Spring Data数据仓库。

spring-boot-starter-data-solr 支持Apache Solr搜索平台，包括spring-data-solr。

spring-boot-starter-freemarker 支持FreeMarker模板引擎。

spring-boot-starter-groovy-templates 支持Groovy模板引擎。

spring-boot-starter-hateoas 通过spring-hateoas支持基于HATEOAS的RESTful Web服务。

spring-boot-starter-hornetq 通过HornetQ支持JMS。

spring-boot-starter-integration 支持通用的spring-integration模块。

spring-boot-starter-jdbc 支持JDBC数据库。

spring-boot-starter-jersey 支持Jersey RESTful Web服务框架。

spring-boot-starter-jta-atomikos 通过Atomikos支持JTA分布式事务处理。

spring-boot-starter-jta-bitronix 通过Bitronix支持JTA分布式事务处理。

spring-boot-starter-mail 支持javax.mail模块。

spring-boot-starter-mobile 支持spring-mobile。

spring-boot-starter-mustache 支持Mustache模板引擎。

spring-boot-starter-redis 支持Redis键值存储数据库，包括spring-redis。

spring-boot-starter-security 支持spring-security。基本的认证和授权功能，提供了加密解密、统一登录等一系列相关支持

spring-boot-starter-social-facebook 支持spring-social-facebook

spring-boot-starter-social-linkedin 支持pring-social-linkedin

spring-boot-starter-social-twitter 支持pring-social-twitter

spring-boot-starter-test 支持常规的测试依赖，包括JUnit、Hamcrest、Mockito以及spring-test模块。

spring-boot-starter-thymeleaf 支持Thymeleaf模板引擎，包括与Spring的集成。

spring-boot-starter-velocity 支持Velocity模板引擎。

spring-boot-starter-web S支持全栈式Web开发，包括Tomcat和spring-webmvc。

spring-boot-starter-websocket 支持WebSocket开发。

spring-boot-starter-ws 支持Spring Web Services。 Spring Boot应用启动器面向生产环境的还有2种，具体如下：

spring-boot-starter-actuator 增加了面向产品上线相关的功能，比如测量和监控。

spring-boot-starter-remote-shell 增加了远程ssh shell的支持。 最后，Spring Boot应用启动器还有一些替换技术的启动器，具体如下：

spring-boot-starter-jetty 引入了Jetty HTTP引擎（用于替换Tomcat. 。

spring-boot-starter-log4j 支持Log4J日志框架。

spring-boot-starter-logging 引入了Spring Boot默认的日志框架Logback。

spring-boot-starter-tomcat 引入了Spring Boot默认的HTTP引擎Tomcat。

spring-boot-starter-undertow 引入了Undertow HTTP引擎（用于替换Tomcat.

参考：

  • 《SpringBoot揭秘 快速构建微服务体系》 第四章
  • SpringBoot 之Spring Boot Starter依赖包及作用
spring 日志服务 网站 嵌入式 html

0 人点赞