springMVC对RESTful的支持

最新推荐文章于 2024-07-23 10:29:30 发布
最新推荐文章于 2024-07-23 10:29:30 发布
阅读量635 收藏
点赞数
分类专栏： spring javaee 文章标签： java SpringMVC REST restful
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/A1342772/article/details/105141959
版权

1 RESTful基础

1.1 RESTful是什么？

RESTful不是一种协议，也不是一种文件格式，更不是一种开发框架。它是一系列设计约束的集合：无状态、将超媒体作为应用状态的引擎等。

1.2 RESTful的基本术语

以RESTful的风格访问web服务：客户端向标识资源的URL发起一系列HTTP请求，然后服务器在响应中向客户端发送表述。随着时间的推移，客户端通过这些表述建立起了一个资源状态的全景图。最后，客户端发起一个意义重大的PUT、POST或者PATCH请求，将一个表述发送回服务器从而更改资源的状态。

读完这句话你肯定有以下几点疑问：

  1. 什么是资源？
  2. 什么是资源状态？
  3. 什么是表述？
  4. 什么是状态的转换？

下面我们一一解答各个术语的含义：

1.资源

资源一般是可以保存到计算机里面的事物。比如网页，电子文档，数据库的一条记录。在Web中，我们使用URL来为每个资源提供一个全球唯一的地址。将一个事物赋以URL，它就会成为一个资源。

2.资源状态

资源状态指的是服务器中资源的状态。例如，服务器中有一个拥有三个邮件的邮件列表，那么邮件列表的状态就是拥有三个邮件的邮件列表。如果用户又发送了一条邮件，那么邮件列表的状态就变为拥有四个邮件的邮件列表。

3.表述

当客户端对一个资源发起一个GET请求的时候，服务器会以一种有效的方式提供一个采集了资源信息的文档作为回应。这就是表述——一种以机器可读的方式对资源当前状态的说明。对于数据库中的一条记录，服务器可以用XML文档、JSON对象、逗号分隔的数值或者用来生成它的SQL INSERT语句来描述它。

4.状态的转换

我们通常都认为表述是服务器发送给客户端的东西，这是由于在我们上网的时候，发送的大部分的请求都是GET请求，我们一直都在请求获取表述。但是实际上，在POST、PUT或者PATCH请求中，客户端也会向服务器端发送表述，服务器随后的工作就是改变资源状态，这种情况下的表述反映的是将来的表述。

2 RESTful实现交互

尽管任何事物都可以成为一个资源，但是客户端并不能随心所欲地对资源进行任意的操作。所能进行的操作是有规定的。在一个RESTful系统里，客户端和服务器端只能通过相互发送遵循预定义协议的消息来进行交互。

6种不同类型的消息：

  • GET：获取资源的某个表述
  • DELETE：销毁一个资源。
  • POST：基于给定的表述信息，在当前资源的下一级创建新的资源。
  • PUT：用给定的表述信息替换资源的当前状态。
  • HEAD：获取服务器发送过来的报头信息(不是资源的表述)，这些报头信息是在服务器发送资源的表述的时候被一起发送过来的。
  • OPTIONS：获取这个资源所能响应的HTTP方法列表。

响应协议的结构：

 从上图可以看出HTTP响应由三部分构成：

  • 状态码：这部分是由三位数字组成的，它简要说明了请求目前的进展。
  • 响应报头：响应报头的发送顺序排在状态码和实体消息体之间，通常是一系列用于描述实体消息体和HTTP响应的键值对。
  • 响应体：这部分是一个采用某种数据格式书写成的文档，并且我们预期该文档是可以被客户端所理解的。

3 RESTful的特点

  • 每一个URI代表1种资源。
  • 客户端使用GET、POST、PUT、DELETE4个表示操作方式的动词对服务端资源进行操作：GET用来获取资源，POST用来新建资源（也可以用于更新资源），PUT用来更新资源，DELETE用来删除资源。
  • 通过操作资源的表现形式来操作资源。
  • 资源的表现形式是XML或者HTML。
  • 通过操作资源的表现形式来操作资源。
  • 客户端与服务端之间的交互在请求之间是无状态的，从客户端到服务端的每个请求都必须包含理解请求所必需的信息。

4 SpringMVC如何支持RESTful

根据RESTful的特点，我们可以得到RESTful的风格，并分析出SpringMVC是如何支持RESTful风格的。

5 基于Rest的Controller（控制器）

我们的 REST API :

  • GET 方式请求 /api/user/ 返回用户列表
  • GET 方式请求 /api/user/1返回id为1的用户
  • POST 方式请求 /api/user/ 通过user对象的JSON 参数创建新的user对象
  • PUT 方式请求 /api/user/3 更新id为3的发送json格式的用户对象
  • DELETE 方式请求/api/user/4删除 ID为 4的user对象
  • DELETE 方式请求/api/user/删除所有user
package com.xuecheng.restful.controller;

import com.xuecheng.restful.api.UserControllerApi;
import com.xuecheng.restful.model.domain.ucenter.User;
import com.xuecheng.restful.service.UserService;
import org.springframework.beans.BeanUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;

import java.util.List;

@RestController
@RequestMapping(value = "/user/")
public class UserController implements UserControllerApi {

    @Autowired
    UserService userService;

    @RequestMapping(value = "/list", method = RequestMethod.GET)
    public List<User> findAllUsers() {
        return userService.findAllUser();
    }

    @RequestMapping(value = "/id", method = RequestMethod.GET)
    public ResponseEntity<User> findById(@PathVariable("id") String id) {
        User user = userService.findById(id);
        if (user == null) {
            return new ResponseEntity<User>(HttpStatus.NOT_FOUND);
        }
        return new ResponseEntity<User>(user,HttpStatus.OK);
    }
    @RequestMapping(value = "/save", method = RequestMethod.POST)
    public ResponseEntity<Void> saveUser(@RequestBody User user) {
        if(userService.isUserExist(user)){
            return new ResponseEntity<>(HttpStatus.CONFLICT);
        }
        userService.saveUser(user);
        return new ResponseEntity<>(HttpStatus.OK);
    }
    @RequestMapping(value = "/update", method = RequestMethod.PUT)
    public ResponseEntity<Void> updateUser(@RequestBody User user) {
        User user1 = userService.findById(user.getId());
        if(user1 == null){
           return new ResponseEntity<>(HttpStatus.NOT_FOUND);
        }
        BeanUtils.copyProperties(user,user1);
        userService.updateUser(user);
        return new ResponseEntity<>(HttpStatus.OK);
    }
    @RequestMapping(value = "/delete", method = RequestMethod.DELETE)
    public ResponseEntity<Void> deleteUserById(@PathVariable("id") String id) {
        User user = userService.findById(id);
        if(user == null){
            return new ResponseEntity<>(HttpStatus.NOT_FOUND);
        }
        userService.deleteUserById(id);
        return new ResponseEntity<>(HttpStatus.OK);
    }
    public ResponseEntity<Void> deleteAllUsers() {
        userService.deleteAllUsers();
        return new ResponseEntity<>(HttpStatus.OK);
    }
    public boolean isUserExist(@RequestBody User user) {
        return false;
    }
}

springmvc注解详解
@RestController :首先我们使用的是Spring 4的新注解 @RestController注解.

此注解避免了每个方法都要加上@ResponseBody注解。也就是说@RestController 自己戴上了 @ResponseBody注解,看以看作是

@RequestBody : 如果方法参数被 @RequestBody注解，Spring将绑定HTTP请求体到那个参数上。如果那样做，Spring将根据请求中的ACCEPT或者 Content-Type header（私下）使用 HTTP Message converters 来将http请求体转化为domain对象。

@ResponseBody : 如果方法加上了@ResponseBody注解，Spring返回值到响应体。如果这样做的话，Spring将根据请求中的 Content-Type header（私下）使用 HTTP Message converters 来将domain对象转换为响应体。

@ResponseEntity： 是一个真实数据.它代表了整个 HTTP 响应（response）. 它的好处是你可以控制任何对象放到它内部。

你可以指定状态码、头信息和响应体。它包含你想要构建HTTP Response 的信息。

@PathVariable： 此注解意味着一个方法参数应该绑定到一个url模板变量[在’{}’里的一个]中

一般来说你，要实现REST API in Spring 4 需要了解@RestController , @RequestBody, ResponseEntity 和 @PathVariable 这些注解 .另外, spring 也提供了一些支持类帮助你实现一些可定制化的东西。

6 发布和测试API

就以查询所有用户为例进行测试

 

 

7 根据RestTemplate 写REST Client

Spring的 RestTemplate随之出现。RestTemplate 提供了高级方法，来响应者6种主要的HTTP方法。

HTTP 方法和对应的 RestTemplate方法:

  • HTTP GET : getForObject, getForEntity
  • HTTP PUT : put(String url, Object request, String…​urlVariables)
  • HTTP DELETE : delete
  • HTTP POST : postForLocation(String url, Object request, String…​ urlVariables), postForObject(String url, Object request, ClassresponseType, String…​ uriVariables)
  • HTTP HEAD : headForHeaders(String url, String…​ urlVariables)
  • HTTP OPTIONS : optionsForAllow(String url, String…​ urlVariables)
  • HTTP PATCH and others : exchange execute

定义 Rest client , 定义REST services

package com.xuecheng.restful;

import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.http.ResponseEntity;
import org.springframework.test.context.junit4.SpringRunner;
import org.springframework.web.client.RestTemplate;

import java.util.List;

@SpringBootTest
@RunWith(SpringRunner.class)
public class TestSpringMVCRest {
    public static final String REST_SERVICE_URI = "http://localhost:31001/user/";

    @Autowired
    RestTemplate restTemplate;

    /* GET */
    @Test
    public void listAllUsers() {
        ResponseEntity<List> users = restTemplate.getForEntity(REST_SERVICE_URI + "list", List.class);
        if (users != null) {
            System.out.println(users.getBody());
        } else {
            System.out.println("No user exist----------");
        }
    }

}

8 完整的项目

8.1 项目结构

 

8.2 pom.xml添加项目依赖

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <artifactId>xc-framework-parent</artifactId>
        <groupId>com.xuecheng</groupId>
        <version>1.0-SNAPSHOT</version>
        <relativePath>../xc-framework-parent/pom.xml</relativePath>
    </parent>
    <groupId>com.xuecheng</groupId>
    <artifactId>test-restful</artifactId>
    <version>1.0-SNAPSHOT</version>
    <dependencies>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-freemarker</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
        <dependency>
            <groupId>org.hibernate</groupId>
            <artifactId>hibernate-core</artifactId>
            <version>5.0.12.Final</version>
        </dependency>
        <dependency>
            <groupId>com.squareup.okhttp3</groupId>
            <artifactId>okhttp</artifactId>
        </dependency>
    </dependencies>

</project>

 8.3 User Service

package com.xuecheng.restful.service;

import com.xuecheng.restful.model.domain.ucenter.User;
import org.springframework.stereotype.Service;

import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.UUID;

@Service
public class UserService {

    private static List<User> users;

    static {
        users = populateDummyUsers();
    }

    private static List<User> populateDummyUsers() {
        List<User> users = new ArrayList<User>();
        users.add(new User(UUID.randomUUID().toString(), "Sam", 30, 70000));
        users.add(new User(UUID.randomUUID().toString(), "Tom", 40, 50000));
        users.add(new User(UUID.randomUUID().toString(), "Jerome", 45, 30000));
        users.add(new User(UUID.randomUUID().toString(), "Silvia", 50, 40000));
        return users;
    }
    public List<User> findAllUser() {
        return users;
    }
    public User findById(String id) {
        for (User user : users) {
            if (user.getId().equals(id)) {
                return user;
            }
        }
        return null;
    }
    public User findByName(String name) {
        for (User user : users) {
            if (user.getName().equals(name)) {
                return user;
            }
        }
        return null;
    }
    public void saveUser(User user) {
        user.setId(UUID.randomUUID().toString());
        users.add(user);
    }
    public void updateUser(User user) {
        int index = users.indexOf(user);
        users.set(index, user);
    }
    public void deleteUserById(String id) {
        Iterator<User> iterable = users.iterator();
        while (iterable.hasNext()){
            if(iterable.next().getId().equals(id)){
                users.remove(iterable.next());
            }
        }
    }
    public void deleteAllUsers() {
         users.clear();
    }
    public boolean isUserExist(User user) {
        return findByName(user.getName())!=null;
    }
}

8.4 Model （模型）类

package com.xuecheng.restful.model.domain.ucenter;

import lombok.Data;
import lombok.ToString;

import javax.persistence.Entity;

@Data
@ToString
@Entity
public class User {
    private String id;
    private String name;
    private int age;
    private double salary;

    public User(String id, String name, int age, double salary) {
        this.id = id;
        this.name = name;
        this.age = age;
        this.salary = salary;
    }
}

8.5 配置类

server:
  port: ${PORT:31001}
spring:
  application:
    name: test-restful

8.6 初始化类（启动springboot）

package com.xuecheng.restful;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.web.client.RestTemplate;

/**
 * @author Administrator
 * @version 1.0
 * @create 2018-09-12 17:13
 **/
@SpringBootApplication
@ComponentScan(basePackages = {"com.xuecheng.restful"})//扫描本项目下的所有类
public class ManageCmsApplication {
    public static void main(String[] args) {
        SpringApplication.run(ManageCmsApplication.class, args);
    }

    @Bean
    RestTemplate restTemplate() {
        return new RestTemplate();
    }

}

8.7 源代码下载地址

https://download.csdn.net/download/A1342772/12275260

鬼灭之刃
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
SpringMVC --- RESTful
乌云的博客
04-01 628
REST：Representational State Transfer，表现层资源状态转移。① 资源资源是一种看待服务器的方式，即，将服务器看作是由很多离散的资源组成。每个资源是服务器上一个 可命名的抽象概念。因为资源是一个抽象的概念，所以它不仅仅能代表服务器文件系统中的一个文件、 数据库中的一张表等等具体的东西，可以将资源设计的要多抽象有多抽象，只要想象力允许而且客户端 应用开发者能够理解。与面向对象设计类似，资源是以名词为核心来组织的，首先关注的是名词。一个 资源可以由一个或多个URI来标识。
springmvc 3.2.8 restful支持
11-28
在3.2.8版本中，它增强了对RESTful风格的支持，使得开发者可以更容易地创建符合REST原则的服务。REST（Representational State Transfer）是一种网络应用程序的设计风格和开发方式，基于HTTP协议，强调资源的表述和...
springmvc学习笔记(19)-RESTful支持
brianway
03-14 5297
本文介绍RESTful的概念，并通过一个小例子展示如何编写RESTful风格的controller和配置前端控制器，最后展示静态资源的解析
RESTful Java 模式和最佳实践（二）
最新发布
龙哥盟
07-23 811
本章涵盖了每个 RESTful API 开发人员都应该了解的高级主题。一开始，我们看到了速率限制示例，演示了如何强制执行节流，以便服务器不会被 API 调用淹没。我们还看到了 Twitter、GitHub 和 Facebook API 如何执行速率限制。我们涵盖了不同的分页技术和基本分页示例以及最佳实践。然后，我们转向国际化和其他杂项主题。最后，我们涵盖了 HATEOAS 以及它如何成为 REST API、REST 和可扩展性主题的下一个级别。
Spring支持Restful
畅游在信息时代的黑马
01-02 472
1.1 什么是REST REST全称是Representational State Transfer，中文意思是表述（编者注：通常译为表征）性状态转移。 它首次出现在2000年Roy Fielding的博士论文中，Roy Fielding是HTTP规范的主要编写者之一。 他在论文中提到：“我这篇文章的写作目的，就是想在符合架构原理的前提下，理解和评估以网络为基础的应用软件的架构设计，得到一个
springmvc对RESTful支持
lhf294的博客
10-17 479
1、 RESTful支持 RESTful架构，就是目前最流行的一种互联网软件架构。它结构清晰，符合标准、易于理解、扩展方便、所以正得到越来越多网站的采用。 RESTful（即Representational State Transfer的缩写）其实是一个开发理念，是对http的很好的诠释。 1.1对URL进行规范，写RESTful格式的URL。
spring mvc实现restful
weixin_34176694的博客
09-12 134
restful它的核心是将所有的 Api 都理解为一个网络资源。把api映射成资源 restful它的核心是将所有的 Api 都理解为一个网络资源。把api映射成资源 把api映射成资源，把api映射成资源   1.浏览器支持http delete/put方法，添加HiddenHttpMethodFilter过滤器，将url转换为http delete/put方法 &lt;!--　浏览器...
SpringMVC RESTful支持实现过程演示
08-25
在本文中，我们将深入探讨如何在SpringMVC框架中实现RESTful支持，通过实例代码来展示具体步骤。RESTful是一种软件开发理念，它充分利用HTTP协议，使得Web服务更具有表现力和状态转换能力。理解RESTful的核心概念...
springmvc 实现restful
07-02
总结来说，Spring MVC提供了强大的工具和支持，使得实现RESTful服务变得简单而高效。通过合理的资源设计和HTTP方法的使用，可以构建出优雅、灵活且可扩展的Web应用程序。对于开发人员来说，掌握Spring MVC和RESTful...
SpringMVC的Restful风格Demo
04-21
在实际开发中，我们通常会结合Spring Boot框架，其内置了对SpringMVC的支持，并提供了很多简化配置和增强功能。例如，自动配置SpringMVC，使用`@SpringBootApplication`启动类即可运行应用，无需额外配置。 此外，...
SpringMVC RESTFUL风格
09-29
采用RESTFUL风格设计的软件能够更好地支持缓存、安全性更高、效率也更好。 #### 二、RESTFUL URL的特点 在RESTFUL风格中，URL通常遵循以下特点： 1. **资源定位**：URL清晰地表达了被操作的对象（资源），例如`/...
（十四）springMvc 对 restful 的支持
young-youth的博客
09-22 551
restful 大概是啥，以及怎么配置。
spring3.0支持restful实例
热门推荐
xiaojunhu的专栏
01-07 1万+
最近在研究spring3.0以及传说中的restful，还好研究出来一个例子，现在贴出来望广大网友能一起讨论下，错误的地方恳请大家指点。项目采用SPRING3.0+HIBERNATE2.5。数据库是oracle只有一个表。create table LMDZ( KH_NUM VARCHAR2(20), LM_NUM NUMBER(2)); 首先在eclipse下新建web
Restful Spring MVC
z69183787的专栏
12-02 1万+
Spring MVC本身对Restful支持非常好。它的@RequestMapping、@RequestParam、@PathVariable、@ResponseBody注解很好的支持了REST。18.2 Creating RESTful services 1. @RequestMapping Spring uses the @RequestMapping method annotatio
Springmvc实现Restful
开水烫鱼的博客
08-07 208
编码 /** * RESTful风格演示 * * @param ids * @param model * @return */ //RESTful风格url上的参数通过{}点位符绑定 //点位符参数名与方法参数名不一致时，通过@PathVariable绑定 @RequestMapping("/item/{id}") public String testRest(@...
Spring 支持 RESTful 功能
qq_26337263的博客
12-07 285
1，了解 RESTful ？           定义是 资源状态转移；         RESTful 区别于非RESTful 有几点：        前者的URL是面向资源型的；后者的URL是服务型的，关注行为和动作        前者URL是参数化的，有层级的；后者URL是输入的        前者URL是参数化，spring 3.0 引入了 注解@PathVariable，获取路
SpringMVC对RESTful支持
我们始终是路人
03-29 311
ESTful软件开发理念，RESTful对http进行非常好的诠释。 RESTful即Representational State Transfer的缩写。 综合上面的解释，我们总结一下什么是RESTful架构： 　　 （1）每一个URI代表一种资源； （2）客户端和服务器之间，传递这种资源的某种表现层； （3）客户端通过四个HTTP动词，对服务器端资源进行操作，实
3.SpringMVC（RESTful风格）
剑雨巍巍的博客
07-03 789
文章目录RESTful概述实例 RESTful概述 一组架构规范约束条件和原则 资源的表述 有被引用的必要——》资源，如文本，图片，服务 URI：唯一识别资源 资源的表述：资源在CS间传递 状态转移：资源在客户端变迁（客户端修改资源，和服务器保存的不同），进入后续的状态 统一客户端访问资源接口——》不同系统之间相互访问资源，使用同样接口——》实现资源共享 不同类型资源使用相同接口进行访问 按...
springmvc对rest的支持
bsw451926392的博客
01-20 1350
springmvc对rest的支持 RESTful的理解 REST，即Representational State Transfer的缩写。我对这个词组的翻译是”表现层状态转化”。 REST的名称”表现层状态转化”中，省略了主语。”表现层”其实指的是”资源”（Resources）的”表现层”。所谓”资源”，就是网络上的一个实体，或者说是网络上的一个具体信息 rest方式url要求简洁，一个
Springmvc注解Restful
05-16
Spring MVC注解风格的Restful API开发，可以使用以下注解来定义控制器方法： 1. @RestController：该注解表示该控制器类中的所有方法都返回JSON格式的数据。 2. @RequestMapping：该注解用于定义请求的URL和请求...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值