sbt-war 项目技术文档

本文档将详细介绍如何使用 sbt-war 插件，这是一个用于打包和运行 .war 文件的 sbt 插件。以下是安装指南、项目使用说明以及项目 API 使用文档。

安装指南

在开始之前，请确保您的系统已经安装了 sbt 1.x 版本和 Scala 2.12.x 版本。

从模板开始

使用以下命令从模板创建新项目：

sbt new earldouglas/sbt-war.g8

按照提示填写项目名称，模板将自动应用并创建一个新的 sbt 项目。

从头开始

如果您想从头开始创建项目，请按照以下步骤操作：

1. 创建一个新的空项目文件夹：

mkdir myproject
cd myproject

2. 设置项目结构：

mkdir project
mkdir -p src/main/scala/mypackage

3. 配置 sbt：

在 project/build.properties 文件中，设置 sbt 版本：

sbt.version=1.10.2

在 project/plugins.sbt 文件中，添加 sbt-war 插件：

addSbtPlugin("com.earldouglas" % "sbt-war" % "5.0.0-M6")

在 build.sbt 文件中，启用 sbt-war 插件：

scalaVersion := "3.5.1"
enablePlugins(SbtWar)

项目使用说明

以下是如何使用 sbt-war 插件打包和运行 .war 文件的步骤。

添加 Servlet

在 src/main/scala/mypackage/MyServlet.scala 文件中添加一个 Servlet：

package mypackage

import jakarta.servlet.annotation.WebServlet
import jakarta.servlet.http.HttpServlet
import jakarta.servlet.http.HttpServletRequest
import jakarta.servlet.http.HttpServletResponse

@WebServlet(urlPatterns = Array("/hello"))
class MyServlet extends HttpServlet:
  override def doGet(
      req: HttpServletRequest,
      res: HttpServletResponse
  ): Unit =
    res.setContentType("text/html")
    res.setCharacterEncoding("UTF-8")
    res.getWriter.write("""<h1>Hello, world!</h1>""")

运行项目

在 sbt 中运行以下命令启动项目：

sbt warStart

您可以通过访问 http://localhost:8080/hello 来查看 Servlet 的输出。

停止项目

要停止运行的项目，请在 sbt 中运行以下命令：

sbt warStop

打包项目

要创建 .war 文件，请在 sbt 中运行以下命令：

sbt package

打包后的 .war 文件将位于 target/scala-版本号/ 目录下。

项目 API 使用文档

以下是 sbt-war 插件的一些关键设置和命令。

设置

键名	类型	默认值	说明
warResources	Map[String,File]	src/main/webapp	静态文件（HTML、CSS、JS、图像等）直接服务的目录
warClasses	Map[String,File]	项目类	复制到 WEB-INF/classes 目录中的 .class 文件
warLib	Map[String,File]	项目库	复制到 WEB-INF/lib 目录中的 .jar 文件
warPort	Int	8080	运行 warStart 时使用的本地容器端口
warForkOptions	ForkOptions	BufferedOutput	运行 warStart 时使用的 JVM 分支选项

命令

键名	说明
warStart	启动本地容器，从打包的 .war 文件中服务内容
warQuickstart	启动本地容器，直接从项目源代码中服务内容
warJoin	阻塞直到容器关闭
warStop	停止运行的容器

通过上述文档，用户可以了解如何安装、使用和配置 sbt-war 插件，以便在 sbt 项目中打包和运行 .war 文件。