VSCode中开发JavaWeb项目的详细过程（Maven+Tomcat+热部署）

作者：陌路skr 时间：2022-10-18 14:42:10　

1.安装插件

首先需要安装所用到的插件，分别用来支持Java、热部署和Tomcat服务器的插件

在插件市场中搜索Java，第一个就是Extension Pack for Java，内置了6个依赖插件，直接一键安装即可。然后是热部署插件，市场搜索Deploy安装即可。最后是Tomcat服务器插件，因为之前的Tomcat for Java被弃用了，官方推荐使用Community Server Connectors来进行代替，同样是搜索安装即可。就是下图的这三个插件。

2.配置全局的Java与Maven

快捷键shift+ctrl+p打开搜索框，然后输入settings.json，会出现下图的情况

点击第一个打开设置的选项，就会跳转到主settings.json文件中，这个文件是存在于C盘中的。下面是我的配置文件信息，根据需要对相关路径进行修改即可。

{
"editor.fontSize": 16,
"liveServer.settings.donotVerifyTags": true,
"liveServer.settings.donotShowInfoMsg": true,
"explorer.confirmDelete": false,
"explorer.confirmDragAndDrop": false,
"security.workspace.trust.untrustedFiles": "open",
"liveServer.settings.CustomBrowser": "chrome",
"javascript.updateImportsOnFileMove.enabled": "always",
"emmet.triggerExpansionOnTab": true,
"redhat.telemetry.enabled": true,
// Maven的相关配置信息
"java.configuration.maven.globalSettings": "D:\\maven\\apache-maven-3.6.3\\conf\\settings.xml",
"java.maven.downloadSources": true,
"java.configuration.maven.userSettings": "",
"maven.executable.path": "D:\\maven\\apache-maven-3.6.3\\bin\\mvn.cmd",
"maven.settingsFile": "D:\\maven\\apache-maven-3.6.3\\conf\\settings.xml",
"maven.executable.options": "-DarchetypeCatalog=internal",
// Java相关配置信息
"java.configuration.runtimes": [
{
"name": "JavaSE-1.8",
"path": "C:\\Program Files\\Java\\jdk1.8.0_181",
"default": true
}
],
"rsp-ui.enableStartServerOnActivation": [
{
"id": "redhat.vscode-community-server-connector",
"name": "Community Server Connector",
"startOnActivation": true
}
],
"java.jdt.ls.java.home": "c:\\Program Files\\Java\\jdk1.8.0_181",
}

3.开始创建Maven项目

点击创建Java项目，选择其中的Maven工具，由于是创建的JavaWeb项目，所以直接选择webapp即可。接下来版本选默认第一个的1.4即可，然后输入自定义groupId和artifactId。确定之后会选择项目的存放路径，然后Maven就开始构建项目了。

注意到此需要按一下回车来继续，并不是构建卡死了

之后还有一个确认，输入y或者回车都可以来继续

最后出现BuildSuccess即表示项目构建成功，点击右下方的open即可打开工程

4.配置该项目的settings.json

项目打开后，先对该项目的settings.json文件进行配置，这个属于该项目私人的配置文件，不同于上面全局的settings.json，它存在于本项目的.vscode文件夹中，一开始是看不见的。还是shift+ctrl+p快捷键打开搜索，输入settings.json，打开工作区设置的那个。

向其中添加配置信息，我的配置如下所示，多多少少与全局的settings.json中的配置有点重复冗余，如果觉得碍眼可以将重复配置的信息删除掉。

{
"java.jdt.ls.java.home": "C:\\Program Files\\Java\\jdk1.8.0_181",
"java.configuration.runtimes": [
{
"name": "JavaSE-1.8",
"path": "C:\\Program Files\\Java\\jdk1.8.0_181",
"default": true
}
],
//maven、gradle的配置文件变更后自动更新
"java.configuration.updateBuildConfiguration": "automatic",
//java源文件路径
"java.project.sourcePaths": [
"src/main/java",
"src/test/java",
],
//关闭自动编译
"java.autobuild.enabled": false,
//关闭debug前强制编译
"java.debug.settings.forceBuildBeforeLaunch": false,
//在项目根目录下生成.classpath等配置文件
"java.import.generatesMetadataFilesAtProjectRoot": true,
//
"maven.executable.path": "D:\\maven\\apache-maven-3.6.3\\bin\\mvn.cmd",
"java.configuration.maven.userSettings": "D:\\maven\\apache-maven-3.6.3\\conf\\settings.xml",
"maven.terminal.customEnv": [
{
"environmentVariable": "JAVA_HOME",
//
"value": "C:\\Program Files\\Java\\jdk1.8.0_181"
}
],
//使用Deploy插件来进行热部署时所需要的配置信息
"deploy": {
"packages": [
{
"name": "前端",
"description": "webapp里面的所有文件",
"files": [
"src/main/webapp/*",
"src/main/webapp/*/*",
"src/main/webapp/*.*",
"src/main/webapp/*/*.*",
"src/main/webapp/*/*/*.*",
"src/main/webapp/*/*/*/*.*",
"src/main/webapp/*/*/*/*/*.*",
"src/main/webapp/*/*/*/*/*",
"src/main/webapp/*/*/*/*/*/*.*",
],
"exclude": [
"src/main/webapp/test/*"
],
"deployOnSave": true,
"useTargetList": true,
"button": {
"text": "热部署",
"tooltip": "点击这里将前端部署到hotsite",
"targets": [ "HOTSITE" ]
},
}
],
"targets": [
{
"type": "local",
"name": "HOTSITE",
"description": "A local folder",
"dir": "target/SDDZYY/",
"mappings": [
{
"source": "src/main/webapp",
"isRegEx": false,
"target": "/"
}
]
}
]
}
}

注意：下面的Deploy配置信息是使用Deploy插件必须要有的。其中的files是一个层级目录，目前必须这样一层一层的写来进行扫描。然后targets配置中的dir指明编译后前端文件的路径，这边指定到target中去，因为后面后端文件编译后也是存放到target中去，这样的话就可以整合成一个完整的项目了，再将其部署到tomcat中即可，就是为什么需要指定存放到target的原因。

5.补全项目结构代码与依赖导入

打开项目之后，文件目录并不完整，缺失了很多，maven的老毛病了，自己手动补全文件夹，工程目录如下

然后将需要迁移的项目代码进行填充进去，后端Java代码放入到java文件夹中，前端页面代码放到webapp文件夹中，注意web.xml别忘了替换掉。

导入代码后会发现Java代码爆红了，是因为没有导入依赖所致，下面进行依赖导入。

由于是Maven项目，所以直接使用自带的pom.xml进行导入了，对于中央仓库上有的依赖包，直接点击Maven上的+号进行搜索添加对应的依赖即可。或者直接拷贝依赖的gav坐标到pom中也可以。

如果需要导入本地的第三方jar包，就只能一个个手动导入了，全部添加到pom.xml中去。下面做一个依赖的结构示范。就是这样的格式一个个的导入即可。

<dependency>
<groupId>fastjson-1.2.47</groupId>
<artifactId>fastjson-1.2.47</artifactId>
<version>1.2.47</version>
<scope>system</scope>
<systemPath>${basedir}/src/main/webapp/WEB-INF/lib/fastjson-1.2.47.jar</systemPath>
</dependency>

对了，还需要配置maven编译class文件的路径信息，也是在pom.xml中配置，在build标签下新增这几行。

<sourceDirectory>src/main/java</sourceDirectory>
<resources>
<resource>
<directory>src/main/resources</directory>
</resource>
</resources>
<outputDirectory>${basedir}/target/SDDZYY/WEB-INF/classes</outputDirectory>