欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

SpringBoot 项目打包分开lib,配置和资源文件

程序员文章站 2022-09-30 18:52:17
原文地址:https://blog.csdn.net/u012811805/article/details/80878848 1 jar启动分离依赖lib和配置 先前发布boot项目的时候,改动一点东西,就需要将整个项目重新打包部署,十分不便,故把依赖lib从项目分离出来,每次部署只需要发布代码即可 ......

原文地址:https://blog.csdn.net/u012811805/article/details/80878848

1 jar启动分离依赖lib和配置
  先前发布boot项目的时候,改动一点东西,就需要将整个项目重新打包部署,十分不便,故把依赖lib从项目分离出来,每次部署只需要发布代码即可。
1.1 半自动化步骤
1.1.1 更换maven的jar打包插件
  先前使用的是spring-boot-maven-plugin来打包,这个插件会将项目所有的依赖打入boot-inf/lib下,替换为maven-jar-plugin:

   <plugin>
      <groupid>org.apache.maven.plugins</groupid>
      <artifactid>maven-jar-plugin</artifactid>
      <version>3.1.1</version>
      <configuration>
         <archive>
            <manifest>
               <addclasspath>true</addclasspath>
               <classpathprefix>lib/</classpathprefix>
               <mainclass>org.orcrtech.pvpsddp.registry.center.pvpsddpregistrycenterapplication</mainclass>
            </manifest>
         </archive>
      </configuration>
   </plugin>

  解释:
    a addclasspath表示需要加入到类构建路径
    b classpathprefix指定生成的manifest文件中class-path依赖lib前面都加上路径,构建出lib/xx.jar

1.1.2 拷贝依赖到jar外面的lib目录

  

<plugin>
      <groupid>org.apache.maven.plugins</groupid>
      <artifactid>maven-dependency-plugin</artifactid>
      <executions>
         <execution>
            <id>copy-lib</id>
            <phase>package</phase>
            <goals>
               <goal>copy-dependencies</goal>
            </goals>
            <configuration>
               <outputdirectory>target/lib</outputdirectory>
               <excludetransitive>false</excludetransitive>
               <stripversion>false</stripversion>
               <includescope>runtime</includescope>
            </configuration>
         </execution>
      </executions>
   </plugin>

  

1.1.3 在和jar包同级的目录下新建一个config目录,放入application.yml文件
  这里可能有小伙伴有疑问了,打包的jar里面不是应该有application.yml文件吗,这里为什么再放一份?
  这是因为boot读取配置有一个优先级,放在jar包外面config目录优先级最高,主要是便于从外部修改配置,而不是改jar包中的application.yml文件。优先级如下:
    当前目录的config目录下
    当前目录
    classpath的config目录下
    classpath的根目录

1.1.4 启动项目
  加入–debug可以让你可以看到比较详细的启动日志:
    java -jar xxx-1.0.0.jar --debug

 

1.2 全自动化步骤
  前面介绍的步骤中,需要手动的拷贝application.yml文件,并且jar包内外都存在配置,总感觉怪怪的(偷笑…)。这里引入一种自动化配置,将所有东西打成zip文件,直接发布到服务目录,解压后,即可启动。
1.2.1 指定打包插件
  如上。
1.2.2 拷贝依赖的插件。
  如上。
1.2.3 自动化步骤2
  排除resources下面的yml(因为我们需要把它放在jar外部,不能让jar打包插件将其打入jar包classpath下去)

<resources>
        <resource>
            <directory>src/main/resources</directory>
            <excludes>
                <exclude>**/application.yml</exclude>
            </excludes>
        </resource>
</resources>

  上面这种排除*.yml配置文件的办法,会在idea编译器启动的时候报错,下面的排除方法不会引起报错:

<plugin>
   <groupid>org.apache.maven.plugins</groupid>
   <artifactid>maven-jar-plugin</artifactid>
   <configuration>
      <archive>
         <manifest>
            <addclasspath>true</addclasspath>
            <classpathprefix>lid/</classpathprefix>
            <mainclass>org.orcrtech.pvpsddp.structure.management.pvpsddpstructuremanagementapplication</mainclass>
         </manifest>
      </archive>
      <!-- 排除配置文件 -->
      <excludes >
         <exclude>*.yml</exclude>
      </excludes>
   </configuration>
</plugin>

1.2.4 使用maven-assembly-plugin自定义打包
  具体打包详情在assembly.xml配置中指定

<plugin>
    <artifactid>maven-assembly-plugin</artifactid>
    <configuration>
         <!-- 打包后的包名是否包含assembly的id名 -->
        <appendassemblyid>false</appendassemblyid>
          <!-- 指定最后tar或者zip包的名字 -->
          <finalname>gateway</finalname>
          <!-- tar或者zip包的输出目录 -->
          <!-- ../ 是指当前项目的根目录 ,例如:f:\pvpsddp\pvpsddp-gateway 的上一级-->
          <outputdirectory>f:\pvpsddp\tar</outputdirectory>
        <descriptors>
              <!-- 引用的assembly配置文件,可以用多个,即可以同时打包多个格式的包 -->
            <descriptor>src/main/resources/assembly.xml</descriptor>
        </descriptors>
    </configuration>
    <executions>
      <!-- phase加入package后,则在执行maven package时就可以调用maven-assembly-plugin插件定义的打包方式 -->
        <execution>
          <!--名字任意 -->
            <id>make-assembly</id>
           <!-- 绑定到package生命周期阶段上 -->
            <phase>package</phase>
            <goals>
               <!-- 只运行一次 --> 
                <goal>single</goal>
            </goals>
        </execution>
    </executions>
</plugin>

  注:
    生成的tar.gz文件的名字为:maven-assembly-plugin插件中配置的 “finalname-assembly.xml配置的id”(若assembly中没有指定id,则只有前半部分。
    assembly.xml具体配置如下:
    将application.yml放在外部config目录下
    所有依赖打成zip压缩包(还可以打成其他类型包https://www.cnblogs.com/f-zhao/p/6929814.html)

<assembly xmlns="http://maven.apache.org/assembly/2.0.0"
          xmlns:xsi="http://www.w3.org/2001/xmlschema-instance"
          xsi:schemalocation="http://maven.apache.org/assembly/2.0.0 http://maven.apache.org/xsd/assembly-2.0.0.xsd">
<id>package</id>
<formats>
    <format>zip</format>
</formats>
<includebasedirectory>true</includebasedirectory>
<filesets>
    <fileset>
        <directory>${basedir}/src/main/resources</directory>
        <includes>
            <include>*.yml</include>
        </includes>
        <filtered>true</filtered>
        <outputdirectory>${file.separator}config</outputdirectory>
    </fileset>

    <fileset>
        <!-- 需要打包的路径 -->
        <directory>src/main/resources/runscript</directory>
        <!-- 打包后输出的路径,自定义 -->
        <outputdirectory>${file.separator}bin</outputdirectory>
    </fileset>
    <fileset>
        <directory>${project.build.directory}/lib</directory>
        <outputdirectory>${file.separator}lib</outputdirectory>
        <!-- 打包需要包含的文件 -->
        <includes>
            <include>*.jar</include>
        </includes>
    </fileset>
    <fileset>
        <directory>${project.build.directory}</directory>
        <outputdirectory>${file.separator}</outputdirectory>
        <includes>
            <include>*.jar</include>
        </includes>
    </fileset>
</filesets>
</assembly>