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 相关文章推荐
使用feign服务调用添加Header参数
Jun 23 Java/Android
总结一下关于在Java8中使用stream流踩过的一些坑
Jun 24 Java/Android
JAVA API 实用类 String详解
Oct 05 Java/Android
详解JAVA的控制语句
Nov 11 Java/Android
Java tomcat手动配置servlet详解
Nov 27 Java/Android
springboot 自定义配置 解决Boolean属性不生效
Mar 18 Java/Android
springboot+zookeeper实现分布式锁
Mar 21 Java/Android
Netty分布式客户端接入流程初始化源码分析
Mar 25 Java/Android
Java 超详细讲解数据结构中的堆的应用
Apr 02 Java/Android
springboot入门 之profile设置方式
Apr 04 Java/Android
MyBatis配置文件解析与MyBatis实例演示
Apr 07 Java/Android
Java使用HttpClient实现文件下载
Aug 14 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
无JS,完全php面向过程数据分页实现代码
2012/08/27 PHP
PHP register_shutdown_function函数的深入解析
2013/06/03 PHP
thinkphp缓存技术详解
2014/12/09 PHP
phpstudy默认不支持64位php的解决方法
2017/02/20 PHP
php中array_fill函数的实例用法
2021/03/02 PHP
baidu博客的编辑友情链接的新的层窗口!经典~支持【FF】
2007/02/09 Javascript
AppBaseJs 类库 网上常用的javascript函数及其他js类库写的
2010/03/04 Javascript
javascript 词法作用域和闭包分析说明
2010/08/12 Javascript
js+xml生成级联下拉框代码
2012/07/24 Javascript
百度地图API之本地搜索与范围搜索
2015/07/30 Javascript
JavaScript tab选项卡插件实例代码
2016/02/23 Javascript
JavaScript数据类型学习笔记分享
2016/09/01 Javascript
js实现做通讯录的索引滑动显示效果和滑动显示锚点效果
2017/02/18 Javascript
bootstrap实现动态进度条效果
2017/03/08 Javascript
Vue2.0 事件的广播与接收(观察者模式)
2018/03/14 Javascript
基于Vue的延迟加载插件vue-view-lazy
2018/05/21 Javascript
小程序获取周围IBeacon设备的方法
2018/10/31 Javascript
Python 网络编程起步(Socket发送消息)
2008/09/06 Python
在Python中进行自动化单元测试的教程
2015/04/15 Python
Python实现输出程序执行进度百分比的方法
2017/09/16 Python
Python实现购物评论文本情感分析操作【基于中文文本挖掘库snownlp】
2018/08/07 Python
python高斯分布概率密度函数的使用详解
2019/07/10 Python
使用Python获取当前工作目录和执行命令的位置
2020/03/09 Python
HTML5 文件域+FileReader 分段读取文件并上传到服务器
2017/10/23 HTML / CSS
日本土著品牌,综合型购物网站:Cecile
2016/08/23 全球购物
StubHub西班牙:购买和出售全球活动门票
2017/06/05 全球购物
全球最大的在线橄榄球商店:Lovell Rugby
2018/05/20 全球购物
StubHub美国:购买或出售您的门票
2019/07/09 全球购物
Static Nested Class 和 Inner Class的不同
2013/11/28 面试题
校园自助餐厅的创业计划书
2013/12/26 职场文书
房屋继承公证书
2014/04/10 职场文书
金融管理专业求职信
2014/07/10 职场文书
时尚女魔头观后感
2015/06/04 职场文书
Python基础之变量的相关知识总结
2021/06/23 Python
python人工智能human learn绘图可创建机器学习模型
2021/11/23 Python
win10壁纸在哪个文件夹 win10桌面背景图片文件位置分享
2022/08/05 数码科技