Spring Boot 快速集成第三方登录功能
Spring Boot 快速集成第三方登录功能
前言
此 demo 主要演示 Spring Boot 项目如何使用 史上最全的第三方登录工具 - JustAuth 实现第三方登录,包括 QQ 登录、GitHub 登录、微信登录、谷歌登录、微软登录、小米登录、企业微信登录。
通过 justauth-spring-boot-starter 快速集成,好嗨哟~
JustAuth,如你所见,它仅仅是一个第三方授权登录的工具类库,它可以让我们脱离繁琐的第三方登录 SDK,让登录变得 So easy!
- 全:已集成十多家第三方平台(国内外常用的基本都已包含),后续依然还有扩展计划!
- 简:API 就是奔着最简单去设计的(见后面
快速开始
),尽量让您用起来没有障碍感!PS: 本人十分幸运的参与到了这个 SDK 的开发,主要开发了 QQ 登录、微信登录、小米登录、微软登录、谷歌登录这
5
个第三方登录,以及一些 BUG 的修复工作。再次感谢 @母狼 开源这个又好用又全面的第三方登录 SDK。
如果技术选型是 JFinal
的,请查看此 demo
https://github.com/xkcoding/jfinal-justauth-demo
如果技术选型是 ActFramework
的,请查看此 demo
https://github.com/xkcoding/act-justauth-demo
1. 环境准备
1.1. 公网服务器准备
首先准备一台有公网 IP 的服务器,可以选用阿里云或者腾讯云,如果选用的是阿里云的,可以使用我的优惠链接购买。
1.2. 内网穿透 frp 搭建
frp 安装程序:https://github.com/fatedier/frp/releases
1.2.1. frp 服务端搭建
服务端搭建在上一步准备的公网服务器上,因为服务器是 centos7 x64 的系统,因此,这里下载安装包版本为 linux_amd64 的 frp_0.27.0_linux_amd64.tar.gz 。
下载安装包
复制
1
$ wget https://github.com/fatedier/frp/releases/download/v0.27.0/frp_0.27.0_linux_amd64.tar.gz
解压安装包
复制
1
$ tar -zxvf frp_0.27.0_linux_amd64.tar.gz
修改配置文件
复制
1 2 3 4 5 6
$ cd frp_0.27.0_linux_amd64 $ vim frps.ini[common] bind_port = 7100 vhost_http_port = 7200
启动 frp 服务端
复制
1 2 3 4
$ ./frps -c frps.ini 2019/06/15 16:42:02 [I] [service.go:139] frps tcp listen on 0.0.0.0:7100 2019/06/15 16:42:02 [I] [service.go:181] http service listen on 0.0.0.0:7200 2019/06/15 16:42:02 [I] [root.go:204] Start frps success
1.2.2. frp 客户端搭建
客户端搭建在本地的 Mac 上,因此下载安装包版本为 darwin_amd64 的 frp_0.27.0_darwin_amd64.tar.gz 。
下载安装包
复制
1
$ wget https://github.com/fatedier/frp/releases/download/v0.27.0/frp_0.27.0_darwin_amd64.tar.gz
解压安装包
复制
1
$ tar -zxvf frp_0.27.0_darwin_amd64.tar.gz
修改配置文件,配置服务端 ip 端口及监听的域名信息
复制
1 2 3 4 5 6 7 8 9 10 11
$ cd frp_0.27.0_darwin_amd64 $ vim frpc.ini[common] server_addr = 120.92.169.103 server_port = 7100[web] type = http local_port = 8080 custom_domains = oauth.xkcoding.com
启动 frp 客户端
复制
1 2 3 4
$ ./frpc -c frpc.ini 2019/06/15 16:48:52 [I] [service.go:221] login to server success, get run id [8bb83bae5c58afe6], server udp port [0] 2019/06/15 16:48:52 [I] [proxy_manager.go:137] [8bb83bae5c58afe6] proxy added: [web] 2019/06/15 16:48:52 [I] [control.go:144] [web] start proxy success
1.3. 配置域名解析
前往阿里云 DNS 解析,将域名解析到我们的公网服务器上,比如我的就是将 oauth.xkcoding.com -> 120.92.169.103
1.4. nginx 代理
nginx 的搭建就不在此赘述了,只说配置
复制
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 |
server {listen 80;server_name oauth.xkcoding.com; location / {proxy_pass http://127.0.0.1:7200;proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;proxy_set_header Host $http_host;proxy_set_header X-Forwarded-Proto $scheme;proxy_set_header X-Real-IP $remote_addr; proxy_buffering off; sendfile off; proxy_max_temp_file_size 0; client_max_body_size 10m; client_body_buffer_size 128k; proxy_connect_timeout 90; proxy_send_timeout 90; proxy_read_timeout 90; proxy_temp_file_write_size 64k; proxy_http_version 1.1; proxy_request_buffering off; } } |
测试配置文件是否有问题
复制
1 2 3 |
$ nginx -t nginx: the configuration file /etc/nginx/nginx.conf syntax is ok nginx: configuration file /etc/nginx/nginx.conf test is successful |
重新加载配置文件,使其生效
复制
1 |
$ nginx -s reload |
现在当我们在浏览器输入
oauth.xkcoding.com
的时候,网络流量其实会经历以下几个步骤:
- 通过之前配的 DNS 域名解析会访问到我们的公网服务器
120.92.169.103
的 80 端口- 再经过 nginx,代理到本地的 7200 端口
- 再经过 frp 穿透到我们的 Mac 电脑的 8080 端口
- 此时 8080 就是我们的应用程序端口
1.5. 第三方平台申请
1.5.1. QQ 互联平台申请
前往 https://connect.qq.com/
申请开发者
应用管理 -> 添加网站应用,等待审核通过即可
1.5.2. GitHub 平台申请
前往 https://github.com/settings/developers
点击
New OAuth App
按钮创建应用
1.5.3 微信开放平台申请
这里微信开放平台需要用企业的,个人没有资质,所以我在某宝租了一个月的资质,需要的可以 戳我租赁
声明:本人与该店铺无利益相关,纯属个人觉得好用做分享
该店铺有两种方式:
- 店铺支持帮你过企业资质,这里就用你自己的开放平台号就好了
- 临时使用可以问店家租一个月进行开发,这里租了之后,店家会把 AppID 和 AppSecret 的信息发给你,你提供回调域就好了
因此这里我就贴出一张授权回调的地址作参考。
1.5.4. 谷歌开放平台申请
前往 https://console.developers.google.com/projectcreate 创建项目
前往 https://console.developers.google.com/apis/credentials ,在第一步创建的项目下,添加应用
1.5.5. 微软开放平台申请
前往 https://portal.azure.com/#blade/Microsoft_AAD_RegisteredApps/ApplicationsListBlade 注册应用
在注册应用的时候就需要填写回调地址,当然后期也可以重新修改
client id 在这里
client secret 需要自己在这里生成
1.5.6. 小米开放平台申请
申请小米开发者,审核通过
前往 https://dev.mi.com/passport/oauth2/applist 添加 oauth 应用,选择
创建网页应用
填写基本信息之后,进入应用信息页面填写
回调地址
应用审核通过之后,可以在应用信息页面的
应用详情
查看到 AppKey 和 AppSecret,吐槽下,小米应用的审核速度特别慢,需要耐心等待。。。。
1.5.7. 企业微信平台申请
参考:https://xkcoding.com/2019/08/06/use-justauth-integration-wechat-enterprise.html
2. 主要代码
代码地址:https://github.com/xkcoding/spring-boot-demo/tree/master/spring-boot-demo-social
本 demo 采用 Redis 缓存 state,所以请准备 Redis 环境,如果没有 Redis 环境,可以将配置文件的缓存配置为复制
1 2 3 4 > justauth: > cache: > type: default >
2.1. pom.xml
复制
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 |
<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"><modelVersion>4.0.0</modelVersion><artifactId>spring-boot-demo-social</artifactId><version>1.0.0-SNAPSHOT</version><packaging>jar</packaging><name>spring-boot-demo-social</name><description>Demo project for Spring Boot</description><parent><groupId>com.xkcoding</groupId><artifactId>spring-boot-demo</artifactId><version>1.0.0-SNAPSHOT</version></parent><properties><project.build.sourceEncoding>UTF-8</project.build.sourceEncoding><project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding><java.version>1.8</java.version><justauth-spring-boot.version>1.1.0</justauth-spring-boot.version></properties><dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-test</artifactId><scope>test</scope></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-data-redis</artifactId></dependency><!-- 对象池,使用redis时必须引入 --><dependency><groupId>org.apache.commons</groupId><artifactId>commons-pool2</artifactId></dependency><!-- oauth工具类 --><dependency><groupId>com.xkcoding</groupId><artifactId>justauth-spring-boot-starter</artifactId><version>${justauth-spring-boot.version}</version></dependency><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><optional>true</optional></dependency><dependency><groupId>com.google.guava</groupId><artifactId>guava</artifactId></dependency><dependency><groupId>cn.hutool</groupId><artifactId>hutool-all</artifactId></dependency></dependencies><build><finalName>spring-boot-demo-social</finalName><plugins><plugin><groupId>org.springframework.boot</groupId><artifactId>spring-boot-maven-plugin</artifactId></plugin></plugins></build></project> |
2.2. application.yml
复制
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 |
server:port: 8080servlet:context-path: /demospring:redis:host: localhost# 连接超时时间(记得添加单位,Duration)timeout: 10000ms# Redis默认情况下有16个分片,这里配置具体使用的分片# database: 0lettuce:pool:# 连接池最大连接数(使用负值表示没有限制) 默认 8max-active: 8# 连接池最大阻塞等待时间(使用负值表示没有限制) 默认 -1max-wait: -1ms# 连接池中的最大空闲连接 默认 8max-idle: 8# 连接池中的最小空闲连接 默认 0min-idle: 0cache:# 一般来说是不用配置的,Spring Cache 会根据依赖的包自行装配type: redisjustauth:enabled: truetype:qq:client-id: 10******85client-secret: 1f7d************************d629eredirect-uri: http://oauth.xkcoding.com/demo/oauth/qq/callbackgithub:client-id: 2d25******d5f01086client-secret: 5a2919b************************d7871306d1redirect-uri: http://oauth.xkcoding.com/demo/oauth/github/callbackwechat:client-id: wxdcb******4ff4client-secret: b4e9dc************************a08ed6dredirect-uri: http://oauth.xkcoding.com/demo/oauth/wechat/callbackgoogle:client-id: 716******17-6db******vh******ttj320i******userco******t.comclient-secret: 9IBorn************7-Eredirect-uri: http://oauth.xkcoding.com/demo/oauth/google/callbackmicrosoft:client-id: 7bdce8******************e194ad76c1bclient-secret: Iu0zZ4************************tl9PWan_.redirect-uri: https://oauth.xkcoding.com/demo/oauth/microsoft/callbackmi:client-id: 288************2994client-secret: nFeTt89************************==redirect-uri: http://oauth.xkcoding.com/demo/oauth/mi/callbackwechat_enterprise:client-id: ww58******f3************fbcclient-secret: 8G6PCr00j************************rgk************AyzaPc78redirect-uri: http://oauth.xkcoding.com/demo/oauth/wechat_enterprise/callbackagent-id: 1*******2cache:type: redisprefix: 'SOCIAL::STATE::'timeout: 1h |
2.3. OauthController.java
复制
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 |
/*** <p>* 第三方登录 Controller* </p>** @package: com.xkcoding.oauth.controller* @description: 第三方登录 Controller* @author: yangkai.shen* @date: Created in 2019-05-17 10:07* @copyright: Copyright (c) 2019* @version: V1.0* @modified: yangkai.shen*/ @Slf4j @RestController @RequestMapping("/oauth") @RequiredArgsConstructor(onConstructor_ = @Autowired) public class OauthController {private final AuthRequestFactory factory;/*** 登录类型*/@GetMappingpublic Map<String, String> loginType() {List<String> oauthList = factory.oauthList();return oauthList.stream().collect(Collectors.toMap(oauth -> oauth.toLowerCase() + "登录", oauth -> "http://oauth.xkcoding.com/demo/oauth/login/" + oauth.toLowerCase()));}/*** 登录** @param oauthType 第三方登录类型* @param response response* @throws IOException*/@RequestMapping("/login/{oauthType}")public void renderAuth(@PathVariable String oauthType, HttpServletResponse response) throws IOException {AuthRequest authRequest = factory.get(getAuthSource(oauthType));response.sendRedirect(authRequest.authorize(oauthType + "::" + AuthStateUtils.createState()));}/*** 登录成功后的回调** @param oauthType 第三方登录类型* @param callback 携带返回的信息* @return 登录成功后的信息*/@RequestMapping("/{oauthType}/callback")public AuthResponse login(@PathVariable String oauthType, AuthCallback callback) {AuthRequest authRequest = factory.get(getAuthSource(oauthType));AuthResponse response = authRequest.login(callback);log.info("【response】= {}", JSONUtil.toJsonStr(response));return response;}private AuthSource getAuthSource(String type) {if (StrUtil.isNotBlank(type)) {return AuthSource.valueOf(type.toUpperCase());} else {throw new RuntimeException("不支持的类型");}} } |
2.4. 如果想要自定义 state 缓存
请看
Spring Boot 快速集成第三方登录功能相关推荐
- SpringBoot项目中集成第三方登录功能
SpringBoot项目中集成第三方登录功能 引言 1 环境准备 2 代码实现 3 第三方平台认证申请 4 打包和部署项目 5 第三方平台登录认证测试 6 参考文章 引言 最近想把自己在公众号上介绍过 ...
- spring boot+Vue整合第三方登录JustAuth
JustAuth,如你所见,它仅仅是一个第三方授权登录的工具类库,它可以让我们脱离繁琐的第三方登录SDK,让登录变得So easy! github地址:https://github.com/justa ...
- 解密电商系统-Spring boot快速开始及核心功能介绍(下)
上次说了Spring boot快速开始及核心功能介绍,本次说说配置文件相关的. Spring Boot属性配置文件详解(一) 修改端口 # application.properties: server ...
- Spring Boot 接入 GitHub 第三方登录,只要两行配置!
点击上方 好好学java ,选择 星标 公众号重磅资讯,干货,第一时间送达 今日推荐:14 个 github 项目!个人原创100W +访问量博客:点击前往,查看更多 本文地址:https://www ...
- SpringBoot2.x系列教程(六十六)Spring Boot快速集成RocketMQ实战教程
前言 RocketMQ是目前主流的消息中间件之一,并且自身就支持分布式功能.最初由阿里巴巴团队开发,并且经历过双十一等海量消息场景的考验,后捐赠给Apache开源基金会,这也是为什么我们经常听说Roc ...
- 软件架构-Spring boot快速开始及核心功能介绍(中)
上次通过Spring boot认知,核心功能.springBoot的搭建[官方向导搭建boot应用]和 [maven的方式搭建boot]. 统一父POM管理(一) ① 建立boot-parent工程 ...
- spring boot快速集成Apache OpenOffice
工作需求:提供一个接口,页面上的文档不仅支持下载,还可以在浏览器上可以预览的功能.我们知道pdf是支持浏览器在线预览的功能的,所以只要把其他格式的文档转换为pdf是不是就间接的展示了呢? 一.open ...
- Spring Boot集成第三方登录之微信登录
Spring Boot集成第三方登录之微信登录 准备工作 注册 创建网站应用 网站应用开发指南 授权流程 请求CODE 获取access_token 使用access_token调用接口 获取用户个人 ...
- Spring Boot集成第三方登录之微博登录
Spring Boot集成第三方登录之微博登录 准备工作 网站接入 开发者信息认证 创建应用 流程分析 引导授权用户 用户授权 授权成功 换取Access Token HTTP客户端 使用Access ...
最新文章
- R中rJava包载入时报错的问题
- SpringBoot 2.1.3配置log4j2日志框架完整代码示例
- uilabel 自行撑开高度_UILabel文本高度计算的那些事儿
- 移动端隐藏滚动条(最全面)
- [转]关于凸优化的一些简单概念
- Linux打开bashrc权限不够,bash-4.2$ bash: /home/test/.bashrc: 权限不够
- C++之指针探究(二):一级指针和一维数组
- zookeeper学习(二)之java客户端API建立连接
- 偏微分方程数值解法pdf_单摆-微分方程浅谈
- 凝聚 • 融合 • 协作——记webpower2015新春年会
- 汽车尾气污染检测 尾气烟雾检测
- 【STM32H750】玩转ART-Pi(八)——添加动态模块
- 类和对象9:属性访问方法
- idea 中git 将 dev 分支合并到 master 分支 或将master 分支 合并到dev 分支
- uni-app项目中引入Vant UI组件库(完美避坑!!!)纯净版
- 我参加NVIDIA Sky Hackathon(语音识别模型训练)
- kestrel服务器性能,深入理解kestrel的应用
- python看门狗(watchdog)、多线程、实现文件夹实时监听、日志输出、备份
- AirDisk产品Q1\T2\Q3C连接和使用方式
- LeetCode——第121题:买股票的最佳时机