.idea文件夹

 1. Overview

1.概述

JetBrains IntelliJ IDEA is a popular choice among Java developers, and while working with it, we’ll encounter the .idea folder in our project structure.

JetBrains IntelliJ IDEA 是 Java 开发人员的首选，在使用它时，我们会在项目结构中遇到 .idea 文件夹。

In this article, we’ll explore this directory’s purpose and how to manage it effectively in real-life projects.

在本文中，我们将探讨该目录的用途以及如何在实际项目中有效管理它。

2. IntelliJ IDEA Configuration Methods

2.IntelliJ IDEA 配置方法

IntelliJ IDEA offers multiple configuration options to customize project settings. We can define global, project-level, and module-level settings.

IntelliJ IDEA 提供多种配置选项来定制项目设置。我们可以定义全局、项目级和模块级设置。

While exploring the project structure, apart from the mentioned .idea directory, we’ll notice the .iml file. Both the .idea directory and .iml file are used for configuration and are automatically generated when we start a new project or open an existing one. We can find them in the project’s root directory, alongside our pom.xml (or other build files).

在探索项目结构时，除了提到的 .idea 目录外，我们还会注意到 .iml 文件。.idea目录和.iml文件都用于配置，并在我们启动新项目或打开现有项目时自动生成。我们可以在项目的根目录中找到它们，以及 pom.xml（或其他构建文件）。

In some cases, a single project can combine multiple technologies and distribute logical components across modules. Consequently, a project can consist of multiple modules, and each module can require a different configuration.

在某些情况下，一个项目可以结合多种技术，并将逻辑组件分配到各个模块。因此，一个项目可能由多个模块组成，而每个模块可能需要不同的配置。

For example, a module might require a different Java version and language level compared to the project-level configuration. IntelliJ IDEA uses the .idea directory for project-level settings and .iml files for module-level settings to facilitate required granular configuration.

例如，与项目级配置相比，模块可能需要不同的 Java 版本和语言级别。 IntelliJ IDEA 将 .idea 目录用于项目级设置，将 .iml 文件用于模块级设置，以方便进行所需的细粒度配置。

3. Content of the .idea Directory

3..idea目录的内容

Inside the .idea directory, we’ll find various files and directories. JetBrains’ developers have tried to distribute configurations across different files to prevent potential merge conflicts when version control systems index this directory. As the IDE evolves and developers introduce new features, this can lead to changes in the contents of these files, as well as the addition of new files.

在 .idea 目录中，我们会发现各种文件和目录。JetBrains 的开发人员试图将配置分布在不同的文件中，以防止版本控制系统索引该目录时可能出现的合并冲突。随着集成开发环境的发展和开发人员引入新功能，这些文件的内容可能会发生变化，也可能会添加新文件。

3.1. Files and Directories Overview

3.1.文件和目录概述

Let’s review the files and directories we can typically find inside .idea:

让我们回顾一下我们通常能在 .idea 中找到的文件和目录：

• workspace.xml – this file serves as a central repository for user-specific project-level configurations, for example, change list information, run configurations, updated run configuration templates, some Maven settings, breakpoints, and more
• modules.xml – inside this file, IntelliJ IDEA stores the locations of .iml files for each module
• vcs.xml – this file stores version control system (VCS) settings and configurations, playing a pivotal role in integrating our project with source control tools like Git, SVN, and others
• codeStyles – stores code style settings tailored to the project, including information about the currently used formatter and additional configured properties
• dataSources – when the project has configured data sources, their settings are here
• shelf – this directory temporarily stores code changes when using the Shelf feature for version control in IntelliJ IDEA

The contents of the .idea folder can vary from project to project. The IDE may add additional directories or files based on our project’s configuration and the tools in use.

.idea文件夹的内容可能因项目而异。集成开发环境可能会根据项目配置和使用的工具添加其他目录或文件。

3.2. Is the .idea Directory Always There?

3.2..idea目录是否始终存在？

.idea文件夹

IntelliJ IDEA automatically generates the .idea folder and .iml files in all projects. The folder is usually visible on Windows systems.

IntelliJ IDEA 会在所有项目中自动生成 .idea 文件夹和 .iml 文件。该文件夹通常在 Windows 系统中可见。

However, it’s usually hidden on macOS and Linux systems. This might lead to confusion, but we can see them with ls -a.

不过，在 macOS 和 Linux 系统中，它通常是隐藏的。这可能会导致混淆，但我们可以使用 ls -a 查看它们。

4. Working with the .idea Directory

4.使用 .idea 目录

As we saw earlier, the .idea folder is created and managed by the IDE.

如前所述，.idea 文件夹由 IDE 创建和管理。

Some teams prefer to commit these files and others prefer not to. Let’s review both approaches.

一些团队喜欢提交这些文件，而另一些团队则不喜欢。让我们回顾一下这两种方法。

4.1. When We Commit the .idea Directory

4.1.当我们提交 .idea 目录时

IntelliJ IDEA can easily regenerate some files inside the .idea folder, but some files require additional manual configuration.

IntelliJ IDEA 可以轻松地重新生成 .idea 文件夹中的某些文件，但有些文件需要额外的手动配置。

When the project setup is complex, we might want to share local configuration with teammates to make bootstrapping smoother. The easiest way to achieve this is by committing the .idea directory along with the .iml files from all modules. We should be careful and avoid sharing user-specific settings, such as workspace.xml, usage.statistics.xml, and the shelf directory.

当项目设置比较复杂时，我们可能希望与队友共享本地配置，以便更顺利地启动项目。最简单的方法是提交 .idea 目录和所有模块的 .iml 文件。我们应该小心谨慎，避免共享 特定于用户的设置，例如 workspace.xml、usage.statistics.xml 和 shelf 目录。

We can resolve this by adding some exclusions to our .gitignore file:

我们可以通过在.gitignore文件中添加一些排除项来解决这个问题：

JetBrains suggests committing the .idea folder and provides its own gitignore example. However, adopting this approach ties our project to a particular IDE, which is generally discouraged in distributed teams with multiple developers, for several reasons:

JetBrains 建议提交.idea文件夹，并提供了自己的gitignore示例。但是，采用这种方法会将我们的项目绑定到特定的集成开发环境中，出于多种原因，在拥有多名开发人员的分布式团队中一般不鼓励采用这种方法：

• Other team members may use different IDEs or configurations.
• The IDE-specific configuration will clutter the repository with files that are not related to the project source code and run configurations.
• Teammates can use different IDE versions and this can lead to merge conflicts or incompatible configurations.

4.2. When We Do Not Commit the .idea Directory

4.2.当我们不提交 .idea 目录时

For seamless collaboration across multiple teams, especially when members are using different IDEs, it’s advisable to gitignore IDE-specific files and refrain from committing them to the shared repository. Let’s take a look at what the .gitignore file should include:

为了实现多个团队之间的无缝协作，尤其是当成员使用不同的集成开发环境时，建议使用.gitignore IDE 特定文件，并避免将其提交到共享仓库。让我们来看看 .gitignore 文件应该包括哪些内容：

With this approach, we can keep our source code clean and project independent. The main disadvantage here is the necessity to perform project setup for every new team member.

通过这种方法，我们可以保持源代码的整洁和项目的独立性。它的主要缺点是必须为每个新团队成员进行项目设置。

This issue is usually resolved via onboarding documents that include info about the required IDE project configuration.

这个问题通常可以通过入职文件来解决，其中包括所需的集成开发环境项目配置信息。

4.3. When Should We Directly Access the .idea Directory?

4.3.何时应直接访问 .idea 目录？

We might need to interact with .idea directory when the project unexpectedly stops working. In such cases, developers typically use the “Invalidate caches / Restart” IntelliJ option. If that doesn’t help, we can entirely delete the .idea directory and all .iml files, and thus completely reboot our project.

当项目意外停止工作时，我们可能需要与 .idea 目录交互。在这种情况下，开发人员通常会使用 “Invalidate caches / Restart”（使缓存失效/重新启动）IntelliJ 选项。如果还无济于事，我们可以完全删除 .idea 目录和所有 .iml 文件，从而彻底重启项目。

We should note that that if we delete the IntelliJ IDEA files, we will lose all shelved changes and we’ll need to set up our project preferences again.

我们应该注意，如果删除 IntelliJ IDEA 文件，我们将丢失所有搁置的更改，并且我们需要重新设置项目首选项。

5. Conclusion

5.结论

In this article, we explored IntelliJ IDEA’s configuration, delved into the essence of the .idea folder, and examined the role of .iml files.

在本文中，我们探讨了 IntelliJ IDEA 的配置，深入研究了 .idea 文件夹的本质，并检查了 .iml 文件的作用。

We discussed what resides within the .idea folder and how our source control might handle this directory, and we looked at the pros and cons of sharing its contents across developer workstations.

我们讨论了.idea文件夹中的内容，以及源代码控制如何处理该目录，并探讨了在开发人员工作站之间共享其内容的利弊。

今天的文章
.idea文件夹分享到此就结束了，感谢您的阅读。