简单讲一下Restful

一、restful接口的开发(设计):

     现在做接口开发,最流行的不就是restful风格的接口;我将restful接口分为了3个等级:

  1.  只要是不负责页面跳转,直接通过response body响应数据的方法,就是一个restful风格的接口;如果是springmvc框架,用@restcontroller注解或者@responsebody注解就可以实现。其他框架,例如Struts(这个我没接触过不了解),可以用response.getWriter().writer(json);
  2. 可以用路径传参,代替?号传参,实现更优雅的restful风格接口;

  3. 同一种资源的增删改查操作,采用同样的接口路径,通过接口请求方式:get、post、put、delete来区分增删改查,是最标准的restful风格接口;

当然,想要完成一个好的restful风格接口,还需要考虑以下几个方面:

  1.       做统一异常的处理,好的接口应该有统一异常处理,把异常信息以json格式同样响应给用户,而不是内部抛了异常,让用户长时间等待;
  2. 用枚举实现一组错误状态编码;再把异常反馈给用户时,对异常信息进行翻译,对应好一组错误编码,让用户可以直接明了的发现自己的错误;(状态编码建议和http默认动态编码一致)/或者你可以用一些现成的工具类

  3. 为了用户解析方便,定义一个统一返回对象;里边主要包含三个参数:String msg,String code,Object data;

  4. 如果升级比较频繁或者版本较多的接口,建议在路径中加入版本号;(最好能实现,当高版本找不到时,自动转到最近的一个较低的版本);

  5. 接口的安全:一是上线后,最好把接口由http协议转换成https(http+CA证书)协议。二是在接口拦截器中,采用签名加密方式对接口进行签名验证,防止参数被篡改。

  6. 接口文档api也是接口的重要组成部分。一个好的接口api应该包括:接口的说明、接口的路径url(公用部分ip和端口应该提取出来);传入参数(包含参数说明和参数格式示例);响应参数(包含参数说明和参数格式示例);

  7. 除了api文档外,我们还应该为调用端客户提供对应语言的sdk开发工具包(调用方式封装成方法,打包成jar包)和demo实例;

  8. 接口的测试,接口开发完成以后,我们一定要先自己测试。最好的测试工具就是postman;测试完成以后,可能还需要和调用接口方进行联调。联调关键是让我们接口服务端和调用端在同一网段内。

二、restful接口的调用

restful接口的调用方式很多,常见的主要有3种:HttpURLConnection,HttpClient和Spring的RestTemplate;HttpURLConnection和HttpClient都需要引入apache的httpclient的jar包。HttpURLConnection是java的标准类,没有做封装,用起来比较原始,HttpClient是开源框架,封装了访问HTTP的请求头、参数、内容体、响应等;HttpURLConnection中的输入输出流操作,在这个接口中被统一封装成了HttpPost(HttpGet)和HttpResponse。这样,减少了操作的繁琐性。restTemplate是spring框架对httpclient的进一步封装,调用接口后,可以直接返回对象,而不是想httpclient一样,返回json字符串,需要我们自己再做简析;

 

 以下部分 记不下来,可以简单说,用的封装好的httpclient工具类,里边包含了发送4种请求(get、post、put、delete)的方法;直接传入url和参数,返回json格式数据

HttpClient字面理解就是http请求的客户端,他的调用步骤是:

1. 创建HttpClient对象。

2. 创建请求方法的实例,并指定请求URL。如果需要发送GET请求,创建HttpGet对象;如果需要发送POST请求,创建HttpPost对象。

3. 如果需要发送请求参数,可调用HttpGet、HttpPost共同的setParams(HetpParams params)方法来添加请求参数;对于HttpPost对象而言,也可调用setEntity(HttpEntity entity)方法来设置请求参数。

4. 调用HttpClient对象的execute(HttpUriRequest request)发送请求,该方法返回一个HttpResponse。

5. 调用HttpResponse的getAllHeaders()、getHeaders(String name)等方法可获取服务器的响应头;调用HttpResponse的getEntity()方法可获取HttpEntity对象,该对象包装了服务器的响应内容。程序可通过该对象获取服务器的响应内容。

6. 释放连接。无论执行方法是否成功,都必须释放连接

 

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值