Spring Boot2從入門到實戰：整合Web項目經常使用功能

時間 2019-11-26

標籤 spring boot2 boot 入門實戰整合 web 項目經常使用功能欄目 Spring 简体版

原文原文鏈接

在Web應用開發過程當中，通常都涵蓋一些經常使用功能的實現，如數據庫訪問、異常處理、消息隊列、緩存服務、OSS服務，以及接口日誌配置，接口文檔生成等。若是每一個項目都來一套，則既費力又難以維護。能夠經過Spring Boot的Starter來將這些經常使用功能進行整合與集中維護，以達到開箱即用的目的。html

項目基於Spring Boot 2.1.5.RELEASE 版。
項目地址： https://github.com/ronwxy/base-spring-bootgit

整個項目分爲以下幾部分：github

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

spring-boot-dependencies 項目

該項目主要是對全部依賴進行集中定義。經過 dependencyManagement 對依賴進行聲明，web

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

這樣，全部依賴的版本能夠集中統一管理，在其它地方引用的時候能夠省去版本的聲明，如redis

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

spring-boot-autoconfigure 項目

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

該項目繼承了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 文件中，聲明瞭全部自動配置類，以下springboot

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>