本文地址: http://1t.click/aqmJ
本文作者: 小茗同学
个人网站最近增加了评论功能,为了方便用户不用注册就可以评论,对接了 QQ 的一键登录,总的来说其实都挺简单的,可能会有一点小坑,但不算多,完整记录下来方便后来人快速对接。
在真正开始对接之前,我们先来聊一聊后台的方案设计。既然是对接第三方登录,那就免不了如何将用户信息保存。首先需要明确一点的是,用户在第三方登录成功之后,我们能拿到的仅仅是一个代表用户唯一身份的 ID(微博是真实 uid,QQ 是加密的 openId )以及用来识别身份的 accessToken ,当然还有昵称、头像、性别等有限资料,对接第三方登录的关键就是如何确定用户是合法登录,如果确定这次登录的和上次登录的是同一个人并且不是假冒的。其实这个并不用我们特别操心,就以微博登录为例,用户登录成功之后会回调一个 code 给我们,然后我们再拿 code 去微博那换取 accessToken ,如果这个 code 是用户乱填的,那这一关肯定过不了,所以,前面的担心有点多余,哈哈。
另外一个问题就是如何和现有用户系统打通,有的网站在用户已经登录成功之后还要用户输入手机号和验证码,或者要用户重新注册账号和密码来绑定第三方账户,感觉这种实现用户体验非常差,碰到这种网站我一般都是直接关掉,都已经登录了还让用户注册,什么鬼!由于我做的是评论功能,我并不希望评论用户和现有用户表打通,所以就不存在这件事了,如果想打通的话,我觉得无非就是登录成功之后默认往老用户表插入一条数据,然后和 OpenUser 表关联起来,判断用户是否登录时把 OpenUser 的鉴权也加进去就 OK 了。
本文的后台以 Java 为例。
再来说说数据库设计,为了系统的扩展性,我有一个专门的 OpenUser 表用来存放第三方登录用户,主要字段如下:
这里我只是说说我的方案,把 accessToken 写入 cookie 肯定是不安全的,因为 accessToken 相当于是第三方网站的临时密码,被别人窃取了就可以随意拿来干坏事了。可以在用户登录成功之后我们自己生成一个 token ,这样的 token 即使泄露了顶多就是被人拿来随意评论,损失不大,但是如果 accessToken 被泄露了,以微博为例,人家可以利用这个 accessToken 随意发微博、删微博、加关注等等,很危险。当然,如果不想 token 泄露的话也可以通过绑定 IP 等方式来限制。推荐阅读: Spring Boot 整合 OAuth2,松哥手把手教你! 。
鉴权的话就是首先判断 cookie 中是否有我们自己的 token ,然后判断是否合法,合法再判断第三方授权是否已过期等等。
QQ 登录我们对接的是 QQ 互联,地址:https://connect.qq.com ,首先需要注册成为开发者并实名认证,需要手持身份证照片,具体就不讲了。
进入应用管理页面创建应用,根据实际需要是创建网站应用还是移动应用,我这里是网站应用:
第一步:
第二步:
提交完之后会自动提交审核,基本上就是审核你的资料和备案的资料是否一致,所有资料必须和备案资料一模一样,否则审核不会通过:
当然,这些资料后面还是可以修改的。申请成功之后你会得到 appId 和 appKey。
这里可以下载一些视觉素材,在页面合适位置放一个QQ登录按钮,点击时引导用户进入授权页面:
/** * 封装一个居中打开新窗口的方法 */ function openWindow(url, width, height) { width = width || 600; height = height || 400; var left = (window.screen.width - width) / 2; var top = (window.screen.height - height) / 2; window.open(url, "_blank", "toolbar=yes, location=yes, directories=no, status=no, menubar=yes, scrollbars=yes, resizable=no, copyhistory=yes, left="+left+", top="+top+", width="+width+", height="+height); } function qqLogin() { var qqAppId = '424323422'; // 上面申请得到的appid var qqAuthPath = 'http://www.test.com/auth'; // 前面设置的回调地址 var state = 'fjdslfjsdlkfd'; // 防止CSRF攻击的随机参数,必传,登录成功之后会回传,最好后台自己生成然后校验合法性 openWindow(`https://graph.qq.com/oauth2.0/authorize?response_type=token&client_id=${qqAppId}&redirect_uri=${encodeURIComponent(qqAuthPath)}&state=${state}`); }
然后会打开一个授权页面,这个页面大家应该都熟悉:
然后到了这里我就碰到一个问题了,官方文档写的是登录成功之后首先会回传一个 code ,然后再拿 code 调接口换取 accessToken ,然后我试了很多次也换过2个账号发现每次都是直接返回了 accessToken ,帮我省了一步了,不知道是什么情况,郁闷。推荐阅读: 七个开源的 Spring Boot 前后端分离项目,一定要收藏!
现在假设我们都是直接拿到 accessToken(因为我暂时还没搞明白 QQ 为啥会直接返回,跟文档说的不一样),但是授权回调时 accessToken 会被放在 # 后面,URL 地址中的 hash 值好像不会被传到后台(貌似是这样,如有不正确欢迎评论指正),所以只能写一个下面这样的临时页面:
/** * QQ鉴权 * @param request * @param response * @throws Exception */ @RequestMapping("/authqq") public void authQQ(HttpServletRequest request, HttpServletResponse response) throws Exception { // QQ登录有点特殊,参数放在#后面,后台无法获取#后面的参数,只能用JS做中间转换 String html = "<!DOCTYPE html>" + "<html lang=/"zh-cn/">" + "<head>" + " <title>QQ登录重定向页</title>" + " <meta charset=/"utf-8/"/>" + "</head>" + "<body>" + " <script type=/"text/javascript/">" + " location.href = location.href.replace('#', '&').replace('auth_qq', 'auth_qq_redirect');" + " </script>" + "</body>" + "</html>"; response.getWriter().print(html); }
根据 accessToken 调接口获取用户的 openId ,特别注意这个 openId 是相对于 QQ 号+appId 唯一的,换句话说同一个 QQ 号登录 2 个不同 appId 时获取到的 openId 是不同的。顺便说一句,QQ 登录的相关接口做的还真够“随便”的,全部都是最简单的 get 请求,所以对接起来非常顺利。
直接看代码:
// 根据accessToken换取openId // 错误示例:callback( {"error":100016,"error_description":"access token check failed"} ); // 正确示例:callback( {"client_id":"10XXXXX49","openid":"CF2XXXXXXXX9F4C"} ); String result = HttpsUtil.get("https://graph.qq.com/oauth2.0/me?access_token=" + accessToken); Map<String, Object> resp = parseQQAuthResponse(result); // 这个方法就是把结果转Map Integer errorCode = (Integer)resp.get("error"); String errorMsg = (String)resp.get("error_description"); String openId = (String)resp.get("openid"); if(errorCode != null) return new ErrorResult(errorCode, "获取QQ用户openId失败:"+errorMsg);
// 获取用户昵称、头像等信息,{ret: 0, msg: '', nickname: '', ...} ret不为0表示失败 result = HttpsUtil.get("https://graph.qq.com/user/get_user_info?access_token="+accessToken+"&oauth_consumer_key="+appId+"&openid="+openId); resp = JsonUtil.parseJsonToMap(result); Integer ret = (Integer)resp.get("ret"); String msg = (String)resp.get("msg"); if(ret != 0) return new ErrorResult("获取用户QQ信息失败:"+msg); // 用户昵称可能存在4个字节的utf-8字符,MySQL默认不支持,直接插入会报错,所以过滤掉 String nickname = StringUtil.filterUtf8Mb4((String)resp.get("nickname")).trim(); // 这个方法可以自行百度 // figureurl_qq_2=QQ的100*100头像,figureurl_2=QQ 100&100空间头像,QQ头像不一定有,空间头像一定有 String avatar = (String)resp.get("figureurl_qq_2"); if(StringUtil.isBlank(avatar)) avatar = (String)resp.get("figureurl_2"); String gender = (String)resp.get("gender");
到了这一步基本上涉及第三方的就结束了,是不是很简单?后面无非就是如何插入数据库、如何保存 token 、写入 session 等。
有几点注意事项:
需要注意数据库中是否已经有改用户,没有的添加,有的修改,不要重复添加了;
QQ 昵称昵称有各种奇奇怪怪的字符,包括 emoji,MySQL 默认没有开启 utf8mb4,直接插入会报错,所以需要过滤掉;
需要做好对各种错误的兼容;
微信搜索江南一点雨,获取更多干货教程;
接口会同时返回QQ头像和空间头像,QQ头像不一定有,空间头像一定有;
回调地址必须和申请的域名一致,否则会报错。
QQ 互联有个特大的 bug,有时候显示已登录但是点击授权管理一直报错,此时只需要退出重新登录即可;
授权之后用户可能会在过期之前提前取消授权;
相关文档官网已经写得比较细了,http://wiki.connect.qq.com/
这个我就不具体讲了,登录 http://open.weibo.com/ 很容易找到相关入口,注册成为开发者,实名认证,一模一样的。
点击链接 http://open.weibo.com/apps/new?sort=web 创建 web 应用:
创建成果后完善相关信息,主要是下面这些:
我就不一一介绍了,都看得懂。
微博登录不需要网站一定要备案,但对网站本身有一定要求,不能弄一个空壳网站让人家去审核,肯定审核不通过的。推荐阅读: 40 篇原创干货,带你进入 Spring Boot 殿堂!
微博视觉素材(https://open.weibo.com/wiki/微博标识下载)下载在这里,页面合适位置放一个登录按钮:
function weiboLogin() { let weiboAppId = '432432'; let weiboAuthPath = 'http://www.test.com/authweibo'; openWindow(`https://api.weibo.com/oauth2/authorize?client_id=${weiboAppId}&response_type=code&redirect_uri=${encodeURIComponent(weiboAuthPath)}`); }
微博登录有一个好处,第一次登录需要授权,后面第二次登录时只会一闪而过自动就登录成功了,都不需要点一下,用户体验非常好,看下图:
登录成功会返回一个 code,根据 code 换取 accessToken:
String params = "client_id=" + appId + "&client_secret=" + appSecret + "&grant_type=authorization_code" + "&redirect_uri=" + URLUtil.encode(authPath) + "&code=" + code; // 用code换取accessToken String result = HttpsUtil.post("https://api.weibo.com/oauth2/access_token", params); Map<String, Object> resp = JsonUtil.toObject(result, new TypeReference<Map<String, Object>>(){}); Integer errorCode = (Integer)resp.get("error_code"); String error = (String)resp.get("error"); String errorMsg = (String)resp.get("error_description"); if(errorCode != null && errorCode != 0) return new ErrorResult(errorCode, error + (errorMsg==null?"":errorMsg)); String accessToken = (String)resp.get("access_token"); String uid = (String)resp.get("uid"); // 这个uid就是微博用户的唯一用户ID,可以通过这个id直接访问到用户微博主页 int expires = (Integer)resp.get("expires_in"); // 有效期,单位秒
// 用uid和accessToken换取用户信息 String result = HttpsUtil.get("https://api.weibo.com/2/users/show.json?access_token="+accessToken+"&uid="+uid); Map<String, Object> resp = JsonUtil.toObject(result, new TypeReference<Map<String, Object>>(){}); errorCode = (Integer)resp.get("error_code"); error = (String)resp.get("error"); errorMsg = (String)resp.get("error_description"); if(errorCode != null && errorCode != 0) return new ErrorResult(errorCode, error + (errorMsg==null?"":errorMsg)); String nickname = (String)resp.get("screen_name"); // 微博180*180高清头像 String avatar = (String)resp.get("avatar_large"); String gender = (String)resp.get("gender"); gender = "m".equals(gender) ? "男" : ("f".equals(gender) ? "女" : "");
至此涉及第三方的东西都完了,剩下的就是用户自己保存到数据库、写入 token 保存 session 以及鉴权接口开发了。
微博接口都有频率限制,不过一般不会超过;
需做好错误兼容;
微博直接返回的 uid,可以根据这个 uid 直达用户微博主页 https://weibo.com/u/xxxxx ,所以可以把用户头像链接到这里;
其实也有现成的 js-sdk,可以根据自己实际需要选择是否使用;
微博的接口是 https,并且是 post,需要注意;
1、 Spring Boot 整合 OAuth2,松哥手把手教你!
2、 一个小小的里程碑! 啥也不说了,签名书奉上!
3、 七个开源的 Spring Boot 前后端分离项目,一定要收藏!
4、 一键部署 Spring Boot 到远程 Docker 容器,就是这么秀!
5、 完结撒花!129 集 21 个小时,松哥自制的 Spring Boot2 系列视频教程杀青啦!
6、 40 篇原创干货,带你进入 Spring Boot 殿堂!
7、 Spring Boot 中的同一个 Bug,竟然把我坑了两次!
8、 Spring Boot 支持 Https 有那么难吗?
9、 一个野生程序员的自我修养
喜欢就点个 "在看" 呗^_^