一文说清SpringBoot项目各个文件作用《SpringBoot-01》

「这是我参与2022首次更文挑战的第9天,活动详情查看:2022首次更文挑战」。

一、新建项目

我们先新建一个项目,看看都有哪些文件和目录

二、最外层文件

我们先看最外层的文件

1、.gitignore文件

现在大多数应用都是使用Git作为代码版本控制系统,该文件定义了最常见的文件或目录的版本控制忽略名单,包括基于Eclipse的STS(Spring Tool Suite)、IDEA和NetBeans等项目元信息资源:

HELP.md
target/
!.mvn/wrapper/maven-wrapper.jar
!**/src/main/**/target/
!**/src/test/**/target/

### STS ###
.apt_generated
.classpath
.factorypath
.project
.settings
.springBeans
.sts4-cache

### IntelliJ IDEA ###
.idea
*.iws
*.iml
*.ipr

### NetBeans ###
/nbproject/private/
/nbbuild/
/dist/
/nbdist/
/.nb-gradle/
build/
!**/src/main/**/build/
!**/src/test/**/build/

### VS Code ###
.vscode/
复制代码

2、<项目名>.iml 文件

iml(infomation  of  module),也就是模块信息。它是我们项目的配置文件,存储一些模块配置信息,比如Maven组件、模块路径信息。

3、HELP.md文件

你项目的帮助文档,比如可以写一些项目架构的说明等内容,删除对项目运行没有影响。

4、.mvn目录和mvnw、mvnw.cmd文件

├── .mvn 
│   └── wrapper 
│       ├── maven-wrapper.jar 
│       └── maven-wrapper.properties 
├── mvnw 
└── mvnw.cmd
复制代码

使用maven的传统方式:

我们会先下载maven,然后Idea中修改maven为我们下载的maven。如果要更换maven版本,我们需要重新下载配置。

maven-wrapper

maven-wrapper的目的就是为了在更换maven版本的时候,不用手动去做上面说的事。

  1. 执行mvnw比如mvnw clean,如果本地没有匹配的maven版本,直接会去下载maven,放在用户目录下的.m2/wrapper中
  2. 如果需要更换maven版本,只需要更改maven-wrapper.properties配置文件中的distributionUrl属性值,更换对应的maven版本下载地址。mvnw命令就会自动重新下载。

mvnw和mvnw.cmd

这两个文件有相同的职责,引导.mvn/wrapper/maven-wrapper.jar下载Maven二进制文件,mvnw用于Linux系统,mvnw.cmd用于Windows系统。

说白了就是这两个文件使用是可执行的,使用maven-wrapper.jar和maven-wrapper.properties来下载Maven以及下载项目中pom配置的jar包。

5、pom.xml文件

这个文件应该就很熟悉了,属于maven的配置文件,我们需要依赖的jar包都在这里面配置并下载使用。

6、.idea文件夹

这是idea这个软件创建的,和项目本身没关系,这里会记录一些设置信息,比如代码风格、maven配置文件路径、编码格式等。

三、项目文件

1、src/main/java

是默认包,默认包下的类不需要写package信息。

priv.look.demo1使我们创建项目的时候自己设置的,属于root package。我们的主程序类Demo1Application就在该路径下,这也是SpringBoot建议主程序所在的路径。

2、resources

资源目录,static存储静态资源、js、css等。

templates存储html等前端页面文件。

application.properites是spring的配置文件。

3、test

单元测试所在的目录

おすすめ

転載: juejin.im/post/7068939345931010062