使用 Struts2 开发 RESTful API-JavaScript中文网-JavaScript教程资源分享门户

随着 Web 应用的发展，RESTful API 已经成为了很多 Web 应用的标配。在 Java Web 开发中，Struts2 是一个非常流行的 Web 框架，它也可以用来开发 RESTful API。本文将介绍如何使用 Struts2 开发 RESTful API，并提供示例代码。

RESTful API 简介

RESTful API 是一种 Web API 的设计风格，它使用 HTTP 协议的 GET、POST、PUT 和 DELETE 方法来实现对资源的 CRUD（Create、Read、Update、Delete）操作。RESTful API 的优点在于它的可扩展性、可移植性和可维护性。RESTful API 通常使用 JSON 或 XML 作为数据交换格式。

Struts2 简介

Struts2 是一个基于 MVC 模式的 Web 框架，它使用了很多设计模式，如拦截器、过滤器、委托等。Struts2 的核心是 Action，它负责处理请求并返回响应。Struts2 还提供了很多扩展，如表单验证、文件上传、国际化等。

在 Struts2 中，可以使用 REST 插件来支持 RESTful API。REST 插件可以将 HTTP 请求转化为 Struts2 Action 的调用。以下是使用 Struts2 开发 RESTful API 的步骤：

1. 添加 REST 插件

在 pom.xml 文件中添加 REST 插件的依赖：

<dependency>
    <groupId>org.apache.struts</groupId>
    <artifactId>struts2-rest-plugin</artifactId>
    <version>2.5.26</version>
</dependency>

2. 定义 Action

定义一个继承自 com.opensymphony.xwork2.ActionSupport 的 Action 类，并使用 @Namespace、@ParentPackage 和 @Action 注解来定义命名空间、父包和请求路径。例如：

-- -------------------- ---- -------
------------------
------------------------------
------ ----- ---------- ------- ------------- -
    ------------- - -------- ------- - -
        ------------ - ---------- ---- - -------
    --
    ------ ------ ---------- -
        -- ----- ---------
    -
-

在上面的代码中，@Namespace("/api") 指定了命名空间为 /api，@ParentPackage("rest-default") 指定了父包为 rest-default，这是 REST 插件提供的默认父包。@Action(value = "users", results = { @Result(name = "success", type = "json") }) 指定了请求路径为 /api/users，并指定了返回类型为 JSON。

3. 处理请求

在 Action 中定义一个处理请求的方法，并使用 @AllowedMethods 注解来指定支持的 HTTP 方法。例如：

@AllowedMethods("GET")
public String getUsers() {
    // TODO: 查询用户列表并返回
}

在上面的代码中，@AllowedMethods("GET") 指定了该方法只支持 GET 方法。

4. 返回响应

在 Action 中返回一个 POJO 或一个集合，并使用 @Result 注解来指定返回类型。例如：

@Action(value = "users", results = {
    @Result(name = "success", type = "json")
})
public String getUsers() {
    List<User> userList = userService.getUserList();
    return SUCCESS;
}

在上面的代码中，userService.getUserList() 返回一个用户列表，@Result(name = "success", type = "json") 指定了返回类型为 JSON。

5. 测试 API

使用浏览器或者 HTTP 客户端工具来测试 API。例如，访问 http://localhost:8080/myapp/api/users 可以获取用户列表。

示例代码

以下是一个完整的示例代码：

-- -------------------- ---- -------
------- ------------

------ --------------------------------------
------ -------------------------------------------

------ ---------------

------------------
------------------------------
------ ----- ---------- ------- ------------- -
    ------- ----------- ------------

    ------ ---- -------------------------- ------------ -
        ---------------- - ------------
    -

    ------------- - -------- ------- - -
        ------------ - ---------- ---- - -------
    --
    ----------------------
    ------ ------ ---------- -
        ---------- -------- - --------------------------
        ------ --------
    -
-

在上面的代码中，UserAction 类定义了一个 getUsers 方法，它返回一个用户列表。

总结

使用 Struts2 开发 RESTful API 是一种比较简单、方便的方式。Struts2 的 REST 插件可以帮助我们快速地实现 RESTful API，同时还提供了很多扩展，如表单验证、文件上传、国际化等。在实际应用中，我们可以根据需要来选择使用 Struts2 还是其他的 Web 框架。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/655d8b29d2f5e1655d7d074c