spring-security进阶2---第三方登陆之QQ登陆1【获取QQ用户信息】

项目源码地址 https://github.com/nieandsun/security

1 开发流程简介

上篇文章spring-security进阶1—第三方登陆原理2【springsocial】介绍了springsocial开发第三方登陆的原理,在文中介绍到要想获取服务提供商(QQ等)的用户信息.

• 首先需要Connection类,它的作用是封装获取到的用户信息
• 获取Connection类,又需要ConnectionFactory类,它的作用就是创建Connection对象
• 获取ConnectionFactory,又需要ServiceProvider对象和ApiAdapter对象(ApiAdapter的作用为将获取的用户信息转换成本系统对应的信息)
• 获取ServiceProvider对象又需要 Oauth2Operation对象(封装了Oauth2协议的整个流程)和Api对象(真正用来获取服务提供商(QQ等)的用户信息)

也就是说,如果获得一个Connection对象,需要先有下面的这一系列的类.本篇文章及接下来几篇文章将从获取服务商用户对象开始来一步步的完成一个第三方登陆的开发流程.

---

2 QQ开发文档关于获取用户信息接口的介绍

(1)获取QQ用户信息需要请求如下url

(2)官网对上面三个请求参数的简介

由此可知

• openid可通过调用https://graph.qq.com/oauth2.0/me?access_token=YOUR_ACCESS_TOKEN 请求获得.

• 同时获取acces_token的详细方法可以通过点击官网中蓝色字体查看.

---

3 ServiceProvider对象的开发

ServiceProvider对象由Oauth2Operation(走OAuth2协议获取授权码,并利用授权码获取access token)和Api(真正用来获取服务提供商的用户信息)两个对象组成,所以开发ServiceProvider对象可以先从Oauth2Operation和Api两个对象入手.

3.1 Api对象开发

• 首先定义一个Api对象的接口

package com.nrsc.security.core.social.qq.api;

public interface QQ {
    QQUserInfo getUserInfo();
}

• 接下来写其实现类

package com.nrsc.security.core.social.qq.api;

import com.fasterxml.jackson.databind.ObjectMapper;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang.StringUtils;
import org.springframework.social.oauth2.AbstractOAuth2ApiBinding;
import org.springframework.social.oauth2.TokenStrategy;

/**
 * @author : Sun Chuan
 * @date : 2019/8/5 14:52
 * Description: 通过查看QQ互联官网可知，获取用户信息接口需要三个参数access_token,appid和openid
 */

/**
 * 继承AbstractOAuth2ApiBinding,该类提供了一些帮我们快速获取服务提供商信息的方法和属性
 * 里面包含accessToken属性
 * 注意accessToken在这里是一个类变量,但是每个用户每次第三方登陆都应该获取一个新的值,
 * 因此QQImpl应该是一个多例的,不能用@Component及其相关的注解
 */
@Slf4j
public class QQImpl extends AbstractOAuth2ApiBinding implements QQ {
    private ObjectMapper objectMapper = new ObjectMapper();
    /**
     * 获取openid的url, opendid与QQ号一一对应
     */
    private static final String URL_GET_OPENID = "https://graph.qq.com/oauth2.0/me?access_token=%s";

    /**
     * 获取用户信息的url
     * 实际url中还包括参数access_token,但我们不需要管,因为AbstractOAuth2ApiBinding会帮我们加上
     */
    private static final String URL_GET_USERINFO =
            "https://graph.qq.com/user/get_user_info?oauth_consumer_key=%s&openid=%s";

    /**
     * 本项目(就是我们的项目)如想用QQ作为第三方登陆,需在QQ官方进行注册,
     * 注册后QQ会利用两个东西来认定是我们的项目
     * 一个是appId--------------相当于本项目在QQ的用户名
     * 另一个是appSecret--------相当于本项目在QQ的密码
     */
    private String appId;
    /**
     * 用户的id与QQ号一一对应,可以通过请求获得
     */
    private String openId;

    /**
     * @param accessToken 走完OAuth2协议的5步后获得
     * @param appId       配置在我们的配置文件里
     */
    public QQImpl(String accessToken, String appId) {
        //在利用restTemplate发起请求时默认将access_token作为请求参数
        super(accessToken, TokenStrategy.ACCESS_TOKEN_PARAMETER);
        this.appId = appId;
        String url = String.format(URL_GET_OPENID, accessToken);

        //至于下面的请求为什么还要传入accessToken,或者是不是可以不传,我会回过头来再来探索
        String result = getRestTemplate().getForObject(url, String.class);
        log.info(" 调用OpenAPI接口,获取到的数据为:{}", result);

        /**
         * openid的返回参数结构为:
         * callback( {"client_id":"YOUR_APPID","openid":"YOUR_OPENID"} );
         * 所以可以按照如下的方式获取到openid
         */
        this.openId = StringUtils.substringBetween(result, "\"openid\":\"", "\"}");
    }

    /**
     * @return
     */
    @Override
    public QQUserInfo getUserInfo() {
        String url = String.format(URL_GET_USERINFO, appId, openId);
        //不用管access_token,父类AbstractOAuth2ApiBinding会自动将其挂上作为请求参数
        String result = getRestTemplate().getForObject(url, String.class);
        log.info("调用获取用户信息接口,获得的数据为:{}", result);

        QQUserInfo userInfo = null;
        try {
            userInfo = objectMapper.readValue(result, QQUserInfo.class);
            userInfo.setOpenId(openId);
            return userInfo;
        } catch (Exception e) {
            throw new RuntimeException("获取用户信息失败", e);
        }
    }
}

• QQUserInfo根据QQ互联开发文档中公布的用户信息而来,可直接从github下载源码查看

---

3.2 利用Api和Oauth2Operation对象组装ServiceProvider

package com.nrsc.security.core.social.qq.connect;

import com.nrsc.security.core.social.qq.api.QQ;
import com.nrsc.security.core.social.qq.api.QQImpl;
import org.springframework.social.oauth2.AbstractOAuth2ServiceProvider;
import org.springframework.social.oauth2.OAuth2Template;

/**
 * @author : Sun Chuan
 * @date : 2019/8/5 23:47
 * Description：利用利用Api和Oauth2Operation对象组装ServiceProvider对象
 */
public class QQServiceProvider extends AbstractOAuth2ServiceProvider<QQ> {

    private String appId;

    /**
     * 对应于OAuth2协议第一步,即将用户导向QQ认证授权页面的url
     */
    private static final String URL_AUTHORIZE = "https://graph.qq.com/oauth2.0/authorize";
    /**
     * 对应于Oauth2协议中拿着授权码获取Access Token这一步的url
     */
    private static final String URL_ACCESS_TOKEN = "https://graph.qq.com/oauth2.0/token";

    /**
     * 必须要有一个构造,否则会报错
     *
     * @param appId
     * @param appSecret
     */
    public QQServiceProvider(String appId, String appSecret) {
        /**
         * 先利用springsocial提供的OAuth2Operation实现类-->OAuth2Template走OAuth2协议的步骤(但有一点问题)
         */
        super(new OAuth2Template(appId, appSecret, URL_AUTHORIZE, URL_ACCESS_TOKEN));
        this.appId = appId;
    }

    @Override
    public QQ getApi(String accessToken) {
        return new QQImpl(accessToken, appId);
    }
}