Blog

Blog

PHODAL

Gradle IDEA 的项目模型

最近在为新的工具 Scie 设计一个模型,以用于描述一个具体的代码工程。而刚好最近也在学习 Gradle 相关的项目模型,便想写一篇文章记录一下相关的模型,以支撑起 Scie 的开发。

PS:相关的代码位于 Gradle 源码中的 IDE 部分。

总体来说,用于支撑 IDE 开发的这个模型主要由这么几部分组成:

  • Project,最顶层的类,包含项目的所有信息。
  • Modules,模块,包含单个模块的信息。
  • GradleProject,包含一个模块的 Gradle 的相关信息。
  • ContentRoot,源码部分。
  • Dependency,依赖

从目录上来看总体的类便是,这个就是我们所需要的所有 Gradle 的 IDEA 相关的接口模型了。

  • BasicIdeaProject
  • IdeaCompilerOutput
  • IdeaContentRoot
  • IdeaDependency
  • IdeaDependencyScope
  • IdeaJavaLanguageSettings
  • IdeaLanguageLevel
  • IdeaModule
  • IdeaModuleDependency
  • IdeaModuleIdentifier
  • IdeaProject
  • IdeaSingleEntryLibraryDependency

不过,还是让我们从头看起,即 IdeaProject 部分。

IdeaProject

IdeaProject 部分的代码相对来说还是比较简单的,主要描述了项目相关的模块(Module)、JDK 信息和对应的语言版本等。

public interface IdeaProject extends HierarchicalElement {
   IdeaJavaLanguageSettings getJavaLanguageSettings() throws UnsupportedMethodException;
    String getJdkName();
    IdeaLanguageLevel getLanguageLevel();
    DomainObjectSet<? extends IdeaModule> getChildren();
    DomainObjectSet<? extends IdeaModule> getModules();
}

为了文章的完整性,我补充一下相关的接口类:

public interface HierarchicalElement extends Element {
    @Nullable
    HierarchicalElement getParent();
    DomainObjectSet<? extends HierarchicalElement> getChildren();
}

public interface Element extends Model {
    String getName();
    @Nullable
    String getDescription();
}

接着,就是 IdeaModule 部分了。

IdeaModule

代码也相对比较简单:

public interface IdeaModule extends HierarchicalElement, HasGradleProject {
    @Nullable
    IdeaJavaLanguageSettings getJavaLanguageSettings() throws UnsupportedMethodException;
    String getJdkName() throws UnsupportedMethodException;
    DomainObjectSet<? extends IdeaContentRoot> getContentRoots();
    GradleProject getGradleProject();
    IdeaProject getParent();
    IdeaProject getProject();
    IdeaCompilerOutput getCompilerOutput();
    DomainObjectSet<? extends IdeaDependency> getDependencies();
}

除了 Java 相关的配置信息,还有几个点值得关注:

  • 描述源码相关的 IdeaContentRoot
  • 描述 Gradle 信息的 GradleProject
  • 描述依赖的 IdeaDependency
  • 描述输出的 IdeaCompilerOutput

这里我们主要关注于 IdeaContentRootIdeaDependency

IdeaContentRoot

IdeaContentRoot,是用于描述源码相关的信息。这里,只需要看一下对应的接口,就能了解对应的信息了:

public interface IdeaContentRoot {
    File getRootDirectory();
    DomainObjectSet<? extends IdeaSourceDirectory> getSourceDirectories();
    DomainObjectSet<? extends IdeaSourceDirectory> getGeneratedSourceDirectories();
    DomainObjectSet<? extends IdeaSourceDirectory> getTestDirectories();
    DomainObjectSet<? extends IdeaSourceDirectory> getGeneratedTestDirectories();
    DomainObjectSet<? extends IdeaSourceDirectory> getResourceDirectories() throws UnsupportedMethodException;
    DomainObjectSet<? extends IdeaSourceDirectory> getTestResourceDirectories() throws UnsupportedMethodException;
    Set<File> getExcludeDirectories();
}

简单来说,就是我们在使用 IDE 的过程中,用于开发的那些要素:源码、测试代码、资源等等。

IdeaDependency

由于依赖采用的是 DomainObjectSet<? extends IdeaDependency>,即继承了这个接口的类都行,于是我找到了:

public interface IdeaSingleEntryLibraryDependency extends IdeaDependency, ExternalDependency {
    File getFile();
    File getSource();
    File getJavadoc();
}

不过,我并没有在 Gradle 的代码里找到对应的实现类,而是在 Intellij IDEA 的源码里找到了:InternalIdeaSingleEntryLibraryDependency,真是有趣。

结论

抽象和描述一个项目并不是一件容易的事情。

关于我

Github: @phodal     微博:@phodal     知乎:@phodal    

微信公众号(Phodal)

围观我的Github Idea墙, 也许,你会遇到心仪的项目

QQ技术交流群: 321689806

新书《全栈应用开发:精益实践》

这不是一本深入前端、后台、运维、设计、分析等各个领域的书籍。本书以实践的方式,将这一系列的领域及理论知识结合到一起,来帮助读者构建全栈Web 开发的知识体系,并辅以精益及敏捷的思想,来一步步开发Web 应用:从创建一个UI 原型到编写出静态的前端页面;从静态的前端页面到带后台的应用,并部署应用;从Web 后台开发API 到开发移动Web 应用。在这个过程中,我们还将介绍一些相辅相成的步骤:使用构建系统来加速Web 应用的开发;为应用添加数据分析工具来改进产品;使用分析工具来改善应用的性能;通过自动化部署来加快上线流程;从而帮助读者开发出一个真正可用的全栈 Web 应用。同时,我们也将帮助读者把这些步骤应用到现有的系统上,改进现有系统的开发流程。

comment

Feeds

RSS / Atom

最近文章

关于作者

Phodal Huang

Developer, Consultant, Writer, Designer

ThoughtWorks 高级咨询师

工程师 / 咨询师 / 作家 / 设计学徒

开源深度爱好者

出版有《前端架构:从入门到微前端》、《自己动手设计物联网》、《全栈应用开发:精益实践》

联系我: h@phodal.com

微信公众号: 与我沟通

标签