1. 简介
随着科技时代日渐繁荣,越来越多的应用融入我们的生活。不同的应用系统不同的用户密码,造成了极差的用户体验。要是能使用常见的应用账号实现全应用的认证登录,将会更加促进应用产品的推广,为生活增加无限乐趣。
本文基于JustAuth实现第三方授权登录,选择JustAuth原因如下:
- 支持Github、Gitee、微博、钉钉、百度、Coding、腾讯云开发者平台、OSChina、支付宝、QQ、微信、淘宝、Google、Facebook、抖音、领英、小米、微软、今日头条、Teambition、StackOverflow、Pinterest、人人、华为、企业微信、酷家乐、Gitlab、美团、饿了么和推特等第三方平台的授权登录;
- 无需去第三方平台找寻繁杂而庞大的SDK文档,JustAuth提供了及其简单的接入方式;
- 支持自定义OAuth平台;
- 支持多种方式的State缓存;
- 支持自定义Http实现;
- 自定义 Scope,支持更完善的授权体系;
- 与SpringBoot完美集成,也可整合Spring Security等安全框架;
官网文档详细、完善,按照文档即可完成需求落地。
官网:https://justauth.wiki/#/
2. 入手准备
使用JustAuth总共分三步(这三步也适合于JustAuth支持的任何一个平台):
- 申请注册第三方平台的开发者账号
- 创建第三方平台的应用,获取配置信息(accessKey, secretKey, redirectUri)
- 使用该工具实现授权登陆
3. 开发
3.1 引入依赖
<dependency>
<groupId>me.zhyd.oauth</groupId>
<artifactId>JustAuth</artifactId>
<version>1.15.1</version>
</dependency>
3.2 集成JUSTAUTH的API
注意,以下代码中,我们的请求链接中是通过动态参数{source}
去取的,这样可以方便的让我们集成任意平台,比如集成gitee时, 我们的请求地址就是:http://localhost:8080/oauth/render/gitee
, 而回调地址就是http://localhost:8080/oauth/callback/gitee
。
package me.zhyd.justauth;
import me.zhyd.oauth.config.AuthConfig;
import me.zhyd.oauth.model.AuthCallback;
import me.zhyd.oauth.request.AuthGiteeRequest;
import me.zhyd.oauth.request.AuthRequest;
import me.zhyd.oauth.utils.AuthStateUtils;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
/**
* 实战演示如何使用JustAuth实现第三方登录
*
* @author yadong.zhang (yadong.zhang0415(a)gmail.com)
* @version 1.0.0
* @since 1.0.0
*/
@RestController
@RequestMapping("/oauth")
public class JustAuthController {
/**
* 获取授权链接并跳转到第三方授权页面
*
* @param response response
* @throws IOException response可能存在的异常
*/
@RequestMapping("/render/{source}")
public void renderAuth(HttpServletResponse response) throws IOException {
AuthRequest authRequest = getAuthRequest();
String authorizeUrl = authRequest.authorize(AuthStateUtils.createState());
response.sendRedirect(authorizeUrl);
}
/**
* 用户在确认第三方平台授权(登录)后, 第三方平台会重定向到该地址,并携带code、state等参数
*
* @param callback 第三方回调时的入参
* @return 第三方平台的用户信息
*/
@RequestMapping("/callback/{source}")
public Object login(AuthCallback callback) {
AuthRequest authRequest = getAuthRequest();
return authRequest.login(callback);
}
/**
* 获取授权Request
*
* @return AuthRequest
*/
private AuthRequest getAuthRequest() {
return new AuthGiteeRequest(AuthConfig.builder()
.clientId("clientId")
.clientSecret("clientSecret")
.redirectUri("redirectUri")
.build());
}
}
接下来我们就需要去gitee上创建我们的OAuth应用。登录gitee后,我们点击右上角用户头像,选择设置,然后点击第三方应用进入第三方应用管理页面,点击右上角的创建应用按钮,进入应用创建页面
我们按照提示填入我们的应用信息即可。
- 应用名称: 一般填写自己的网站名称即可
- 应用描述: 一般填写自己的应用描述即可
- 应用主页: 填写自己的网站首页地址
- 应用回调地址:
**重点**,该地址为用户授权后需要跳转到的自己网站的地址,默认携带一个code参数
- 权限: 根据页面提示操作,默认勾选第一个就行,因为我们只需要获取用户信息即可
以上信息输入完成后,点击确定按钮创建应用。创建完成后,点击进入应用详情页,可以看到应用的**等信息
复制以下三个信息:Client ID
、Client Secret
和应用回调地址
。
3.3 自定义HTTP工具
将上一步获取到配置信息配置AuthConfig
中,如下:
private AuthRequest getAuthRequest() {
return new AuthGiteeRequest(AuthConfig.builder()
.clientId("4c504cd2e1b1dbaba8dc1187d8070adf679acab17b2bc9cf6dfa76b9ae06aadc")
.clientSecret("fa5857175723475e4675e36af9eafde338545c1a0dfa49d1e0cc78f9c3ce5ebe")
.redirectUri("http://localhost:8080/oauth/callback/gitee")
.build());
}
以上工作完成后,我们直接启动项目,然后在浏览器中访问http://localhost:8080/oauth/render/gitee,当出现以下页面时,表示我们已经集成成功,并且已跳转到了第三方的授权页面。
注意,如果您当前没有在浏览器中登录过您的账号,您将会看到如下页面:
我们点击“同意授权”后,第三方应用(Gitee)将会生成一个code
授权码,连带着我们先前传过去的state一并回调到我们配置的redirectUri
接口中。
如上图,进入回调接口后,我们可以断点跟踪到第三方平台传回的信息:state和code。
授权完成后,您将会看到如下页面: