Scala Play RealWorld 示例应用教程

Scala Play RealWorld 示例应用教程

scala-play-realworld-example-appExemplary real world application built with Scala 2.13 & Play项目地址:https://gitcode.com/gh_mirrors/sc/scala-play-realworld-example-app

1. 项目的目录结构及介绍

目录结构

scala-play-realworld-example-app/
├── app/
│   ├── commons/
│   │   └── models/
│   │       └── WithId.scala
│   ├── articles/
│   ├── authentication/
│   └── users/
├── bin/
├── conf/
│   ├── application.conf
│   └── routes
├── libexec/
├── project/
├── test/
├── build.sbt
├── codecov.yml
├── .gitignore
├── .travis.yml
├── LICENSE
├── Procfile
├── README.md
└── logo.png

目录介绍

• app/: 包含应用程序的主要代码，分为 commons, articles, authentication 和 users 模块。
• bin/: 包含可执行文件。
• conf/: 包含配置文件，如 application.conf 和路由文件 routes。
• libexec/: 包含库文件。
• project/: 包含项目配置文件。
• test/: 包含测试代码。
• build.sbt: 项目构建文件。
• codecov.yml: Codecov 配置文件。
• .gitignore: Git 忽略文件。
• .travis.yml: Travis CI 配置文件。
• LICENSE: 项目许可证。
• Procfile: Heroku 部署文件。
• README.md: 项目说明文档。
• logo.png: 项目图标。

2. 项目的启动文件介绍

启动文件

• RealWorldApplicationLoader.scala: 该文件位于 app/ 目录下，包含应用程序的启动逻辑，负责初始化和组合所有模块。

启动逻辑

class RealWorldApplicationLoader extends ApplicationLoader {
  def load(context: Context) = {
    new BuiltInComponentsFromContext(context) with AuthenticationComponents with ArticleComponents with UserComponents {
      // 初始化逻辑
    }.application
  }
}

3. 项目的配置文件介绍

配置文件

• application.conf: 位于 conf/ 目录下，包含应用程序的配置信息，如数据库连接、日志级别等。

配置示例

# application.conf

play.http.secret.key = "your-secret-key"

db.default.driver = "org.h2.Driver"
db.default.url = "jdbc:h2:mem:play"
db.default.username = "sa"
db.default.password = ""

logger.root = ERROR
logger.play = INFO

• routes: 位于 conf/ 目录下，定义了应用程序的路由规则，包括 HTTP 方法、路径和对应的控制器方法。

路由示例

# conf/routes

GET     /articles           controllers.ArticleController.listArticles
POST    /articles           controllers.ArticleController.createArticle
GET     /articles/:id       controllers.ArticleController.getArticle(id: Long)
PUT     /articles/:id       controllers.ArticleController.updateArticle(id: Long)
DELETE  /articles/:id       controllers.ArticleController.deleteArticle(id: Long)

以上是 Scala Play RealWorld 示例应用的基本教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些内容能帮助你更好地理解和使用该项目。

scala-play-realworld-example-appExemplary real world application built with Scala 2.13 & Play项目地址:https://gitcode.com/gh_mirrors/sc/scala-play-realworld-example-app