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

程序员的成长之路

共 2721字,需浏览 6分钟

 ·

2021-04-23 17:13

程序员的成长之路
互联网/程序员/技术/资料共享 
关注


阅读本文大概需要 2.8 分钟。


本文我们了解下 Spring Boot 的目录结构,了解一个事物,清楚了它的结构,明白了内部元素各自的职责,就能很好的认识到它的组织方式和运行机制。

我们以 IntelliJ IDEA 这个 IDE 生成的 Spring Boot 应用为例,详细地看一下应用里边都有哪些东西。

下图是在上一讲中我们用  IntelliJ IDEA 生成的 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.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 方式呢?以下这个图应该可以给你讲清楚!

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 坐标和依赖关系等信息,是项目级别的配置文件。

<END>

扫码加入技术交流群,不定送书

推荐阅读:

总结一下,我在国企当程序员!

服务端如何防止重复支付

互联网初中高级大厂面试题(9个G)

内容包含Java基础、JavaWeb、MySQL性能优化、JVM、锁、百万并发、消息队列、高性能缓存、反射、Spring全家桶原理、微服务、Zookeeper、数据结构、限流熔断降级......等技术栈!

戳阅读原文领取!                                       朕已阅 

浏览 27
点赞
评论
收藏
分享

手机扫一扫分享

分享
举报
评论
图片
表情
推荐
点赞
评论
收藏
分享

手机扫一扫分享

分享
举报