RestTemplate如何通过HTTP Basic Auth认证示例说明


Posted in Java/Android onMarch 17, 2022

服务提供方通常会通过一定的授权、鉴权认证逻辑来保护API接口。其中比较简单、容易实现的方式就是使用HTTP 的Basic Auth来实现接口访问用户的认证。我们本节就来为大家介绍一下,在服务端加入Basic Auth认证的情况下,该如何使用RestTemplate访问服务端接口。

一、HttpBasic认证原理说明

RestTemplate如何通过HTTP Basic Auth认证示例说明

首先,HttpBasic模式要求传输的用户名密码使用Base64模式进行加密。如果用户名是 "admin"  ,密码是“ admin”,则将字符串"admin:admin"使用Base64编码算法加密。加密结果可能是:YWtaW46YWRtaW4=。

然后,在Http请求中使用authorization作为一个HTTP请求头Header name,“Basic YWtaW46YWRtaW4=“作为Header的值,发送给服务端。(注意这里使用Basic+空格+加密串)

服务器在收到这样的请求时,到达BasicAuthenticationFilter过滤器,将提取“authorization”的Header值,并使用用于验证用户身份的相同算法Base64进行解码。

解码结果与登录验证的用户名密码匹配,匹配成功则可以继续过滤器后续的访问。

二、HTTP Basic Auth服务端实现

如果你想自己搭建一个服务端,那么如何为Spring Boot 服务添加Basic Auth认证?请参考我的另外一篇文章:《Spring Security系列之Http Basic Auth登录认证模式》 。

当然我们也可以不用自己去搭建服务端,给大家介绍一个提供免费在线的RESTful接口服务的网站:httpbin.com。这个网站为我们提供了Basic Auth认证测试服务接口。如果我们只是为了学习RestTemplate,直接用这个网站提供的服务就可以了。

RestTemplate如何通过HTTP Basic Auth认证示例说明

浏览器访问地址:http://www.httpbin.org/#/Auth/get_basic_auth__user___passwd_

这个接口服务是通过OpenAPI(swagger)实现的,所以可以进行在线的访问测试。所以可以先通过页面操作测试一下,再开始下面学习使用RestTemplate访问服务端接口。

三、请求头方式携带认证信息

在HTTP请求头中携带Basic Auth认证的用户名和密码,具体实现参考下文代码注释:

@SpringBootTest
class BasicAuthTests {
   @Resource
   private RestTemplate restTemplate;
   @Test
   void testBasicAuth() {
      //该url上携带用户名密码是httpbin网站测试接口的要求,
     //真实的业务是不需要在url上体现basic auth用户名密码的
      String url = "http://www.httpbin.org/basic-auth/admin/adminpwd";
      //在请求头信息中携带Basic认证信息(这里才是实际Basic认证传递用户名密码的方式)
      HttpHeaders headers = new HttpHeaders();
      headers.set("authorization",
                  "Basic " +
                  Base64.getEncoder()  
                       .encodeToString("admin:adminpwd".getBytes()));
     //发送请求
      HttpEntity<String> ans = restTemplate
                  .exchange(url,
                        HttpMethod.GET,   //GET请求
                        new HttpEntity<>(null, headers),   //加入headers
                        String.class);  //body响应数据接收类型
      System.out.println(ans);
   }

}

测试用例执行成功,说明RestTemplate 正确的携带了Basic 认证信息,得到正常的响应结果:200。

RestTemplate如何通过HTTP Basic Auth认证示例说明

四、拦截器方式携带认证信息

第三小节中的代码虽然实现了功能,但是不够好。因为每一次发送HTTP请求,我们都需要去组装HttpHeaders 信息,这样不好,造成大量的代码冗余。那么有没有一种方式可以实现可以一次性的为所有RestTemplate请求API添加Http Basic认证信息呢?答案就是:在RestTemplate Bean初始化的时候加入拦截器,以拦截器的方式统一添加Basic认证信息。

下面的代码结合注释去看,如果看不懂,需要去参考:

精讲RestTemplate第2篇-多种底层HTTP客户端类库的切换

 

@Configuration
public class ContextConfig {
    @Bean("OKHttp3")
    public RestTemplate OKHttp3RestTemplate(){
        RestTemplate restTemplate = new RestTemplate(getClientHttpRequestFactory());
        //添加拦截器
        restTemplate.getInterceptors().add(getCustomInterceptor());
        return restTemplate;
    }
   //实现一个拦截器:使用拦截器为每一个HTTP请求添加Basic Auth认证用户名密码信息
    private ClientHttpRequestInterceptor getCustomInterceptor(){
        ClientHttpRequestInterceptor interceptor = (httpRequest, bytes, execution) -> {
            httpRequest.getHeaders().set("authorization",
                    "Basic " +
                            Base64.getEncoder()
                                    .encodeToString("admin:adminpwd".getBytes()));
            return execution.execute(httpRequest, bytes);
        };
        return interceptor;
    }
    //这段代码是《第3节-底层HTTP客户端实现切换》的内容
    private ClientHttpRequestFactory getClientHttpRequestFactory() {
        int timeout = 100000;
        OkHttp3ClientHttpRequestFactory clientHttpRequestFactory
                = new OkHttp3ClientHttpRequestFactory();
        clientHttpRequestFactory.setConnectTimeout(timeout);
        return clientHttpRequestFactory;
    }
}

在RestTemplate Bean初始化的时候加入拦截器之后,第三小节中的代码就可以省略HttpHeaders Basic Auth请求头携带信息的组装过程。发送请求,结果和第三小节中的效果是一样的。

五、进一步简化

上面的方式使用了拦截器,但仍然是我们自己来封装HTTP headers请求头信息。进一步的简化方法就是,Spring RestTemplate 已经为我们提供了封装好的Basic Auth拦截器,我们直接使用就可以了,不需要我们自己去实现拦截器。

RestTemplate如何通过HTTP Basic Auth认证示例说明

下面的方法是在RestTemplate Bean实例化的时候使用RestTemplateBuilder,自带basicAuthentication。所以到这里拦截器也不需要了(实际底层代码实现仍然是拦截器,只是api层面不需要指定拦截器了)。

RestTemplate如何通过HTTP Basic Auth认证示例说明

发送请求,结果和第三小节中的效果是一样的。

以上就是RestTemplate如何通过HTTP Basic Auth认证示例说明的详细内容,更多关于RestTemplate认证HTTP Basic Auth的资料请关注三水点靠木其它相关文章!

Java/Android 相关文章推荐
Java中常用解析工具jackson及fastjson的使用
Jun 28 Java/Android
Java Socket实现多人聊天系统
Jul 15 Java/Android
springboot 启动如何排除某些bean的注入
Aug 02 Java/Android
关于springboot配置druid数据源不生效问题(踩坑记)
Sep 25 Java/Android
使用Java去实现超市会员管理系统
Mar 18 Java/Android
Java字符串逆序方法详情
Mar 21 Java/Android
Java 数据结构七大排序使用分析
Apr 02 Java/Android
零基础学java之循环语句的使用
Apr 10 Java/Android
Java 数组的使用
May 11 Java/Android
解决spring.thymeleaf.cache=false不起作用的问题
Jun 10 Java/Android
JDK8中String的intern()方法实例详细解读
Sep 23 Java/Android
Java实现贪吃蛇游戏的示例代码
Sep 23 Java/Android
Java实现二分搜索树的示例代码
使用HttpSessionListener监听器实战
Mar 17 #Java/Android
spring cloud eureka 服务启动失败的原因分析及解决方法
Mar 17 #Java/Android
Java基于Dijkstra算法实现校园导游程序
Java中的随机数Random
Mar 17 #Java/Android
SpringBoot中HttpSessionListener的简单使用方式
Mar 17 #Java/Android
SpringBoot+Redis实现布隆过滤器的示例代码
Mar 17 #Java/Android
You might like
BBS(php &amp; mysql)完整版(一)
2006/10/09 PHP
本地机apache配置基于域名的虚拟主机详解
2013/08/10 PHP
php实现根据字符串生成对应数组的方法
2014/09/22 PHP
php+mysqli预处理技术实现添加、修改及删除多条数据的方法
2015/01/30 PHP
PHP延迟静态绑定的深入讲解
2018/04/02 PHP
phpStorm+XDebug+chrome 配置详解
2019/04/01 PHP
JavaScript入门教程(5) js Screen屏幕对象
2009/01/31 Javascript
jquery zTree异步加载简单实例分享
2013/02/05 Javascript
浅谈javascript中基本包装类型
2015/06/03 Javascript
jQuery实现两款有动画功能的导航菜单代码
2015/09/16 Javascript
JS实现从顶部下拉显示的带动画QQ客服特效代码
2015/10/24 Javascript
jQuery+jsp下拉框联动获取本地数据的方法(附源码)
2015/12/03 Javascript
AngularJS实现Model缓存的方式
2016/02/03 Javascript
bootstrap网页框架的使用方法
2016/05/10 Javascript
微信开发 微信授权详解
2016/10/21 Javascript
vue的props实现子组件随父组件一起变化
2016/10/27 Javascript
简单的jQuery拖拽排序效果的实现(增强动态)
2017/02/09 Javascript
js实现打地鼠小游戏
2017/02/13 Javascript
jQuery Validate 校验多个相同name的方法
2017/05/18 jQuery
JS实现加载时锁定HTML页面元素的方法
2017/06/24 Javascript
vue项目tween方法实现返回顶部的示例代码
2018/03/02 Javascript
vue.js this.$router.push获取不到params参数问题
2020/03/03 Javascript
[01:08:43]DOTA2-DPC中国联赛定级赛 Phoenix vs DLG BO3第一场 1月9日
2021/03/11 DOTA
python实现K近邻回归,采用等权重和不等权重的方法
2019/01/23 Python
十个Python练手的实战项目,学会这些Python就基本没问题了(推荐)
2019/04/26 Python
用Python抢火车票的简单小程序实现解析
2019/08/14 Python
Tensorflow实现部分参数梯度更新操作
2020/01/23 Python
通过cmd进入python的步骤
2020/06/16 Python
PHP数据运算类型都有哪些
2013/11/05 面试题
华为慧通笔试题
2016/04/22 面试题
重阳节登山活动方案
2014/02/03 职场文书
消防先进事迹材料
2014/02/10 职场文书
教师教学评估方案
2014/05/09 职场文书
诚实守信道德模范事迹材料
2014/08/15 职场文书
幼师小班个人总结
2015/02/12 职场文书
在HTML中引入CSS的几种方式介绍
2021/12/06 HTML / CSS