依赖加载

依赖加载在 common 模块中有着至关重要的作用，能够在项目运行过程中动态加载第三方依赖文件。并对 pom 文件进行简单的解析，完成依赖传递等一系列逻辑。极大程度的减少 jar 文件的体积，以及 TabooLib 中的 Kotlin 环境便是由该系统完成。

在绝大多数情况下，我们都只需要 @RuntimeDependency 与 @RuntimeDependencies 来完成这些操作。

示例：加载 Guava

@RuntimeDependency("com.google.code.gson:gson:2.8.7")
class TabooLibCommon

依赖文件默认从 https://maven.aliyun.com/repository/central 仓库下载，也可以通过 repository 参数来修改这个地址。

示例：加载 Guava 前检测重复

@RuntimeDependency("com.google.code.gson:gson:2.8.7", test = "com.google.gson.JsonElement")
class TabooLibCommon

使用 test 参数会在依赖下载之前检测 com.google.gson.JsonElement 是否存在并跳过加载过程，防止重复加载依赖产生资源浪费。

示例：加载多个依赖

Java：

@RuntimeDependency(value = "com.google.guava:guava:21.0", test = "com.google.common.base.Optional")
@RuntimeDependency(value = "com.google.code.gson:gson:2.8.7", test = "com.google.gson.JsonElement")
public class TabooLibCommon { }

Kotlin：

@RuntimeDependencies(
    RuntimeDependency("com.google.guava:guava:21.0", test = "com.google.common.base.Optional"),
    RuntimeDependency("com.google.code.gson:gson:2.8.7", test = "com.google.gson.JsonElement")
)
class TabooLibCommon

两种语言的写法有细微的差别，注意区分。

示例：避免重定向（relocate）

在开发过程中我们可能会使用到 relocate 功能对包名进行重定向，这可能会出现一些问题。例如我们在 TabooLib 构建文件中使用了以下配置：

taboolib {
    relocate("com.google", "com.github.username.library")
}

就会产生下面的效果导致依赖加载失败：

我们只需要在字段前加上 ! 符号，便可以解决这个问题。

@RuntimeDependency("!com.google.code.gson:gson:2.8.7")
class MyPlugin

示例：依赖传递

在默认情况下，我们会对 pom 文件进行解析并同时加载它的其他依赖。

例如 asm-commons 的依赖关系如下：

<dependencies>
    <dependency>
        <groupId>org.ow2.asm</groupId>
        <artifactId>asm</artifactId>
        <version>9.2</version>
        <scope>compile</scope>
    </dependency>
    <dependency>
        <groupId>org.ow2.asm</groupId>
        <artifactId>asm-tree</artifactId>
        <version>9.2</version>
        <scope>compile</scope>
    </dependency>
    <dependency>
        <groupId>org.ow2.asm</groupId>
        <artifactId>asm-analysis</artifactId>
        <version>9.2</version>
        <scope>compile</scope>
    </dependency>
</dependencies>

加载 asm-commons 时同时加载：

• org.ow2.asm:asm:9.2

• org.ow2.asm:asm-tree:9.2

• org.ow2.asm:asm-commons:9.2

• org.ow2.asm:asm-analysis:9.2

通过 transitive 参数关闭依赖传递。

@RuntimeDependency("org.ow2.asm:asm-commons:9.2", transitive = false)
class MyPlugin

以及，默认情况下不会传递可选的依赖，通过 ignoreOptional 参数关闭这一限制。

@RuntimeDependency("org.ow2.asm:asm-commons:9.2", ignoreOptional = false)
class MyPlugin

不仅如此，还可以通过修改 scopes 参数来加载特定范围内的依赖。

@RuntimeDependency("org.ow2.asm:asm-commons:9.2", scopes = {DependencyScope.RUNTIME})
class MyPlugin