vscode开发java环境配置，很细

xlybyte
10,171 阅读6分钟

说明

根据此文档步骤，可以搭建一个简单的服务端，HTTP接口处理响应

image.png

环境搭建

因为做前端习惯了vscode，而idea又太重量级了，好在vscode在最近出了对java的插件，所以在vscode中也能很好的开发java

jdk安装

java的jdk类似于前端的浏览器或node运行环境，jdk下载地址Java Downloads | Oracle 中国，选择对应操作系统下的安装包下载安装，安装后会自动设置环境变量

我用的是window

image.png

关于版本

jdk1.8 = jdk8，截至目前2024，很多项目用的依然是jdk8版本，为学习，这里使用的为17版本

Maven安装

maven是用来管理java项目依赖的，类似前端的npm包管理工具。maven可以帮我们管理jar包，以及编译测试，运行，打包，安装，部署整个过程都可以利用maven来完成

  1. 下载安装maven下载地址Maven – 下载 Apache Maven

下载后将maven解压到一个没中文没空格的目录下，目录内文件说明如下

  • bin mvn运行的脚本
  • boot 含有plexus-classworlds类加载器框架，maven使用该框架加载自己的类库
  • conf 是配置文件，例如settings.xml
  • lib，是maven运行时候需要的java类库

image.png

  1. 设置环境变量
1.新建环境变量
变量名：MAVEN_HOME
变量值：D:\sw\install\java\apache-maven-3.9.7
2.添加path环境变量
变量值：%MAVEN_HOME%\bin

image.png

image.png

  1. 测试
mvn -v    # 查看版本
  1. 设置国内镜像

为了解决下载依赖慢的问题，需要设置为国内镜像，在/conf/目录内settings.xml配置文件中添加如下代码

<!-- 阿里镜像地址 -->
<mirror>
    <id>aliyunmaven</id>
    <mirrorOf>*</mirrorOf>
    <name>aliyunmaven</name>
    <url>https://maven.aliyun.com/repository/public</url>
</mirror>

image.png

  1. 默认情况下，安装的依赖目录为 win用户目录/.m2/repository，相当于是本地仓库一样
  1. 本地仓库

就是settings.xml中配置的目录，使用过的依赖会存储在这里，后续复用。

  1. 中央仓库

是maven社区提供的仓库，内置了中央仓库的地址，其中包含了流行的开源java构件

  1. 公共仓库(重点)

依赖包下载

  1. 私服

公司私有的共享仓库，不对外开放，可以通过Nexus来创建，管理

vscode配置

基本环境

为了能够在vscode中方便的使用java语言，Microsoft特意推出了java插件包。

Java Extension Pack截至目前v0.27.0版本，该扩展需要java17或者以上版本。如果使用的是java老版本则需要安装旧版本插件

安装Extension Pack for Java插件

image-20240612145037988.png

安装该插件后会自动帮我们安装其它的6个插件，这个插件包含了多个 VSCode 扩展，包括 Java 核心功能和常用工具，如代码补全、调试器、测试工具等

各个子插件说明

  1. Maven for Java：如果你使用 Maven 构建工具，这个插件将为你提供与 Maven 相关的功能，如构建、依赖管理等。

  2. Language Support for Java（通过 Red Hat）：这个插件提供了基本的 Java 语法高亮、自动完成和代码片段，支持 Maven 和 Gradle 项目。

  3. Debugger for Java：这个插件允许你在 VSCode 中调试 Java 代码，可设置断点、观察变量和执行步进操作。

  4. Java Test Runner：该插件提供了 JUnit 和 TestNG 的测试运行器，使你可以方便地运行和调试测试代码。

  5. Java Project Manager：这个插件提供了一个图形界面来创建、构建和管理 Java 项目。

  6. IntelliCode： 它是由Microsoft开发的一个智能代码补全工具。

修改插件设置

vscode配置文件内加入以下配置项

根据当前的jdk安装目录，maven安装目录修改一下配置

// ===================java配置==start=================
// java插件配置
"java.jdt.ls.java.home": "D:\\sw\\install\\java\\jdk17",
"java.completion.matchCase": "off",
"[java]": {
"editor.defaultFormatter": "redhat.java"
},
"[xml]": {
"editor.defaultFormatter": "DotJoshJohnson.xml"
},
// maven插件配置
"maven.executable.path": "D:\\sw\\install\\java\\apache-maven-3.9.7\\bin\\mvn.cmd",
"maven.settingsFile": "D:\\sw\\install\\java\\apache-maven-3.9.7\\conf\\settings.xml",
"java.configuration.maven.userSettings": "D:\\sw\\install\\java\\apache-maven-3.9.7\\conf\\settings.xml",
"java.maven.downloadSources": true,
"maven.terminal.useJavaHome": true,
"maven.terminal.customEnv": [
{"environmentVariable": "JAVA_HOME",
"value": "D:\\sw\\install\\java\\jdk17"
}],
// ===================java配置==end=================

SpringBoot插件

Spring Boot Extension Pack：这个扩展包含了多个与 Spring Boot 相关的扩展，包括 Spring Boot Initializr、Spring Boot Dashboard、Spring Boot Snippets 等。

image-20240612153129207.png

  1. Spring Boot Tools：这个插件提供了对 Spring Boot 项目的支持，包括代码自动补全、快速定位到类和资源文件、智能导入依赖等功能。

  2. Spring Boot Dashboard：这个插件为你提供了一个可视化的仪表板，用于查看和管理运行中的 Spring Boot 项目。

  3. Spring Initializr Java Support：这个插件允许你在 VSCode 中通过 Spring Initializr 创建新的 Spring Boot 项目，并支持自动生成代码和配置。

  4. Spring Boot Snippets：这个插件提供了一些代码片段，可以快速生成常用的 Spring Boot 代码块，如控制器、服务、存储库等。

创建项目

当以上插件配置完成后，接下来就可以创建java项目了

创建普通项目

  1. 在vscode资源管理器区域，右键，创建java项目
  2. 在弹出的选项中，选择No build tools，然后选择目录，在输入项目名称即可

创建的项目结构如下

bin
lib   // jar包放置位置
src
 -App.java   // 入口main方法
README.md

image.png

创建springBoot项目

  1. 在vscode资源管理器区域，右键，创建java项目，或直接点击创建java项目
  2. 在弹出的选项中，选择Spring Boot，然后选择Maven Project，然后选择boot版本，在选择java

image.png

选择Maven Project

image.png

选择boot版本

image.png

选择java

image.png

  1. 输入项目组id，一般为倒写域名，例如com.example，接着输入项目名称，例如demo

image.png

项目名称

image.png

  1. 然后弹窗中选择jar，接着选择jdk版本，然后选需要的依赖，可以勾选 Spring Web，Spring Boot DevTools，Lombok，勾选后接下来选择保存目录就行了

image.png

选择java版本

image.png

勾选需要的依赖包

image.png

创建的项目结构如下

.mvn
.vscode
src
 -main
 --java  // 项目代码目录
 --resources
 ---application.properties   // 项目boot配置，例如启动端口号
 -test
target  // 打包后输出文件夹
HELP.md
mvnw
mvnw.cmd
pom.xml   // 项目依赖列表

image.png

编写测试代码

在创建controller文件夹，并在controller文件夹内创建Hello.java文件

// main/java/com/example/demo/controller/Hello.java
package com.example.demo.controller;   // 声明当前文件为一个包
import org.springframework.web.bind.annotation.*;  // 引入模块

@RestController
public class Hello {
  @RequestMapping("/hello")  // 注解
  public String handel(@RequestParam String name) {  // 接口处理
    return "Hello " + name + "!";
  }
  @PostMapping("/hello2")
  public String handel2(@RequestParam String name) {
    return "Hello22 " + name + "!";
  }
}

image.png

启动项目

按F5即可启动，或者点击vscode右上角的 图标，出现这个小面板就代表启动成功了

此时我们访问接口，成功了，默认端口是8080，当然你也可以去配置里面修改，前面有讲

image.png

打包

 mvn package   # 打包为jar,打包后会输出到 target文件夹
 # 进入target文件夹
 java -jar demo.jar  # 运行打包后的jar
avatar
文章
阅读
粉丝