前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >Spring Boot 项目的这些文件都是干啥用的?

Spring Boot 项目的这些文件都是干啥用的?

作者头像
程序员小跃
发布2021-02-25 11:19:14
1.8K2
发布2021-02-25 11:19:14
举报
文章被收录于专栏:程序员小跃程序员小跃

大家好,我是你们的跃哥。跃哥一直在以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_idea_dir

乍一看,内容是挺多。不过上边不全是 Spring Boot 本身的文件,还包含了 IDE 生成的文件以及应用构建时生成的文件。

我们挨个来看吧。

course

course:Spring Boot 生成,应用的根文件目录,名称是在创建应用的时候初始化的。你创建的应用名叫 demo,那这个目录文件名就是 demo。

.idea

dot_idea_dir

.idea:IntelliJ IDEA 生成,用于配置应用信息的文件目录。内部包含了类库,应用字符编码,模块,工作区等信息。

.mvn

.mvn:Spring Boot 生成,用于一键通过 Maven 构建、编译、打包和部署的文件目录。内部结构如下:

dot_mvn_dir

可以看到,该文件目录包含了 maven-wrapper.jarmaven-wrapper.propertiesMavenWrapperDownloader.java 三个文件。另外和 .mvn 同层级的 mvnwmvnw.cmd 两个文件,是执行 maven-wrapper.jar 的入口,mvnw 用于 Linux 或 macOS,mvnw.cmd 用于 Windows

代码语言:javascript
复制
├── .mvn 
│   └── wrapper 
│       ├── maven-wrapper.jar 
│       └── maven-wrapper.properties 
│       └── MavenWrapperDownloader.java
├── mvnw 
└── mvnw.cmd

那么为什么要用 wrapper,而不用原生的 maven 方式呢?以下这个图应该可以给你讲清楚!

mvn_compare

我们发现和传统 maven 的使用方式相比, maven-wrapper 每次更换版本要少操作一步(图中标红箭头),只需要更新配置文件(maven-wrapper.properties )中的 distributionUrl 为目标版本即可。不过也有代价,就是首次下载 maven 包的时候,要单独下载 wrapper(图中蓝色区块),但这是一劳永逸的事情。

mvn_wrapper_cfg

简单讲,maven-wrapper 解决了应用依赖的 Maven 版本手动切换的问题,达成自动更新的目标,提高了工作效率 。

src

src_with_test_dir

src:Spring Boot 生成,存放应用源代码的文件目录。

二级目录 main存放程序实际执行相关代码, test 存放程序测试相关代码

三级目录 java 存放后缀为 .java 的代码文件,resources 存放静态文件,模板文件,应用配置文件等资源或配置类文件。java 目录里边就是一个个代码包和代码文件,CourseApplication 是整个应用程序的启动入口。

target

target_dir

target:应用构建时生成,主要存放了源代码编译后的 class 文件,相关的配置文件以及打好的包文件等用于实际执行的文件。

.gitignore

gitingore_file

.gitignore:Spring Boot 生成,版本控制系统 Git 的配置文件,表示忽略提交。该文件中,只要遵循相应的语法,每一行可以指定一个忽略规则。

course.iml

iml_cfg

course.iml:IntelliJ IDEA 生成,IntelliJ IDEA 的工程配置文件。包含了当前工程的一些配置信息,比如模块信息,Java 组件,Maven 组件等等以及一些模块的路径信息和依赖信息。

HELP.md

help_file

HELP.md:Spring Boot 生成,帮助文档,提供了 Spring Boot相关文档和教程。

mvnw 和 mvnw.cmd

mvnw 和 mvnw.cmd:Spring Boot 生成,和 .mvn 目录下文件搭配使用,是执行 mvnw 命令的入口。

pom.xml

pom_file

pom.xml:Spring Boot 生成的项目对象模型文档,主要描述了项目的 Maven 坐标和依赖关系等信息,是项目级别的配置文件。

好了,Spring Boot 应用的目录结构介绍就到这里,如果对你也有用的话,可以给我点个赞,点个在看,也可以分享给身边朋友,非常感谢读者朋友。

本文参与 腾讯云自媒体分享计划,分享自微信公众号。
原始发表:2021-02-02,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 奔跑吧攻城狮 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体分享计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • course
  • .idea
  • .mvn
  • src
  • target
  • .gitignore
  • course.iml
  • HELP.md
  • mvnw 和 mvnw.cmd
  • pom.xml
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档