在 Visual Studio Code 中运行 Java

简介

Visual Studio Code（简称 VS Code）是一款广受欢迎的轻量级代码编辑器，它具有强大的扩展性和跨平台性。对于 Java 开发者来说，在 VS Code 中配置并运行 Java 程序能带来高效便捷的开发体验。本文将详细介绍如何在 VS Code 中运行 Java，涵盖基础概念、使用方法、常见实践以及最佳实践，帮助读者快速上手并深入掌握这一技能。

目录

1. 基础概念
2. 使用方法
   • 安装必备组件
   • 创建 Java 项目
   • 编写 Java 代码
   • 运行 Java 程序
3. 常见实践
   • 调试 Java 程序
   • 管理依赖
4. 最佳实践
   • 项目结构优化
   • 代码格式化与风格
   • 版本控制集成
5. 小结
6. 参考资料

基础概念

Visual Studio Code

VS Code 是微软开发的一款开源代码编辑器，支持多种编程语言，通过丰富的扩展生态系统，开发者可以根据自己的需求添加各种功能。

Java

Java 是一种广泛使用的编程语言，具有跨平台、面向对象、安全等特点。在运行 Java 程序时，需要经过编译（将 .java 文件编译成 .class 文件）和运行（执行 .class 文件）两个主要步骤。在 VS Code 中，我们需要借助一些工具和扩展来完成这些操作。

使用方法

安装必备组件

1. Java Development Kit (JDK)：首先需要安装 JDK，它是 Java 开发的基础，包含了 Java 编译器（javac）和 Java 运行时环境（JRE）。可以从 Oracle 官网或其他开源镜像站点下载适合你操作系统的 JDK 版本，并按照安装向导进行安装。安装完成后，需要配置 JAVA_HOME 环境变量，指向 JDK 的安装目录。
2. Visual Studio Code：从官网下载并安装 VS Code。
3. Java 扩展：打开 VS Code，点击左侧的扩展图标（四个方块的图标），在搜索框中输入 “Java”，安装以下几个核心扩展：
   • Java Extension Pack：这是一组官方推荐的 Java 扩展集合，包含了语法高亮、代码智能提示、调试等多个功能。
   • Maven for Java：如果项目使用 Maven 管理依赖，这个扩展可以提供对 Maven 的支持。

创建 Java 项目

1. 打开 VS Code，点击菜单栏的 “文件” -> “新建文件夹”，创建一个新的文件夹作为项目目录。
2. 在 VS Code 中，通过 “文件” -> “打开文件夹”，选择刚刚创建的文件夹。
3. 在项目文件夹中，创建一个新的文件夹用于存放 Java 源文件，通常命名为 src。

编写 Java 代码

在 src 文件夹下创建一个新的 Java 类文件，例如 HelloWorld.java。代码示例如下：

public class HelloWorld {
    public static void main(String[] args) {
        System.out.println("Hello, World!");
    }
}

在上述代码中，public class HelloWorld 定义了一个名为 HelloWorld 的公共类，类中包含一个 main 方法，这是 Java 程序的入口点。System.out.println("Hello, World!"); 语句用于在控制台输出文本。

运行 Java 程序

1. 方法一：使用命令面板
   • 按下 Ctrl + Shift + P（Windows/Linux）或 Command + Shift + P（Mac）打开命令面板。
   • 在命令面板中输入 “Java: 运行 Java 程序”，然后选择 HelloWorld 类（如果有多个类，会列出所有包含 main 方法的类供你选择）。
   • VS Code 会自动编译并运行程序，在 “终端” 面板中显示输出结果。
2. 方法二：使用运行按钮
   • 安装完 Java 扩展后，VS Code 会在编辑器的右上角显示一个运行按钮（绿色三角形）。
   • 确保当前打开的是包含 main 方法的 Java 类文件，点击运行按钮，VS Code 同样会编译并运行程序，并在终端显示结果。

常见实践

调试 Java 程序

调试是开发过程中非常重要的环节，可以帮助我们找到代码中的错误。 1. 在要调试的代码行左侧点击，会出现一个红点，表示设置了断点。例如在 HelloWorld.java 中的 System.out.println("Hello, World!"); 这一行设置断点。 2. 点击调试图标（虫子形状），如果是第一次调试，VS Code 会提示你创建一个调试配置文件。选择 “Java 应用程序”，VS Code 会生成一个 .vscode/launch.json 文件。 3. 点击调试面板中的绿色 “开始调试” 按钮，程序会运行到设置的断点处暂停，此时可以查看变量的值、单步执行代码等操作，以便找出问题所在。

管理依赖

如果项目需要使用第三方库，有两种常见的方式管理依赖： 1. 使用 Maven - 在项目根目录下创建一个 pom.xml 文件，例如对于一个简单的项目，pom.xml 可以如下配置：

<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.example</groupId>
    <artifactId>myproject</artifactId>
    <version>1.0-SNAPSHOT</version>

    <dependencies>
        <!-- 在这里添加依赖 -->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.13.2</version>
            <scope>test</scope>
        </dependency>
    </dependencies>

</project>

- 安装了 `Maven for Java` 扩展后，VS Code 会自动检测 `pom.xml` 文件，并可以通过右键点击 `pom.xml` 文件进行依赖更新等操作。

1. 手动添加依赖
   • 下载所需的第三方库的 .jar 文件，并将其放到项目的一个文件夹中，例如 lib 文件夹。
   • 在 VS Code 中，配置项目的类路径，将 lib 文件夹中的 .jar 文件包含进去。具体配置方法可以参考 VS Code 的官方文档。

最佳实践

项目结构优化

一个良好的项目结构有助于代码的管理和维护。常见的 Java 项目结构如下：

project/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── com/
│   │   │       └── example/
│   │   │           └── myproject/
│   │   │               ├── App.java
│   │   │               └──...
│   │   └── resources/
│   │       └── config.properties
│   └── test/
│       ├── java/
│       │   └── com/
│       │       └── example/
│       │           └── myproject/
│       │               ├── AppTest.java
│       │               └──...
│       └── resources/
│           └── test-config.properties
├── pom.xml
└── README.md

src/main/java 存放主程序代码，src/main/resources 存放主程序的资源文件，src/test/java 存放测试代码，src/test/resources 存放测试相关的资源文件。pom.xml 用于管理项目依赖，README.md 用于记录项目说明。

代码格式化与风格

保持一致的代码风格有助于团队协作和代码阅读。可以使用一些代码格式化工具，如 Prettier 或 Google Java Format。 1. 安装相应的扩展，例如在 VS Code 扩展市场搜索并安装 Prettier - Code formatter 或 Google Java Format。 2. 配置格式化规则，通常可以在 VS Code 的设置中找到对应的格式化工具设置项，根据自己的需求进行配置。

版本控制集成

使用版本控制系统（如 Git）可以更好地管理项目的变更历史。 1. 在项目根目录初始化 Git 仓库，在终端中运行 git init。 2. 安装 GitLens 扩展，它可以在 VS Code 中提供更强大的 Git 功能，如查看文件的修改历史、比较版本差异等。 3. 将代码添加到版本控制中，通过 git add、git commit 等命令进行日常的版本管理操作。

小结

通过本文，我们详细了解了在 Visual Studio Code 中运行 Java 的相关知识，包括基础概念、使用方法、常见实践和最佳实践。从安装必备组件、创建项目、编写和运行代码，到调试程序、管理依赖，以及优化项目结构和代码风格，这些内容可以帮助读者在 VS Code 环境中高效地进行 Java 开发。希望读者通过不断实践，能熟练掌握并运用这些技能，提升自己的开发效率。

参考资料

• Visual Studio Code 官方网站
• Java 官方文档
• VS Code Java 扩展官方文档