justauth /JustAuth
🏆Gitee 最有价值开源项目 🚀:100: 小而全而美的第三方登录开源组件。目前已支持Github、Gitee、微博、钉钉、百度、Coding、腾讯云开发者平台、OSChina、支付宝、QQ、微信、淘宝、Google、Facebook、抖音、领英、小米、微软、今日头条、Teambition、StackOverflow、Pinterest、人人、华为、企业微信、酷家乐、Gitlab、美团、饿了么、推特、飞书、京东、阿里云、喜马拉雅、Amazon、Slack和 Line 等第三方平台的授权登录。 Login, so easy!
★ 17,542⑂ 2,856👁 326⑃ 85● 147▤ 47
+1
Daily
17,542
stars
2,856
forks
326
watchers
85
prs
147
issues
47
releases
README
Login, so easy.
-------------------------------------------------------------------------------
-------------------------------------------------------------------------------
QQ 群:230017570
微信群:justauth (备注justauth或者ja)
帮助文档:www.justauth.cn
什么是 JustAuth?
JustAuth,如你所见,它仅仅是一个第三方授权登录的工具类库,它可以让我们脱离繁琐的第三方登录 SDK,让登录变得So easy!
JustAuth 集成了诸如:Github、Gitee、支付宝、新浪微博、微信、Google、Facebook、Twitter、StackOverflow等国内外数十家第三方平台。更多请参考已集成的平台
有哪些特点?
1. 全:已集成十多家第三方平台(国内外常用的基本都已包含),仍然还在持续扩展中(开发计划)!
2. 简:API就是奔着最简单去设计的(见后面快速开始),尽量让您用起来没有障碍感!
有哪些功能?
- 集成国内外数十家第三方平台,实现快速接入。参考文档
- 自定义 State 缓存,支持各种分布式缓存组件。参考文档
- 自定义 OAuth 平台,更容易适配自有的 OAuth 服务。参考文档
- 自定义 Http 实现,选择权完全交给开发者,不会单独依赖某一具体实现。参考文档
- 自定义 Scope,支持更完善的授权体系。参考文档
- 更多...参考文档
快速开始
引入依赖
xml
me.zhyd.oauth
JustAuth
{latest-version}
latest-version 可选:
- 稳定版:!
- 快照版:!
注意:快照版本是功能的尝鲜,并不保证稳定性。请勿在生产环境中使用。
如何引入快照版本
JustAuth 的快照版本托管在 ossrh 上,所以要指定下载地址。
xml
ossrh-snapshot
https://oss.sonatype.org/content/repositories/snapshots
true
如果你想第一时间获取 JustAuth 的最新快照,可以添加下列代码,每次构建时都检查是否有最新的快照(默认每天检查)。
diff
https://oss.sonatype.org/content/repositories/snapshots
+ always
true
如下任选一种 HTTP 工具 依赖,_项目内如果已有,请忽略。另外需要特别注意,如果项目中已经引入了低版本的依赖,请先排除低版本依赖后,再引入高版本或者最新版本的依赖_
- hutool-http
xml
cn.hutool
hutool-http
5.7.7
- httpclient
xml
org.apache.httpcomponents
httpclient
4.5.13
- okhttp
xml
com.squareup.okhttp3
okhttp
4.9.1
调用api
普通方式
java
// 创建授权request
AuthRequest authRequest = new AuthGiteeRequest(AuthConfig.builder()
.clientId("clientId")
.clientSecret("clientSecret")
.redirectUri("redirectUri")
.build());
// 生成授权页面
authRequest.authorize("state");
// 授权登录后会返回code(auth_code(仅限支付宝))、state,1.8.0版本后,可以用AuthCallback类作为回调接口的参数
// 注:JustAuth默认保存state的时效为3分钟,3分钟内未使用则会自动清除过期的state
authRequest.login(callback);
Builder 方式一
静态配置 AuthConfig
java
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);
Builder 方式二
动态获取并配置 AuthConfig
java
AuthRequest authRequest = AuthRequestBuilder.builder()
.source("gitee")
.authConfig((source) - {
// 通过 source 动态获取 AuthConfig
// 此处可以灵活的从 sql 中取配置也可以从配置文件中取配置
return AuthConfig.builder()
.clientId("clientId")
.clientSecret("clientSecret")
.redirectUri("redirectUri")
.build();
})
Top issues
#51能支持苹果第三方登录吗9 comments · 2019-10-23#42可以打一个 aar 到 jcenter 吗?支持一下移动端8 comments · 2019-08-23#55请问一下app端授权登录如何使用?7 comments · 2019-11-18#17Who is using JustAuth?(欢迎使用 JustAuth 的个人、组织和公司在此留言)7 comments · 2019-07-12#160feat: 是否考虑fastjson依赖更新为fastjson26 comments · 2022-11-07#140我这使用facebook授权登录报错,您能帮看看是什么原因吗?6 comments · 2021-11-25#242请问这个项目还在更新吗5 comments · 2025-08-07#227bug:新版企微扫码登录校验字段大小写错误5 comments · 2024-12-24
Discussions
#246Learning path for GitHub advance0 comments · 2025-11-04#225v1.16.70 comments · 2024-12-14#212authorize中的scope不是已经写死了吗,怎么还能自定义呢1 comments · 2024-08-21#185v1.16.60 comments · 2023-12-03#184v1.16.60 comments · 2023-12-03#139v1.16.50 comments · 2021-10-18#136v1.16.40 comments · 2021-09-22#129v1.16.30 comments · 2021-08-15
Latest release
v1.16.7 v1.16.7 2024-12-14- 新增 - 添加微信小程序登录能力,对接文档:点击查看。 - 添加支付宝证书模式登录能力(原支持的公钥登录模式依然可用),对接文档:点击查看。 - 添加appleid社交登录能力,对接文档:点击查看。 Github192 - 添加QQ小程序社交登录能力。 Github223 - 添加figma社交登录能力。 Gitee41 - 添加新版企业微信扫码登录能力,对接文档:点击查看。 Github Issue165 - 添加新版钉钉扫码登录能力,对接文档:点击查看。 Gitee IssueI73FZL - 添加新版华为登录能力,对接文档:点击查看,原AuthHuaweiRequest会在后面版本被弃用,如有使用,请切换到AuthHuaweiV3Request - 优化 - 修复文档错误。Github 222 - 更新 Google 端点地址。Github 198 - Amazon PKCE 中的 code_verifier 基于 state 缓存 - AuthRequest响应时携带泛型,避免二次解析。Gitee38 - 优化业务调用方式:getAccessToken和getUserInfo两个方法从AuthDefaultRequest提升至AuthRequest中,部分场景下可以减少一次网络请求。Gith