为Maven项目配置多个源文件夹

本文介绍如何使用Maven配置项目的源文件夹和资源文件夹,包括配置多个源文件夹和资源文件夹的方法,以及如何让Maven从源文件夹中读取资源文件。

Maven 为我们提供了一致的项目目录配置(源文件夹、资源文件夹等),在自动构建项目时, Maven 会按照这个配置来执行操作(编译源文件、拷贝资源文件)。

Maven 规约的默认配置不能够满足我们的需求时,我们就要动手修改项目的 Maven 配置,让我们的项目能够与 Maven 很好地协同工作。这里讨论的需求有:

  1. 配置多个源文件夹来管理我们项目的模块
  2. 配置多个资源文件夹来管理我们项目模块的资源文件
  3. 有些遗留代码的一些资源文件是放在源文件夹下的,为了不改变原有项目结构,我希望 Maven 能够从源文件夹下读取资源文件
  4. 我想将项目模块的源文件和资源文件放置在同一个文件夹下,以方便开发与维护

1. 配置项目的pom文件(Maven配置文件)

1.1 Maven 默认的源文件夹及资源文件夹配置

 

Maven 默认的源文件夹及资源文件夹的配置代码如下:

    <build>
       ...
       < sourceDirectory > src/main/java </ sourceDirectory >
       < testSourceDirectory > src/test/java </ testSourceDirectory >
       < resources >
           < resource >
              < directory > src/main/resources </ directory >
           </ resource >
       </ resources >
       < testResources >
           < testResource >
              < directory > src/test/resources </ directory >
           </ testResource >
       </ testResources >
       ...
    </build>
 

eclipse 下,项目源文件夹及资源文件夹展现成这样:

 

 

1.2 配置多个资源文件夹

从上面 Maven 的默认配置来看,源文件夹和测试源文件夹都只能配置一个,要配置多个源文件夹比较困难。这里我们先展示如何配置多个资源文件夹。

有人会认为,在 eclipse 下将这些文件夹都设置为源文件夹不就 OK 了吗?其实不然, Maven 在构建的时候并不会去读取任何 IDE 的配置信息,所以他不会知道我们在 eclipse 下指定的源文件夹,也不会将这些源文件夹下的代码编译打包。

配置多个资源文件夹的代码:

    <build>
       ...
        < resources >
           < resource >
              < directory > src/main/resources </ directory >
           </ resource >
           < resource >
              < directory > src/labs/resources </ directory >
           </ resource >
       </ resources >
       ...
    </build>
 

配置好以后, IDEeclipse )不会识别我们的配置,我们需要更新项目的配置:

 

更新后, 在 eclipse 下项目源文件夹及资源文件夹展现成这样(多了一个资源文件夹):

 

 

 

1.3 配置读取源文件夹里的资源文件

为了让 Maven 能够从源文件夹下读取资源文件(或将所有资源文件配置到源文件夹下),我们可以这样配置:

    <build>
       ...
       < resources >
           < resource >
              < directory > src/main/resources </ directory >
           </ resource >
           < resource >
              < directory > src/labs/resources </ directory >
           </ resource >
           < resource >
              < directory > src/main/java </ directory >
              < includes >
                  < include > **/*.hbm.xml </ include >
              </ includes >
           </ resource >
           < resource >
              < directory > src/labs/java </ directory >
              < includes >
                  < include > **/*.hbm.xml </ include >
              </ includes >
           </ resource >
       </ resources >
       ...
    </build>
 

这样,不仅 src/main/resourcessrc/labs/resources 这两个目录下的文件会作为资源文件被打包, src/main/javasrc/labs/java 目录下的所有 .hbm.xml 文件也都会作为资源文件被打包。否则, Maven 构建时不会打包这两个目录下的 .hbm.xml 文件,导致运行时因为找不到资源文件而抛异常。

 

 

1.4 配置多个源文件夹

前面讲过, Maven 默认只支持一个源文件夹,为了给项目配置多个源文件夹,我们需要用到一个 Maven 插件,目的是在 Maven 构建生命周期内为项目添加源文件夹:

	<build>
		...
		<plugins>
			... 
			<!-- build-helper-maven-plugin, 设置多个源文件夹 -->
			<plugin>
				<groupId>org.codehaus.mojo</groupId>
				<artifactId>build-helper-maven-plugin</artifactId>
				<version>1.4</version>
				<executions>
					<execution>
						<id>add-source</id>
						<phase>generate-sources</phase>
						<goals>
							<goal>add-source</goal>
						</goals>
						<configuration>
							<sources>
								<source>${basedir}/src/labs/java</source>
								<!-- 我们可以通过在这里添加多个source节点,来添加任意多个源文件夹 -->
							</sources>
						</configuration>
					</execution>
				</executions>
			</plugin>
			... 
		</plugins>
		... 
	</build>

更新项目配置(操作同2.2)后,在eclipse下项目源文件夹及资源文件夹展现成这样(多了一个源文件夹):

Maven项目中,若需将多个额外的文件夹打包进最终的JAR文件中,可以通过配置Maven的资源过滤机制或使用特定的插件来实现这一需求。Maven默认会将`src/main/resources`目录下的资源文件打包进JAR,但如果有额外的目录需要包含进来,则需要进行相应的配置。 ### 使用maven-resources-plugin进行多目录打包 Maven的`maven-resources-plugin`插件可以用来复制资源文件到构建输出目录(默认是`target/classes`),从而确保这些资源最终会被包含进JAR包中。对于多个额外的资源目录,可以在`pom.xml`中配置多个资源目录路径,如下所示: ```xml <build> <resources> <resource> <directory>src/main/resources</directory> </resource> <resource> <directory>additional-resources</directory> </resource> </resources> </build> ``` 上述配置将`additional-resources`目录下的内容也包含进了最终的JAR文件中,与`src/main/resources`目录下的内容处于相同的类路径下[^1]。 ### 使用maven-jar-plugin自定义JAR打包内容 如果需要更细粒度地控制JAR文件的内容,可以使用`maven-jar-plugin`插件,并通过其配置选项指定哪些文件或目录应该被包含在JAR中。例如: ```xml <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-jar-plugin</artifactId> <version>3.2.0</version> <configuration> <archive> <manifest> <mainClass>com.example.MainClass</mainClass> </manifest> </archive> <fileSets> <fileSet> <directory>src/main/resources</directory> <includes> <include>**/*</include> </includes> </fileSet> <fileSet> <directory>additional-resources</directory> <includes> <include>**/*</include> </includes> </fileSet> </fileSets> </configuration> </plugin> </plugins> </build> ``` 此配置不仅指定了JAR文件中的主类,还通过`<fileSets>`标签明确了哪些目录及其内容应当被包含进JAR文件中[^2]。 ### 相关问题 1. 如何在Maven项目配置资源过滤以包含外部文件? 2. Maven中如何使用maven-jar-plugin插件自定义JAR文件的内容? 3. 如果Maven项目中有多个额外的资源目录需要被打包进JAR文件,应该如何配置? 4. 使用Maven打包时,如何确保额外的配置文件也被正确包含进最终的JAR包中? 5. 在Maven项目中,除了默认的资源目录外,如何添加其他目录到构建过程中以便它们能被打包进JAR文件?
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值