Java项目用Makefile管理编译运行

有志者，事竟成！如果你在学习文章，那么本文《Java程序用Makefile管理编译与运行》，就很适合你！文章讲解的知识点主要包括，若是你对本文感兴趣，或者是想搞懂其中某个知识点，就请你继续往下看吧~

本文详细阐述了Java程序的标准编译与执行流程，并探讨了如何利用Makefile来自动化这一过程，特别是如何将命令行参数传递给Java应用。虽然Maven和Gradle是Java生态中更主流的构建工具，但理解Makefile在特定场景下的应用能帮助开发者更好地控制构建流程。文章将通过示例代码，指导读者构建一个能够编译、运行并接受动态命令行参数的Java项目，并讨论其适用场景与主流替代方案。

1. Java程序的标准工作流：编译与执行

在Java开发中，程序的运行通常分为两个主要步骤：编译和执行。这与一些脚本语言（如Python）直接运行源代码的方式有所不同。

1. 编译 (Compilation): 使用 javac 命令将 .java 源代码文件编译成 .class 字节码文件。

   javac AvlTree.java

   这条命令会生成一个名为 AvlTree.class 的文件。

2. 执行 (Execution): 使用 java 命令来运行已编译的 .class 文件。

   java -cp . AvlTree inputs.txt

   这里需要注意几点：

   • java: Java虚拟机启动命令。
   • -cp . 或 -classpath .: 指定当前目录（.）作为类路径。Java虚拟机将在此路径下查找所需的 .class 文件。
   • AvlTree: 这是要执行的主类的名称，不带 .class 后缀。
   • inputs.txt: 这是传递给Java程序的命令行参数。在Java程序中，这些参数可以通过 main 方法的 String[] args 数组获取。

直接使用 java AvlTree.java inputs.txt 运行虽然在某些Java版本和配置下可能奏效（它会隐式地先编译），但这不是标准的、推荐的实践方式，因为它模糊了编译和执行的界限，且效率较低。

2. 理解Makefile在Java项目中的应用

Makefile 是一种自动化构建工具，常用于C/C++项目，但也可用于自动化Java项目的编译和执行过程。一个 Makefile 包含变量、规则（目标、依赖、命令）等元素。

以下是一个基本的 Makefile 示例，用于编译Java源代码：

# 定义Java编译器和编译选项
JFLAGS = -g
JC = javac

# 定义文件后缀规则，说明如何从.java文件生成.class文件
.SUFFIXES: .java .class
.java.class:
    $(JC) $(JFLAGS) $*.java

# 定义需要编译的Java源文件
CLASSES = \
        AvlTree.java

# 默认目标：编译所有类文件
default: classes

# classes目标：将所有.java文件编译成.class文件
classes: $(CLASSES:.java=.class)

# clean目标：清除所有生成的.class文件
clean:
    $(RM) *.class

解析：

• JFLAGS = -g: 定义编译标志，-g 用于生成调试信息。
• JC = javac: 定义Java编译器命令。
• .SUFFIXES: .java .class: 声明 Makefile 关注 .java 和 .class 两种后缀。
• .java.class:: 这是一个隐式规则，表示如何从 .java 文件生成 .class 文件。$*.java 代表不带后缀的源文件名。
• CLASSES = AvlTree.java: 列出所有需要编译的Java源文件。
• default: classes: 指定 default 目标依赖于 classes 目标。当你在命令行输入 make 而不指定目标时，default 目标会被执行。
• classes: $(CLASSES:.java=.class): classes 目标依赖于所有 .java 文件对应的 .class 文件。$(CLASSES:.java=.class) 会将 AvlTree.java 转换为 AvlTree.class。
• clean: $(RM) *.class: clean 目标用于删除所有生成的 .class 文件，$(RM) 是 make 内置的删除命令。

当你运行 make 命令时，它会首先检查 default 目标，然后执行 classes 目标，最终调用 javac AvlTree.java 来编译你的Java程序。

3. 集成Java程序执行与命令行参数

要在 Makefile 中运行已编译的Java程序并传递命令行参数，我们需要添加一个新的目标（例如 run），并将其依赖于 classes 目标，确保程序在运行前已被编译。

以下是修改后的 Makefile，增加了 run 目标：

JFLAGS = -g
JC = javac

.SUFFIXES: .java .class
.java.class:
    $(JC) $(JFLAGS) $*.java

CLASSES = \
        AvlTree.java

# 默认目标现在是运行程序
default: run

classes: $(CLASSES:.java=.class)

# 新增run目标，用于执行Java程序并传递硬编码参数
run: classes
    java -cp . AvlTree inputs.txt

clean:
    $(RM) *.class

解析：

• default: run: 我们将 default 目标改为 run。这意味着当你只输入 make 时，它将首先编译（通过 classes 依赖），然后执行Java程序。
• run: classes: run 目标依赖于 classes 目标。这确保了在尝试运行程序之前，所有必要的 .class 文件都已经生成。
• java -cp . AvlTree inputs.txt: 这是实际执行Java程序的命令。它指定了类路径、主类名以及硬编码的命令行参数 inputs.txt。

现在，运行 make 命令将首先编译 AvlTree.java，然后执行 java -cp . AvlTree inputs.txt。

4. Makefile动态命令行参数传递

在实际开发中，我们可能需要向Java程序传递不同的命令行参数，而不是每次都修改 Makefile。Makefile 允许我们定义变量，并在执行 make 命令时通过命令行覆盖这些变量。

为了实现动态参数传递，我们可以修改 Makefile 如下：

JFLAGS = -g
JC = javac

.SUFFIXES: .java .class
.java.class:
    $(JC) $(JFLAGS) $*.java

CLASSES = \
        AvlTree.java

# 定义一个变量来存储命令行参数，并设置默认值
FILE_ARG ?= inputs.txt

default: run

classes: $(CLASSES:.java=.class)

# run目标现在使用FILE_ARG变量
run: classes
    java -cp . AvlTree $(FILE_ARG)

clean:
    $(RM) *.class

解析：

• FILE_ARG ?= inputs.txt: 定义了一个名为 FILE_ARG 的变量，并使用 ?= 操作符为其设置了默认值 inputs.txt。这意味着如果 FILE_ARG 没有在 make 命令行中被指定，它将使用 inputs.txt。
• java -cp . AvlTree $(FILE_ARG): run 目标中的执行命令现在使用 $(FILE_ARG) 来引用这个变量，从而实现了参数的动态传递。

如何使用：

• 使用默认参数：

  make run

  这将执行 java -cp . AvlTree inputs.txt。

• 指定不同的参数：

  make run FILE_ARG=another_file.txt

  这将执行 java -cp . AvlTree another_file.txt。通过这种方式，你可以在不修改 Makefile 的情况下，灵活地向Java程序传递不同的命令行参数。

5. 注意事项与最佳实践

1. Makefile的适用性： 尽管 Makefile 可以用于Java项目，但它并非Java生态系统中最主流的构建工具。对于复杂的Java项目，Makefile 在依赖管理、多模块项目、生命周期管理等方面会显得力不从心。

2. 主流Java构建工具：

   • Apache Maven: 广泛使用的构建工具，基于项目对象模型（POM），强调约定优于配置。它提供依赖管理、项目报告、Web应用程序部署等功能。
   • Gradle: 基于Groovy或Kotlin的DSL（领域特定语言），提供更高的灵活性和性能，尤其擅长处理多项目构建和自定义构建逻辑。
   • Apache Ant: 基于XML的构建工具，提供高度的灵活性，但需要开发者手动编写所有构建逻辑，相对繁琐。

   这些工具提供了标准化的项目结构、强大的依赖管理（自动下载库文件）、丰富的插件生态系统以及统一的构建生命周期，极大地简化了Java项目的管理和构建。

3. 何时考虑Makefile：

   • 小型、简单的项目： 只需要编译和运行少数几个文件。
   • 与现有非Java构建流程集成： 当Java项目是大型多语言项目的一部分，且整体构建流程已由 Makefile 管理时。
   • 学习目的： 帮助理解构建过程的底层机制。

4. make 命令的行为：

   • 当你只输入 make 时，它会尝试执行 Makefile 中的第一个非特殊目标，通常是 default。
   • 你可以通过 make 来执行 Makefile 中的任何特定目标，例如 make clean 或 make classes。

6. 总结

本文详细介绍了Java程序的标准编译 (javac) 和执行 (java) 流程，并探讨了如何利用 Makefile 来自动化这两个步骤。我们首先展示了一个基本的 Makefile 如何实现Java代码的编译，接着介绍了如何添加 run 目标以执行已编译的程序并传递硬编码的命令行参数。进一步地，我们优化了 Makefile，使其能够通过变量实现命令行参数的动态传递，极大地提升了灵活性。

尽管 Makefile 在特定场景下仍有其价值，但对于大多数Java项目而言，我们强烈推荐使用更专业的构建工具，如Maven或Gradle。它们提供了更强大的功能，包括依赖管理、标准化项目结构和更丰富的插件生态，能够更高效、更可靠地管理复杂的Java项目。理解 Makefile 的工作原理，可以帮助开发者更好地理解构建过程的本质，并在需要时做出明智的工具选择。

今天关于《Java项目用Makefile管理编译运行》的内容介绍就到此结束，如果有什么疑问或者建议，可以在golang学习网公众号下多多回复交流；文中若有不正之处，也希望回复留言以告知！