项目结构

原文链接：
http://www.jetbrains.org/intellij/sdk/docs/basics/project_structure.html

本节主要讲述IntelliJ平台 中项目及其相关的概念，如模块、facet、库 和SDK。你可以使用项目结构和Java类来管理项目和模块。

项目和它的组件

本节简要讨论了IDEA项目结构、项目组件和相关术语。 有关项目及其组件的更多信息，请到IntelliJ IDEA Web帮助参阅Project、Module、Library和Facet。

项目

在IntelliJ平台 中，一个项目 将所有的源代码，库和构建指令封装到单个组织单元中。你使用IntelliJ平台 SDK所做的一切都是在项目的上下文中完成的。项目可以定义为相关模块 和库 的集合。根据项目的逻辑和功能要求，你可以创建单模块 或多模块 项目。

模块

模块 是一个功能可以独立运行，测试和调试的离散单元。 模块包括如源代码，构建脚本，单元测试，部署描述符等内容。在项目中，每个模块可以使用指定SDK或继承项目指定的SDK（查看本文SDK部分）。一个模块可以依赖项目中的其它模块。

库

库是指你的模块所依赖的已编译的文件（例如JAR文件）。 IntelliJ 平台 支持三种类型的库：

  • 模块库：库中的类仅在当前模块可见，库的信息记录在模块.iml文件中；
  • 项目库：库中的类仅在整个项目可见，库的信息记录在项目.ipr文件或.idea/libraries文件夹中；
  • 全局库：库的信息记录在~/.IntelliJIdea/config/options文件夹的applicationLibraries.xml文件。全局库与项目库类似，但其在不同的项目中可见。

更多关于库的信息，参考库。

SDK

每个项目都要使用软件开发工具包（SDK）。 对于Java项目，SDK称为JDK（Java开发工具包）。

SDK决定构建项目使用的API库。如果你的项目是多模块项目，项目中的所有模块都默认使用项目SDK。

当然，你也可以为每个模块单独配置SDK。

更多关于SDK的信息，请到IntelliJ IDEA Web帮助参考配置全局、项目和模块的SDK 。

Facet

Facet表示与模块相关联的特定框架/技术的配置。一个模块可以有多个facet，例如Spring的特定配置存储在Spring facet中。

更多关于facet的信息，请到IntelliJ IDEA Web帮助查看Facet和Facet依赖。

项目结构

从插件开发者的角度来看，一个项目可以看成下图所示：

项目由一个或多个模块组成。每个模块包括插件源代码和order entries，即模块使用的SDK 和库。默认情况下，所有模块都使用项目SDK。 除此之外，一个模块也可以设置多个facet。

本文档解释了如何使用API浏览和更改项目结构。

使用项目

本节介绍如何完成与项目管理相关的一些常见任务，讨论那些可用于浏览和更改项目内容的Java类和接口。

如何使用项目文件？

IntelliJ平台 将项目配置数据保存到XML文件中。 这些文件取决于插件的项目格式。

对于文件格式的项目，项目本身的核心信息（如组件模块的位置、编译设置等）保存在%project_name%.ipr文件中。

项目所包含的模块信息保存在%module_name%.iml文件中。每个模块都会创建此文件。

对于目录格式的项目，项目和工作空间设置保存在%project_home_directory%/.idea目录下的一系列XML文件中。每个XML文件负责自己的一组设置，并且可以通过文件名识别：projectCodeStyle.xml, encodings.xml, vcs.xml等。

与文件格式的项目一样，.iml文件描述模块信息。

要使用项目和项目文件，你可以使用以下类和接口：

注意：你不必直接访问项目文件来加载或保存设置。 更多详情请参阅持久化组件状态。在此之后，变量project均为Project类型。例如在打开的项目中，你可以从操作获取它：Project project = e.getProject();

如何获取项目中所有模块的源代码根目录？

使用ProjectRootManager.getContentSourceRoots()方法。示例代码如下：

String projectName = project.getName();
StringBuilder sourceRootsList = new StringBuilder();
VirtualFile[] vFiles = ProjectRootManager.getInstance(project).getContentSourceRoots();
for (VirtualFile file : vFiles) {
  sourceRootsList.append(file.getUrl()).append("\n");
}

Messages.showInfoMessage("Source roots for the " + projectName + " plugin:\n" + sourceRootsList, "Project Properties");

如何检查一个文件是否与项目有关？

IntelliJ平台 提供了ProjectFileIndex接口，你可以使用它验证文件或文件夹是否与指定IDEA项目有关。本节解释了如何使用此接口。

如何获取ProjectFileIndex接口的实例？

使用ProjectRootManager.getFileIndex()方法。例如：
ProjectFileIndex projectFileIndex = ProjectRootManager.getInstance(project).getFileIndex()。

如何获取文件所属的模块？

要确定指定虚拟文件属于项目中的那个模块，使用ProjectFileIndex.getModuleForFile(virtualFile)方法：

Module module = ProjectRootManager.getInstance(project).getFileIndex().getModuleForFile(virtualFile);

注意：如果文件不属于任何模块，这个方法将返回null。

你也可以使用ProjectFileIndex.getContentRootForFile方法获取指定文件或文件夹所属模块内容的根目录：

VirtualFile moduleContentRoot = ProjectRootManager.getInstance(project).getFileIndex().getContentRootForFile(virtualFileorDirectory);

如何获取指定文件或文件夹所属模块源代码根目录或库源代码根目录？

使用ProjectFileIndex.getSourceRootForFile方法。例如：

VirtualFile moduleSourceRoot = ProjectRootManager.getInstance(project).getFileIndex().getSourceRootForFile(virtualFileorDirectory);

注意：如果文件或文件夹不属于项目模块中的源代码目录，这个方法将返回null。

我如何检查一个文件或文件夹是否与项目的库有关？

ProjectFileIndex接口有一系列的方法，你可以使用它们检查指定文件是否属于项目的库。

你可以使用以下方法：

  • ProjectFileIndex.isLibraryClassFile(virtualFile)：如果指定virtualFile是一个已编译的类文件，此方法返回true；
  • ProjectFileIndex.isInLibraryClasses(virtualFileorDirectory)：如果指定virtualFileorDirectory属于库，此方法返回true；
  • ProjectFileIndex.isInLibrarySource(virtualFileorDirectory)：如果指定virtualFileorDirectory属于库的源代码，此方法返回true。

如何获取项目的SDK？

  • 获取项目级SDK：Sdk projectSDK = ProjectRootManager.getInstance(project).getProjectSdk()；
  • 获取项目级SDK名称：String projectSDKName = ProjectRootManager.getInstance(project).getProjectSdkName()。

如何设置项目的SDK？

  • 设置项目级SDK：ProjectRootManager.getInstance(project).setProjectSdk(Sdk jdk);
  • 设置项目级SDK名称：ProjectRootManager.getInstance(project).setProjectSdkName(String name);

注意：默认情况下，项目模块使用项目SDK，当然你也可以为每个模块设置单独的SDK。

使用模块

IntelliJ平台提供了一系列使用模块的Java类和接口：

本节介绍如何完成与模块管理相关的一些常见任务。

如何获取项目包含的模块列表？

使用ModuleManager.getModules()方法。

如何获取模块的依赖和classpath？

Order entries包括SDK、库和模块使用的其它模块。 你可以在项目结构 对话框的依赖选项卡查看模块的order entries。

要浏览模块依赖可以使用OrderEnumerator类。

以下代码片段展示了如何获取模块的classpath（所有依赖的类的跟目录）：

VirtualFile[] roots = ModuleRootManager.getInstance(module).orderEntries().classes().getRoots();

如何获取模块使用的SDK？

使用ModuleRootManager.getSdk()方法。此方法返回的是Sdk类型。

以下代码段展示了如何获取指定模块使用的SDK的详细信息：

ModuleRootManager moduleRootManager = ModuleRootManager.getInstance(module);
Sdk SDK = moduleRootManager.getSdk();
String jdkInfo = "Module: " + module.getName() + " SDK: " + SDK.getName() + " SDK version: "
                 + SDK.getVersionString() + " SDK home directory: " + SDK.getHomePath();

如何获取此模块直接依赖的模块列表？

使用ModuleRootManager.getDependencies()方法获取一个Module类型的数组或使用ModuleRootManager.getDependencyModuleNames()方法获取一个模块名数组，示例代码如下：

ModuleRootManager moduleRootManager = ModuleRootManager.getInstance(module);
Module[] dependentModules = moduleRootManager.getDependencies();
String[] dependentModulesNames = moduleRootManager.getDependencyModuleNames();

如何获取依赖此模块的模块列表？

使用ModuleManager.getModuleDependentModules(module)方法。

你也可以使用ModuleManager.isModuleDependent方法检查一个模块(module1)是否依赖于另一个指定模块(module2) ：

boolean isDependent = ModuleManager.getInstance(project).isModuleDependent(module1,module2);

如何获取指定文件或PSI元素所属的模块？

  • 获取指定文件所属的项目模块，请使用ModuleUtil.findModuleForFile()静态方法；
    示例代码如下：

    String pathToFile = "C:\\users\\firstName.LastName\\plugins\\myPlugin\src\MyAction.java";
VirtualFile virtualFile = LocalFileSystem.getInstance().findFileByPath(pathToFile);
Module module = ModuleUtil.findModuleForFile(virtualFile,myProject);
String moduleName = module == null ? "Module not found" : module.getName();

  • 获取指定PSI元素 所属的项目模块，请使用ModuleUtil.findModuleForPsiElement(psiElement)方法。

如何使用模块中可用库？

如何获取模块中可用库的列表？

使用OrderEnumerator.forEachLibrary方法获取库列表。示例代码如下：

final List<String> libraryNames = new ArrayList<String>();
ModuleRootManager.getInstance(module).orderEntries().forEachLibrary(new Processor<Library>() {
  @Override
  public boolean process(Library library) {
    libraryNames.add(library.getName());
    return true;
  }
});
Messages.showInfoMessage(StringUtil.join(libraryNames, "\n"), "Libraries in Module");

此示例代码输出module模块的库列表。

如何获取库的内容？

Library类提供了getUrls方法，你可以使用它获取源代码根目录和库包含的类的列表。示例代码如下：

StringBuilder roots = new StringBuilder("The " + lib.getName() + " library includes:\n");
roots.append("Sources:\n");
for (String each : lib.getUrls(OrderRootType.SOURCES)) {
  roots.append(each).append("\n");
}
roots.append"Classes:\n");
for (String each : lib.getUrls(OrderRootType.CLASSES)) {
  strRoots.append(each).append("\n");
}
Messages.showInfoMessage(roots.toString(), "Library Info");

此示例代码中，lib为Library类型。

如何获得模块包含的facet？

使用FacetManager和Facet类。

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成，浏览时请结合常识与多方信息审慎甄别。
平台声明：文章内容（如有图片或视频亦包括在内）由作者上传并发布，文章内容仅代表作者本人观点，简书系信息发布平台，仅提供信息存储服务。

推荐阅读更多精彩内容