杰瑞科技汇

Java 如何设置 library?

核心概念:库、依赖 和构建工具

  • :一个或多个 .jar 文件的集合,包含了可重用的 Java 类和资源,用于处理 JSON 的 Gson 库,用于进行 HTTP 请求的 OkHttp 库。
  • 依赖:你的项目所依赖的库,当你设置一个库时,你就是在为你的项目添加一个依赖。
  • 构建工具:Java 项目的“管家”或“包管理器”,它负责自动化项目的编译、打包、测试以及最重要的——管理依赖,主流的构建工具有:
    1. Maven
    2. Gradle (目前更流行,更灵活)
    3. Ant (较老,不推荐新项目使用)

下面我们主要围绕 Maven 和 Gradle 这两大主流工具来讲解。

Java 如何设置 library?-图1
(图片来源网络,侵删)

手动添加 JAR 文件 (不推荐)

这种方式适用于非常简单的项目,或者在没有构建工具的情况下,但它有很多缺点,比如依赖冲突、版本管理困难、无法自动传递依赖等。

步骤:

  1. 下载 JAR 文件:访问库的官方网站(如 Maven Central Repository)找到对应的 JAR 文件并下载。
  2. 创建 lib 目录:在你的项目根目录下,创建一个名为 lib 的文件夹。
  3. 复制 JAR 文件:将下载好的 .jar 文件复制到 lib 文件夹中。
  4. 配置 IDE
    • IntelliJ IDEA:
      1. 右键点击 lib 文件夹。
      2. 选择 Add as Library...
      3. 在弹出的窗口中,选择模块并点击 OK
    • Eclipse:
      1. 右键点击你的项目。
      2. 选择 Build Path -> Configure Build Path...
      3. Libraries 标签页中,点击 Add JARs...Add External JARs...
      4. 选择 lib 文件夹中的 JAR 文件并确认。

缺点

  • 每个项目都要手动下载和添加。
  • 无法自动管理库的依赖库(传递性依赖)。
  • 版本升级非常麻烦。
  • 容易产生版本冲突。

使用 Maven (最经典、最普及)

Maven 使用一个名为 pom.xml (Project Object Model) 的 XML 文件来管理项目配置和依赖。

Java 如何设置 library?-图2
(图片来源网络,侵删)

步骤:

  1. 创建 Maven 项目:如果你使用 IntelliJ IDEA 或 Eclipse,可以直接选择新建 Maven 项目,它会自动为你生成 pom.xml 文件。

  2. 编辑 pom.xml 文件:在 <dependencies> 标签内添加你需要的库。

    <project ...>
        ...
        <properties>
            <!-- 可以在这里定义版本号,方便统一管理 -->
            <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
            <maven.compiler.source>11</maven.compiler.source>
            <maven.compiler.target>11</maven.compiler.target>
            <gson.version>2.10.1</gson.version>
        </properties>
        <dependencies>
            <!-- 示例:添加 Google Gson 库 -->
            <dependency>
                <groupId>com.google.code.gson</groupId>
                <artifactId>gson</artifactId>
                <version>${gson.version}</version>
            </dependency>
            <!-- 示例:添加 JUnit 测试库 -->
            <dependency>
                <groupId>org.junit.jupiter</groupId>
                <artifactId>junit-jupiter</artifactId>
                <version>5.9.3</version>
                <scope>test</scope> <!-- 表示这个依赖只在测试时有效 -->
            </dependency>
        </dependencies>
        ...
    </project>
  3. 刷新 Maven 项目

    • IntelliJ IDEA: 右键点击 pom.xml 文件,选择 Maven -> Reload project,IDEA 会自动下载所需的库到本地仓库(通常是 ~/.m2/repository)。
    • Eclipse: 右键点击项目,选择 Maven -> Update Project...

如何找到库的坐标(GroupId, ArtifactId, Version)?

最简单的方法是访问 Maven Central Repository,搜索库名称,复制页面中给出的 XML 代码即可。


使用 Gradle (更现代、更灵活)

Gradle 使用基于 Groovy 或 Kotlin 的 build.gradlebuild.gradle.kts 文件来构建项目,Kotlin DSL (.kts) 语法更安全、更清晰,越来越受欢迎。

步骤:

  1. 创建 Gradle 项目:同样,IDE 可以帮你创建一个标准的 Gradle 项目。

  2. 编辑 build.gradle.kts (Kotlin DSL) 文件:在 dependencies 代码块中添加库。

    plugins {
        // 应用 Java 插件
        java
        // 如果需要,可以应用其他插件,如 Spring Boot
        // id("org.springframework.boot") version "3.1.0"
    }
    group = "com.example"
    version = "1.0-SNAPSHOT"
    repositories {
        // 使用 Maven 中央仓库
        mavenCentral()
    }
    dependencies {
        // 示例:添加 Google Gson 库
        // implementation 表示编译和运行时都需要这个依赖
        implementation("com.google.code.gson:gson:2.10.1")
        // 示例:添加 JUnit 测试库
        // testImplementation 表示只在测试编译和运行时需要
        testImplementation("org.junit.jupiter:junit-jupiter:5.9.3")
    }
    // 配置 JUnit 5 运行
    tasks.test {
        useJUnitPlatform()
    }
  3. 刷新 Gradle 项目

    • IntelliJ IDEA: 右侧边栏会显示 Gradle 工具窗口,点击刷新按钮(一个旋转的箭头)。
    • Eclipse: 安装 Buildship 插件后,右键点击项目,选择 Gradle -> Refresh Gradle Project

如何找到库的坐标?

同样,访问 Maven Central Repository,搜索库名称,复制它提供的 Gradle 代码块。


使用 IDE 的内置功能 (便捷但项目外)

现代 IDE 如 IntelliJ IDEA 提供了图形化的依赖管理功能,非常方便,但通常会将依赖信息保存在 IDE 自己的配置文件中(如 .idea/libraries),而不是 pom.xmlbuild.gradle,这可能导致项目配置在不同环境中不一致。

步骤 (以 IntelliJ IDEA 为例):

  1. 打开你的项目。
  2. 进入 File -> Project Structure...
  3. 在左侧选择 Modules
  4. 在中间窗口选择你的模块,然后点击右侧的 Dependencies 标签页。
  5. 点击 号,选择 Library...
  6. 在弹出的窗口中,你可以选择从 Maven、Gradle、本地文件等方式添加库,最推荐的是选择 Maven,然后搜索并添加,这样它会帮你自动下载并关联。

优点:非常直观,快速。 缺点项目配置会与 IDE 绑定,如果你把项目代码给别人,别人的 IDE 可能没有这些配置,导致编译失败。这种方式只适合临时添加或快速验证,最终项目配置应该回归到 pom.xmlbuild.gradle


总结与最佳实践

特性 手动添加 JAR Maven Gradle IDE 内置功能
易用性 简单(仅限单机) 中等(XML 稍繁琐) 高(Kotlin DSL 清晰) 非常高(图形化)
依赖管理 (无传递依赖) (自动传递依赖) 优秀(更灵活的依赖配置) (仅限 IDE)
构建速度 中等 (增量编译) 依赖 IDE
社区生态 非常庞大 非常庞大 依赖 IDE
项目可移植性 (标准配置) (标准配置) 极差(与 IDE 绑定)

强烈建议:

  1. 对于任何新项目,都请使用构建工具
  2. Gradle 是目前的首选,因为它更现代、更灵活、构建速度更快,特别是 Kotlin DSL (build.gradle.kts) 能提供更好的开发体验。
  3. Maven 依然是行业标准,非常稳定,拥有海量的资源和教程,如果你的项目或团队已经在使用 Maven,请继续使用。
  4. 避免使用 IDE 的内置功能来管理核心依赖,它只应该作为辅助工具,用于快速添加或临时管理,最终的依赖信息必须写在 pom.xmlbuild.gradle 文件中,以保证项目的可移植性。
分享:
扫描分享到社交APP
上一篇
下一篇