JustAuth,如你所见,它仅仅是一个第三方授权登录的工具类库,它可以让我们脱离繁琐的第三方登录 SDK,让登录变得 So easy!
图片
JustAuth 集成了诸如:Github、Gitee、支付宝、新浪微博、微信、Google、Facebook、Twitter、StackOverflow 等国内外数十家第三方平台。
1.功能
- 丰富的 OAuth 平台: 集成国内外数十家第三方平台,实现快速接入。
- 自定义 state: 支持自定义 State 和缓存方式,开发者可根据实际情况选择任意缓存插件。
- 自定义 OAuth: 提供统一接口,支持接入任意 OAuth 网站,快速实现 OAuth 登录功能。更容易适配自有的 OAuth 服务。
- 自定义 Http: 接口 HTTP 工具,开发者可以根据自己项目的实际情况选择相对应的 HTTP 工具。
- 自定义 Scope: 支持自定义 scope,以适配更多的业务场景,而不仅仅是为了登录。
- 代码规范·简单: JustAuth 代码严格遵守阿里巴巴编码规约,结构清晰、逻辑简单。
2.快速使用(以 QQ 为例)
(1) 申请开发者
如果是第一次使用,需要到“QQ 互联平台”申请开发者,通过后创建应用并且复制三个信息:App ID、App Key和网站回调域。
(2) 集成 JustAuth
添加依赖:
me.zhyd.oauth
JustAuth
{latest-version}
创建Request,把第一步的三个信息添加进去:
AuthRequest authRequest = new AuthQqRequest(AuthConfig.builder()
.clientId("App ID")
.clientSecret("App Key")
.redirectUri("网站回调域")
.build());
生成授权地址:
//这个链接可以直接在后台重定向跳转,也可以返回到前端跳转
String authorizeUrl = authRequest.authorize(AuthStateUtils.createState());
或者生成静态授权页面:
AuthRequest authRequest = AuthRequestBuilder.builder()
.source("github")
.authConfig(AuthConfig.builder()
.clientId("clientId")
.clientSecret("clientSecret")
.redirectUri("redirectUri")
.build())
.build();
// 生成授权页面
authRequest.authorize("state");
// 授权登录后会返回code(auth_code(仅限支付宝))、state,1.8.0版本后,可以用AuthCallback类作为回调接口的参数
// 注:JustAuth默认保存state的时效为3分钟,3分钟内未使用则会自动清除过期的state
authRequest.login(callback);
或者生成动态授权页面:
AuthRequest authRequest = AuthRequestBuilder.builder()
.source("gitee")
.authConfig((source) -> {
// 通过 source 动态获取 AuthConfig
// 此处可以灵活的从 sql 中取配置也可以从配置文件中取配置
return AuthConfig.builder()
.clientId("clientId")
.clientSecret("clientSecret")
.redirectUri("redirectUri")
.build();
})
.build();
Assert.assertTrue(authRequest instanceof AuthGiteeRequest);
System.out.println(authRequest.authorize(AuthStateUtils.createState()));
JustAuth 的团队还在持续接入其他平台的授权登录,感兴趣的同学可以关注一下。
3.开源地址
https://github.com/justauth/JustAuth