Spring Boot 项目的这些文件都是干啥用的?
共 2424字,需浏览 5分钟
·
2021-02-02 21:40
大家好,我是你们的跃哥。跃哥一直在以Java作为自己的第一语言,从之前的Android到现在的SpringBoot、SpringCloud、Dubbo 都还没离开过Java。
虽然一直强调SpringBoot,也没好好和大家解释过SpringBoot下的文件夹是干啥用的。那今天就和大家一起探讨下吧。
上一讲我们用官网包或者 IDE 工具,快速构建了 Spring Boot 应用,并且看到了第一个程序的运行结果:Hello World!
本文我们了解下 Spring Boot 的目录结构,了解一个事物,清楚了它的结构,明白了内部元素各自的职责,就能很好的认识到它的组织方式和运行机制。
我们以 IntelliJ IDEA 这个 IDE 生成的 Spring Boot 应用为例,详细地看一下应用里边都有哪些东西。
下图是在上一讲中我们用 IntelliJ IDEA 生成的 Spring Boot 应用,详情戳:五分钟快速构建第一个 Spring Boot 应用。
乍一看,内容是挺多。不过上边不全是 Spring Boot 本身的文件,还包含了 IDE 生成的文件以及应用构建时生成的文件。
我们挨个来看吧。
course
course:Spring Boot 生成,应用的根文件目录,名称是在创建应用的时候初始化的。你创建的应用名叫 demo,那这个目录文件名就是 demo。
.idea
.idea:IntelliJ IDEA 生成,用于配置应用信息的文件目录。内部包含了类库,应用字符编码,模块,工作区等信息。
.mvn
.mvn:Spring Boot 生成,用于一键通过 Maven 构建、编译、打包和部署的文件目录。内部结构如下:
可以看到,该文件目录包含了 maven-wrapper.jar、maven-wrapper.properties 和 MavenWrapperDownloader.java 三个文件。另外和 .mvn 同层级的 mvnw 和 mvnw.cmd 两个文件,是执行 maven-wrapper.jar 的入口,mvnw 用于 Linux 或 macOS,mvnw.cmd 用于 Windows。
├── .mvn
│ └── wrapper
│ ├── maven-wrapper.jar
│ └── maven-wrapper.properties
│ └── MavenWrapperDownloader.java
├── mvnw
└── mvnw.cmd
那么为什么要用 wrapper,而不用原生的 maven 方式呢?以下这个图应该可以给你讲清楚!
我们发现和传统 maven 的使用方式相比, maven-wrapper 每次更换版本要少操作一步(图中标红箭头),只需要更新配置文件(maven-wrapper.properties )中的 distributionUrl 为目标版本即可。不过也有代价,就是首次下载 maven 包的时候,要单独下载 wrapper(图中蓝色区块),但这是一劳永逸的事情。
简单讲,maven-wrapper 解决了应用依赖的 Maven 版本手动切换的问题,达成自动更新的目标,提高了工作效率 。
src
src:Spring Boot 生成,存放应用源代码的文件目录。
二级目录 main存放程序实际执行相关代码, test 存放程序测试相关代码。
三级目录 java 存放后缀为 .java 的代码文件,resources 存放静态文件,模板文件,应用配置文件等资源或配置类文件。java 目录里边就是一个个代码包和代码文件,CourseApplication 是整个应用程序的启动入口。
target
target:应用构建时生成,主要存放了源代码编译后的 class 文件,相关的配置文件以及打好的包文件等用于实际执行的文件。
.gitignore
.gitignore:Spring Boot 生成,版本控制系统 Git 的配置文件,表示忽略提交。该文件中,只要遵循相应的语法,每一行可以指定一个忽略规则。
course.iml
course.iml:IntelliJ IDEA 生成,IntelliJ IDEA 的工程配置文件。包含了当前工程的一些配置信息,比如模块信息,Java 组件,Maven 组件等等以及一些模块的路径信息和依赖信息。
HELP.md
HELP.md:Spring Boot 生成,帮助文档,提供了 Spring Boot相关文档和教程。
mvnw 和 mvnw.cmd
mvnw 和 mvnw.cmd:Spring Boot 生成,和 .mvn 目录下文件搭配使用,是执行 mvnw 命令的入口。
pom.xml
pom.xml:Spring Boot 生成的项目对象模型文档,主要描述了项目的 Maven 坐标和依赖关系等信息,是项目级别的配置文件。
好了,Spring Boot 应用的目录结构介绍就到这里,如果对你也有用的话,可以给我点个赞,点个在看,也可以分享给身边朋友,非常感谢读者朋友。