SpringBoot 在 idea中的 .idea和 .iml文件

一、 引言

     最近为了测试MP各版本的差异，建了一个 boot-test的测试项目。然后接手了一个新平台，懒得新建项目框架了，就直接把 boot-test项目CV了一份，并命名为cps-task。

    然后我发现**两个项目共用一个 .iml 文件，无论修改哪个，都会影响另一个项目的名字**，如下图所示。同时，在这种情况下，**idea 侧面状态栏的maven打包，影响的也是同一个项目**。为此，做了本文记录一下 解决办法以及 .idea 和 .iml 文件的作用。

二、解决流程

     1、检查 pom.xml 文件中的  artifactId 标签，确保其为正确的项目名。

    2、检查 finalName标签，使其保持一致。(这个步骤不是必须的，这个标签只影响打包的jar包名，在这里并非必要)

    3、退出项目，并打开项目所在的目录。然后删掉 .idea文件夹 和 .iml文件，如下图所示。

    4、在 idea中 选择"File" -> "Open"或"Import Project"，然后浏览到你的项目目录，选择pom文件，并点击 OK。

    5、在新的弹窗中 选择 Open as Project ，打开项目。 

    6、双击Ctrl键 ，在下面的弹窗中 先输入  mvn  idea:module，然后在 Project 中 点击Browse Directory 。**这里的实际顺序为 ② -> ③ -> ①，输入后点回车**

    7、选择目标项目，并确认OK。 

     8、然后看到重新加载出来的 .iml 文件就正常了。

     9、重复上述操作，重新加载 boot-test项目，可以看到，项目也回复正常了。

三、.iml文件

     从上面可以看到生成 .iml文件的流程，那 .iml文件是什么呢

3.1. .iml文件是什么

** SpringBoot新项目中的iml文件是IntelliJ IDEA自动创建的模块文件**，用于描述项目的配置和依赖关系。它是Java应用开发中不可或缺的一部分，特别是在使用IntelliJ IDEA作为开发工具时。

3.2. .iml文件的主要内容

    iml文件主要包含以下几类信息：

1. 模块信息： - 项目的模块名称和标识符。- 模块的路径和位置。
2. 依赖信息： - 项目的依赖库列表，这些依赖库可能包括Java组件、插件组件、Maven组件等。- 依赖的版本和来源，确保项目能够正确地构建和运行。
3. 编译选项： - 项目的编译设置，如JDK版本、编译输出目录等。- 这些设置有助于确保项目在不同环境中保持一致的构建行为。
4. 其他设置： - 项目的编码设置，以确保文件在不同操作系统和编辑器中能够正确显示。- 项目的运行/调试配置，如主类、VM选项等。

3.3. .iml文件的重要性

• 项目识别：iml文件是IntelliJ IDEA识别项目的重要标识，缺少该文件IDEA可能无法正确加载项目。
• 快速构建和调试：iml文件记录了项目的模块和依赖信息，有助于IDE快速定位和加载项目结构，从而提高开发效率。
• 团队协作：通过共享iml文件，可以确保团队成员使用相同的项目配置和依赖项，减少配置错误和版本冲突。

3.4.注意事项

• 在使用版本控制系统（如Git）时，通常建议将iml文件添加到忽略列表中，因为它们是IDE特有的文件，不同开发者的开发环境可能有所不同。
• 如果不小心删除了iml文件，通常可以在IDE中重新生成它，但这可能会覆盖一些自定义设置。

四、.idea 文件

4.1. .idea文件是什么

    在SpringBoot项目中，

.idea

文件夹是由IntelliJ IDEA（一种流行的Java集成开发环境，IDE）自动创建的。这个文件夹包含了多个以

.xml

为后缀的文件，用于存放项目的配置信息，包括但不限于Maven依赖、历史记录、版本控制信息等。

    简单来说，.idea是 IntelliJ IDEA 生成，是IDEA用来管理项目设置和配置的核心部分，用于**配置应用信息**的文件目录。内部包含了类库，应用字符编码，模块，工作区等信息。 

    这里可以看到，**.idea文件夹很重要，是不推荐删除的，我能删是因为项目是我建的，我确定这个目录里没有自定义配置，我要删是因为不删该文件夹，.iml重新生成后名字没变化，还是错误的。**那么，如果平时误删了怎么办

4.2. .idea误删处理

4.2.1.从版本控制系统中恢复

     如果你的项目已经添加到了版本控制系统（如Git），那么可以通过版本控制系统来恢复.idea文件夹。在IDEA中，你可以通过右键点击项目文件，选择"Git" -> "Show History"，找到包含.idea文件夹的提交记录，并通过"Revert"操作来恢复。

4.2.2.使用IDEA的本地历史功能

    IDEA提供了一个本地历史功能，允许你查看和恢复文件的旧版本。你可以尝试在项目文件上右键点击，选择"Local History" -> "Show History"，然后查找.idea文件夹或其内部文件的旧版本，并进行恢复。但需要注意的是，这种方法可能无法完全恢复整个.idea文件夹的结构，因为本地历史功能可能只跟踪了部分文件的更改。 

4.2.3.重新导入项目

    如果以上方法都不可行，你可以尝试重新导入项目到IDEA中。在IDEA中，选择"File" -> "Open"或"Import Project"，然后浏览到你的项目目录，选择项目文件（如pom.xml对于Maven项目）并重新导入。IDEA在重新导入项目时，会尝试重新生成.idea文件夹和必要的配置文件。 

    **可以看到，我上面的操作2.4 和操作2.5实际上就是重新生成 .idea文件的。 ** 

4.2.4.手动创建配置文件

    在极端情况下，如果以上方法都不可行，你可能需要手动创建一些基本的IDEA配置文件。然而，这通常是一个复杂且容易出错的过程，因为.idea文件夹包含了许多复杂的配置信息。因此，这种方法通常不建议作为首选解决方案。 

4.2.5.使用数据恢复软件

    如果.idea文件夹被永久删除（例如，从文件系统中删除而不仅仅是从IDEA中删除），并且没有备份或版本控制记录，那么你可以尝试使用专业的数据恢复软件来尝试恢复文件。但需要注意的是，数据恢复的成功率取决于多种因素，如文件被删除后的时间、磁盘的使用情况等。 

    总之，为了避免数据丢失和不必要的麻烦，建议定期备份你的项目文件，并在删除任何文件之前三思而后行。此外，将项目添加到版本控制系统中也是一个很好的做法，它可以为你提供额外的数据保护和恢复选项。 

五、拓展：SpringBoot还有哪些内容，作用是什么

5.1. .mvn

    .mvn是Spring Boot 生成，用于一键通过 Maven 构建、编译、打包和部署的文件目录。 

5.2. src文件夹

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

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

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

5.3. target 文件夹

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

5.4. .gitignore文件

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

5.5. md文件

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

5.6. mvnw 和 mvnw.cmd

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

5.7. pom.xml

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

    暂时就记录这么多，有其他的，再进行补充。