SpringMVC 中的 RESTful 编码风格案例详解

🕗 发布于 2024-09-20 14:01 restful pandas 后端 java mvc

文章目录

一、RESTful 简介
二、SpringMVC 中实现 RESTful 的方法
三、HiddenHttpMethodFilter
四、RESTful 代码实现案例

在现代 Web 开发中，RESTful 架构风格越来越受到开发者的青睐。SpringMVC 作为一个强大的 Java Web 开发框架，对 RESTful 风格的支持非常出色。本文将详细介绍 SpringMVC 中 RESTful 编码风格的简介、实现方法、HiddenHttpMethodFilter的作用以及一个具体的 RESTful 代码实现案例。

一、RESTful 简介

REST（Representational State Transfer）即表述性状态转移，是一种软件架构风格，它将网络上的一切都抽象为资源，每个资源都有唯一的标识（URI），通过 HTTP 协议的不同方法（GET、POST、PUT、DELETE 等）对资源进行操作，以实现对资源的增删改查。

RESTful 架构具有以下优点：

简单直观：资源的标识和操作方法都通过标准的 HTTP 协议来表示，易于理解和使用。
可扩展性强：可以方便地添加新的资源和操作方法，而不会影响现有的系统。
松耦合：客户端和服务器之间通过标准的接口进行通信，彼此之间的耦合度较低。
缓存友好：可以利用 HTTP 协议的缓存机制，提高系统的性能。

二、SpringMVC 中实现 RESTful 的方法

SpringMVC 提供了多种方式来实现 RESTful 风格的 Web 服务。其中最常用的方法是使用@RequestMapping注解和 HTTP 方法注解（如@GetMapping、@PostMapping、@PutMapping、@DeleteMapping等）来映射不同的请求方法到相应的处理方法上。

例如：

@RestController
@RequestMapping("/users")
public class UserController {

    // 获取所有用户
    @GetMapping
    public List<User> getAllUsers() {
        // 实现逻辑
    }

    // 获取单个用户
    @GetMapping("/{id}")
    public User getUserById(@PathVariable Long id) {
        // 实现逻辑
    }

    // 创建用户
    @PostMapping
    public User createUser(@RequestBody User user) {
        // 实现逻辑
    }

    // 更新用户
    @PutMapping("/{id}")
    public User updateUser(@PathVariable Long id, @RequestBody User user) {
        // 实现逻辑
    }

    // 删除用户
    @DeleteMapping("/{id}")
    public void deleteUser(@PathVariable Long id) {
        // 实现逻辑
    }
}

在上面的代码中，@RestController注解表示这是一个 RESTful 风格的控制器，@RequestMapping("/users")注解定义了控制器的基础路径。然后，通过不同的 HTTP 方法注解和路径参数，实现了对用户资源的增删改查操作。

三、HiddenHttpMethodFilter

在 HTML 表单中，只能使用GET和POST方法。如果要使用其他 HTTP 方法（如PUT和DELETE），可以使用HiddenHttpMethodFilter来模拟这些方法。

HiddenHttpMethodFilter的工作原理是在表单中添加一个隐藏字段_method，其值为要模拟的 HTTP 方法（如PUT或DELETE）。当表单提交时，HiddenHttpMethodFilter会检查这个隐藏字段，并将请求的方法转换为指定的方法。

例如：

<form action="/users/1" method="post">
    <!-- 隐藏字段，用于模拟 PUT 方法 -->
    <input type="hidden" name="_method" value="put">
    <!-- 其他表单字段 -->
    <input type="text" name="username">
    <input type="submit" value="Update">
</form>

在 SpringMVC 的配置文件中，需要添加HiddenHttpMethodFilter的配置：

<bean id="hiddenHttpMethodFilter" class="org.springframework.web.filter.HiddenHttpMethodFilter"/>

四、RESTful 代码实现案例

下面是一个完整的 SpringMVC RESTful 代码实现案例，包括实体类、控制器和服务层。

1. 实体类（User.java）

public class User {
    private Long id;
    private String username;
    private String email;

    // 构造方法、getter 和 setter 方法
}

2. 服务层接口（UserService.java）

public interface UserService {
    List<User> getAllUsers();
    User getUserById(Long id);
    User createUser(User user);
    User updateUser(Long id, User user);
    void deleteUser(Long id);
}

3. 服务层实现（UserServiceImpl.java）

@Service
public class UserServiceImpl implements UserService {

    private static List<User> users = new ArrayList<>();

    static {
        users.add(new User(1L, "user1", "user1@example.com"));
        users.add(new User(2L, "user2", "user2@example.com"));
    }

    @Override
    public List<User> getAllUsers() {
        return users;
    }

    @Override
    public User getUserById(Long id) {
        return users.stream().filter(user -> user.getId().equals(id)).findFirst().orElse(null);
    }

    @Override
    public User createUser(User user) {
        Long newId = users.stream().mapToLong(User::getId).max().orElse(0L) + 1;
        user.setId(newId);
        users.add(user);
        return user;
    }

    @Override
    public User updateUser(Long id, User user) {
        User existingUser = getUserById(id);
        if (existingUser!= null) {
            existingUser.setUsername(user.getUsername());
            existingUser.setEmail(user.getEmail());
            return existingUser;
        }
        return null;
    }

    @Override
    public void deleteUser(Long id) {
        users.removeIf(user -> user.getId().equals(id));
    }
}

4. 控制器（UserController.java）

@RestController
@RequestMapping("/users")
public class UserController {

    private final UserService userService;

    public UserController(UserService userService) {
        this.userService = userService;
    }

    // 获取所有用户
    @GetMapping
    public List<User> getAllUsers() {
        return userService.getAllUsers();
    }

    // 获取单个用户
    @GetMapping("/{id}")
    public User getUserById(@PathVariable Long id) {
        return userService.getUserById(id);
    }

    // 创建用户
    @PostMapping
    public User createUser(@RequestBody User user) {
        return userService.createUser(user);
    }

    // 更新用户
    @PutMapping("/{id}")
    public User updateUser(@PathVariable Long id, @RequestBody User user) {
        return userService.updateUser(id, user);
    }

    // 删除用户
    @DeleteMapping("/{id}")
    public void deleteUser(@PathVariable Long id) {
        userService.deleteUser(id);
    }
}

通过以上代码，我们实现了一个简单的 RESTful Web 服务，用于管理用户资源。可以使用 HTTP 方法对用户进行增删改查操作。

总结：
SpringMVC 中的 RESTful 编码风格使得 Web 开发更加简洁、高效和可维护。通过合理地使用@RequestMapping注解和 HTTP 方法注解，以及HiddenHttpMethodFilter，可以轻松地实现 RESTful 风格的 Web 服务。在实际开发中，可以根据具体需求灵活运用这些技术，提高开发效率和系统的可扩展性。

原文地址：https://blog.csdn.net/dawn191228/article/details/142280147

免责声明：本站文章内容转载自网络资源，如本站内容侵犯了原著者的合法权益，可联系本站删除。更多内容请关注自学内容网（zxcms.com）！

上一篇：【每天学点AI】一个例子带你了解Python装饰器到底在干嘛！
下一篇：Linux文件系统

ai写作软件排行榜前十名，5个软件帮助你快速使用ai写作
无论是需要撰写一篇深度分析的行业报告、一篇引人入胜的故事小说、一封专业得体的商务邮件，还是一段吸引眼球的社交媒体文案，这款AI写作工具都能轻松应对，让创作过程变得更加高效与便捷。随着用户的使用与反馈，
阅读更多2024-09-20
react 甘特图之旅
dhtmlx-gantt
阅读更多2024-09-20
[Spring]Spring MVC 请求和响应及用到的注解
Spring Web MVC 是基于 Servlet API 构建的原始 Web 框架，从⼀开始就包含在 Spring 框架中。MVC 是 Model View Controller 的缩写，它是软件
阅读更多2024-09-20
MATLAB基础：1.矩阵
矩阵是大部分运算或命令都是针对矩阵的不需要对矩阵的维数、大小和类型进行说明会根据用户所输入的内容自动进行配置矩阵：由m*n个数排列而成，简称 m*n矩阵字符串也视为矩阵，元素是字符。
阅读更多2024-09-20
中石化法律服务AI大平台 | OPENAIGC开发者大赛企业组AI创新之星奖
中石化法律服务AI大平台是基于企业相关信息系统操作及法律咨询需求打造的一套自动化产品，通过AIGC技术 ( OCR+NLP+ChatGPT ) 的结合，在法律咨询、合同审查、制度审查等阶段协助经办人制
阅读更多2024-09-20
单身狗的逆袭之路之开发相亲交友系统
相亲交友系统为单身人士提供逆袭机会，通过智能匹配算法提高成功率，满足个性化需求。
阅读更多2024-09-20
js-利用创建a便签实现下载文件功能
vue2 利用a标签实现文件下载功能
阅读更多2024-09-20
删除视频最后几帧剪切视频
删除视频最后帧剪切视频
阅读更多2024-09-20
JVM字节码与局部变量表
x：可以是i(int、byte、char、short、boolean类型)、l(long类型)、f(float类型)、d(double类型)、a(引用类型)x：可以是i(int、byte、char、s
阅读更多2024-09-20
基于深度学习的文本引导的图像编辑
基于深度学习的文本引导图像编辑技术结合了图像生成和自然语言处理的最新进展，通过生成对抗网络、变换器和扩散模型等方法，使用户能够通过文本描述实现对图像内容的灵活编辑。这一技术在多个应用场景中展现了巨大的
阅读更多2024-09-20