微服务拆分之通用工具jar包管理方案

一、背景说明
对现有系统进行微服务化拆分，在拆分过程中遇到了通用工具jar包版本管理、版本升级的问题，以下为我们部门的解决方案。

二、问题详细说明
原有系统中服务较少，通用工具类各自为战，未统一管理。现进行微服务细致拆分，随着微服务的增多，继续保留各服务间通用工具类各自为战的情况，在处理依赖底层jar包版本升级、jar包不兼容、工具类升级问题上，大大增加了维护成本，并且无法面面俱到。

三、目前解决方案
将通用工具类整体拆分为2个层次，分别是：底层基础jar包、微服务基础jar包

1、底层基础jar包

     主要用于提供底层基础工具类jar包，像jsonUtils、beanUtil、dateUtils、RedisUtils、ES等工具类，像其中的ES 可针对不同ES版本、MQ版本开发不同版本的底层基础工具类jar包。
     项目类分布情况：
    

 

     在基础工具jar包中可以统一管理各依赖其他jar包的版本情况，具体maven配置pom如下所示：

<!-- 底层核心 bean.jar-->
<groupId>com.timer.common</groupId>
<artifactId>common-base</artifactId>
<name>common-base</name>
<version>1.0.1</version>
<packaging>jar</packaging>

<dependencies>
    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-api</artifactId>
      <version>1.7.25<</version>
    </dependency>
</dependencies>

<!-- 底层 redis.jar-->
<groupId>com.timer.common</groupId>
  <artifactId>common-redis</artifactId>
  <name>common-redis</name>
  <version>1.0.3</version>
  <packaging>jar</packaging>
  
  <dependencies>
	<dependency>
	  <groupId>com.timer.common</groupId>
	  <artifactId>common-base</artifactId>
	  <version>1.0.1</version>
	  <scope>provided</scope>
	</dependency>
	<dependency>
		.......
	</dependency>
  </dependencies>

其中maven的build 配置如下：

<build>
      <plugins>
          <!--指定打包jdk版本-->
          <plugin>
              <groupId>org.apache.maven.plugins</groupId>
              <artifactId>maven-compiler-plugin</artifactId>
              <version>3.7.0</version>
              <configuration>
                  <source>1.8</source>
                  <target>1.8</target>
                  <encoding>UTF-8</encoding>
              </configuration>
          </plugin>

          <!-- 配置构建时忽略测试用例 -->
          <plugin>
              <groupId>org.apache.maven.plugins</groupId>
              <artifactId>maven-surefire-plugin</artifactId>
              <version>2.19.1</version>
              <configuration>
                  <argLine>-Dfile.encoding=UTF-8</argLine>
                  <skipTests>true</skipTests>
              </configuration>
          </plugin>
      </plugins>
  </build>

2、微服务基础jar包

微服务的基础jar 可以选择使用底层基础jar和底层基础jar的版本、并且可以对底层基础jar进行水平扩展
项目类分布情况：

具体maven 的pom 如下所示：

 <groupId>com.timer.common</groupId>
  <artifactId>user-common</artifactId>
  <name>user-common</name>
  <version>1.0.1</version>
  <packaging>jar</packaging>
  
  <dependencies>
      <dependency>
        <groupId>com.timer.common</groupId>
        <artifactId>common-redis</artifactId>
        <version>1.0.3</version>
      </dependency>
	<dependency>
	  <groupId>com.timer.common</groupId>
	  <artifactId>common-base</artifactId>
	  <version>1.0.1</version>
	</dependency>
  </dependencies>

其中maven的build 配置如下：

<build>
      <plugins>
          <!--指定打包jdk版本-->
          <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>3.7.0</version>
            <configuration>
              <source>1.8</source>
              <target>1.8</target>
              <encoding>utf-8</encoding>
            </configuration>
          </plugin>
          <!--jar包资源文件合并-->
          <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-shade-plugin</artifactId>
            <version>3.2.1</version>
            <executions>
                <execution>
                    <phase>package</phase>
                    <goals>
                        <goal>shade</goal>
                    </goals>
                    <configuration>
                        <createSourcesJar>true</createSourcesJar>
                        <promoteTransitiveDependencies>true</promoteTransitiveDependencies>
                        <!-- 包含要合并的模块 -->
                        <artifactSet>
                            <includes>
                              <include>com.timer.common:common-base</include>
                              <include>com.timer.common:common-redis</include>
                            </includes>
                        </artifactSet>
                    </configuration>
                </execution>
            </executions>
          </plugin>

          <!-- 打包resources 资源文件-->
          <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-source-plugin</artifactId>
            <version>3.2.0</version>
            <executions>
              <execution>
                <id>attach-sources</id>
                <goals>
                  <goal>jar</goal>
                </goals>
              </execution>
            </executions>
            <configuration>
              <attach>true</attach>
            </configuration>
          </plugin>
          <!-- 配置构建时忽略测试用例 -->
          <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-surefire-plugin</artifactId>
            <version>2.19.1</version>
            <configuration>
              <argLine>-Dfile.encoding=UTF-8</argLine>
              <skipTests>true</skipTests>
            </configuration>
          </plugin>
      </plugins>
  </build>

3、微服务jar包，整体打包后类分布结果：

注：使用了maven的jar包合并打包插件
其他帮助文档：
http://zhentao-li.blogspot.com/2012/06/maven-shade-plugin-invalid-signature.html
https://maven.apache.org/plugins/maven-shade-plugin/examples/attached-artifact.html