第 11 节 starter 包的设计与如何自定义

港控/mmm° 2022-11-11 05:27 94阅读 0赞

### 1 starter 包 ###

在前面介绍 SpringBoot 框架的设计初衷时我们提到，通过 Spring 框架开发应用的其中一个不足之处就是需要解决不同功能 jar 包之间的版本冲突问题，如在 pom.xml 文件中配置了两个功能 jar 包，由于这两个 jar 包都引用了同一个类而导致类冲突，此时需要花费大量的时间来折腾解决这种问题。另外就是需要记住实现某个功能所需的所有 jar 包，如果漏掉某个，则可能导致程序启动失败。

所以为了解决这两个问题，SpringBoot 框架设计了 starter 包。对于实现某个功能会用到的多个 jar 包，由 SpringBoot 团队统一测试和解决好版本冲突问题，统一打包到一个 starter 包中并且为该 starter 包指定一个版本号。这样应用开发人员只需要引入这个已解决好版本冲突问题的 starter 包即可，而不需要一个个配置这多个 jar 包，进一步简化了开发难度，减少了开发工作量。

#### 1.1 starter 包的设计 ####

##### 1.1.1 统一的版本管理 #####

在基于 SpringBoot 搭建的项目中，我们不需要在 maven 的 jar 包管理文件 pom.xml 为 starter 包指定版本号，只需要指定该 starter 包的 groupId 和 artifactId 即可。不过需要在 pom.xml 中使用 parent 标签指定 SpringBoot 框架或者称为当前所有的 starter 包的版本号，具体如下：该配置使用的是 SpringBoot 的 2.1.7 版本。

<parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.7.RELEASE</version>
        <relativePath/> 
    </parent>

所以 SpringBoot 是通过 spring-boot-starter-parent 这个特殊的 starter 包来统一管理所有其他 starter 包的版本的。同时，在项目中，通过 maven 的 parent 标签来使用 maven 的继承机制，使得这种统一版本管理的机制生效。

通过统一的版本管理，我们只需要根据业务需求，引入对应的 starter 包即可，不同 starter 包之间都是使用这个统一的版本，故不会存在类冲突问题。这种便利性背后的原因是 SpringBoot 开发团队在发布这个版本的 starter 包时，已经帮我们解决好了类冲突问题，所以我们需要感谢 SpringBoot 团队的贡献\_

> 拓展
> 
> spring-boot-starter-parent 是 SpringBoot 框架的 starter 包统一版本管理这个设计的一个对外入口，而在内部实现层面，每个 starter 包会在各自的 pom.xml 中指定实际需要的功能 jar 包，但是也不会指定版本号。
> 
> 这些功能 jar 包的版本号是在 spring-boot-starter-parent 的父项目 spring-boot-dependencies 中集中管理的，所以这样就保证了在所有的 starter 包中，对于某个功能 jar 包，它的版本都是唯一的，或者说是统一管理的，不会出现某个功能 jar 包存在两个或多个不同版本的问题。

##### 1.1.2 Java 框架集成规则 #####

SpringBoot 通过 starter 包汇总多个功能 jar 包来完成对多个第三方 Java 框架的集成，从而实现一个特定的业务功能，如 web 功能，数据存储功能等，这样就解决了以往项目中需要对功能 jar 包一个个单独配置的繁琐和易出错问题。

> 题外话
> 
> 基于 SpringMVC 开发过 web 项目的同学应该都经历过，在配置 pom.xml 文件时不知道具体需要配置哪几个功能 jar 包，如 spring-web 包、spring-webmvc包等。经常会因为少配或多配了某个 jar 包而导致程序无法启动，所以 starter 包极大简化了我们的项目搭建难度，提高了开发效率。

starter 包对第三方 Java 框架的集成是以实现某个完整功能来作为最小粒度的，功能分类包括基于 SpringMVC 框架实现的 web 功能，基于 Redis 实现的分布式缓存功能，基于 JDBC 实现的数据库存储功能，以及其他的消息队列、搜索、应用服务器等功能。具体可以参考 SpringBoot 官网查看对应的 starter 包。

我们以基于 SpringMVC 框架实现的 web 功能为例，在 springboot-starter-web 包中需要集成 SpringMVC 框架对应的 spring-webmvc 包，以及提供 Java web 的 servlet 规范的相关类的 spring-web 包。如下为实现这个功能的 spring-boot-starter-web 包的定义：

<dependencies>
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter</artifactId>
    		</dependency>
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-json</artifactId>
    		</dependency>
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-tomcat</artifactId>
    		</dependency>
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-validation</artifactId>
    			<exclusions>
    				<exclusion>
    					<groupId>org.apache.tomcat.embed</groupId>
    					<artifactId>tomcat-embed-el</artifactId>
    				</exclusion>
    			</exclusions>
    		</dependency>
    		<dependency>
    			<groupId>org.springframework</groupId>
    			<artifactId>spring-web</artifactId>
    		</dependency>
    		<dependency>
    			<groupId>org.springframework</groupId>
    			<artifactId>spring-webmvc</artifactId>
    		</dependency>
      </dependencies>

从 spring-boot-starter-web 包的 pom.xml 的定义可以看出，除了需要集成 spring-web 与 spring-webmvc 之外，还需要集成其他 starter 包来引入其他的功能 jar 包的依赖，包括提供 json 序列化功能的 spring-boot-starter-json 包，提供 servlet 引擎功能的 spring-boot-starter-tomcat 包，以及提供数据校验功能和相关注解的 spring-boot-starter-validation 包。

可想而知，如果需要一个个来配置这些功能 jar 包，没有一两个小时来摸索，肯定是搞不定的。。所以这也看出了 starter 包设计的创新性对提升开发效率的重要性。

### 2 自定义 starter 包 ###

> 引导语
> 
> 以上介绍的 starter 包主要是围绕 starter 包在自身 pom.xml 文件集成多个功能 jar 包的角度来分析的。但是 starter 包集成这些功能 jar 包最终也是用于为 SpringBoot 的自动配置服务的，即帮助 SpringBoot 的自动配置功能引入所需的类。
> 
> 所以我们所讲的自定义 starter 包一般都是如何基于 SpringBoot 的自动配置的实现原理来将自定义的业务类融入到 SpringBoot 的自动配置体系。

我们通常会将项目中的公用代码，如被多个模块引用的某个功能，抽离成独立的 jar 包来供多个项目复用。有了 SpringBoot 框架之后，为了方便基于 SpringBoot 框架搭建的项目的使用，我们可以将该 jar 包定义为 starter 包，并且将该 jar 包接入到 SpringBoot 的自动配置体系，从而可以跟 SpringBoot 自身提供的 starter 包一样来使用这个 jar 包定义的相关类。

通过上面对 starter 包的相关设计原理的分析，以及前面两节对 SpringBoot 自动配置实现原理的分析，我们再来学习如何在项目中自定义一个 starter 包就容易多了。废话少说，我们通过编写一个查询天气的 starter 包来讲解自定义 starter 包的流程。

1.  编写天气查询业务类
    
    首先我们编写一个查询天气的业务类，这个类是一个普通的业务类，类似于 Redis 的 RedisTemplate。具体在 WeatherTemplate 定义，实现如下：定义了一个方法 query，使用国家气象局的地区编号作为参数，查询该地区的天气信息。
    
        public class WeatherTemplate { 
        
            /** * 国家气象局天气查询接口 */
            private static String WEATHER_QUERY_API = "http://www.weather.com.cn/data/cityinfo/";
            private static String WEATHER_QUERY_API_TYPE = ".html";
        
            /** * 根据给定的地区代号，查询天气情况 * 代号查询：https://www.cnblogs.com/wangjingblogs/p/3192953.html * @param areaCode * @return */
            public String query(String areaCode) { 
                String url = WEATHER_QUERY_API + areaCode + WEATHER_QUERY_API_TYPE;
                RestTemplate restTemplate=new RestTemplate();
                HttpHeaders headers = new HttpHeaders();
                HttpEntity<String> entity = new HttpEntity<>(headers);
                String strbody=restTemplate.exchange(url, HttpMethod.GET, entity,String.class).getBody();
                try { 
                    // 解决中文乱码问题
                    return new String(strbody.getBytes("ISO-8859-1"),"UTF-8");
                } catch (Exception e) { 
                    e.printStackTrace();
                }
                return null;
            }
        }
2.  编写自动配置类
    
     有了以上业务类之后，这步开始才是跟 SpringBoot 的 starter 包直接相关的。在自动配置类上会使用 @Configuration 注解，并且会使用 @Conditional 的相关注解定义该配置类的生效条件。
    
     具体实现如下：使用 @ConditionalOnClass 注解判断类路径是否存在 WeatherTemplate 类，如果存在，则解析该配置类，处理类内部的成员方法 weatherTemplate。
    
     其中在 weatherTemplate 方法上使用 @ConditionalOnMissingBean 注解，表示当 Spring 的 IOC 容器不存在该 bean 对象时，调用这个方法创建该 bean 对象。
    
        @Configuration
        @ConditionalOnClass(WeatherTemplate.class)
        public class WeatherAutoConfiguration { 
        
            @Bean
            @ConditionalOnMissingBean
            public WeatherTemplate weatherTemplate() { 
                WeatherTemplate weatherTemplate = new WeatherTemplate();
                return weatherTemplate;
            }
        }
3.  编写 application.properties 文件的配置属性处理类
    
     在应用开发时，我们一般需要在 SpringBoot 的配置文件 application.properties 中配置功能组件的相关参数，如 Redis 的 host 和 port 对应的配置为 spring.redis.host 和 spring.redis.port ，即是以 spring.redis 作为前戳的。
    
     关于这块的实现，我们会在下一节讲解 application.properties 配置文件时再具体分析。对于天气查询这个案例，则会补充讲解可以配置不同的查询 url，敬请期待~
    
    > tips
    > 
    > 这里不实现 application.properties 的相关配置功能也说明了 starter 包并不一定是需要在 application.properties 进行相关配置的。
    > 
    > 即 SpringBoot 基于 starter 包实现的自动配置主要是基于以上介绍的，使用了 @Configuration 注解和 @Conditional 相关注解的配置类，以及 SpringBoot 的自动配置开关注解 @EnableAutoConfiguration 和对应的注解处理器来实现的。
4.  在 META-INF 目录添加 spring.factories 文件
    
     编写好以上的业务类和配置类之后，还需要在该 starter 包所在工程的 META-INF 目录添加 spring.factories 文件，以便让 SpringBoot 的自动配置机制发现该配置类，从而进行加载和处理。
    
     spring.factories 文件内容如下：以 EnableAutoConfiguration 类的全限定类名作为 key，WeatherAutoConfiguration 类的全限定类名作为 value，具体为 value 是一个列表，该列表当前只包含 WeatherAutoConfiguration 这个类。
    
        org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
          com.yzxie.study.java.demo.weatherstarter.WeatherAutoConfiguration
5.  编译打包
    
    此时就可以使用 maven 的命令执行打包了，这里为简单起见，pom.xml 文件就使用工程名 spring-boot-starter-demo 来作为包名。具体如下：
    
    执行 mvn clean install -Dmaven.test.skip=true 命令编译、打包、安装 spring-boot-starter-demo-0.0.1-SNAPSHOT.jar 到本地仓库。
6.  运用
    
    在另外一个工程，即 spring-boot-demo 项目引入该 spring-boot-starter-demo-0.0.1-SNAPSHOT.jar 包：
    
        <dependency>
            <groupId>com.yzxie.study.java</groupId>
            <artifactId>spring-boot-starter-demo</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>
    
    然后定义一个 WeatherController 并注入 WeatherTemplate，如下：
    
        @RestController
        @RequestMapping("/weather")
        public class WeatherController { 
        
            @Autowired
            private WeatherTemplate weatherTemplate;
        
            @GetMapping("/query")
            public String query(@RequestParam("areaCode") String areaCode) { 
                return weatherTemplate.query(areaCode);
            }
        }
    
    通过 PostMan 访问该接口，如下可以正常返回结果，说明该 starter 包定义的 WeatherTemplate 自动注入成功了：
    
    \[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-xCDsxiog-1616139746223)(./img/starter-demo.png)\]

### 3 总结 ###

我们再对本节的内容进行一个回顾总结。首先我们介绍了 SpringBoot 设计 starter 包的目的主要是为了解决在项目搭建时，对第三方功能 jar 包进行配置存在的配置繁琐、易出错问题。通过 starter 包对功能 jar 包的汇总，完成了对实现某个完整功能的多个 Java 框架的集成，极大降低了项目的搭建难度。

其次是我们也可以自定义 starter 包来实现对项目的公用代码，如某个被多个业务模块引用的功能的抽象与封装，从而实现代码复用。具体为仿照 SpringBoot 的自动配置的实现来封装这些公用代码，然后进行编译打包，生成对应的 jar 包，或者称为 starter 包，从而实现将该自定义的 starter 包融入到 SpringBoot 的自动配置体系，可以跟 SpringBoot 自身提供的 starter 包一样来使用该 jar 包的相关类。

代码仓库

1.  spring-boot-starter-demo：https://github.com/yzxie/java-framework-demo/tree/master/spring-boot-starter-demo
2.  spring-boot-demo：https://github.com/yzxie/java-framework-demo/tree/master/spring-boot-demo