Scalatra servlet的独立部署

时间:2013-05-31 11:24:31

标签: scala sbt scalatra sbt-assembly

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

我使用IntelliJ IDEA和Scala插件进行开发,并使用sbt来构建和运行我的servlet(我使用sbt-idea来生成项目文件)。 我的问题是当我尝试编译项目时,无法找到教程中JettyLauncher使用的jetty包。

更新:使用Matt的答案,我能够编译并运行JettyLauncher。但是,我仍然遇到sbt-assembly(https://github.com/sbt/sbt-assembly)的问题。我按照自述文件中的说明进行操作,但在尝试执行汇编任务时出现以下错误:

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

更新2:感谢Matt我现在有一个正在运行的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")
          )
        )
      }
    )
  )
}

提前致谢!

3 个答案:

答案 0 :(得分:15)

目前有两种独立部署选项:

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

    对于使用sbt-assembly的独立.jar文件,您需要先将插件添加到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。它们将包含在子文件夹/webapp中的最终.jar中。

    在项目中包含设置:

    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文件夹中。

答案 1 :(得分:4)

我最近遇到了麻烦。

首先,您需要确保在编译时可以使用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之后立即将scalateSettings添加到您的foobar项目中。您的plugins.sbt文件还需要包含以下行:

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

作为参考,我建议不要使用sbt-assembly,因为您很可能遇到需要使用merge strategy解决的依赖项冲突。相反,我建议您使用将依赖项收集到目录中的任务(示例herehere)。然后使用java -cp /lib/* ...将它们添加到java类路径中。

第三,要警惕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位于the usual place

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

答案 2 :(得分:1)