Spring Boot整合Web項(xiàng)目常用功能詳解
前言
在Web應(yīng)用開發(fā)過程中,一般都涵蓋一些常用功能的實(shí)現(xiàn),如數(shù)據(jù)庫訪問、異常處理、消息隊(duì)列、緩存服務(wù)、OSS服務(wù),以及接口日志配置,接口文檔生成等。如果每個(gè)項(xiàng)目都來一套,則既費(fèi)力又難以維護(hù)。可以通過Spring Boot的Starter來將這些常用功能進(jìn)行整合與集中維護(hù),以達(dá)到開箱即用的目的。
項(xiàng)目基于Spring Boot 2.1.5.RELEASE 版。
項(xiàng)目地址
整個(gè)項(xiàng)目分為如下幾部分:
- spring-boot-autoconfigure: 具體的各功能實(shí)現(xiàn),每個(gè)功能通過package的形式組織
- spring-boot-commons: 一些公共的工具類或共享類
- spring-boot-dependencies: 依賴的集中維護(hù)管理,集中管理各個(gè)依賴的版本號
- spring-boot-parent: 提供一個(gè)基本的父項(xiàng)目,web服務(wù)項(xiàng)目可通過繼承該項(xiàng)目創(chuàng)建
- spring-boot-starters: 各功能的starter項(xiàng)目,引入相應(yīng)starter即引入相應(yīng)功能
spring-boot-dependencies 項(xiàng)目
該項(xiàng)目主要是對所有依賴進(jìn)行集中定義。通過 dependencyManagement 對依賴進(jìn)行聲明,
<dependencyManagement> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-dependencies</artifactId> <version>${spring-boot.version}</version> <scope>import</scope> <type>pom</type> </dependency> <dependency> <groupId>cn.jboost.springboot</groupId> <artifactId>spring-boot-commons</artifactId> <version>${base-spring-boot.version}</version> </dependency> ... </dependencies> </dependencyManagement>
這樣,所有依賴的版本可以集中統(tǒng)一管理,在其它地方引用的時(shí)候可以省去版本的聲明,如
<dependency> <groupId>org.springframework</groupId> <artifactId>spring-webmvc</artifactId> <optional>true</optional> </dependency>
spring-boot-autoconfigure 項(xiàng)目
該項(xiàng)目是各功能自動(dòng)配置的具體實(shí)現(xiàn),以package的形式進(jìn)行組織,如 tkmapper 包下實(shí)現(xiàn)了通用Mapper的自動(dòng)配置,error 包下實(shí)現(xiàn)了錯(cuò)誤處理的自動(dòng)配置, 等等。
該項(xiàng)目繼承了spring-boot-dependencies, 在項(xiàng)目的 pom.xml 中,依賴部分聲明類似于
<dependencies> <!-- spring denpendencies --> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-webmvc</artifactId> <optional>true</optional> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-jdbc</artifactId> <optional>true</optional> </dependency> ... </dependencies>
不需要再指定版本號。通過將optional設(shè)置為true,表示該依賴不會(huì)進(jìn)行傳遞,即另外一個(gè)項(xiàng)目引用該項(xiàng)目時(shí),optional的依賴不會(huì)被傳遞依賴過去。
在 resources/META-INF/spring.factories 文件中,聲明了所有自動(dòng)配置類, 如下
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ cn.jboost.springboot.autoconfig.tkmapper.MapperAutoConfiguration,\ cn.jboost.springboot.autoconfig.aoplog.AopLoggerAutoConfiguration,\ cn.jboost.springboot.autoconfig.alimq.config.AliMQAutoConfiguration,\ cn.jboost.springboot.autoconfig.qiniu.QiniuAutoConfiguration,\ cn.jboost.springboot.autoconfig.swagger.Swagger2AutoConfiguration,\ cn.jboost.springboot.autoconfig.druid.DruidAutoConfiguration,\ cn.jboost.springboot.autoconfig.error.exception.ExceptionHandlerAutoConfiguration,\ cn.jboost.springboot.autoconfig.alimns.MnsAutoConfiguration,\ cn.jboost.springboot.autoconfig.redis.RedisClientAutoConfiguration,\ cn.jboost.springboot.autoconfig.web.CORSAutoConfiguration
spring-boot-starters 項(xiàng)目
該項(xiàng)目包含按功能劃分的多個(gè)子項(xiàng)目,主要用來引入依賴以達(dá)到自動(dòng)配置的依賴條件,使引入對應(yīng)starter時(shí),能讓自動(dòng)配置生效。如通用Mapper集成的 tkmapper-spring-boot-starter 依賴如下
<dependencies> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-jdbc</artifactId> </dependency> <dependency> <groupId>tk.mybatis</groupId> <artifactId>mapper</artifactId> </dependency> <dependency> <groupId>org.mybatis</groupId> <artifactId>mybatis</artifactId> </dependency> <dependency> <groupId>org.mybatis</groupId> <artifactId>mybatis-spring</artifactId> </dependency> </dependencies>
同時(shí)在 resources/META-INF/spring.provides 里聲明了該starter的用途,這里可隨意編寫。
spring-boot-commons 項(xiàng)目
可將一些常用的工具類, 或共享類放到這個(gè)項(xiàng)目中。比如一些常量定義,加解密工具類等。
spring-boot-parent 項(xiàng)目
該項(xiàng)目將Web應(yīng)用需要的一些常見功能整合進(jìn)來,應(yīng)用項(xiàng)目可繼承該項(xiàng)目進(jìn)行構(gòu)建,從而直接引入相應(yīng)的功能。
在接下來的spring boot系列博文中,將一一詳細(xì)介紹各功能的整合集成與應(yīng)用。同時(shí)會(huì)不斷更新與完善,以達(dá)到能直接用于生產(chǎn)項(xiàng)目的水平。
以上就是本文的全部內(nèi)容,希望對大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。
相關(guān)文章
springboot項(xiàng)目引入外部jar包的詳細(xì)圖文教程
在項(xiàng)目中有時(shí)候需要引入外部jar包,啟動(dòng)運(yùn)行,下面這篇文章主要給大家介紹了關(guān)于springboot項(xiàng)目引入外部jar包的詳細(xì)圖文教程,需要的朋友可以參考下2023-09-09SpringBoot讀取resource文件代碼實(shí)例
這篇文章主要介紹了SpringBoot讀取resource文件代碼實(shí)例,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-04-04springcloud安裝rabbitmq并配置延遲隊(duì)列插件的過程詳解
本期主要講解如何利用docker快速安裝rabbitmq并且配置延遲隊(duì)列插件,本文給大家介紹的非常詳細(xì),對大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2022-05-05關(guān)于springboot 配置文件中屬性變量引用方式@@解析
這篇文章主要介紹了關(guān)于springboot 配置文件中屬性變量引用方式@@解析,具有很好的參考價(jià)值,希望對大家有所幫助。一起跟隨小編過來看看吧2020-04-04mybatis 運(yùn)行時(shí)加載自定義mapper文件方式
這篇文章主要介紹了mybatis 運(yùn)行時(shí)加載自定義mapper文件方式,具有很好的參考價(jià)值,希望對大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2021-07-07SpringBoot用JdbcTemplates操作Mysql實(shí)例代碼詳解
JdbcTemplate是Spring框架自帶的對JDBC操作的封裝,目的是提供統(tǒng)一的模板方法使對數(shù)據(jù)庫的操作更加方便、友好,效率也不錯(cuò),這篇文章主要介紹了SpringBoot用JdbcTemplates操作Mysql2022-10-10