Day06_13_SpringBoot教程之实现Restful风格API

不念不忘少年蓝@ 2024-01-20 07:16 56阅读 0赞

## Day06\_13\_SpringBoot教程之实现Restful风格API ##

### 一.Restful简介 ###

#### 1. Restful概述 ####

Restful是一种软件架构风格,它是一种设计风格而**不是**标准,只是提供了一组设计原则和约束条件.它主要用于客户端和服务器交互类型的软件开发中,基于这个风格设计的软件可以更简洁,更有层次,更易于实现缓存等机制.

在服务器端,应用程序状态和功能可以分为各种资源.资源是一个有趣的概念实体,它向客户端公开.资源的例子有:应用程序对象、数据库记录、算法等等.每个资源都可以使用 `URI` (`Universal Resource Identifier`) 得到一个唯一的地址,所有资源都共享统一的接口,以便在客户端和服务器之间传输状态.使用的是标准的 `HTTP` 方法,比如 `GET、PUT、POST 和 DELETE`.

#### 2. Rest常用请求方式 ####

在基于Rest的设计中,使用一组通用的动词来操作资源:

*  创建资源: 应使用`HTTP POST`;
 *  检索资源: 应该使用`HTTP GET`;
 *  更新资源: 应使用`HTTP PUT`;
 *  删除资源: 应该使用`HTTP DELETE`.

### 二. SpringBoot搭建 RESTful风格的API接口实现步骤 ###

#### 1. 创建一个新的模块--boot\_restful ####

![Image 1][]![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N5YzAwMDY2Ng_size_16_color_FFFFFF_t_70][]

#### 2. pom.xml中添加依赖包 ####

<dependencies>
        
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
    
        
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-thymeleaf</artifactId>
        </dependency>
    
        
        <dependency>
            <groupId>net.sourceforge.nekohtml</groupId>
            <artifactId>nekohtml</artifactId>
            <version>1.9.22</version>
        </dependency>
    
        
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.16.20</version>
        </dependency>
    
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

#### 3. 创建一个pojo类--User ####

package com.syc.boot.domain;
    import lombok.Data;
    import java.io.Serializable;
    
    @Data
    public class User implements Serializable {
    
        private Long id;
        private String name;
        private Integer age;
    
    }

#### 4. 创建Controller接口方法 ####

package com.syc.boot.web;
    import com.syc.boot.domain.User;
    import org.springframework.web.bind.annotation.*;
    import java.util.*;
    
    @RestController
    // 通过这里配置使下面的映射都在/users下
    @RequestMapping(value="/users")
    public class UserController {
    
        // 创建线程安全的Map
        static Map<Long, User> users = Collections.synchronizedMap(new HashMap<>());
    
        // 处理GET请求,用来获取用户列表.
        // 可以通过@RequestParam获取从页面中传递进来的查询条件或者翻页信息等参数.
        @RequestMapping(value="/", method=RequestMethod.GET)
        public List<User> getUserList() {
            return new ArrayList<>(users.values());
        }
    
        // 处理POST请求,用来创建User.
        // 除了@ModelAttribute绑定参数之外,还可以通过@RequestParam从页面中传递参数.
        @RequestMapping(value="/", method=RequestMethod.POST)
        public String addUser(@RequestBody User user) {
            users.put(user.getId(), user);
            System.out.println("user==="+users.get(user.getId()));
            return "success";
        }
    
        // 处理GET请求,用来获取url中id值的User信息;
        // url中的id可通过@PathVariable绑定到函数的参数中.
        @RequestMapping(value="/{id}", method=RequestMethod.GET)
        public User getUser(@PathVariable Long id) {
            return users.get(id);
        }
    
        // 处理PUT请求,用来更新User信息.
        @RequestMapping(value="/{id}", method=RequestMethod.PUT)
        public String updateUser(@PathVariable Long id, @RequestBody User user) {
            User u = users.get(id);
            u.setName(user.getName());
            u.setAge(user.getAge());
            users.put(id, u);
            return "success";
        }
    
        // 处理DELETE请求,用来删除User
        @RequestMapping(value="/{id}", method=RequestMethod.DELETE)
        public String deleteUser(@PathVariable Long id) {
            users.remove(id);
            return "success";
        }
    
    }

#### 5. 创建应用程序入口类 ####

package com.syc.boot;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    /**
     *
     */
    @SpringBootApplication
    public class RestWebApplication {
    
        public static void main(String[] args) {
            SpringApplication.run(RestWebApplication.class, args);
        }
    }

### 三. 运行测试 ###

#### 1. 添加一个新用户 ####

执行post请求,传递json格式的参数.  
![Image 1][]![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N5YzAwMDY2Ng_size_16_color_FFFFFF_t_70 1][]

#### 2. 查询全部用户 ####

执行get请求,查询刚才添加的用户,不需要传递任何参数.  
![Image 1][]![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N5YzAwMDY2Ng_size_16_color_FFFFFF_t_70 2][]

#### 3. 更新用户信息 ####

执行put请求,传递id作为参数.  
![Image 1][]![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N5YzAwMDY2Ng_size_16_color_FFFFFF_t_70 3][]

查询更新后的结果

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N5YzAwMDY2Ng_size_16_color_FFFFFF_t_70 4][]

#### 4. 删除用户 ####

执行delete请求,删除id为1的用户  
![Image 1][]![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N5YzAwMDY2Ng_size_16_color_FFFFFF_t_70 5][]

查询删除后的结果

![Image 1][]![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N5YzAwMDY2Ng_size_16_color_FFFFFF_t_70 6][]

[Image 1]: 
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N5YzAwMDY2Ng_size_16_color_FFFFFF_t_70]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/20/3c28514d02684df3a9ba90cd548b95be.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N5YzAwMDY2Ng_size_16_color_FFFFFF_t_70 1]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/20/1ba3fa3778cd4f82ae69ffee2c6f7b77.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N5YzAwMDY2Ng_size_16_color_FFFFFF_t_70 2]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/20/a2395717bc5747e99bab3a21251c76e3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N5YzAwMDY2Ng_size_16_color_FFFFFF_t_70 3]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/20/61a53a116bac4b638e208de5286e57cc.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N5YzAwMDY2Ng_size_16_color_FFFFFF_t_70 4]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/20/75349985ffd14a2cbc7aaa36bb73d91b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N5YzAwMDY2Ng_size_16_color_FFFFFF_t_70 5]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/20/9ff39ca23eb24175b1c6ad3b2c1b1e81.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N5YzAwMDY2Ng_size_16_color_FFFFFF_t_70 6]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/20/83f2354eb7ad44039af52d0b4f8822e2.png