混合语言源目录布局

Question

我们正在运行一个使用多种不同语言的大型项目：Java、Python、PHP、SQL 和 Perl。

到目前为止，人们一直在自己的私有存储库中工作，但现在我们希望将整个项目合并到一个存储库中。 现在的问题是：目录结构应该是什么样的？ 我们应该为每种语言设置单独的目录，还是应该按组件/项目将其分开？ python/perl/java 处理公共目录布局的能力如何？

Answer 1

我的经验表明这种布局是最好的：

mylib/
    src/
       java/
       python/
       perl/
       .../
    bin/
       java/
       python/
       perl/
    stage/
    dist/

src 是您的源代码，并且是唯一签入的内容。

bin 是构建期间发生“编译”的位置，并且未签入。

stage 是在构建过程中复制内容以准备打包的地方

dist 是放置构建工件的位置

我放置模块/组件/库在层次结构的顶部，因为我单独构建每个模块，并使用依赖项管理器根据需要组合它们。

当然，命名约定有所不同。 但我发现这个方法的效果相当令人满意。

Answer 2

我认为最好的办法是确保您的各种模块不依赖于同一目录（即按组件分开）。 很多人似乎对这个想法非常害怕，但是一组好的构建脚本应该能够自动化消除任何痛苦。

最终目标是使基础设施的安装变得容易，然后在环境设置好后就可以轻松地在单个组件上工作。

（需要注意的是，我来自 Perl 和 CL 世界，我们将“模块”安装到某个全局位置，例如 ~/perl 或 ~/.sbcl，而不是像 Java 人员那样将每个模块包含在每个项目中。您可能认为这会是一个维护问题，但最终它不是一个定期更新 git 存储库（或 CPAN）中每个模块的脚本，这确实是最好的方法。）

编辑：一。更重要的是：

项目总是有外部依赖项。 我的项目需要 Postgres 和一个可用的 Linux 安装。 将其与版本控制中的应用程序代码捆绑在一起是疯狂的——但是在新工作站上进行所有设置的脚本非常有帮助。

我想我想说的是，也许以一种迂回的方式，我认为你不应该以不同于外部模块的方式对待你的内部模块。