广告
返回顶部
首页 > 资讯 > 后端开发 > Python >一篇文章带你搞懂Java restful 接口开发
  • 852
分享到

一篇文章带你搞懂Java restful 接口开发

2024-04-02 19:04:59 852人浏览 八月长安

Python 官方文档:入门教程 => 点击学习

摘要

目录1、RESTful 简介a>资源b>资源的表述c>状态转移2、RESTful 的实现3、HiddenHttpMethodFilter4、RESTful 案例4.

1、RESTful 简介

REST:Representational State Transfer,表现层资源状态转移。

a>资源

资源是一种看待服务器的方式,即,将服务器看作是由很多离散的资源组成。每个资源是服务器上一个可命名的抽象概念。因为资源是一个抽象的概念,所以它不仅仅能代表服务器文件系统中的一个文件、数据库中的一张表等等具体的东西,可以将资源设计的要多抽象有多抽象,只要想象力允许而且客户端应用开发者能够理解。与面向对象设计类似,资源是以名词为核心来组织的,首先关注的是名词。一个 资源可以由一个或多个 URI 来标识。URI 既是资源的名称,也是资源在 WEB 上的地址。对某个资源感兴趣的客户端应用,可以通过资源的 URI 与其进行交互。

b>资源的表述

资源的表述是一段对于资源在某个特定时刻的状态的描述。可以在客户端-服务器端之间转移(交换)。资源的表述可以有多种格式,例如 html/XML/JSON/纯文本/图片/视频/音频等等。资源的表述格式可以通过协商机制来确定。请求-响应方向的表述通常使用不同的格式。

c>状态转移

状态转移说的是:在客户端和服务器端之间转移(transfer)代表资源状态的表述。通过转移和操作资源的表述,来间接实现操作资源的目的。

2、RESTful 的实现

具体说,就是 HTTP 协议里面,四个表示操作方式的动词:GET、POST、PUT、DELETE。

它们分别对应四种基本操作:GET 用来获取资源,POST 用来新建资源,PUT 用来更新资源,DELETE 用来删除资源。

REST 风格提倡 URL 地址使用统一的风格设计,从前到后各个单词使用斜杠分开,不使用问号键值对方式携带请求参数,而是将要发送给服务器的数据作为 URL 地址的一部分,以保证整体风格的一致性。

操作 传统方式 REST 风格
查询操作 getUserById?id=1 user/1-->get 请求方式
保存操作 saveUser user-->post 请求方式
删除操作 deleteUser?id=1 user/1-->delete 请求方式
更新操作 updateUser user-->put 请求方式

3、HiddenHttpMethodFilter

由于浏览器只支持发送 get 和 post 方式的请求,那么该如何发送 put 和 delete 请求呢?

springMVC 提供了 HiddenHttpMethodFilter 帮助我们将 POST 请求转换为 DELETE 或 PUT 请求。

HiddenHttpMethodFilter 处理 put 和 delete 请求的条件:

  • 当前请求的请求方式必须为 post
  • 前请求必须传输请求参数_method

满足以上条件,HiddenHttpMethodFilter 过滤器就会将当前请求的请求方式转换为请求参数_method 的值,因此请求参数_method 的值才是最终的请求方式。

在 web.xml 中注册 HiddenHttpMethodFilter


<filter>
    <filter-name>HiddenHttpMethodFilter</filter-name>
    <filter-class>org.springframework.web.filter.HiddenHttpMethodFilter</filterclass>
</filter>
<filter-mapping>
    <filter-name>HiddenHttpMethodFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

使用注意:

目前为止,Springmvc 中提供了两个过滤器:CharacterEncodingFilter 和 HiddenHttpMethodFilter

在 web.xml 中注册时,必须先注册 CharacterEncodingFilter,再注册 HiddenHttpMethodFilter

原因:

在 CharacterEncodingFilter 中通过 request.setCharacterEncoding(encoding) 方法设置字符集的

request.setCharacterEncoding(encoding) 方法要求前面不能有任何获取请求参数的操作而 HiddenHttpMethodFilter 恰恰有一个获取请求方式的操作:


String paramValue = request.getParameter(this.methodParam);

4、RESTful 案例

4.1、需求

通过 restfull 实现用户的增删改查,需要提供 5 个接口。

接口 method 描述
/user/list GET 获取用户列表
/user/{userId} GET 根据用户 id 获取用户信息
/user POST 新增用户信息
/user PUT 保存用户信息
/user/{userId} DELETE 删除用户信息

4.2、git 代码位置

https://gitee.com/javacode2018/springmvc-series

9c531dfb77b5870eb83558aff4c15c0d.png

4.3、UserController

UserController 中实现了需求中提到的 4 个接口,大家重点看下每个接口的方法上用到的注解。


@RestController
public class UserController {
    private List<User> userList = new ArrayList<>();
 
    {
        userList.add(new User(1, "Spring高手系列"));
        userList.add(new User(2, "SpringMVC系列"));
    }
 
    @GetMapping("/user/list")
    public List<User> list() {
        System.out.println("list()");
        return userList;
    }
 
    @GetMapping("/user/{userId}")
    public User getUser(@PathVariable("userId") Integer userId) {
        System.out.println("getUser()");
        for (User user : userList) {
            if (user.getUserId().equals(userId)) {
                return user;
            }
        }
        return null;
    }
 
    @PostMapping(value = "/user", produces = "text/html;charset=UTF-8")
    public String add(User user) {
        System.out.println("add()");
        this.userList.add(user);
        return "新增成功";
    }
 
    @PutMapping(value = "/user", produces = "text/html;charset=UTF-8")
    public String modify(User user) {
        System.out.println("modify()");
        for (User item : userList) {
            if (item.getUserId().equals(user.getUserId())) {
                item.setName(user.getName());
            }
        }
        return "修改成功";
    }
 
    @DeleteMapping(value = "/user/{userId}", produces = "text/html;charset=UTF-8")
    public String delete(@PathVariable("userId") Integer userId) {
        System.out.println("delete()");
        Iterator<User> iterator = userList.iterator();
        while (iterator.hasNext()) {
            User user = iterator.next();
            if (user.getUserId().equals(userId)) {
                iterator.remove();
            }
        }
        return "删除成功";
    }
 
 
    public static class User {
        private Integer userId;
        private String name;
 
        public User() {
        }
 
        public User(Integer userId, String name) {
            this.userId = userId;
            this.name = name;
        }
 
        public Integer getUserId() {
            return userId;
        }
 
        public void setUserId(Integer userId) {
            this.userId = userId;
        }
 
        public String getName() {
            return name;
        }
 
        public void setName(String name) {
            this.name = name;
        }
 
        @Override
        public String toString() {
            return "User{" +
                    "userId=" + userId +
                    ", name='" + name + '\'' +
                    '}';
        }
    }
}

4.4、添加 HiddenHttpMethodFilter


HiddenHttpMethodFilter hiddenHttpMethodFilter = new HiddenHttpMethodFilter();

fb359e3e1eb468807e691156956ae084.png

4.5、测试效果

项目发布到 Tomcat,如下图,跑一下 UserController.http 中的 5 个用例,点击每个用户中的绿色箭头即可运行,注意下后面 3 个用例都是 POST 方式提交的,但是参数中多了一个_method 参数用来指定提交的类型,这个参数会被HiddenHttpMethodFilter 解析。

5d2af105258372e24a7bea0f7b640c93.png

总结

本篇文章就到这里了,希望能够给你带来帮助,也希望您能够多多关注编程网的更多内容!

--结束END--

本文标题: 一篇文章带你搞懂Java restful 接口开发

本文链接: https://www.lsjlt.com/news/155530.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com    QQ/279061341

本篇文章演示代码以及资料文档资料下载

下载Word文档到电脑,方便收藏和打印~

下载Word文档
猜你喜欢
  • 一篇文章带你搞懂Java restful 接口开发
    目录1、RESTful 简介a>资源b>资源的表述c>状态转移2、RESTful 的实现3、HiddenHttpMethodFilter4、RESTful 案例4....
    99+
    2022-11-12
  • 一篇文章带你彻底搞懂Redis 事务
    目录Redis 事务简介Redis 事务基本指令实例分析Redis 事务与 ACID总结Redis 事务简介 Redis 只是提供了简单的事务功能。其本质是一组命令的集合,事务支持一...
    99+
    2022-11-13
    redis有几种部署方式 redis事务三大特性 redis怎么做到事务回滚
  • 一篇文章带你彻底搞懂Redis 事务
    目录Redis 事务简介Redis 事务基本指令实例分析Redis 事务与 ACID总结Redis 事务简介 Redis 只是提供了简单的事务功能。其本质是一组命令的集合,事务支持一次执行多个命令,在事务执行过程中,会顺...
    99+
    2022-10-31
  • 一篇文章带你搞懂VUE基础知识
    目录VUE是什么Vue中的核心插件  VueRouterVuexaxioselement-uiVue前端整体架构 总结VUE是什么 Vue (读音 /v...
    99+
    2022-11-12
  • 一篇文章带你搞定JAVA Maven
    目录1、maven是什么,为什么存在?项目结构是什么样子,怎么定位jar2、Idea 的操作1.新建maven项目2.配置仓库3.添加依赖,添加fastjson的依赖4.打包项目3、...
    99+
    2022-11-12
  • 一篇文章带你入门Java接口
    目录什么是接口:关键字:创建接口代码展示:如何实现接口呢:实现接口代码展示:具体代码实现:接口继承和类继承的区别:总结什么是接口: 接口是一系列方法的声明,是一些方法特征的集合 注...
    99+
    2022-11-12
  • 一篇文章带你搞懂Java线程池实现原理
    目录1. 为什么要使用线程池2. 线程池的使用3. 线程池核心参数4. 线程池工作原理5. 线程池源码剖析5.1 线程池的属性5.2 线程池状态5.3 execute源码5.4 wo...
    99+
    2022-11-13
    Java线程池实现原理 Java线程池原理 Java线程池实现 Java线程池
  • 一篇文章带你搞定JAVA泛型
    目录1、泛型的概念2、泛型的使用3、泛型原理,泛型擦除3.1 IDEA 查看字节码3.2 泛型擦除原理4、?和 T 的区别5、super extends6、注意点1、静态方法无法访问...
    99+
    2022-11-12
  • 一篇文章带你搞定JAVA注解
    目录1、注解是什么2、jdk支持的注解有哪些2.1 三种常用的注解:2.2 元注解3、注解实例1、自定义注解2、在对应的方法上增加注解3、在项目启动的时候检查注解的枚举4、总结1、注...
    99+
    2022-11-12
  • 一篇文章带你搞定JAVA反射
    目录1、反射的概念1、概念2、获取字节码文件对象的方式2.1 元数据的概念2.2 获取class对象的方式1、访问权限2、获取方法2.1 访问静态方法2.2 访问类方法 3...
    99+
    2022-11-12
  • 一篇文章带你轻松搞懂Golang的error处理
    目录Golang中的errorerror的几种玩法哨兵错误自定义错误类型Wrap errorGolang1.13版本error的新特性errors.UnWrap()errors.Is...
    99+
    2022-11-13
  • 一篇文章带你搞懂Python类的相关知识
    目录一、什么是类二、类的方法三、类的特性四、总结一、什么是类 类(class),作为代码的父亲,可以说它包裹了很多有趣的函数和方法以及变量,下面我们试着简单创建一个吧。 这样就算创...
    99+
    2022-11-12
  • 一篇文章带你搞懂Go语言标准库Time
    目录前言时间类型时间戳时间间隔操作时间AddSubEqualBeforeAfter定时器时间格式化解析字符串格式的时间总结前言 在编程过程中,我们经常会用到与时间和日期相关的各种需求...
    99+
    2022-11-11
  • 一篇文章带你了解Java基础-接口
    目录Java基础知识(接口)接口接口的定义接口和抽象的区别接口的格式接口中的主要成分接口的案例接口与接口的关系JDK 8之后的接口新增方法总结Java基础知识(接口) 接口 Jav...
    99+
    2022-11-12
  • 一篇文章带你彻底搞懂VUE响应式原理
    目录响应式原理图编译创建compile类操作fragment获取元素节点上的信息获取文本节点信息操作fragment响应式数据劫持收集依赖响应式代码完善Dep类全局watcher用完...
    99+
    2022-11-13
  • 一篇文章带你Java Spring开发入门
    目录Spring概述Spring简单应用Spring框架地基本使用项目创建添加依赖包创建Spring配置文件修改配置文件修改测试类运行结果总结Spring概述 Spring就是为解决...
    99+
    2022-11-12
  • 一篇文章带你搞定JAVA内存泄漏
    目录1、什么是内存泄漏2、内存泄漏的原因3、内存泄漏有哪些情况3.1 代码中没有及时释放,导致内存无法回收。3.2 资源未关闭造成的内存泄漏3.3 全局缓存持有的对象不使用的时候没有...
    99+
    2022-11-12
  • 五分钟学Java:一篇文章带你搞懂spring全家桶套餐
    原创声明本文首发于微信公众号【程序员黄小斜】本文作者:黄小斜转载请务必在文章开头注明出处和作者。本文思维导图spring全家桶里都有哪些食物上期我们讲了spring和springmvc两个框架的基础知识和学习路线,而这期内容,我们将围绕着s...
    99+
    2023-06-02
  • 一篇文章带你了解java接口与继承
    目录JAVA接口的概念接口的代码实现定义关键字:interface实现 关键字: implements举个列子注意事项Java继承什么是继承:总结JAVA接口的概念 官方解释:Jav...
    99+
    2022-11-12
  • 一篇文章带你搞懂JavaScript的变量与数据类型
    目录前言:温馨提示:变量1.声明2.赋值3.二个语法小细节变量的命名规范为什么需要数据类型?简单数据类型(基本数据类型)数字型字符串型 String什么是数据类型的转换1.转换为字符...
    99+
    2022-11-12
软考高级职称资格查询
编程网,编程工程师的家园,是目前国内优秀的开源技术社区之一,形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容,为IT开发者提供了一个发现、使用、并交流开源技术的平台。
  • 官方手机版

  • 微信公众号

  • 商务合作