Spark Java

2025 年 5 月 12 日 | 阅读 6 分钟

什么是 Spark Java？

Spark 是一个 Java 微框架，允许您快速创建 Java 8 的 Web 应用程序。Spark 是一个轻量级且简单的 Java Web 框架，专为快速开发而设计。它是受流行的 Ruby 微框架 Sinatra 的启发而创建的。

Spark 大量使用了 Java 8 的 lambda 表达式，这使得 Spark 应用程序的冗余代码更少。与其他 Java Web 框架不同，它不怎么依赖 XML 文件或注解。

开始使用 Spark Java

步骤 1：创建一个 Maven 项目，并将依赖项添加到 pom.xml 文件中

<dependency>
    <groupId>com.sparkjava</groupId>
    <artifactId>spark-core</artifactId>
    <version>2.9.3</version>
</dependency>

步骤 2：复制以下代码。

import static spark.Spark.*;
public class HelloWorld 
{
    public static void main(String[] args) 
{
        get("/hello", (req, res) -> "Hello World");
    }
}

步骤 3：在 Web 浏览器中输入以下 URL 以查看结果。

启动服务器

当我们执行需要启动服务器的操作时（例如声明一个路由或设置端口），服务器会自动启动。

我们也可以通过输入 init() 来手动启动服务器。

如果初始化失败，我们可以描述应该发生什么

日志记录和关闭是默认行为

private Consumer<Exception> initExceptionHandler = (e) -> {
    LOG.error("ignite failed", e);
    System.exit(100);
};

停止服务器

调用 stop() 方法时，服务器会停止，所有路由都会被清理。

路由

Spark 应用程序中有许多路由。路由是 URL 模式和 Java 处理程序之间的映射。

路由有三个部分

一个动词 - get, post, put, delete, head, trace, connect, and options
一个路径 - 例如 /first 或 /hello/:name
一个回调函数 - (request, response) ->{ }

定义路由的顺序决定了它们的匹配方式。请求会被转发到第一个匹配请求的路由。

为了保持良好的可读性，请始终静态导入 Spark 方法

get("/", (request, response) -> {
    // Show something
});
post("/", (request, response) -> {
    // Create something
});
put("/", (request, response) -> {
    // Update something
});
delete("/", (request, response) -> {
    // Annihilate something
});
options("/", (request, response) -> {
    // Appease something
});

可以使用请求对象上的 params() 方法来检索路由模式中的命名参数

// matches "GET /hello/foo" and "GET /hello/bar"
// request.params(":name") is 'foo' or 'bar'
get("/hello/:name", (request, response) -> {
    return "Hello: " + request.params(":name");
});

路由模式中也可以使用 Splat（或通配符）参数。可以使用请求对象上的 splat() 方法来检索这些参数

// matches "GET /say/hello/to/world"
// request.splat()[0] is 'hello' and request.splat()[1] 'world'
get("/say/*/to/*", (request, response) -> {
    return "Number of splat parameters: " + request.splat().length;
});

路由的取消映射

可以使用 'unmap' 函数来取消路由的映射

unmap("/hello"); // unmaps all routes with path 'hello'
unmap("/hello", "get"); // unmaps all 'GET' routes with path 'hello'

路径分组

如果有很多路由，将它们分成组会很有用。这可以通过调用 path() 方法来实现。该方法接受一个字符串前缀，并返回一个作用域，用于创建路由和过滤器（或嵌套路径）

path("/api", () -> {
    before("/*", (q, a) -> log.info("Received api call"));
    path("/email", () -> {
        post("/add",       EmailApi.addEmail);
        put("/change",     EmailApi.changeEmail);
        delete("/remove",  EmailApi.deleteEmail);
    });
    path("/username", () -> {
        post("/add",       UserApi.addUsername);
        put("/change",     UserApi.changeUsername);
        delete("/remove",  UserApi.deleteUsername);
    });
});

请求

请求参数提供以下信息和功能

request.attributes();             // the attributes list
request.attribute("foo");         // value of foo attribute
request.attribute("A", "V");      // sets value of attribute A to V
request.body();                   // request body sent by the client
request.bodyAsBytes();            // request body as bytes
request.contentLength();          // length of request body
request.contentType();            // content type of request.body
request.contextPath();            // the context path, e.g. "/hello"
request.cookies();                // request cookies sent by the client
request.headers();                // the HTTP header list
request.headers("BAR");           // value of BAR header
request.host();                   // the host, e.g. "example.com"
request.ip();                     // client IP address
request.params("foo");            // value of foo path parameter
request.params();                 // map with all parameters
request.pathInfo();               // the path info
request.port();                   // the server port
request.protocol();               // the protocol, e.g. HTTP/1.1
request.queryMap();               // the query map
request.queryMap("foo");          // query map for a certain parameter
request.queryParams();            // the query param list
request.queryParams("FOO");       // value of FOO query param
request.queryParamsValues("FOO")  // all values of FOO query param
request.raw();                    // raw request handed in by Jetty
request.requestMethod();          // The HTTP method (GET, ..etc)
request.scheme();                 // "http"
request.servletPath();            // the servlet path, e.g. /result.jsp
request.session();                // session management
request.splat();                  // splat (*) parameters
request.uri();                    // the uri, e.g. "http://example.com/foo"
request.url();                    // the url. e.g. "http://example.com/foo"
request.userAgent();              // user agent

响应

响应参数提供以下信息和功能

response.body();               // get response content
response.body("Hello");        // sets content to Hello
response.header("FOO", "bar"); // sets header FOO with value bar
response.raw();                // raw response handed in by Jetty
response.redirect("/example"); // browser redirect to /example
response.status();             // get the response status
response.status(401);          // set status code to 401
response.type();               // get the content type
response.type("text/xml");     // set content type to text/xml

查询映射

我们可以使用查询映射根据前缀将参数分组到一个映射中。这使我们能够向用户映射添加两个参数，例如 user[name] 和 user[age]。

request.queryMap().get("user", "name").value();
request.queryMap().get("user").get("name").value();
request.queryMap("user").get("age").integerValue();
request.queryMap("user").toMap();

Cookies

request.cookies();                         // get map of all request cookies
request.cookie("foo");                     // access request cookie by name
response.cookie("foo", "bar");             // set cookie with a value
response.cookie("foo", "bar", 3600);       // set cookie with a max-age
response.cookie("foo", "bar", 3600, true); // secure cookie
response.removeCookie("foo");              // remove cookie

会话

每个请求都可以访问服务器端会话，该会话通过以下方法提供

request.session(true);                     // create and return session
request.session().attribute("user");       // Get session attribute 'user'
request.session().attribute("user","foo"); // Set session attribute 'user'
request.session().removeAttribute("user"); // Remove session attribute 'user'
request.session().attributes();            // Get all session attributes
request.session().id();                    // Get session id
request.session().isNew();                 // Check if session is new
request.session().raw();                   // Return servlet object

中断

在过滤器或路由中使用 halt() 方法可以立即停止一个请求

halt();                // halt 
halt(401);             // halt with status
halt("Body Message");  // halt with message
halt(401, "Go away!"); // halt with status and message

注意：halt() 不应在异常映射器 (exception-mapper) 中使用。

过滤器

Before-filters 在每个请求之前进行检查，并且可以读取和修改请求和响应。

使用 halt() 方法可以停止程序的执行

before((request, response) -> {
    boolean authenticated;
    // ... check if authenticated
    if (!authenticated) {
        halt(401, "You are not welcome here");
    }
});

After-filters 在每个请求之后进行检查，并且可以读取请求并读取/修改响应

after((request, response) -> {
    response.header("foo", "set by after filter");
});

在 after-filters 之后，会检查 after-after-filters。可以将其视为“finally”块。

afterAfter((request, response) -> {
    response.header("foo", "set by afterAfter filter");
});

过滤器可以选择性地接受一个模式，这意味着它们仅在请求路径与其匹配时才会被评估

before("/protected/*", (request, response) -> {
    // ... check if authenticated
    halt(401, "Go Away!");
});

重定向

通过响应上的 redirect 方法，我们可以强制浏览器重定向

也可以通过特定的 HTTP 3XX 状态码触发浏览器重定向

重定向 API

还有一个重定向便捷 API，可以在不使用响应的情况下使用

// redirect a GET to "/fromPath" to "/toPath"
redirect.get("/fromPath", "/toPath");
// redirect a POST to "/fromPath" to "/toPath", with status 303
redirect.post("/fromPath", "/toPath", Redirect.Status.SEE_OTHER);
// redirect any request to "/fromPath" to "/toPath" with status 301
redirect.any("/fromPath", "/toPath", Redirect.Status.MOVED_PERMANENTLY);

下一个主题Smart-city-project-in-java

← 上一个下一个 →

Spark Java

什么是 Spark Java？

开始使用 Spark Java

启动服务器

停止服务器

路由

注意：halt() 不应在异常映射器 (exception-mapper) 中使用。

联系信息

关注我们

教程

面试题

在线编译器

Python

Java

.Net Framework

AI, ML and Data Science

Cloud Technology

B.Tech and MCA

Web Technology

PHP

Software Testing

Technical Interview

Java Interview

Python

Web Interview

Database Interview

B.Tech / MCA

Important Interview

Software Testing Interview

Company Interviews

Online Compilers

Multiple Choice Questions

Java Conversion

Java Misc

Spark Java

什么是 Spark Java？

开始使用 Spark Java

启动服务器

停止服务器

路由

注意：halt() 不应在异常映射器 (exception-mapper) 中使用。

相关帖子

Java 泛型队列

How to check Palindrome String in Java

Arrange an Array in Alternate Positive Negative Elements Using Java

Java 并行流示例

Java 中 Constraints 和 Annotations 的区别

Java Mono 类

AES 256 Encryption in Java

Java 中的图像处理 - 对比度增强

Invert k-th Most Significant Bits of N in Java

Java 中的模板创建

订阅 Tpoint Tech

联系信息

关注我们

教程

面试题

在线编译器