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 相关文章推荐
解决tk mapper 通用mapper的bug问题
Jun 16 Java/Android
Java常用工具类汇总 附示例代码
Jun 26 Java/Android
Springboot使用Spring Data JPA实现数据库操作
Jun 30 Java/Android
关于Mybatis中SQL节点的深入解析
Mar 19 Java/Android
SpringBoot2零基础到精通之数据库专项精讲
Mar 22 Java/Android
Java版 单机五子棋
May 04 Java/Android
利用正则表达式匹配浮点型数据
May 30 Java/Android
解决spring.thymeleaf.cache=false不起作用的问题
Jun 10 Java/Android
SpringBoot使用ip2region获取地理位置信息的方法
Jun 21 Java/Android
springboot 全局异常处理和统一响应对象的处理方式
Jun 28 Java/Android
HttpClient实现表单提交上传文件
Aug 14 Java/Android
Android实现获取短信验证码并自动填充
May 21 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
PHP 身份验证方面的函数
2009/10/11 PHP
php gd等比例缩放压缩图片函数
2016/06/12 PHP
代码精简的可以实现元素圆角的js函数
2007/07/21 Javascript
Javascript 陷阱 window全局对象
2008/11/26 Javascript
javascript中创建对象的三种常用方法
2010/12/30 Javascript
JS图片无缝滚动(简单利于使用)
2013/06/17 Javascript
HTML页面登录时的JS验证方法
2014/05/28 Javascript
使用javascript将时间转换成今天,昨天,前天等格式
2015/06/25 Javascript
jQuery实现分章节锚点“回到顶部”动画特效代码
2015/10/23 Javascript
jQuery xml字符串的解析、读取及查找方法
2016/03/01 Javascript
jQuery点击弹出层弹出模态框点击模态框消失代码分享
2017/01/21 Javascript
jQuery元素选择器实例代码
2017/02/06 Javascript
vue-router history模式下的微信分享小结
2018/07/05 Javascript
详解Vue开发微信H5微信分享签名失败问题解决方案
2018/08/09 Javascript
基于vue中对鼠标划过事件的处理方式详解
2018/08/22 Javascript
jQuery.validate.js表单验证插件的使用代码详解
2018/10/22 jQuery
微信小程序 可搜索的地址选择实现详解
2019/08/28 Javascript
webpack HappyPack实战详解
2019/10/08 Javascript
用Node写一条配置环境的指令
2019/11/14 Javascript
vue集成openlayers加载geojson并实现点击弹窗教程
2020/09/24 Javascript
Vue组件简易模拟实现购物车
2020/12/21 Vue.js
[10:04]国际邀请赛采访专栏:DK.Farseer,mouz.Black^,采访员Josh专访
2013/08/05 DOTA
python中的字典使用分享
2016/07/31 Python
Python+MongoDB自增键值的简单实现
2016/11/04 Python
python递归全排列实现方法
2018/08/18 Python
Python之时间和日期使用小结
2019/02/14 Python
Python处理mysql特殊字符的问题
2020/03/02 Python
Numpy中ndim、shape、dtype、astype的用法详解
2020/06/14 Python
python 牛顿法实现逻辑回归(Logistic Regression)
2020/10/15 Python
俄罗斯金苹果网上化妆品和香水商店:Goldapple
2019/12/01 全球购物
社会实践评语
2014/04/28 职场文书
基层组织建设年活动总结
2015/05/09 职场文书
红色革命电影观后感
2015/06/18 职场文书
2015年秋季学校开学标语
2015/07/16 职场文书
2015新员工工作总结范文
2015/10/15 职场文书
Android studio 简单计算器的编写
2022/05/20 Java/Android