此处仅讨论单体多模块的父子工程的打包配置, 可以推及springcloud多模块的打包, 一样一样的…
关于maven基础, 可以参考此笔记中的两篇文档:
https://www.yuque.com/fvy7xd/xinzhang/uy0tm7
https://www.yuque.com/fvy7xd/xinzhang/ll0ppb

classpath

参考: https://blog.csdn.net/wppwpp1/article/details/106628669
https://blog.csdn.net/qq_35772435/article/details/105251885
顾名思义, classpath指的是项目编译后的class文件的路径
因为编译后的文件路径与源程序是对应的, 因此classpath 等价于 main/java + main/resources + 第三方jar包的根目录。

  1. 引用classpath路径下的文件，只需在文件名前加classpath, 比如指定log配置文件

    1. server:
    2. port: 60001
    3. logging:
    4. config: classpath:logback-spring.xml

  2. lib和classes同属classpath，两者的访问优先级为: lib>classes。

  3. classpath 和 classpath* 区别：
  • classpath：只会到你的class路径中查找找文件;
  • classpath*：不仅包含class路径，还包括jar文件中(class路径)进行查找。

打jar包

项目结构如图
image.png

父工程pom配置

  • 依赖版本管理以及插件版本管理
  • jdk编译版本以及编译格式

  • 项目版本 ```xml <?xml version=”1.0” encoding=”UTF-8”?> <project xmlns=”http://maven.apache.org/POM/4.0.0“

    1.    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    2.    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    4.0.0

    top.xinzhang0618 oa pom 1.0.0-SNAPSHOT

    oa-core oa-schema oa-web oa-biz 1.8 1.8 1.8 UTF-8 1.0.0-SNAPSHOT 
  1. <dependencyManagement>
  2.     <dependencies>
  3.         <dependency>
  4.             <groupId>top.xinzhang0618</groupId>
  5.             <artifactId>oa-biz</artifactId>
  6.             <version>${project.version}</version>
  7.         </dependency>
  8.         <dependency>
  9.             <groupId>top.xinzhang0618</groupId>
  10.             <artifactId>oa-core</artifactId>
  11.             <version>${project.version}</version>
  12.         </dependency>
  13.         <dependency>
  14.             <groupId>top.xinzhang0618</groupId>
  15.             <artifactId>oa-schema</artifactId>
  16.             <version>${project.version}</version>
  17.         </dependency>
  18.         <dependency>
  19.             <groupId>top.xinzhang0618</groupId>
  20.             <artifactId>oa-web</artifactId>
  21.             <version>${project.version}</version>
  22.         </dependency>
  24.         <!--springboot, 此处import引入依赖版本管理-->
  25.         <dependency>
  26.             <groupId>org.springframework.boot</groupId>
  27.             <artifactId>spring-boot-dependencies</artifactId>
  28.             <version>2.1.3.RELEASE</version>
  29.             <type>pom</type>
  30.             <scope>import</scope>
  31.         </dependency>
  32.         <!--fastjson-->
  33.         <dependency>
  34.             <groupId>com.alibaba</groupId>
  35.             <artifactId>fastjson</artifactId>
  36.             <version>1.2.33</version>
  37.         </dependency>
  38.         <!--jwt-->
  39.         <dependency>
  40.             <groupId>com.auth0</groupId>
  41.             <artifactId>java-jwt</artifactId>
  42.             <version>3.10.3</version>
  43.         </dependency>
  44.         <!--mybatisPlus-->
  45.         <dependency>
  46.             <groupId>com.baomidou</groupId>
  47.             <artifactId>mybatis-plus-boot-starter</artifactId>
  48.             <version>3.3.2</version>
  49.         </dependency>
  50.         <!--mysql-->
  51.         <dependency>
  52.             <groupId>mysql</groupId>
  53.             <artifactId>mysql-connector-java</artifactId>
  54.             <version>6.0.6</version>
  55.         </dependency>
  56.         <!--druid-->
  57.         <dependency>
  58.             <groupId>com.alibaba</groupId>
  59.             <artifactId>druid-spring-boot-starter</artifactId>
  60.             <version>1.1.23</version>
  61.         </dependency>
  62.         <!--oss-->
  63.         <dependency>
  64.             <groupId>com.aliyun.oss</groupId>
  65.             <artifactId>aliyun-sdk-oss</artifactId>
  66.             <version>3.10.2</version>
  67.         </dependency>
  68.         <!--httpclient-->
  69.         <dependency>
  70.             <groupId>org.apache.httpcomponents</groupId>
  71.             <artifactId>httpclient</artifactId>
  72.             <version>4.5.12</version>
  73.         </dependency>
  74.         <!-- transmittable-thread-local -->
  75.         <dependency>
  76.             <groupId>com.alibaba</groupId>
  77.             <artifactId>transmittable-thread-local</artifactId>
  78.             <version>2.11.5</version>
  79.         </dependency>
  80.     </dependencies>
  81. </dependencyManagement>
  83. <build>
  84.     <pluginManagement>
  85.         <plugins>
  86.             <plugin>
  87.                 <groupId>org.apache.maven.plugins</groupId>
  88.                 <artifactId>maven-jar-plugin</artifactId>
  89.                 <version>3.1.1</version>
  90.             </plugin>
  91.             <plugin>
  92.                 <groupId>org.apache.maven.plugins</groupId>
  93.                 <artifactId>maven-resources-plugin</artifactId>
  94.                 <version>3.1.0</version>
  95.             </plugin>
  96.             <plugin>
  97.                 <groupId>org.apache.maven.plugins</groupId>
  98.                 <artifactId>maven-dependency-plugin</artifactId>
  99.                 <version>3.1.1</version>
  100.             </plugin>
  101.             <plugin>
  102.                 <groupId>org.apache.maven.plugins</groupId>
  103.                 <artifactId>maven-compiler-plugin</artifactId>
  104.                 <version>3.8.0</version>
  105.             </plugin>
  106.             <plugin>
  107.                 <groupId>org.springframework.boot</groupId>
  108.                 <artifactId>spring-boot-maven-plugin</artifactId>
  109.                 <version>2.1.3.RELEASE</version>
  110.             </plugin>
  111.         </plugins>
  112.     </pluginManagement>
  113. </build>

  1. <a name="1Ttu0"></a>
  2. ### web(springboot模块)打包配置
  4. - springboot打包插件
  6. 参考: [https://blog.csdn.net/taiyangdao/article/details/75303181](https://blog.csdn.net/taiyangdao/article/details/75303181)<br />注意需加上repackage的插件目标, repackage会将web依赖的模块都打进xxx-web.jar里
  8. - 资源过滤
  10. 通过filter过滤后的资源文件, 会视为系统的配置文件, 其中的${}变量, 编译时会被赋值; 而不想要excel等文件的${}被赋值, 在filter中需排除这类文件
  11. ```xml
  12. <?xml version="1.0" encoding="UTF-8"?>
  13. <project xmlns="http://maven.apache.org/POM/4.0.0"
  14.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  15.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  16.     <parent>
  17.         <artifactId>oa</artifactId>
  18.         <groupId>top.xinzhang0618</groupId>
  19.         <version>1.0.0-SNAPSHOT</version>
  20.     </parent>
  21.     <modelVersion>4.0.0</modelVersion>
  23.     <artifactId>oa-web</artifactId>
  24.     <dependencies>
  25.         <dependency>
  26.             <groupId>top.xinzhang0618</groupId>
  27.             <artifactId>oa-biz</artifactId>
  28.         </dependency>
  29.         <dependency>
  30.             <groupId>top.xinzhang0618</groupId>
  31.             <artifactId>oa-core</artifactId>
  32.         </dependency>
  33.         <dependency>
  34.             <groupId>top.xinzhang0618</groupId>
  35.             <artifactId>oa-schema</artifactId>
  36.         </dependency>
  38.         <!--springbootWeb-->
  39.         <dependency>
  40.             <groupId>org.springframework.boot</groupId>
  41.             <artifactId>spring-boot-starter-web</artifactId>
  42.         </dependency>
  43.         <!--springbootTest-->
  44.         <dependency>
  45.             <groupId>org.springframework.boot</groupId>
  46.             <artifactId>spring-boot-starter-test</artifactId>
  47.             <scope>test</scope>
  48.         </dependency>
  49.     </dependencies>
  51.     <build>
  52.         <resources>
  53.             <resource>
  54.                 <directory>src/main/resources</directory>
  55.                 <includes>
  56.                     <include>excel/**</include>
  57.                     <include>es/**</include>
  58.                 </includes>
  59.                 <filtering>false</filtering>
  60.             </resource>
  61.             <resource>
  62.                 <directory>src/main/resources</directory>
  63.                 <filtering>true</filtering>
  64.             </resource>
  65.         </resources>
  67.         <plugins>
  68.             <plugin>
  69.                 <groupId>org.springframework.boot</groupId>
  70.                 <artifactId>spring-boot-maven-plugin</artifactId>
  71.                 <executions>
  72.                     <execution>
  73.                         <goals>
  74.                             <goal>repackage</goal>
  75.                         </goals>
  76.                     </execution>
  77.                 </executions>
  78.             </plugin>
  79.         </plugins>
  80.     </build>
  81. </project>

其他补充

  1. 打完jar后启动命令: java -jar -Dspring.profiles.active=dev oa-web-1.0.0-SNAPSHOT.jar
  2. 依赖模块无需配置打包插件等
  3. 其他模块若有资源文件, 一样需要放到resources文件夹下供web模块引用, 比如base.xml的引用, 见下

image.png
image.png

打包结果分析

image.png
我们解压oa-web-1.0.0-SNAPSHOT.jar，所有的jar包在BOOT-INF/lib下, 其中也能找到依赖的模块的jar包, 打完包后jar大小为36.7M
image.png
image.png

配置分离

打zip包

参考: https://blog.csdn.net/qq_38279833/article/details/105513529

  1. 父工程加个输出目录的配置, 注意basedir是web工程的根目录, ${basedir}/../target是父工程下的target目录

    1. <properties>
    2.      <dist.path>${basedir}/../target</dist.path>
    3.      <java.version>1.8</java.version>
    4.      <maven.compiler.source>1.8</maven.compiler.source>
    5.      <maven.compiler.target>1.8</maven.compiler.target>
    6.      <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    7.      <project.version>1.0.0-SNAPSHOT</project.version>
    8.  </properties>

  2. web工程变更如下:

  • 更改资源文件的输出路径
  • springboot打包插件打包方式为zip包, 并指定jar输出目录

  • 增加dependency插件, 将web工程依赖的包复制进指定jar目录 ```xml <?xml version=”1.0” encoding=”UTF-8”?> <project xmlns=”http://maven.apache.org/POM/4.0.0“

    1.    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    2.    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

    1.   <artifactId>oa</artifactId>
    2.   <groupId>top.xinzhang0618</groupId>
    3.   <version>1.0.0-SNAPSHOT</version>

    4.0.0

    oa-web

    top.xinzhang0618 oa-biz top.xinzhang0618 oa-core top.xinzhang0618 oa-schema org.springframework.boot spring-boot-starter-web org.springframework.boot spring-boot-starter-test test src/main/resources ${dist.path} false excel/ es/ src/main/resources ${dist.path} true org.springframework.boot spring-boot-maven-plugin ZIP non-exists non-exists ${dist.path}/lib repackage org.apache.maven.plugins maven-dependency-plugin copy package copy-dependencies ${dist.path}/lib 

  2. 3. 其他工程不需要变更, 依旧不需要打包插件
  3. 3. 项目启动需要指定lib目录, 启动命令为: java -jar -Dspring.profiles.active=dev -Dloader.path=. ./lib/oa-web-1.0.0-SNAPSHOT.jar
  5. 注意, 项目打包后, idea无法通过debug按钮直接启动, 因为需要指定lib目录, 简单做法, 先Clean清除打的包, 再debug启动(执行的是build)
  7. 打包结果如下, lib目录下的oa-web-1.0.0-SNAPSHOT.jar不包含其他模块的依赖, 打完包后target文件夹46.5M, 比打jar包大了10M.........<br />![image.png](https://cdn.nlark.com/yuque/0/2021/png/281275/1610691765477-736e593a-2c46-431a-ae7d-4b06dc39da11.png#crop=0&crop=0&crop=1&crop=1&height=437&id=OTWdb&margin=%5Bobject%20Object%5D&name=image.png&originHeight=437&originWidth=348&originalType=binary&ratio=1&rotation=0&showTitle=false&size=16516&status=done&style=none&title=&width=348)
  9. ---
  11. <a name="YNoXP"></a>
  12. ### Nacos
  13. 官方文档: [https://nacos.io/zh-cn/docs/quick-start-spring-boot.html](https://nacos.io/zh-cn/docs/quick-start-spring-boot.html)<br />主要的使用官方文档上都有, 这里简略写一点
  15. 1. 安装及启动nacos
  16. 1. 加依赖
  17. ```xml
  18.  <!--nacos-->
  19.             <dependency>
  20.                 <groupId>com.alibaba.boot</groupId>
  21.                 <artifactId>nacos-config-spring-boot-starter</artifactId>
  22.                 <version>0.2.7</version>
  23.             </dependency>

  1. 代码配置(启动类加@NacosPropertySource注解, 配置文件加上nacos配置) ```java @SpringBootApplication(scanBasePackages = “top.xinzhang0618.oa”) @NacosPropertySource(dataId = “oa-test.yml”, autoRefreshed = true,type = ConfigType.YAML) public class WebApplication {

    public static void main(String[] args) {

    1.  SpringApplication.run(WebApplication.class, args);

    }

}

  1. ```yaml
  2. spring:
  3.   application:
  4.     name: oa
  5. nacos:
  6.   config:
  7.     server-addr: http://39.106.55.179:40000
  8.     namespace: c3545dbe-b516-49a4-9f86-da97dd019ce7
  1. 在配置中心添加相关配置

image.png
image.png

支持配置的动态刷新, 使用示例

  1.  @NacosValue(value = "${useLocalCache:false}", autoRefreshed = true)
  2.  private boolean useLocalCache;

配置绑定变量

这里拿打jar包的配置做如下变更
通过maven的profile实现配置绑定变量, 以在不同的环境使用不同的轻量化的配置文件

  1. 父工程添加profile

    1. <profiles>
    2.      <profile>
    3.          <id>oa-prod</id>
    4.          <build>
    5.              <filters>
    6.                  <filter>${basedir}/../profiles/oa-prod.properties</filter>
    7.              </filters>
    8.          </build>
    9.      </profile>
    10.  </profiles>

  2. web工程建立application-prod.yml, 参数使用变量 ```yaml spring: datasource: druid: url: jdbc:mysql://${database.host}:${database.port}/oa_dev?serverTimezone=Hongkong&useUnicode=true&characterEncoding=utf-8&zeroDateTimeBehavior=convertToNull&transformedBitIsBoolean=true&autoReconnect=true&failOverReadOnly=false&useSSL=false username: ${database.user} password: ${database.password} redis: host: ${redis.host} port: ${redis.port} database: ${redis.database} password: ${redis.password}

  2. 3. 在工程目录下建profiles/oa-prod.properties配置文件
  3. ```yaml
  4. #database
  5. database.host=39.106.55.179
  6. database.port=3306
  7. database.user=root
  8. database.password=xxx
  10. #redis
  11. redis.host=39.106.55.179
  12. redis.port=6379
  13. redis.password=xxx
  14. redis.database=1

如上配置完成后, 在主目录下, 打包命令如下:
$mvn clean package -Dmaven.test.skip=true -P oa-prod -f pom.xml

其中mvn参数: (参数不懂的 mvn -h 获取帮助)
-D 表示定义的系统属性, maven或者java的
-P 表示指定的profile
-f 表示指定的pom文件

将打出的oa-web-1.0.0-SNAPSHOT.jar包解压后能看到相应的prod.yml配置文件中的变量已经被赋值了
image.png

最后, 启动命令不变: $java -jar -Dspring.profiles.active=prod oa-web-1.0.0-SNAPSHOT.jar

抽取公共pom文件

如下, 可以像springcloudDependences一样, 抽取公共依赖, install和deploy到仓库后, 其他模块就可以import使用

xz-demo-dependencies-1.0.0-SNAPSHOT.pom

  1. <?xml version="1.0" encoding="utf-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3.         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  4.     <modelVersion>4.0.0</modelVersion>
  5.     <groupId>com.pingan.lcloud</groupId>
  6.     <artifactId>xz-demo-dependencies</artifactId>
  7.     <version>1.0.0-SNAPSHOT</version>
  8.     <packaging>pom</packaging>
  10.     <properties>
  11.         <fastjson.version>1.2.33</fastjson.version>
  12.         <lombok.version>1.18.22</lombok.version>
  13.         <commons-lang3.version>3.12.0</commons-lang3.version>
  14.         <hutool-all.version>5.7.21</hutool-all.version>
  15.     </properties>
  17.     <dependencyManagement>
  18.         <dependencies>
  19.             <!--fastjson-->
  20.             <dependency>
  21.                 <groupId>com.alibaba</groupId>
  22.                 <artifactId>fastjson</artifactId>
  23.             </dependency>
  24.             <!--lombok-->
  25.             <dependency>
  26.                 <groupId>org.projectlombok</groupId>
  27.                 <artifactId>lombok</artifactId>
  28.             </dependency>
  29.             <!--commons-lang3-->
  30.             <dependency>
  31.                 <groupId>org.apache.commons</groupId>
  32.                 <artifactId>commons-lang3</artifactId>
  33.             </dependency>
  34.             <!--hutool-all-->
  35.             <dependency>
  36.                 <groupId>cn.hutool</groupId>
  37.                 <artifactId>hutool-all</artifactId>
  38.             </dependency>
  39.             <dependency>
  40.                 <groupId>org.springframework.cloud</groupId>
  41.                 <artifactId>spring-cloud-dependencies</artifactId>
  42.                 <version>Greenwich.SR3</version>
  43.                 <type>pom</type>
  44.                 <scope>import</scope>
  45.             </dependency>
  46.             <dependency>
  47.                 <groupId>org.springframework.boot</groupId>
  48.                 <artifactId>spring-boot-dependencies</artifactId>
  49.                 <version>2.1.3.RELEASE</version>
  50.                 <type>pom</type>
  51.                 <scope>import</scope>
  52.             </dependency>
  53.         </dependencies>
  54.     </dependencyManagement>
  57.     <build>
  58.         <pluginManagement>
  59.             <plugins>
  60.                 <plugin>
  61.                     <groupId>org.springframework.boot</groupId>
  62.                     <artifactId>spring-boot-maven-plugin</artifactId>
  63.                     <configuration>
  64.                         <!--devTools-->
  65.                         <fork>true</fork>
  66.                     </configuration>
  67.                     <executions>
  68.                         <execution>
  69.                             <goals>
  70.                                 <goal>repackage</goal>
  71.                             </goals>
  72.                         </execution>
  73.                     </executions>
  74.                 </plugin>
  75.             </plugins>
  76.         </pluginManagement>
  77.     </build>
  78. </project>

安装到仓库

  1. mvn -f xz-demo-dependencies-1.0.0-SNAPSHOT.pom install
  2. mvn -f xz-demo-dependencies-1.0.0-SNAPSHOT.pom deploy

其他模块使用

  1.  <dependencyManagement>
  2.         <dependencies>
  3.             <dependency>
  4.                 <groupId>com.pingan.lcloud</groupId>
  5.                 <artifactId>xz-demo-dependencies</artifactId>
  6.                 <version>1.0.0-SNAPSHOT</version>
  7.                 <type>pom</type>
  8.                 <scope>import</scope>
  9.             </dependency>
  10.         </dependencies>
  11.     </dependencyManagement>