Spring Boot從入門到實戰：整合Web專案常用功能

【空山新雨】發表於2019-06-21
Spring BootWeb

在Web應用開發過程中，一般都涵蓋一些常用功能的實現，如資料庫訪問、異常處理、訊息佇列、快取服務、OSS服務，以及介面日誌配置，介面文件生成等。如果每個專案都來一套，則既費力又難以維護。可以通過Spring Boot的Starter來將這些常用功能進行整合與集中維護，以達到開箱即用的目的。

專案基於Spring Boot 2.1.5.RELEASE 版。
專案地址： https://github.com/ronwxy/base-spring-boot

 

整個專案分為如下幾部分：

  • spring-boot-autoconfigure： 具體的各功能實現，每個功能通過package的形式組織
  • spring-boot-commons： 一些公共的工具類或共享類
  • spring-boot-dependencies： 依賴的集中維護管理，集中管理各個依賴的版本號
  • spring-boot-parent： 提供一個基本的父專案，web服務專案可通過繼承該專案建立
  • spring-boot-starters： 各功能的starter專案，引入相應starter即引入相應功能

spring-boot-dependencies 專案

該專案主要是對所有依賴進行集中定義。通過 dependencyManagement 對依賴進行宣告，

<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>

 

這樣，所有依賴的版本可以集中統一管理，在其它地方引用的時候可以省去版本的宣告，如

<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-webmvc</artifactId>
    <optional>true</optional>
</dependency>

 

spring-boot-autoconfigure 專案

該專案是各功能自動配置的具體實現，以package的形式進行組織，如 tkmapper 包下實現了通用Mapper的自動配置，error 包下實現了錯誤處理的自動配置， 等等。

該專案繼承了spring-boot-dependencies， 在專案的 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設定為true，表示該依賴不會進行傳遞，即另外一個專案引用該專案時，optional的依賴不會被傳遞依賴過去。

在 resources/META-INF/spring.factories 檔案中，宣告瞭所有自動配置類， 如下

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 專案

該專案包含按功能劃分的多個子專案，主要用來引入依賴以達到自動配置的依賴條件，使引入對應starter時，能讓自動配置生效。如通用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>

同時在 resources/META-INF/spring.provides 裡宣告瞭該starter的用途，這裡可隨意編寫。

 

spring-boot-commons 專案

可將一些常用的工具類， 或共享類放到這個專案中。比如一些常量定義，加解密工具類等。

 

spring-boot-parent 專案

該專案將Web應用需要的一些常見功能整合進來，應用專案可繼承該專案進行構建，從而直接引入相應的功能。

在接下來的spring boot系列博文中，將一一詳細介紹各功能的整合整合與應用。同時會不斷更新與完善，以達到能直接用於生產專案的水平。



Spring Boot入門到實戰彙總：https://www.cnblogs.com/spec-dog/p/11062994.html

 


我的個人部落格地址：http://blog.jboost.cn
我的頭條空間： https://www.toutiao.com/c/user/5833678517/#mid=1636101215791112
我的github地址：https://github.com/ronwxy
我的微信公眾號：jboost-ksxy

—————————————————————————————————————————————————

微信公眾號
歡迎關注我的微信公眾號，及時獲取最新分享

相關文章