Spring Boot构建优雅的RESTful接口过程详解
RESTful
相信在座的各位对于RESTful都是略有耳闻，那么RESTful到底是什么呢？
REST（Representational State Transfer）表述性状态转移是一组架构约束条件和原则。满足这些约束条件和原则的应用程序或设计就是RESTful。需要注意的是，REST是设计风格而不是标准。REST通常基于使用HTTP，URI，和XML（标准通用标记语言下的一个子集）以及HTML（标准通用标记语言下的一个应用）这些现有的广泛流行的协议和标准。
也许这段话有些晦涩难懂，换个角度我们来解释一下RESTful。
首先来看一组例子：
//查询所有人员（传统） localhost:8088/api/user/findAll 请求方式：GET //查询所有人员（RESTful） localhost:8088/api/users 请求方式：GET //修改人员（传统） localhost:8088/api/user/update 请求方式：POST //修改人员（RESTful） localhost:8088/api/users 请求方式：PUT //添加人员（传统） localhost:8088/api/user/add 请求方式：POST //添加人员（RESTful） localhost:8088/api/users 请求方式：POST //删除人员（传统） localhost:8088/api/user/delete 请求方式：DELETE //删除人员（RESTful） localhost:8088/api/users 请求方式：DELETE
我们通常称地址栏中输入的地址为URI（Uniform Resource Identifier），翻译成中文就是统一资源标识符。
资源，我们在浏览器页面上看到的东西都可以称之为资源，比如图片，文字，语音等等。
而URI就是用于定位这些资源的位置的，RESTful风格的接口中只出现了表示资源的名词，关于这个资源的操作，通过HTTP内置的几种请求类型来区分。同一个路径localhost:8088/api/users，因为请求方式的不同，而去找寻不同的接口，完成对资源状态的转变。
总结一下，REST就是指对同一个URI的资源的不同请求方式（GET，POST，PUT，DELETE）（表述）下的做出的不同的操作（查，增，改，删），改变的是资源的状态，即表述性状态转移。 一个符合REST风格的URI就可以称之一个RESTful的接口。
看到这里，相信RESTful已经了解的差不多了，下面我们来看看在Spring Boot中如何去使用
SpringMVC 构建RESTful接口
SpringMVC中给我们提供了一些注解，可以帮助我们去构建RESTful的接口，下面来直接看代码：
package indi.viyoung.viboot.restful.controller;
import indi.viyoung.viboot.restful.entity.User;
import indi.viyoung.viboot.restful.service.UserService;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
import java.util.List;
/**
* <p>
* 前端控制器
* </p>
*
* @author viyoung
* @since 2019-01-23
*/
@RestController
@RequestMapping("/users")
@Slf4j
@CrossOrigin
public class UserController {
@Autowired
private UserService userService;
@GetMapping
public List<User> get() {
log.info("GET方法执行。。。");
return userService.list();
}
@GetMapping(value = "/{id}")
public User get(@PathVariable String id) {
log.info("GET..{}...方法执行。。。",id);
return userService.getById(id);
}
@PostMapping
public void post() {
log.info("POST方法执行。。。");
}
@PutMapping
public void put() {
log.info("PUT方法执行。。。");
}
@DeleteMapping
public void delete() {
log.info("DELETE方法执行。。。");
}
}
下面我们也许需要一个前端的工程或者POSTMAN等测试接口的工具来发送不同的请求，我这里已经写好了一个前端的基于vue的工程，有需要的可以去下载一下：viboot-front。记得顺手点个star哟~
依次点击这五个按钮，可以看到后台的控制台分别打印出了不同的语句：
原创文章，才疏学浅，如有不对之处，万望告知！
以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持我们。
相关推荐
-
详解如何使用Jersey客户端请求Spring Boot(RESTFul)服务
本文介绍了使用Jersey客户端请求Spring Boot(RESTFul)服务,分享给大家,具体如下: Jersey客户端获取Client对象实例封装: @Service("jerseyPoolingClient") public class JerseyPoolingClientFactoryBean implements FactoryBean<Client>, InitializingBean, DisposableBean{ /** * Client接口是REST
-
使用 Spring Boot 2.0 + WebFlux 实现 RESTful API功能
概述 什么是 Spring WebFlux, 它是一种异步的, 非阻塞的, 支持背压(Back pressure)机制的Web 开发框架. 要深入了解 Spring WebFlux, 首先要了知道 Reactive Stream . 另一种编程姿势, 和命令式编程相对的姿势. WebFlux 支持两种编程风(姿)格(势) 使用 @Controller 这种基于注解的姿势, 与Sring MVC的姿势相同 基于Java 8 Lambda的函数式编程风格 注意: 上面只是两种编程的姿势, 和"普通话
-
SpringBoot2.1 RESTful API项目脚手架（种子）项目
最近在做一个大型的J2EE项目,后端语言选择了Java,理所当然的选择了Spring,使用Spring MVC来做restful风格的api开发很是方便,Spring下面有很多子项目通过Springboot集成也很舒服.程序员都知道沟通很重要,实际项目中,往往是各自为战,尽管使用的是相同的框架.工具,编写的代码却千差万别,为了统一基础代码风格,编写了这个项目种子. 除此之外,在开发一个Web后端api项目时,通常都会经历搭建项目.选择依赖管理工具.引入基础包依赖.配置框架等,为了加快项目的开发进
-
SpringBoot+Spring Security+JWT实现RESTful Api权限控制的方法
摘要:用spring-boot开发RESTful API非常的方便,在生产环境中,对发布的API增加授权保护是非常必要的.现在我们来看如何利用JWT技术为API增加授权保护,保证只有获得授权的用户才能够访问API. 一:开发一个简单的API 在IDEA开发工具中新建一个maven工程,添加对应的依赖如下: <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-b
-
SpringBoot构建Restful service完成Get和Post请求
一个基本的RESTfule service最进场向外提供的请求Method就是Get和Post. 在Get中,常用的都会在请求上带上参数,或者是路径参数.响应Json. 在Post中,常用的会提交form data或者json data作为参数,响应Json. 1. Get请求,url传参,返回json. 先准备一个请求后,响应的对象. package com.example.demo; public class Echo { private final long id; private fin
-
Spring Boot 实现Restful webservice服务端示例代码
1.Spring Boot configurations application.yml spring: profiles: active: dev mvc: favicon: enabled: false datasource: driver-class-name: com.mysql.jdbc.Driver url: jdbc:mysql://localhost:3306/wit_neptune?createDatabaseIfNotExist=true&useUnicode=true&
-
Spring Boot构建优雅的RESTful接口过程详解
RESTful 相信在座的各位对于RESTful都是略有耳闻,那么RESTful到底是什么呢? REST(Representational State Transfer)表述性状态转移是一组架构约束条件和原则.满足这些约束条件和原则的应用程序或设计就是RESTful.需要注意的是,REST是设计风格而不是标准.REST通常基于使用HTTP,URI,和XML(标准通用标记语言下的一个子集)以及HTML(标准通用标记语言下的一个应用)这些现有的广泛流行的协议和标准. 也许这段话有些晦涩难懂,换个角度
-
Spring Boot如何优雅的使用多线程实例详解
前言 本文带你快速了解@Async注解的用法,包括异步方法无返回值.有返回值,最后总结了@Async注解失效的几个坑. 在 SpringBoot 应用中,经常会遇到在一个接口中,同时做事情1,事情2,事情3,如果同步执行的话,则本次接口时间取决于事情1 2 3执行时间之和:如果三件事同时执行,则本次接口时间取决于事情1 2 3执行时间最长的那个,合理使用多线程,可以大大缩短接口时间.那么在 SpringBoot 应用中如何优雅的使用多线程呢? Don't bb, show me code. 快速
-
Spring Boot设置支持跨域请求过程详解
现代浏览器出于安全的考虑, HTTP 请求时必须遵守同源策略,否则就是跨域的 HTTP 请求,默认情况下是被禁止的,IP(域名)不同.或者端口不同.协议不同(比如 HTTP.HTTPS)都会造成跨域问题. 一般前端的解决方案有: ① 使用 JSONP 来支持跨域的请求,JSONP 实现跨域请求的原理简单的说,就是动态创建<script>标签,然后利用<script>的 SRC 不受同源策略约束来跨域获取数据.缺点是需要后端配合输出特定的返回信息. ② 利用反应代理的机制来解决跨域的
-
Spring IoC学习之ApplicationContext中refresh过程详解
refresh() 该方法是 Spring Bean 加载的核心,它是 ClassPathXmlApplicationContext 的父类 AbstractApplicationContext 的一个方法 , 顾名思义,用于刷新整个Spring 上下文信息,定义了整个 Spring 上下文加载的流程. public void refresh() throws BeansException, IllegalStateException { synchronized(this.startupShu
-
Spring boot进行参数校验的方法实例详解
Spring boot开发web项目有时候我们需要对controller层传过来的参数进行一些基本的校验,比如非空.整数值的范围.字符串的长度.日期.邮箱等等.Spring支持JSR-303 Bean Validation API,可以方便的进行校验. 使用注解进行校验 先定义一个form的封装对象 class RequestForm { @Size(min = 1, max = 5) private String name; public String getName() { return n
-
SpringMVC使用RESTful接口案例详解
目录 一.准备工作 二.功能清单 三.具体功能-访问首页 一.准备工作 和传统 CRUD 一样,实现对员工信息的增删改查. ①搭建环境 添加相关依赖 web.xml springmvc.xml ②准备实体类 public class Employee { private Integer id; private String lastName; private String email; //1 male, 0 female private Integer gender; public Integ
-
spring boot 图片上传与显示功能实例详解
首先描述一下问题,spring boot 使用的是内嵌的tomcat, 所以不清楚文件上传到哪里去了, 而且spring boot 把静态的文件全部在启动的时候都会加载到classpath的目录下的,所以上传的文件不知相对于应用目录在哪,也不知怎么写访问路径合适,对于新手的自己真的一头雾水. 后面想起了官方的例子,没想到一开始被自己找到的官方例子,后面太依赖百度谷歌了,结果发现只有官方的例子能帮上忙,而且帮上大忙,直接上密码的代码 package hello; import static org
-
Spring Boot的listener(监听器)简单使用实例详解
监听器(Listener)的注册方法和 Servlet 一样,有两种方式:代码注册或者注解注册 1.代码注册方式 通过代码方式注入过滤器 @Bean public ServletListenerRegistrationBean servletListenerRegistrationBean(){ ServletListenerRegistrationBean servletListenerRegistrationBean = new ServletListenerRegistrationBean
-
spring cloud alibaba Nacos 注册中心搭建过程详解
这篇文章主要介绍了spring cloud alibaba Nacos 注册中心搭建过程详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下 nacos下载地址 什么是 Nacos? nacos主要起到俩个作用一个是注册中心,另外一个是配置中心. 下面图 是nacos的功能结构图 运行环境 JDK 1.8+: Maven 3.2.x+: 下载 你可以通过源码和发行包两种方式来获取 Nacos. nacos发行包下载地址 选择版本解压 unzip
-
Spring Cloud应用实现配置自动刷新过程详解
这篇文章主要介绍了Spring Cloud应用实现配置自动刷新过程详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下 通过spring cloud 的消息总线,将配置github 等源代码仓库的变更通知到spring cloud 的所有组件. spring-bus 需要用到rabbitmq ,所以需要提前准备rabbitmq消息队列环境 配置中心调整 1.配置中心配置引用pom <dependency> <groupId>org.