工作笔记之maven插件使用（一）

情景一：SpringBoot打包时复制指定配置文件到指定目录，并剔除jar包内所有配置文件

参考博客地址：https://juejin.im/post/6844904001339654158

最近遇到一个需求，把SpringBoot项目的配置文件放到Jar包外面，Jar包内不包含多余配置文件，Jar包运行时指定外部配置文件启动。我的配置文件放在src/main/resources/config下，打包时拷贝到Jar包同级config目录下（SpringBoot默认支持读取Jar包同级config文件夹中的配置），具体解决方案如下：

• 使用maven-jar-plugin插件移除配置文件将其不打包进jar包中
• 使用maven-resources-plugin插件将需要复制的文件复制到指定路径（例：将配置文件提取到指定路径）

maven配置：

<!--声明多环境-->
<profiles>
    <profile>
        <!-- 本地开发环境 -->
        <id>dev</id>
        <properties>
            <profiles.active>dev</profiles.active>
            <modifier></modifier>
        </properties>
        <activation>
            <!-- 默认的，不加参数时执行这个profile -->
            <activeByDefault>true</activeByDefault>      
        </activation>
    </profile>
    <profile>
        <!-- 测试环境 -->
        <id>test</id>
        <properties>
            <profiles.active>test</profiles.active>
            <modifier>-test</modifier>
        </properties>
    </profile>
    <profile>
        <!-- 生产环境 -->
        <id>prod</id>
        <properties>
            <profiles.active>prod</profiles.active>
            <modifier>-prod</modifier>
        </properties>
    </profile>
</profiles>

<build>
    <plugins>
        <!-- 复制指定环境配置文件到指定目录 -->
        <plugin>
            <artifactId>maven-resources-plugin</artifactId>
            <executions>
                <execution>
                    <id>copy-resources</id>
                    <phase>package</phase>
                    <goals>
                        <goal>copy-resources</goal>
                    </goals>
                    <configuration>
                        <resources>
                            <resource>
                                <directory>src/main/resources/config</directory>
                                <includes>
                                    <include>application.yml</include>
                                    <include>application-${profiles.active}.yml</include>
                                </includes>
                            </resource>
                        </resources>
                        <outputDirectory>${project.build.directory}/config</outputDirectory>
                    </configuration>
                </execution>
            </executions>
        </plugin>
        <!-- jar包内剔除所有配置文件 -->
        <plugin>
            <artifactId>maven-jar-plugin</artifactId>
            <configuration>
                <!--不打入jar包的文件类型或者路径-->
                <excludes>
                    <exclude>config/**</exclude>
                </excludes>
            </configuration>
        </plugin>
    </plugins>
</build>

情景二：SpringBoot打包时，根据不同的环境将配置的后缀，将对应的配置文件进行打包

参考博客地址：https://blog.csdn.net/java_collect/article/details/83870215

maven配置：

 <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <executions>
                    <execution>
                        <goals>
                            <goal>repackage</goal>
                        </goals>
                    </execution>
                </executions>
                <configuration>
                    <executable>true</executable>
                </configuration>
            </plugin>
        </plugins>

        <resources>
            <resource>
                <directory>src/main/resources/</directory>
                <!--打包时先排除掉三个文件夹-->
                <excludes>
                    <exclude>dev/*</exclude>
                    <exclude>prod/*</exclude>
                    <exclude>test/*</exclude>
                </excludes>
                <includes>
                    <!--如果有其他定义通用文件，需要包含进来-->
                    <!--<include>messages/*</include>-->
                </includes>
            </resource>
            <resource>
                <!--这里是关键！ 根据不同的环境，把对应文件夹里的配置文件打包-->
                <directory>src/main/resources/${profiles.active}</directory>
            </resource>
        </resources>
    </build>

    <profiles>
        <profile>
            <!--不同环境Profile的唯一id-->
            <id>dev</id>
            <properties>
                <!--profiles.active是自定义的字段，自定义字段可以有多个-->
                <profiles.active>dev</profiles.active>
            </properties>
        </profile>
        <profile>
            <id>prod</id>
            <properties>
                <profiles.active>prod</profiles.active>
            </properties>
            <!--activation用来指定激活方式，可以根据jdk环境，环境变量，文件的存在或缺失-->
            <activation>
                <!--这个字段表示默认激活-->
                <activeByDefault>true</activeByDefault>
            </activation>
        </profile>
        <profile>
            <id>test</id>
            <properties>
                <profiles.active>test</profiles.active>
            </properties>
        </profile>
    </profiles>

情景三：SpringBoot，通过maven引入外部的jar包

maven配置：

第一步：

第二步：

		<dependency>
            <groupId>org.example</groupId>
            <artifactId>spring-common</artifactId>
            <version>1.0-SNAPSHOT</version>
    		<!--这个scope必须为system-->
            <scope>system</scope>
            <systemPath>${basedir}/lib/spring-common-1.0-SNAPSHOT.jar</systemPath>
        </dependency>

情景四：SpringBoot 排除resource下的配置文件

dubbo版本更新与nacos结合使用只会读取内部配置的文件，如果jar包有配置文件则不读取，简单来说优先读取内部，内部不存在读取外部。

maven配置：

   		<!--设置指定的环境变量-->
        <profile.active>config</profile.active>

<build>
  <resources>
            <resource>
                <filtering>true</filtering>
                <directory>src/main/resource</directory>
                <excludes>
                    <exclude>application-${profile.active}.properties</exclude>
                </excludes>
            </resource>
        </resources>
</build>