scala - Scalatra servlet 的独立部署

Question

我实现了一个 Scalatra servlet，现在想创建一个可执行 jar，就像本教程中描述的那样：http ://www.scalatra.org/2.2/guides/deployment/standalone.html

我使用 IntelliJ IDEA 和 Scala 插件进行开发，使用 sbt 构建和运行我的 servlet（我使用 sbt-idea 生成项目文件）。我的问题是，当我尝试编译我的项目时，找不到教程中的 JettyLauncher 使用的码头包。

更新：使用马特的回答，我能够编译和运行 JettyLauncher。但是，我仍然对 sbt-assembly ( https://github.com/sbt/sbt-assembly ) 有问题。我按照自述文件中的说明进行操作，但在尝试执行组装任务时出现以下错误：

[error] Not a valid command: assembly
[error] No such setting/task
[error] assembly
[error]         ^  

更新 2：感谢马特，我现在有了一个可以工作的 build.scala，我可以使用组装任务生成一个可执行的 jar。但是，sbt-assembly 不会将 /src/main/webapp 的内容添加到 jar 中。我使用这个文件夹来存储我的 HTML、CSS 和 JavaScript 文件。如果 Scalatra 无法匹配路由，它会提供这些文件，这在使用 container:start 运行 servlet 时有效。此外，我将服务器需要的一些文件存储在 /src/main/webapp/WEB-INF 中。这些文件也不会添加到 jar 中。

我的 build.scala 看起来像这样：

import sbt._
import Keys._
import org.scalatra.sbt._
import org.scalatra.sbt.PluginKeys._
import com.mojolly.scalate.ScalatePlugin._
import ScalateKeys._
import sbtassembly.Plugin._
import AssemblyKeys._

object SketchlinkBuild extends Build {
  val Organization = "de.foobar"
  val Name = "Foobar"
  val Version = "0.1"
  val ScalaVersion = "2.10.0"
  val ScalatraVersion = "2.2.0"

  lazy val project = Project (
    "foobar",
    file("."),
    settings = Defaults.defaultSettings ++ ScalatraPlugin.scalatraWithJRebel ++ scalateSettings ++ assemblySettings ++ Seq(
      organization := Organization,
      name := Name,
      version := Version,
      scalaVersion := ScalaVersion,
      resolvers += Classpaths.typesafeReleases,
      libraryDependencies ++= Seq(
            "org.scalatra" %% "scalatra" % ScalatraVersion,
            "org.scalatra" %% "scalatra-scalate" % ScalatraVersion,
            "org.scalatra" %% "scalatra-specs2" % ScalatraVersion % "test",
            "ch.qos.logback" % "logback-classic" % "1.0.6" % "runtime",
            "org.eclipse.jetty" % "jetty-webapp" % "8.1.8.v20121106" % "compile;container",
            "org.eclipse.jetty.orbit" % "javax.servlet" % "3.0.0.v201112011016" % "compile;container;provided;test" artifacts (Artifact("javax.servlet", "jar", "jar")),
            /* Apache commons libraries */
            "commons-codec" % "commons-codec" % "1.7", 
            "commons-io" % "commons-io" % "2.4",
            /* JSON support */
            "org.scalatra" %% "scalatra-json" % "2.2.1",
            "org.json4s"   %% "json4s-jackson" % "3.2.4",
            /* thumbnail library */
            "net.coobird" % "thumbnailator" % "0.4.3"
     ),
     // ignore about.html in jars (needed for sbt-assembly)
     mergeStrategy in assembly <<= (mergeStrategy in assembly) { (old) => {
       case "about.html" => MergeStrategy.discard
       case x => old(x) }
     },
     scalateTemplateConfig in Compile <<= (sourceDirectory in Compile){ base =>
        Seq(
          TemplateConfig(
            base / "webapp" / "WEB-INF" / "templates",
            Seq.empty,  /* default imports should be added here */
            Seq(
              Binding("context", "_root_.org.scalatra.scalate.ScalatraRenderContext", importMembers = true, isImplicit = true)
            ),  /* add extra bindings here */
            Some("templates")
          )
        )
      }
    )
  )
}

提前致谢！

Answer 1

目前有两种独立部署方式：

1. 使用 sbt-assembly 的单个 .jar，其中包含运行时和 webapp 资源。根据我的经验，从 .jar 文件加载资源非常慢。
2. 使用插件分发 .zip 文件scalatra-sbt，包含启动 shell 脚本、运行时资源和文件夹中的 webapp 资源。

1. 独立 JAR

对于使用的独立 .jar 文件，sbt-assembly您需要先将插件添加到project/build.sbt：

addSbtPlugin("com.eed3si9n" % "sbt-assembly" % "0.9.0")

然后您需要修改项目构建，例如project/build.scala. 导入插件的设置和密钥：

import sbtassembly.Plugin._
import sbtassembly.Plugin.AssemblyKeys._

sbt-assembly有了它，您可以为插件创建设置：

// settings for sbt-assembly plugin
val myAssemblySettings = assemblySettings ++ Seq(

  // handle conflicts during assembly task
  mergeStrategy in assembly <<= (mergeStrategy in assembly) {
    (old) => {
      case "about.html" => MergeStrategy.first
      case x => old(x)
    }
  },

  // copy web resources to /webapp folder
  resourceGenerators in Compile <+= (resourceManaged, baseDirectory) map {
    (managedBase, base) =>
      val webappBase = base / "src" / "main" / "webapp"
      for {
        (from, to) <- webappBase ** "*" x rebase(webappBase, managedBase / "main" / "webapp")
      } yield {
        Sync.copy(from, to)
        to
      }
  }
)

第一个定义了合并策略，最后一个将静态 Web 资源从 复制src/main/webapp到<resourceManaged>/main/webapp. 它们将包含在子文件夹中的最终 .jar 中/webapp。

在项目中包含设置：

lazy val project = Project("myProj", file(".")).settings(mySettings: _*).settings(myAssemblySettings:_*)

现在需要创建启动器。请注意如何设置资源库：

import org.eclipse.jetty.server.nio.SelectChannelConnector
import org.eclipse.jetty.server.Server
import org.eclipse.jetty.webapp.WebAppContext
import org.scalatra.servlet.ScalatraListener

object JettyMain {

  def run = {
    val server = new Server
    val connector = new SelectChannelConnector
    connector.setPort(8080)
    server.addConnector(connector)

    val context = new WebAppContext
    context.setContextPath("/")

    val resourceBase = getClass.getClassLoader.getResource("webapp").toExternalForm
    context.setResourceBase(resourceBase)
    context.setEventListeners(Array(new ScalatraListener))
    server.setHandler(context)

    server.start
    server.join
  }
}

2. .zip 使用scalatra-sbt插件分发

您需要将这些导入添加到您的 SBT build.scala：

import org.scalatra.sbt.DistPlugin._
import org.scalatra.sbt.DistPlugin.DistKeys._

然后您需要将插件的设置添加到您的项目中。设置在DistPlugin.distSettings.

您还可以自定义您的分发并添加自定义内存设置、导出和命令行选项。请注意，这些都是可选的：

val myDistSettings = DistPlugin.distSettings ++ Seq(
  mainClass in Dist := Some("ScalatraLauncher"),
  memSetting in Dist := "2g",
  permGenSetting in Dist := "256m",
  envExports in Dist := Seq("LC_CTYPE=en_US.UTF-8", "LC_ALL=en_US.utf-8"),
  javaOptions in Dist ++= Seq("-Xss4m", "-Dfile.encoding=UTF-8")
)

然后，您可以在 SBT 提示符下键入dist. .zip 文件将在target文件夹中。

Answer 2

我最近遇到了麻烦。

首先，您需要确保 jetty 在编译时可用。这两行：

"org.eclipse.jetty" % "jetty-webapp" % "8.1.8.v20121106" % "container",
"org.eclipse.jetty.orbit" % "javax.servlet" % "3.0.0.v201112011016" %     "container;provided;test" artifacts (Artifact("javax.servlet", "jar", "jar")),

需要在其中编译：

"org.eclipse.jetty" % "jetty-webapp" % "8.1.8.v20121106" % "compile;container",
"org.eclipse.jetty.orbit" % "javax.servlet" % "3.0.0.v201112011016" % "compile;container;provided;test" artifacts (Artifact("javax.servlet", "jar", "jar"))

其次，根据您的描述，听起来 sbt-assembly 配置不正确。您需要删除（注释掉）这些行：

lazy val buildSettings = Defaults.defaultSettings ++ Seq(
  version := "0.1",
  organization := "de.foobar",
  scalaVersion := "2.10.1"
)

lazy val app = Project("app", file("app"),
  settings = buildSettings ++ assemblySettings) settings(
    // your settings here
)

您需要在++ assemblySettings之后立即添加到您的 foobar 项目scalateSettings。您的 plugins.sbt 文件还需要包含以下行：

addSbtPlugin("com.eed3si9n" % "sbt-assembly" % "0.9.0")

作为参考，我建议不要使用sbt-assembly，因为您很可能会遇到需要使用合并策略解决的依赖冲突。相反，我建议您使用将依赖项收集到目录中的任务（此处和此处的示例）。然后使用 .将它们添加到 java 类路径中java -cp /lib/* ...。

第三，提防 Scalatra 的 GitHub 中的 Jetty 项目。我用了：

import java.net.InetSocketAddress
import org.eclipse.jetty.server.Server
import org.eclipse.jetty.servlet.DefaultServlet

import org.scalatra.servlet.ScalatraListener
import org.eclipse.jetty.webapp.WebAppContext

object Jetty {
  def main(args: Array[String]) = {
    val socketAddress = new InetSocketAddress(8080)
    val server = new Server(socketAddress)
    val context = new WebAppContext()
    context.setContextPath("/")
    context.setResourceBase("src/main/webapp")
    context.addEventListener(new ScalatraListener)
    context.addServlet(classOf[DefaultServlet], "/")
    server.setHandler(context)
    server.start()
    server.join()
  }
}

最后，可能值得仔细检查您的 ScalatraBootstrap 是否在通常的位置。

希望有帮助。如果没有，我可以为您发布我的整个 build.scala。

Answer 3

有关最新答案，请参阅这两个文件（学分转到 Scalatra in Action 书）：

https://github.com/scalatra/scalatra-in-action/blob/master/chapter09-standalone/src/main/scala/ScalatraLauncher.scala

和

https://github.com/scalatra/scalatra-in-action/blob/master/chapter09-standalone/project/Build.scala