SpringBoot网站添加第三方登录之GitHub登录

avatar 2018年05月16日18:22:38 6 7039 views
博主分享免费Java教学视频，B站账号：Java刘哥 ，长期提供技术问题解决、项目定制：本站商品点此
接着上一篇文章SpringBoot网站添加第三方登录之QQ登录，本文介绍第三方登录之 GitHub。

GitHub 授权相对比较简单，因为无需审核，分分钟搞定。


一、创建应用


1、登录 github 后台，创建应用

地址：https://github.com/settings/developers

或者在个人设置里，点最下面那个开发者设置







进去后，创建一个应用。如图，我已经创建了一个应用



查看应用，可以看到应用的id和密码



这里没什么好说的，跟 QQ 登录类似



2、授权的基本原理

可以参考官方文档

1）根据 GitHub 登录链接可以回调获得 code

2）根据Client ID 、Client Secret 和 code 可获得 token

3）根据 token 获得 用户信息





其中 id 是一个唯一的值，比如上面的 25662729



3、几个必要的URL

参考官方文档

1）登录页面授权 URL：

https://github.com/login/oauth/authorize?client_id=%s&redirect_uri=%s&state=%s



2）获得 Token 的 URL：

https://github.com/login/oauth/access_token?client_id=%s&client_secret=%s&code=%s&redirect_uri=%s&state=%s





3）获得用户信息的 URL：



https://api.github.com/user?access_token=%s


二、基本准备


1、数据库设计



直接看图片





2、放置 Github 登录按钮

这里有两种常用的方式

① 弹小窗
  1. <script>
  2.     function openWin(url,name,iWidth,iHeight) {
  3.         //获得窗口的垂直位置
  4.         var iTop = (window.screen.availHeight - 30 - iHeight) / 2;
  5.         //获得窗口的水平位置
  6.         var iLeft = (window.screen.availWidth - 10 - iWidth) / 2;
  7.         window.open(url, name, 'height=' + iHeight + ',innerHeight=' + iHeight + ',width=' + iWidth + ',innerWidth=' + iWidth + ',top=' + iTop + ',left=' + iLeft + ',status=no,toolbar=no,menubar=no,location=no,resizable=no,scrollbars=0,titlebar=no');
  8.     }
  9.     function qqLogin() {
  10.         var url = "https://github.com/login/oauth/authorize?client_id=96bb0592e6b3b8f2fb90&redirect_uri=http://codergroup.cn/oauth/github/callback&state=LiuYanzhaoLoveLuoQiNeverGiveUp";
  11.         openWin(url,"qqLogin",650,500);
  12.     }
  13. </script>
  14. <a  href="javascript:void(0);" onclick="qqLogin()"></a>



② 在新窗口打开
  1. <a href="https://github.com/login/oauth/authorize?client_id=96bb0511e6b3b8f2fb90&redirect_uri=http://codergroup.cn/oauth/github/callback&state=use-login" target="_blank"></a>



点击链接后，跳到授权页面




三、具体代码


参考上一篇文章的 QQ 登录

1、由于做了多个登录，所以代码做了一定程度的封装，大致如下：
  1. package com.liuyanzhao.sens.service;
  3. import com.liuyanzhao.sens.model.dto.BindUserDTO;
  4. import com.liuyanzhao.sens.model.dto.JsonResult;
  5. import com.liuyanzhao.sens.utils.Response;
  7. import java.io.UnsupportedEncodingException;
  9. /**
  10.  * @author 言曌
  11.  * @date 2019/1/20 上午10:24
  12.  */
  14. public interface AuthService {
  16.     /**
  17.      * 根据code获得Token
  18.      *
  19.      * @param code code
  20.      * @return token
  21.      */
  22.     Response<String> getAccessToken(String code);
  24.     /**
  25.      * 根据Token获得OpenId
  26.      *
  27.      * @param accessToken Token
  28.      * @return openId
  29.      */
  30.     Response<String> getOpenId(String accessToken);
  32.     /**
  33.      * 刷新Token
  34.      *
  35.      * @param code code
  36.      * @return 新的token
  37.      */
  38.     Response<String> refreshToken(String code);
  40.     /**
  41.      * 拼接授权URL
  42.      *
  43.      * @return URL
  44.      */
  45.     Response<String> getAuthorizationUrl();
  47.     /**
  48.      * 根据Token和OpenId获得用户信息
  49.      *
  50.      * @param accessToken Token
  51.      * @param openId openId
  52.      * @return 第三方应用给的用户信息
  53.      */
  54.     Response<BindUserDTO> getUserInfo(String accessToken, String openId);
  55. }



2、由于全部是自己封装的，所以http请求的代码也是所有的登录共用的，这里统一放放到了类DefaultAuthServiceImpl中，代码如下：
  1. package com.liuyanzhao.sens.service.impl;
  3. import com.liuyanzhao.sens.service.AuthService;
  4. import org.springframework.http.client.SimpleClientHttpRequestFactory;
  5. import org.springframework.http.converter.ByteArrayHttpMessageConverter;
  6. import org.springframework.http.converter.HttpMessageConverter;
  7. import org.springframework.http.converter.ResourceHttpMessageConverter;
  8. import org.springframework.http.converter.StringHttpMessageConverter;
  9. import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;
  10. import org.springframework.http.converter.support.AllEncompassingFormHttpMessageConverter;
  11. import org.springframework.http.converter.xml.SourceHttpMessageConverter;
  12. import org.springframework.web.client.RestTemplate;
  14. import javax.xml.transform.Source;
  15. import java.nio.charset.StandardCharsets;
  16. import java.util.LinkedList;
  17. import java.util.List;
  19. /**
  20.  * @author 言曌
  21.  * @date 2018/5/9 下午3:02
  22.  */
  24. public abstract class DefaultAuthServiceImpl implements AuthService {
  25.     public static RestTemplate getRestTemplate() {// 手动添加
  26.         SimpleClientHttpRequestFactory requestFactory=new SimpleClientHttpRequestFactory();
  27.         requestFactory.setReadTimeout(120000);
  28.         List<HttpMessageConverter<?>> messageConverters = new LinkedList<>();
  29.         messageConverters.add(new ByteArrayHttpMessageConverter());
  30.         messageConverters.add(new StringHttpMessageConverter(StandardCharsets.UTF_8));
  31.         messageConverters.add(new ResourceHttpMessageConverter());
  32.         messageConverters.add(new SourceHttpMessageConverter<Source>());
  33.         messageConverters.add(new AllEncompassingFormHttpMessageConverter());
  34.         messageConverters.add(new MappingJackson2HttpMessageConverter());
  35.         RestTemplate restTemplate=new RestTemplate(messageConverters);
  36.         restTemplate.setRequestFactory(requestFactory);
  37.         return restTemplate;
  38.     }
  39. }

由此，所有的登录Service只需要继承AuthService即可。



3、GithubAuthService.java
  1. package com.liuyanzhao.sens.service;
  3. /**
  4.  * @author 言曌
  5.  * @date 2018/5/15 下午11:28
  6.  */
  8. public interface GithubAuthService extends AuthService {
  9. }



4、GithubAuthServiceImpl.java
  1. package com.liuyanzhao.sens.service.impl;
  3. import com.alibaba.fastjson.JSONObject;
  4. import com.liuyanzhao.sens.model.dto.BindUserDTO;
  5. import com.liuyanzhao.sens.service.GithubAuthService;
  6. import com.liuyanzhao.sens.utils.Response;
  7. import lombok.extern.slf4j.Slf4j;
  8. import org.springframework.stereotype.Service;
  9. import org.springframework.web.util.UriComponentsBuilder;
  11. import java.net.URI;
  12. import java.util.HashMap;
  13. import java.util.Map;
  15. /**
  16.  * @author 言曌
  17.  * @date 2018/5/15 下午11:31
  18.  */
  19. @Service
  20. @Slf4j
  21. public class GithubAuthServiceImpl extends DefaultAuthServiceImpl implements GithubAuthService {
  23.     private static final String AUTHORIZE_URL = "https://github.com/login/oauth/authorize?client_id=%s&redirect_uri=%s&state=%s";
  25.     private static final String ACCESS_TOKEN_URL = "https://github.com/login/oauth/access_token?client_id=%s&client_secret=%s&code=%s&redirect_uri=%s&state=%s";
  27.     private static final String USER_INFO_URL = "https://api.github.com/user?access_token=%s";
  29.     // 下面的属性可以通过配置读取
  30.     private static final String CALLBACK_URL = "http://localhost:8080/oauth/github/callback";//回调地址
  32.     private static final String API_KEY = "11111111111111111";//Client ID
  34.     private static final String API_SECRET = "1111111111111111111111111111111";//Client Secret
  36.     private static final String GITHUB_STATE = "use-login";//state，随便填，会返回原值给你
  38.     //此处是获取key-value类型的参数
  39.     private Map<String, String> getParam(String string) {
  40.         Map<String, String> map = new HashMap();
  41.         String[] kvArray = string.split("&");
  42.         for (int i = 0; i < kvArray.length; i++) {
  43.             String[] kv = kvArray[i].split("=");
  44.             if (kv.length == 2) {
  45.                 map.put(kv[0], kv[1]);
  46.             } else if (kv.length == 1) {
  47.                 map.put(kv[0], "");
  48.             }
  49.         }
  50.         return map;
  51.     }
  53.     @Override
  54.     public Response<String> getAccessToken(String code) {
  55.         String url = String.format(ACCESS_TOKEN_URL, API_KEY, API_SECRET, code, CALLBACK_URL, GITHUB_STATE);
  56.         UriComponentsBuilder builder = UriComponentsBuilder.fromHttpUrl(url);
  57.         URI uri = builder.build().encode().toUri();
  58.         String resp;
  59.         try {
  60.             resp = getRestTemplate().getForObject(uri, String.class);
  61.         } catch (Exception e) {
  62.             log.error("Github获得access_token失败，code不正确或者已过期, cause:{}", e);
  63.             return Response.no("code无效");
  64.         }
  65.         if (resp != null && resp.contains("access_token")) {
  66.             Map<String, String> map = getParam(resp);
  67.             String access_token = map.get("access_token");
  68.             return Response.yes(access_token);
  69.         }
  70.         log.error("GitHub登录失败，code不正确或者已过期：");
  71.         return Response.no("code无效");
  72.     }
  74.     @Override
  75.     public Response<String> getOpenId(String accessToken) {
  76.         String url = String.format(USER_INFO_URL, accessToken);
  77.         UriComponentsBuilder builder = UriComponentsBuilder.fromHttpUrl(url);
  78.         URI uri = builder.build().encode().toUri();
  79.         String resp;
  80.         try {
  81.             resp = getRestTemplate().getForObject(uri, String.class);
  82.         } catch (Exception e) {
  83.             log.error("GitHub获得OpenId失败，access_token无效, cause:{}", e);
  84.             return Response.no("access_token无效！");
  85.         }
  86.         if (resp != null && resp.contains("id")) {
  87.             JSONObject data = JSONObject.parseObject(resp);
  88.             String openid = data.getString("id");
  89.             return Response.yes(openid);
  90.         }
  91.         return Response.no("access_token无效！");
  92.     }
  94.     @Override
  95.     public Response<String> refreshToken(String code) {
  96.         return null;
  97.     }
  99.     @Override
  100.     public Response<String> getAuthorizationUrl() {
  101.         String url = String.format(AUTHORIZE_URL, API_KEY, CALLBACK_URL, GITHUB_STATE);
  102.         return Response.yes(url);
  103.     }
  105.     @Override
  106.     public Response<BindUserDTO> getUserInfo(String accessToken, String openId) {
  108.         String url = String.format(USER_INFO_URL, accessToken);
  109.         UriComponentsBuilder builder = UriComponentsBuilder.fromHttpUrl(url);
  110.         URI uri = builder.build().encode().toUri();
  111.         String resp;
  112.         try {
  113.             resp = getRestTemplate().getForObject(uri, String.class);
  114.         } catch (Exception e) {
  115.             log.error("GitHub获得用户信息失败，access_token无效, cause:{}", e);
  116.             return Response.no("access_token无效！");
  117.         }
  118.         if (resp != null && resp.contains("id")) {
  119.             JSONObject data = JSONObject.parseObject(resp);
  120.             BindUserDTO result = new BindUserDTO();
  121.             result.setOpenId(data.getString("id"));
  122.             result.setAvatar(data.getString("avatar_url"));
  123.             result.setNickname(data.getString("name"));
  124.             return Response.yes(result);
  125.         }
  126.         return Response.no("access_token无效！");
  127.     }
  128. }



5、Controller，根据项目不同，自己修改

这里把qq登录和github登录，未登录之前绑定，登录后再后台绑定融合到了一起。
  1. package com.liuyanzhao.sens.web.controller.front;
  3. import cn.hutool.core.date.DateUtil;
  4. import cn.hutool.extra.servlet.ServletUtil;
  5. import com.liuyanzhao.sens.entity.Log;
  6. import com.liuyanzhao.sens.entity.ThirdAppBind;
  7. import com.liuyanzhao.sens.entity.User;
  8. import com.liuyanzhao.sens.model.dto.LogsRecord;
  9. import com.liuyanzhao.sens.model.dto.SensConst;
  10. import com.liuyanzhao.sens.model.enums.BindTypeEnum;
  11. import com.liuyanzhao.sens.service.*;
  12. import com.liuyanzhao.sens.utils.Response;
  13. import lombok.extern.slf4j.Slf4j;
  14. import org.springframework.beans.factory.annotation.Autowired;
  15. import org.springframework.stereotype.Controller;
  16. import org.springframework.web.bind.annotation.GetMapping;
  17. import org.springframework.web.bind.annotation.RequestParam;
  19. import javax.servlet.http.HttpServletRequest;
  22. /**
  23.  * @author 言曌
  24.  * @date 2018/5/9 下午2:59
  25.  */
  26. @Controller
  27. @Slf4j
  28. public class AuthController {
  30.     @Autowired
  31.     private GithubAuthService githubAuthService;
  33.     @Autowired
  34.     private UserService userService;
  36.     @Autowired
  37.     private ThirdAppBindService thirdAppBindService;
  39.     @Autowired
  40.     private LogService logService;
  42.     /**
  43.      * 第三方授权后会回调此方法，并将code传过来
  44.      *
  45.      * @param code code
  46.      * @return
  47.      */
  48.     @GetMapping("/oauth/github/callback")
  49.     public String oauthByGitHub(@RequestParam(value = "code") String code,
  50.                                 HttpServletRequest request) {
  51.         Response<String> tokenResponse = githubAuthService.getAccessToken(code);
  52.         if (tokenResponse.isSuccess()) {
  53.             Response<String> openidResponse = githubAuthService.getOpenId(tokenResponse.getData());
  54.             if (openidResponse.isSuccess()) {
  55.                 //根据openId去找关联的用户
  56.                 ThirdAppBind bind = thirdAppBindService.findByAppTypeAndOpenId(BindTypeEnum.GITHUB.getValue(), openidResponse.getData());
  57.                 if (bind != null && bind.getUserId() != null) {
  58.                     //执行Login操作
  59.                     User user = userService.findByUserId(bind.getUserId());
  60.                     if (user != null) {
  61.                         request.getSession().setAttribute(SensConst.USER_SESSION_KEY, user);
  62.                         logService.saveByLog(new Log(LogsRecord.LOGIN, LogsRecord.LOGIN_SUCCESS+"(GitHub登录)", ServletUtil.getClientIP(request), DateUtil.date()));
  63.                         log.info("用户[{}]登录成功(登录)。", user.getUserDisplayName());
  64.                         return "redirect:/admin";
  65.                     }
  66.                 }
  67.             }
  68.         }
  69.         return "redirect:/admin/login";
  70.     }
  72. }











历史上的今天
五月
16日
  • 微信
  • 交流学习，资料分享
  • weinxin
  • 个人淘宝
  • 店铺名：言曌博客咨询部

  • (部分商品未及时上架淘宝)
avatar

发表评论

avatar 登录者：匿名
匿名评论，评论回复后会有邮件通知

  

已通过评论：0   待审核评论数：0