RESTful风格 以及small case !

最新推荐文章于 2024-07-14 16:42:13 发布
最新推荐文章于 2024-07-14 16:42:13 发布
阅读量429 收藏
点赞数 1
分类专栏： RESTFul 前后端交互的设计风格 RESTful小案例 文章标签： restful
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_51138619/article/details/108834492
版权

一. RESTful概念:

官方解释:

RESTFUL是一种网络应用程序的设计风格和开发方式，基于HTTP，可以使用XML格式定义或JSON格式定义。RESTFUL适用于移动互联网厂商作为业务使能接口的场景，实现第三方OTT调用移动网络资源的功能，动作类型 为 新增、变更、删除所调用资源.

场景：
不同显示端 以及不同的平台系统

​ 要求我们开发的软件需要多套前端资源对应一个后台程序

​ 前后端分离开发

​ 所有前端资源都是html 都是通过ajax来发出请求 通过json来封装数据

​ RestFul为前后端分离开发时 为前端请求和后台action的url定义统一的url规范

​ 所有的功能：增删改查操作

二. RESTful的url规范:

这里以对Exam类的操作 统一的虚拟目录为 /exams 如：

@Controller
@RequestMapping("/exams")
public class ExamAction {
}

添加一个

​ 请求方式：POST

​ 请求参数： json对象

​ 请求url: /exams

删除一个

​ 请求方式：DELETE

​ 请求参数： 无

​ 请求url: /exams/{id}

修改一个

​ 请求方式：PUT

​ 请求参数： json对象

​ 请求url: /exams

获取一个

​ 请求方式：GET

​ 请求参数：无

​ 请求url: /exams/{id}

获取所有

​ 请求方式：GET

​ 请求参数：无

​ 请求url: /exams

条件查询

​ 请求方式：GET

​ 请求参数：无

​ 请求url: /exams/{xxx}/{xxx}

三. RESTful的初次体验(小案例):

先来做一下准备工作:

准备工作1：创建实体类：ResponseEntity:封装响应状态码+响应提示信息+响应数据
实现序列化接口Serializable

public class ResponseEntity<T>   implements Serializable{
      private Integer status;/*响应状态码*/
      private String message;/*状态描述信息*/
      private  T    obj;/*响应的j对象  需要转换为json串*/
}

准备工作2： 创建Dao层实现类ExamDaoImpl实现ExamDao接口 对增删改添加事务提交

@Repository//加上注解(好像加不加无所谓)
public class ExamDaoImp   implements   ExamDao{
    public List<Exam> getAllByEnameOrEtime(String ename, Date etime){
        return getSession().createQuery("from com.zhiyou100.entity.Exam  where ename=:en or etime=:et")
                .setString("en",ename).setDate("et",etime).list();
    }
    //分页查询
    public List<Exam> getAllFenYe(int startIndex,int pageSize){
        Query query=getSession().createQuery("from com.zhiyou100.entity.Exam order by etime desc");
        query.setMaxResults(pageSize);
        query.setFirstResult(startIndex);
        return query.list();
    }
    @Autowired
    private SessionFactory factory;
    private Session getSession(){
        return factory.openSession();
    }
    @Override
    public void addOne(Exam o) {//加上事务
        Session session=getSession();
        session.beginTransaction();
        session.save(o);   System.out.println("添加"+o);
        session.getTransaction().commit();;
    }
    @Override
    public void deleteOne(Integer integer) {//加上事务
           Session session=getSession();
           session.beginTransaction();
           Exam  e=session.get(Exam.class,integer);
           session.delete(e);System.out.println("删除"+e);
           session.getTransaction().commit();
    }
    @Override
    public void updateOne(Exam e) {//加上事务
        Session session=getSession();
        session.beginTransaction();
        session.update(e); System.out.println("修改"+e);
        session.getTransaction().commit();
    }
}

准备工作3： 给exam提供一个etimeStr是etime的字符串形式 并且保证永远同步.

public class Exam   implements Serializable{
     private static SimpleDateFormat  sdf=new SimpleDateFormat("yyyy-MM-dd");
      private Integer eid;
      private String ename;
      private Date   etime;//Date类型
       private String etimeStr;//字符串类型
      public Date getEtime() {
        if(etime==null){
            try {
                etime=sdf.parse(etimeStr);
            }catch (Exception e){
                throw new RuntimeException(e);
            }
        }
        return etime;
     }

    public void setEtime(Date etime) {
        this.etime = etime;
        etimeStr=sdf.format(etime);
    }
    public String getEtimeStr() {
        if(etimeStr==null&&etimeStr.trim().length()==0){
            etimeStr=sdf.format(etime);
        }
        return etimeStr;
    }

    public void setEtimeStr(String etimeStr) {
        this.etimeStr = etimeStr;
        try {
            etime=sdf.parse(etimeStr);
        }catch (Exception e){
            throw new RuntimeException(e);
        }

    }
}

准备工作4：为了实现文件上传：给exam再添加一个属性url 记录本次考试的题目文本.

private String url;//考试的题目文本

获取一个:

controller层

//获取一个
@RequestMapping(value ="/restful_exams/{id}",method ={RequestMethod.GET})
public  @ResponseBody ResponseEntity<Exam>  getOne(@PathVariable("id") int eid){
    System.out.println("getOne");
    Exam e=examService.getOn      (eid);
    return new ResponseEntity<Exam>(200,null,e);
}

jsp页面

<h1>获取一个</h1>
<input type="button" value="测试restful获取一个"  onclick="getOne(3)"/><br/>
<script type="text/javascript">
    function getOne(id){
        $.ajax({
            type:"GET",
            data:null,
            url:"<c:url value='/'/>restful_exams/"+id+".action",
            dataType:"json",
            async:true,
            success:function(data){
                alert(data);
                alert(data.obj.ename+"::"+data.obj.eid+":"+data.obj.etimeStr);
            }
        });
    }
</script>

获取所有

controller层

@RequestMapping(value ="/restful_exams",method ={RequestMethod.GET})
public  @ResponseBody ResponseEntity<List<Exam>>  getAll(){
    System.out.println("getAll");
    List<Exam> list=examService.getAll();
    return new ResponseEntity<List<Exam>>(200,null,list);
}

jsp页面

<h1>获取所有</h1>
<input type="button" value="测试restful获取所有"  onclick="getAll()"/><br/>
<script type="text/javascript">
    function getAll(){
        $.ajax({
            type:"GET",
            data:null,
            url:path+"restful_exams.action",
            dataType:"json",
            async:true,
            success:function(data){
                for(var i=0;i<data.obj.length;i++){
                    alert(data.obj[i].ename+"::"+data.obj[i].eid);
                }
            }
        });
    }
</script>

按条件获取:分页查询

controller层

//分页查询
@RequestMapping(value ="/restful_exams/{startIndex}/{pageSize}",method ={RequestMethod.GET})
public  @ResponseBody ResponseEntity<List<Exam>>  getAllFenYe(@PathVariable("startIndex")Integer startIndex, @PathVariable("pageSize")Integer pageSize)throws Exception{
    System.out.println("getAllFenYe");
    List<Exam> list=examService.getAllFenYe(startIndex,pageSize);
    return new ResponseEntity<List<Exam>>(200,null,list);
}

jsp页面

<h1>按条件查询：分页查询</h1>
<form  id="form_getAllFenYe">
    起始索引：<input  type="text" name="startIndex"/><br/>
    每页记录数：<input  type="text" name="pageSize"/><br/>
    <input  type="button" value="分页查询"  onclick="getAllFenYe()"/>
</form>
<script type="text/javascript">
    function getAllFenYe(){
        //获取ename和etime
        var startIndex=$("input[name='startIndex']").val();
        var pageSize=$("input[name='pageSize']").val();
        //通过ajax请求action
        $.ajax({
            data:null,  //
            type:"GET",
            dataType:"json",            
            url:path+"restful_exams/"+startIndex+"/"+pageSize+".action",
            success:function(responseEntity){
                alert(responseEntity.obj.length);
            }
        });
    }
</script>

添加一个

方式一:拼凑字符串把表单转换为json对象

controller层

//添加一个：接受json对象
@RequestMapping(value ="/restful_exams1",method ={RequestMethod.POST})
@ResponseBody
public   ResponseEntity<Exam> addOne1(@RequestBody Exam  exam){
    System.out.println("addOne1");
    examService.addOne(exam);
    return new ResponseEntity<Exam>(200,"添加成功",null);
}

jsp页面

<h1>添加一个：自己把表单 拼凑成json串</h1>
<form id="tab_add1">
    考试名称：<input  type="text" name="ename"/><br/>
    考试时间：<input  type="text" name="etimeStr"  placeholder="格式：xxxx-xx-xx"/><br/>
    <input  type="button" value="添加一个:拼凑json"  onclick="addOne1()"/><br/>
</form>
<script type="text/javascript">
    function addOne1(){
        //通过ajax把form_add对应的数据封装成json串 通过post方式 提交给action
        var  ename=$("#tab_add1 input[name='ename']").val();
        var  etimeStr=$("#tab_add1 input[name='etimeStr']").val();
        var  jsonData={"ename":ename,"etimeStr":etimeStr};
        //通过ajax把json对象发送给action
        $.ajax({
            data:JSON.stringify(jsonData),  //传递给java的必须时json串  不是json对象
            contentType:"application/json",  //请求参数时json串时  添加请求头
            type:"POST",
            dataType:"json",
            url:path+"restful_exams1.action",
            success:function(responseEntity){
                alert(responseEntity.message);
            }
        });
    }
</script>
方式二:通过FormData方法把表单中的数据转换为formdata对象

controller层

//添加一个：接受formdata的数据  用普通参数即可
@PostMapping(value ="/restful_exams2")
@ResponseBody
public   ResponseEntity<Exam> addOne2(Exam  exam){
    System.out.println("addOne2");
    examService.addOne(exam);
    return new ResponseEntity<Exam>(200,"添加成功",null);
}

jsp页面

<h1>添加一个：fromdate方法获取表单对应的formdata对象</h1>
<form  id="form_add2">
    考试名称：<input  type="text" name="ename"/><br/>
    考试时间：<input  type="text" name="etimeStr"/><br/>
    <input  type="button" value="添加一个:fromdate方法"  onclick="addOne2()"/>
</form> 
<script type="text/javascript">
    function addOne2(){
        //获取表单对应的json对象串
        var  jsonData2=new FormData($("#form_add2")[0]);
        //                var  jsonData2=new FormData();
        //                jsonData2.append("ename",$("#form_add2 input[name='ename']").val());
        //                jsonData2.append("etimeStr",$("#form_add2 input[name='etimeStr']").val());
        //通过ajax把json对象发送给action
        $.ajax({
            data:jsonData2,  //传递的时formdata对象
            processData: false,//formdata对象不能设置请求头processData和contentType
            contentType: false,
            type:"POST",
            dataType:"json",
            url:path+"restful_exams2.action",
            success:function(responseEntity){
                alert(responseEntity.message);
            }
        });
    }
</script>

修改一个

controller层

//修改一个
//@RequestMapping(value ="/exams",method ={RequestMethod.PUT})
@PutMapping("/restful_exams")
@ResponseBody
public   ResponseEntity<String>  updateOne(@RequestBody Exam exam)throws Exception{
    System.out.println("updateOne");
    examService.updateOne(exam);
    return new ResponseEntity<String>(200,"修改成功！",null);
}

jsp页面(写法一:)自己拼凑json对象

<h1>修改一个</h1>
<form  id="form_update">
    考试编号：<input  type="text" name="eid"/><br/>
    考试新名称：<input  type="text" name="ename"/><br/>
    考试新时间：<input  type="text" name="etimeStr"  placeholder="格式：xxxx-xx-xx"/><br/>
    <input  type="button" value="修改一个"  onclick="updateOne1()"/>
</form>
<script type="text/javascript">
function updateOne1(){
    //获取json串方法1  自己拼接
    var ename=$("#form_update input[name='ename']").val();
    var etimeStr=$("#form_update input[name='etimeStr']").val();
    var eid=$("#form_update input[name='eid']").val();
    var  jsonData={"ename":ename,"etimeStr":etimeStr,"eid":eid};
    var  jsonStr=JSON.stringify(jsonData);//把json对象转换为json串
    $.ajax({
        data:jsonStr,//
        contentType:"application/json",  //请求参数时json串时  添加请求头
        type:"PUT",
        dataType:"json",
        url:path+"restful_exams.action",
        success:function(responseEntity){
       		 alert(responseEntity.message);
        }
    });
}
</script>

jsp页面(写法二:)通过jquery的jquery.serializejson.min.js实现把表单转换为json串

//先引入jquery.serializejson.min.js
<script type="text/javascript" src="<c:url value='/js/jquery.serializejson.min.js'/>"></script>
<h1>修改一个</h1>
<form  id="form_update">
    考试编号：<input  type="text" name="eid"/><br/>
    考试新名称：<input  type="text" name="ename"/><br/>
    考试新时间：<input  type="text" name="etimeStr"  placeholder="格式：xxxx-xx-xx"/><br/>
    <input  type="button" value="修改一个"  onclick="updateOne1()"/>
</form>
<script type="text/javascript">
    function updateOne1(){
        //获取json串方法2： 通过jquery.serializejson.min.js的serializeJSON方法
        var  jsonStr=JSON.stringify($('#form_update').serializeJSON());
        $.ajax({
            data:jsonStr,//
            contentType:"application/json",  //请求参数时json串时添加请求头
            type:"PUT",
            dataType:"json",
            url:path+"restful_exams.action",
            success:function(responseEntity){
                alert(responseEntity.message);
            }
        });
    }
</script>

删除一个

controller层

//删除一个
@RequestMapping(value ="/restful_exams/{id}",method ={RequestMethod.DELETE})
public  @ResponseBody ResponseEntity<String>  deleteOne(@PathVariable("id") Integer eid){
    System.out.println("deleteOne");
    examService.deleteOne(eid);
    return new ResponseEntity<String>(200,"删除成功！",null);
}

jsp页面

<h1>删除一个</h1>
<form  id="form_delete">
    考试编号：<input  type="text" name="eid"/><br/>
    <input  type="button" value="删除一个"  onclick="deleteOne()"/>
</form>
<script type="text/javascript">
    function deleteOne(){
        //获取ename和etime
        var eid=$("#form_delete input[name='eid']").val();
        //通过ajax请求action
        $.ajax({
            data:null,//
            type:"DELETE",
            dataType:"json",
            url:path+"restful_exams/"+eid+".action",
            success:function(responseEntity){
                alert(responseEntity.message);
            }
        });
    }
</script>

实现文件上传

controller层

//文件上传  接受formdata的数据  用普通参数接受普通组件  用
@PostMapping(value ="/restful_exams3")
@ResponseBody
public   ResponseEntity<Exam> addOne3(@RequestParam("examText") MultipartFile examText, Exam  exam, HttpServletRequest req)throws Exception{

    String path=req.getSession().getServletContext().getRealPath("/imgs");//webapp下的文件夹
    //获取文件名字
    String fileName=examText.getOriginalFilename();
    String fileHZ=fileName.substring(fileName.lastIndexOf("."));
    fileName=exam.getEname()+fileHZ;//保存的文件名字和考试名字一致
    //获取文件的后缀
    File  muDiFile=new File(path,fileName);
    examText.transferTo(muDiFile);//实现文件的读写
    exam.setEurl(fileName);
    examService.addOne(exam);
    return new ResponseEntity<Exam>(200,"添加成功",null);
}

jsp页面

<h1>文件上传：fromdate方法获取表单对应的formdata对象</h1>
<form  id="form_upload">
    考试名称：<input  type="text" name="ename"/><br/>
    考试时间：<input  type="text" name="etimeStr"/><br/>
    考试文档：<input  type="file" name="examText"/><br/>
    <input  type="button" value="文件上传"  onclick="uploadAdd()"/>
</form>
<script type="text/javascript">
    function uploadAdd(){
        //获取表单对应的json对象串
        var  jsonData3=new FormData($("#form_upload")[0]);
        $.ajax({
            data:jsonData3,  //传递的时formdata对象
            processData: false,//formdata对象必须设置processData和contentType属性
            contentType: false,
            type:"POST",
            dataType:"json",
            url:path+"restful_exams3.action",
            success:function(responseEntity){
                alert(responseEntity.message);
            }
        });
    }
</script>

对了,可以使用postman(邮递员)工具进行测试,可以不用写jsp页面 !
官方网站: https://www.postman.com/
最下面:
在这里插入图片描述
postman使用教程: https://blog.csdn.net/fxbin123/article/details/80428216

以上就是RESTful的小案列,感谢阅读 Thanks ! ! !

Thesmile`
关注
  • 1
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
RESTful API的版本管理、安全性、可用性、文档和测试、监控
禅与计算机程序设计艺术
08-06 810
REST (Representational State Transfer) 是一种架构风格，它定义了一组约束条件和原则。它主要用于客户端和服务器之间交换数据，通过一系列的REST API调用来实现服务。REST是基于HTTP协议标准化的一种Web服务接口标准。RESTful API是一种遵循REST规范的API。REST API的版本管理每个新版本的REST API都应该有其文档。RESTful API的版本管理可以有效防止API的过时或废弃，并让开发者清楚地知道自己在使用的哪个版本的API。
乱七八糟的small case
weixin_43888760的博客
01-17 156
>>> re.findall('企业名称:(.+)\\n出资额:(.+)\\n百分比:(.+)\\n法人性质',a.strip()) [(' 杭州康普投资有限公司', ' 2137.5', ' 4.75%'), (' 浙江东方集团股份有限公司', ' 2250', ' 5%'), (' 杭州威讯投资管理有限公司', ' 6412.5', ' 14.25%'), (' 中国电子科技集团公司第五十二研究所', ' 21802.5', ' 48.45%')] >>> re.f.
前端面试题
微信号：RunsenLiu
05-05 4255
内容 写“Hello World”的正确javascript 语法是（） “A. document.write(”“Hello World”")" “B. ““Hello World””” “C. response.write(”“Hello World”")" “D. (”“Hello World”")" JS特性不包括（） A.解释性 B.用于客户端 C.基于对象 D.面向对象 下列JS的判断...
js对文字的修饰 big() small() fixed() toUpperCase() toLowerCase()
kbx8916的博客
08-01 336
js对文字的修饰 big() small() fixed()     toUpperCase() toLowerCase()
js练习题
ZZZ___jh的博客
11-05 2158
js练习题 一. 选择题 写“Hello World ”的正确 javascript语法是( ). A A. document.write(“Hello World”) B. “Hello World” C. response.write(“Hello World”) D. (“Hello World”) 在JavaScript表达式中13+“13”+"5"的结果是( ). D A. 29 B. 1217 C. 126 D. 13135 对JavaScript基本语法描述不正确的一项是( ).
Flask插件之Flask_Restful设计API
爱人BT的博客
03-28 884
一、前言 flask框架默认的路由和视图函数映射规则是通过在视图函数上直接添加路由装饰器来实现的，这使得路由和视图函数的对应关系变得清晰，但对于统一的API开发就变得不怎么美妙了，尤其是当路由接口足够多的时候，可读性会变差。flask_restful可以使我们像Django那样统一在一个地方设计所有的API规则。 二、Flask_Restful 2.1、安装 pip install fl...
python3 flask-restful web backend api
ruicore的博客
05-24 444
flask-restful This is a web backend project based on the flask-restful, coding in python3.8. You can treat it as a template to learn web-framework or just simply a start to use python writing web project. This project use Python Typing Hint. The repositor
delphi Restful:客户端实现的四种方式及其比较
热门推荐
pulledup的博客
02-11 1万+
delphi Restful:客户端实现的四种方式 摘要： 一、NetHTTP技术体系： TNetHTTPClient; TNetHTTPRequest二、REST技术体系： TRESTClient; TRESTRequest; TRESTResponse; TRESTResponseDataSetAdapter三、Indy技术体系：IdHTTP + IdSSLOpenSS...
SpringMVC入门到实战------八、RESTful案例。SpringMVC+thymeleaf+BootStrap+RestFul实现员工信息的增删改查
做笔记\记录遇到的程序bug
11-30 565
RESTful案例。SpringMVC+thymeleaf+BootStrap+RestFul实现员工信息的增删改查
servlet_restful风格所需jar包
06-25
在开发基于Servlet的应用时，尤其是涉及RESTful风格的API，依赖于正确的库是至关重要的。RESTful风格是一种软件架构设计模式，它强调通过HTTP方法（如GET、POST、PUT、DELETE）来操作资源，实现轻量级、无状态的交互...
用CXF开发RESTful风格WebService
09-24
用CXF开发RESTful风格WebService RESTful风格WebService是一种基于HTTP协议的WebService，使用CXF（Apache CXF）开发RESTful风格WebService可以提供灵活、可扩展的WebService解决方案。下面将详细介绍如何使用CXF...
SaToken实现Restful风格
02-27
在IT行业中，RESTful风格的API设计已经成为现代Web服务的标准，因为它强调了资源的独立性和统一的接口。然而，这种风格在实现权限控制时可能会带来挑战，特别是在使用SaToken这样的权限管理框架时。SaToken是一个轻...
restful风格java版本
06-16
本文将深入探讨RESTful风格在Java开发中的应用，以及如何利用Spring Boot来构建这样的服务。 1. **RESTful架构风格**：REST（Representational State Transfer）是一种网络应用程序的设计风格和开发方式，基于HTTP...
Restful风格实现CRUD源码.7z
05-12
RESTFUL是一种网络应用程序的设计风格和开发方式，基于HTTP，可以使用XML格式定义或JSON格式定义。RESTFUL适用于移动互联网厂商作为业务使能接口的场景，实现第三方OTT调用移动网络资源的功能，动作类型为新增、变更...
Activity启动流程
k663514387的博客
07-14 751
Activity启动流程详解
南昌航空大学考研17个学院，59个专业课历年考试真题及答案汇总，备考资料题库笔记，专业课调剂信息查询.pdf
07-15
南昌航空大学考研17个学院，59个专业课历年考试真题及答案汇总，备考资料题库笔记，专业课调剂信息查询.pdf
齐齐哈尔医学院考研，57个专业课历年考试真题及答案汇总整理，备考资料题库视频.pdf
最新发布
07-15
齐齐哈尔医学院考研，57个专业课历年考试真题及答案汇总整理，备考资料题库视频.pdf
龙年吉祥开门红PPT模板，适用于年度总结，工作总结
07-15
【作品名称】：龙年吉祥开门红PPT模板，适用于年度总结，工作总结 【适用人群】：适用于希望学习不同技术领域的小白或进阶学习者。可作为毕设项目、课程设计、大作业、工程实训或初期项目立项。
简述RESTFUL风格
06-13
RESTFUL（Representational State Transfer）是一种软件架构风格，它基于 HTTP 协议实现，是一种轻量级、灵活、易于扩展的架构风格。RESTFUL 风格的设计理念是：资源（Resource）作为网络中的一个对象，每个资源都有...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值