文档

§从源代码构建 Play

如果你想使用 Play 的一些未发布的更改,或者想自己为 Play 的开发做出贡献,你需要从源代码编译 Play。你需要一个 Git 客户端 来获取源代码。

§先决条件

要构建 Play,你需要安装 sbt

§获取源代码

从 shell 中,首先检出 Play 源代码

$ git clone [email protected]:playframework/playframework.git

检出你想要的分支,main 是当前开发分支,而主要版本的稳定分支以 .x 命名,例如 2.8.x

现在运行 sbt

$ sbt

要构建和发布 Play,运行 publishLocal

> publishLocal

这将为默认的 Scala 版本构建和发布 Play。如果你想为所有版本的 Scala 发布,你可以交叉构建

> +publishLocal

或者为特定版本的 Scala 发布

> ++ 2.13.13 publishLocal

§构建文档

文档在 playframework/documentation 中以 Markdown 文件的形式提供。要查看 HTML,运行以下命令

$ cd playframework/documentation
$ sbt run

你现在可以在 http://localhost:9000/@documentation 浏览文档。

有关开发 Play 文档的更多详细信息,请参阅 文档指南

§运行测试

你可以使用 test 任务从 sbt 控制台中运行单元测试和集成测试

> test

与发布一样,你可以在命令前加上 + 来针对所有支持的 Scala 版本运行测试。

Play PR 验证除了运行单元测试和集成测试外,还运行一些其他测试,包括脚本测试、测试文档代码示例和测试 Play 模板。PR 验证运行的脚本可以在 framework/scripts 目录中找到,您可以运行其中的每个脚本以执行与 PR 验证相同的测试。

§在项目中使用

当您在本地发布 Play 时,它会将快照版本发布到您的本地存储库。要使用它,您需要更新您的构建配置以使用此版本。

导航到您现有的 Play 项目,并在 project/plugins.sbt 中进行以下编辑

// Change the sbt plugin to use the local Play build (3.0.0-SNAPSHOT)
addSbtPlugin("org.playframework" % "sbt-plugin" % "3.0.0-SNAPSHOT")

完成此操作后,您可以启动控制台并正常与您的项目交互

$ cd <projectdir>
$ sbt

§在 Eclipse 中使用代码

您可以在 Stackoverflow 上找到一些关于如何在 Eclipse 中设置代码的信息。

下一步:存储库


发现此文档中的错误?此页面的源代码可以在 此处 找到。阅读完 文档指南 后,请随时贡献拉取请求。有疑问或建议要分享?前往 我们的社区论坛 与社区开始对话。