Maven中可选依赖(optional）和依赖排除(exclusion)的用法

最新推荐文章于 2025-07-07 20:53:31 发布

Thinkingcao

最新推荐文章于 2025-07-07 20:53:31 发布

阅读量8.5k

点赞数 1

CC 4.0 BY-SA版权

文章标签： Maven Optional Exclusions

本文链接：https://blog.youkuaiyun.com/Thinkingcao/article/details/88256218

本文深入解析Maven中Optional和Exclusions的使用，说明两者在依赖管理中的作用与区别。Optional属性使依赖变为可选，避免在父项目中无意识地传递；Exclusions则用于主动排除特定依赖，确保项目的干净与可控。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

前面必读的话

Optional和Exclusions都是用来排除jar包依赖使用的，两者在使用上却是相反。Optional表示可选择的，Exclusions表示排除

Optional定义后，该依赖只能在本项目中传递，不会传递到引用该项目的父项目中，父项目需要主动引用该依赖才行。

Exclusions则是主动排除子项目传递过来的依赖。

假如有三个项目分别为A项目、B项目、C项目，依赖引用关系是：A引用B的依赖、C引用A的依赖，当在B中设置某个依赖 <optional>true</optional>时，A项目中不会将这个依赖引用过来，由于依赖的传递性，C引用A项目时，C项目也不会将这个依赖引用过来，如果C项目想引用这个依赖，需要显示的申明（见下面例子），才可以引用过来；true表示不传递，false即可传递；

1、Exclusions,主动排除子项目传递过来的依赖

<dependencies>
    <dependency>
      <groupId>sample.ProjectA</groupId>
      <artifactId>Project-A</artifactId>
      <version>1.0</version>
      <scope>compile</scope>
      <exclusions>
        <exclusion>
          <groupId>sample.ProjectB</groupId>
          <artifactId>Project-B</artifactId>
        </exclusion>
      </exclusions> 
    </dependency>
</dependencies>

2、optional用法

新建两个Maven工程，分别为maven-projectA和maven-projectB

2.1. 在maven-projectA项目中贴出pom依赖如下：

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

	<groupId>com.thinkingcao</groupId>
	<artifactId>maven-projectA</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<packaging>jar</packaging>

	<name>maven-project1</name>
	<url>http://maven.apache.org</url>

	<properties>
		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
	</properties>

	<dependencies>
		<dependency>
			<groupId>junit</groupId>
			<artifactId>junit</artifactId>
			<version>3.8.1</version>
			<scope>test</scope>
		</dependency>

		<!-- fastjson -->
		<dependency>
			<groupId>com.alibaba</groupId>
			<artifactId>fastjson</artifactId>
			<version>1.2.60</version>
		</dependency>


	</dependencies>
</project>

2.2. 在maven-projectB项目中贴出pom依赖如下：

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

  <groupId>com.thinkingcao</groupId>
  <artifactId>maven-projectB</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <packaging>jar</packaging>

  <name>maven-projectB</name>
  <url>http://maven.apache.org</url>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  </properties>

  <dependencies>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>3.8.1</version>
      <scope>test</scope>
    </dependency>
  </dependencies>
</project>

2.3. 以上是新建两个Maven工程的项目配置信息，这里假设maven-projectB项目要使用maven-projectA项目中的fastjson依赖包，这时候, maven-projectB项目配置如下：

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

  <groupId>com.thinkingcao</groupId>
  <artifactId>maven-projectB</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <packaging>jar</packaging>

  <name>maven-projectB</name>
  <url>http://maven.apache.org</url>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  </properties>

  <dependencies>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>3.8.1</version>
      <scope>test</scope>
    </dependency>
    <dependency>
          <groupId>com.thinkingcao</groupId>
	  <artifactId>maven-projectA</artifactId>
	  <version>0.0.1-SNAPSHOT</version>
    </dependency>
  </dependencies>
</project>

在这种情况下，maven-projectA项目中的fastjson依赖信息会被maven-projectB项目所依赖引用，从Maven的依赖包存放的仓库路径就可以看出来，如图所示：

那么，如何让fastjson依赖变成可选依赖呢，这时候就要用到可选依赖（Optional）这个属性了，我们在maven-projectA项目的fastjson依赖中加入optional属性，加入之后，这时候你就发现你的maven-projectB工程刚才的fastjson依赖没有了

	    <!-- fastjson -->
		<dependency>
			<groupId>com.alibaba</groupId>
			<artifactId>fastjson</artifactId>
			<version>1.2.60</version>
			<optional>true</optional>
		</dependency>

那么问题来了，我怎么才能可选择性的在maven-projectB项目中使用maven-projectA项目的fastjson依赖呢，就是像项目比较庞大的情况下，依赖关系很多，使用Optional属性就可以自由的在依赖和不依赖两者中切换了，如果我们想要使用maven-projectA项目中的fastjson依赖，需要在maven-projectA项目中设optional为false或者去除optional，或者说在B项目中显式调用。

2.4. 关于parent 继承的情况

如果maven-projectA的配置是下面这种形式

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

	<groupId>com.thinkingcao</groupId>
	<artifactId>maven-projectA</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<packaging>jar</packaging>

	<name>maven-project1</name>
	<url>http://maven.apache.org</url>

	<properties>
		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
	</properties>

	<dependencies>
		<dependency>
			<groupId>junit</groupId>
			<artifactId>junit</artifactId>
			<version>3.8.1</version>
			<scope>test</scope>
		</dependency>

		<!-- fastjson -->
		<dependency>
			<groupId>com.alibaba</groupId>
			<artifactId>fastjson</artifactId>
			<version>1.2.60</version>
			<optional>true</optional>
		</dependency>


	</dependencies>
</project>

maven-projectB项目再去引用的话，还是可以正常引用fastjson包，optional选项在统一控制版本的情况下会失效。

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

  <groupId>com.thinkingcao</groupId>
  <artifactId>maven-projectB</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <packaging>jar</packaging>

  <name>maven-projectB</name>
  <url>http://maven.apache.org</url>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  </properties>

  <dependencies>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>3.8.1</version>
      <scope>test</scope>
    </dependency>
    
                <dependency>
			<groupId>com.alibaba</groupId>
			<artifactId>fastjson</artifactId>
		</dependency>

  </dependencies>
</project>