使用SpringSocial開發微信登錄

⒈編寫微信用戶對應的數據結構

package cn.coreqi.social.weixin.entities;

/**
 * 微信用戶實體類
 */
public class WeixinUserInfo {
    /**
     * 普通用戶的標識，對當前開發者賬號唯一
     */
    private String openid;
    /**
     * 普通用戶昵稱
     */
    private String nickname;

    /**
     * 語言
     */
    private String language;

    /**
     * 普通用戶性別，1為男性，2為女性
     */
    private String sex;
    /**
     * 普通用戶個人資料填寫的省份
     */
    private String province;
    /**
     * 普通用戶個人資料填寫的城市
     */
    private String city;
    /**
     * 國家，如中國為CN
     */
    private String country;
    /**
     * 用戶頭像，最后一個數值代表正方形頭像大小（有0，46，64，96，132數值可選，0代表640*640正方形）
     */
    private String headimgurl;
    /**
     * 用戶特權信息，json數組，如微信沃卡用戶為（chinaunicom）
     */
    private String[] privilege;
    /**
     * 用戶統一標識，針對一個微信開放平台賬號下的應用，同一用戶的unionid是唯一的。
     */
    private String unionid;


    public String getOpenid() {
        return openid;
    }

    public void setOpenid(String openid) {
        this.openid = openid;
    }

    public String getNickname() {
        return nickname;
    }

    public void setNickname(String nickname) {
        this.nickname = nickname;
    }

    public String getLanguage() {
        return language;
    }

    public void setLanguage(String language) {
        this.language = language;
    }

    public String getSex() {
        return sex;
    }

    public void setSex(String sex) {
        this.sex = sex;
    }

    public String getProvince() {
        return province;
    }

    public void setProvince(String province) {
        this.province = province;
    }

    public String getCity() {
        return city;
    }

    public void setCity(String city) {
        this.city = city;
    }

    public String getCountry() {
        return country;
    }

    public void setCountry(String country) {
        this.country = country;
    }

    public String getHeadimgurl() {
        return headimgurl;
    }

    public void setHeadimgurl(String headimgurl) {
        this.headimgurl = headimgurl;
    }

    public String[] getPrivilege() {
        return privilege;
    }

    public void setPrivilege(String[] privilege) {
        this.privilege = privilege;
    }

    public String getUnionid() {
        return unionid;
    }

    public void setUnionid(String unionid) {
        this.unionid = unionid;
    }
}

⒉編寫一個微信API接口用於獲取微信用戶信息

package cn.coreqi.social.weixin.api;


import cn.coreqi.social.weixin.entities.WeixinUserInfo;

/**
 * 微信API調用接口
 */
public interface Weixin {

    /**
     * 獲取微信用戶信息
     * @param openId
     * @return
     */
    WeixinUserInfo getUserInfo(String openId);
}

⒊編寫一個微信API接口實現

package cn.coreqi.social.weixin.api.impl;

import cn.coreqi.social.weixin.api.Weixin;
import cn.coreqi.social.weixin.entities.WeixinUserInfo;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.commons.lang.StringUtils;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.converter.StringHttpMessageConverter;
import org.springframework.social.oauth2.AbstractOAuth2ApiBinding;
import org.springframework.social.oauth2.TokenStrategy;

import java.nio.charset.Charset;
import java.util.List;

/**
 * 微信API調用模板，scope為Request的SpringBean，根據當前用戶的accessToken創建。
 */
public class WeixinImpl extends AbstractOAuth2ApiBinding implements Weixin {

    /**
     * 用於序列化Json數據
     */
    private ObjectMapper objectMapper = new ObjectMapper();

    /**
     * 獲取用戶信息url
     */
    private static final String URL_GET_USER_INFO="https://api.weixin.qq.com/sns/userinfo?openid=";

    /**
     * WeixinImpl構造器
     * @param accessToken
     */
    public WeixinImpl(String accessToken){
        super(accessToken, TokenStrategy.ACCESS_TOKEN_PARAMETER);
    }

    /**
     * 默認注冊的HttpMessageConverter字符集為ISO-8859-1,而微信返回的是UTF-8,因此必須覆蓋原來的方法
     * @return
     */
    @Override
    protected List<HttpMessageConverter<?>> getMessageConverters() {
        List<HttpMessageConverter<?>> messageConverters = super.getMessageConverters();
        messageConverters.remove(0);    //刪除StringHttpMessageConverter
        messageConverters.add(new StringHttpMessageConverter(Charset.forName("UTF-8")));
        return messageConverters;
    }

    /**
     * 獲取微信用戶信息
     * @param openId
     * @return
     */
    @Override
    public WeixinUserInfo getUserInfo(String openId) {
        String url = URL_GET_USER_INFO + openId;
        String response = getRestTemplate().getForObject(url,String.class);
        if(StringUtils.contains(response,"errcode")){   //如果響應中存在錯誤碼則返回null
            return null;
        }
        WeixinUserInfo userInfo = null;
        try {
            userInfo = objectMapper.readValue(response,WeixinUserInfo.class);
        }catch (Exception e){

        }
        return userInfo;
    }
}

⒋編寫微信access_token類

package cn.coreqi.social.weixin.connect;

import org.springframework.social.oauth2.AccessGrant;

/**
 * 對微信access_token信息的封裝
 * 與標准的OAuth2協議不同，微信在獲取access_token時會同時返回openId，並沒有單獨的通過accessToke換取openId的服務
 * 在此處繼承標准AccessGrant（Spring提供的令牌封裝類），添加openId字段
 */
public class WeixinAccessGrant extends AccessGrant {

    private String openId;

    public WeixinAccessGrant() {
        super("");
    }
    public WeixinAccessGrant(String accessToken, String scope, String refreshToken, Long expiresIn) {
        super(accessToken, scope, refreshToken, expiresIn);
    }

    public String getOpenId() {
        return openId;
    }

    public void setOpenId(String openId) {
        this.openId = openId;
    }
}

⒌編寫微信OAuth2認證流程模板類。

package cn.coreqi.social.weixin.connect;

import java.nio.charset.Charset;
import java.util.Map;
import org.apache.commons.collections4.MapUtils;
import org.apache.commons.lang.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.http.converter.StringHttpMessageConverter;
import org.springframework.social.oauth2.AccessGrant;
import org.springframework.social.oauth2.OAuth2Parameters;
import org.springframework.social.oauth2.OAuth2Template;
import org.springframework.util.MultiValueMap;
import org.springframework.web.client.RestTemplate;
import com.fasterxml.jackson.databind.ObjectMapper;

/**
 * 完成微信的OAuth2認證流程的模板類。
 * 國內廠商實現的OAuth2方式不同, Spring默認提供的OAuth2Template無法完整適配，只能針對每個廠商調整。
 */
public class WeixinOAuth2Template extends OAuth2Template {

    private Logger logger = LoggerFactory.getLogger(getClass());

    private String clientId;

    private String clientSecret;

    private String accessTokenUrl;

    private static final String REFRESH_TOKEN_URL = "https://api.weixin.qq.com/sns/oauth2/refresh_token";

    public WeixinOAuth2Template(String clientId, String clientSecret, String authorizeUrl, String accessTokenUrl) {
        super(clientId, clientSecret, authorizeUrl, accessTokenUrl);
        setUseParametersForClientAuthentication(true);  //請求中添加client_id和client_secret參數
        this.clientId = clientId;
        this.clientSecret = clientSecret;
        this.accessTokenUrl = accessTokenUrl;
    }

    /**
     * 微信變更了OAuth請求參數的名稱，我們覆寫相應的方法按照微信的文檔改為微信請求參數的名字。
     * @param authorizationCode
     * @param redirectUri
     * @param parameters
     * @return
     */
    @Override
    public AccessGrant exchangeForAccess(String authorizationCode, String redirectUri,
                                         MultiValueMap<String, String> parameters) {

        StringBuilder accessTokenRequestUrl = new StringBuilder(accessTokenUrl);

        accessTokenRequestUrl.append("?appid="+clientId);
        accessTokenRequestUrl.append("&secret="+clientSecret);
        accessTokenRequestUrl.append("&code="+authorizationCode);
        accessTokenRequestUrl.append("&grant_type=authorization_code");
        accessTokenRequestUrl.append("&redirect_uri="+redirectUri);

        return getAccessToken(accessTokenRequestUrl);
    }

    /**
     * 微信變更了OAuth請求參數的名稱，我們覆寫相應的方法按照微信的文檔改為微信請求參數的名字。
     * @param refreshToken
     * @param additionalParameters
     * @return
     */
    public AccessGrant refreshAccess(String refreshToken, MultiValueMap<String, String> additionalParameters) {

        StringBuilder refreshTokenUrl = new StringBuilder(REFRESH_TOKEN_URL);

        refreshTokenUrl.append("?appid="+clientId);
        refreshTokenUrl.append("&grant_type=refresh_token");
        refreshTokenUrl.append("&refresh_token="+refreshToken);

        return getAccessToken(refreshTokenUrl);
    }

    /**
     * 獲取微信access_token信息
     * @param accessTokenRequestUrl
     * @return
     */
    @SuppressWarnings("unchecked")
    private AccessGrant getAccessToken(StringBuilder accessTokenRequestUrl) {

        logger.info("獲取access_token, 請求URL: "+accessTokenRequestUrl.toString());

        String response = getRestTemplate().getForObject(accessTokenRequestUrl.toString(), String.class);

        logger.info("獲取access_token, 響應內容: "+response);

        Map<String, Object> result = null;
        try {
            result = new ObjectMapper().readValue(response, Map.class);
        } catch (Exception e) {
            e.printStackTrace();
        }

        //返回錯誤碼時直接返回空
        if(StringUtils.isNotBlank(MapUtils.getString(result, "errcode"))){
            String errcode = MapUtils.getString(result, "errcode");
            String errmsg = MapUtils.getString(result, "errmsg");
            throw new RuntimeException("獲取access token失敗, errcode:"+errcode+", errmsg:"+errmsg);
        }

        WeixinAccessGrant accessToken = new WeixinAccessGrant(
                MapUtils.getString(result, "access_token"),
                MapUtils.getString(result, "scope"),
                MapUtils.getString(result, "refresh_token"),
                MapUtils.getLong(result, "expires_in"));

        accessToken.setOpenId(MapUtils.getString(result, "openid"));

        return accessToken;
    }

    /**
     * 構建獲取授權碼的請求。也就是引導用戶跳轉到微信的地址。
     */
    public String buildAuthenticateUrl(OAuth2Parameters parameters) {
        String url = super.buildAuthenticateUrl(parameters);
        url = url + "&appid="+clientId+"&scope=snsapi_login";
        return url;
    }

    public String buildAuthorizeUrl(OAuth2Parameters parameters) {
        return buildAuthenticateUrl(parameters);
    }

    /**
     * 微信返回的contentType是html/text，添加相應的HttpMessageConverter來處理。
     */
    protected RestTemplate createRestTemplate() {
        RestTemplate restTemplate = super.createRestTemplate();
        restTemplate.getMessageConverters().add(new StringHttpMessageConverter(Charset.forName("UTF-8")));
        return restTemplate;
    }

}

⒍編寫微信API適配器，將從微信API拿到的用戶數據模型轉換為Spring Social的標准用戶數據模型。

package cn.coreqi.social.weixin.connect;

import cn.coreqi.social.weixin.api.Weixin;
import cn.coreqi.social.weixin.entities.WeixinUserInfo;
import org.springframework.social.connect.ApiAdapter;
import org.springframework.social.connect.ConnectionValues;
import org.springframework.social.connect.UserProfile;

/**
 * 微信API適配器，將從微信API拿到的用戶數據模型轉換為Spring Social的標准用戶數據模型。
 * @author fanqi 
 */
public class WeixinAdapter implements ApiAdapter<Weixin> {

    private String openId;

    public WeixinAdapter() {}

    public WeixinAdapter(String openId){
        this.openId = openId;
    }

    /**
     * 用來測試當前的API是否可用
     * @param api
     * @return
     */
    @Override
    public boolean test(Weixin api) {
        return true;
    }

    /**
     * 將微信的用戶信息映射到ConnectionValues標准的數據化結構上
     * @param api
     * @param values
     */
    @Override
    public void setConnectionValues(Weixin api, ConnectionValues values) {
        WeixinUserInfo profile = api.getUserInfo(openId);
        values.setProviderUserId(profile.getOpenid());
        values.setDisplayName(profile.getNickname());
        values.setImageUrl(profile.getHeadimgurl());
    }

    /**
     *
     * @param api
     * @return
     */
    @Override
    public UserProfile fetchUserProfile(Weixin api) {
        return null;
    }

    /**
     *
     * @param api
     * @param message
     */
    @Override
    public void updateStatus(Weixin api, String message) {
        //do nothing
    }

}

⒎編寫微信的OAuth2流程處理器的提供器

package cn.coreqi.social.weixin.connect;

import cn.coreqi.social.weixin.api.Weixin;
import cn.coreqi.social.weixin.api.impl.WeixinImpl;
import org.springframework.social.oauth2.AbstractOAuth2ServiceProvider;

/**
 * 微信的OAuth2流程處理器的提供器，供spring social的connect體系調用
 */
public class WeixinServiceProvider extends AbstractOAuth2ServiceProvider<Weixin> {

    /**
     * 微信獲取授權碼的url
     */
    private static final String URL_AUTHORIZE = "https://open.weixin.qq.com/connect/qrconnect";
    /**
     * 微信獲取accessToken的url
     */
    private static final String URL_ACCESS_TOKEN = "https://api.weixin.qq.com/sns/oauth2/access_token";

    /**
     * 
     * @param appId
     * @param appSecret
     */
    public WeixinServiceProvider(String appId, String appSecret) {
        super(new WeixinOAuth2Template(appId, appSecret,URL_AUTHORIZE,URL_ACCESS_TOKEN));
    }

    /**
     * 
     * @param accessToken
     * @return
     */
    @Override
    public Weixin getApi(String accessToken) {
        return new WeixinImpl(accessToken);
    }

}

⒏創建微信連接工廠

package cn.coreqi.social.weixin.connect;

import cn.coreqi.social.weixin.api.Weixin;
import org.springframework.social.connect.ApiAdapter;
import org.springframework.social.connect.Connection;
import org.springframework.social.connect.ConnectionData;
import org.springframework.social.connect.support.OAuth2Connection;
import org.springframework.social.connect.support.OAuth2ConnectionFactory;
import org.springframework.social.oauth2.AccessGrant;
import org.springframework.social.oauth2.OAuth2ServiceProvider;

/**
 * 微信連接工廠
 */
public class WeixinConnectionFactory extends OAuth2ConnectionFactory<Weixin> {

    /**
     *
     * @param providerId
     * @param appId
     * @param appSecret
     */
    public WeixinConnectionFactory(String providerId, String appId, String appSecret) {
        super(providerId, new WeixinServiceProvider(appId, appSecret), new WeixinAdapter());
    }

    /**
     * 由於微信的openId是和accessToken一起返回的，所以在這里直接根據accessToken設置providerUserId即可，不用像QQ那樣通過QQAdapter來獲取
     * @param accessGrant
     * @return
     */
    @Override
    protected String extractProviderUserId(AccessGrant accessGrant) {
        if(accessGrant instanceof WeixinAccessGrant) {
            return ((WeixinAccessGrant)accessGrant).getOpenId();
        }
        return null;
    }

    /**
     *
     * @param accessGrant
     * @return
     */
    public Connection<Weixin> createConnection(AccessGrant accessGrant) {
        return new OAuth2Connection<Weixin>(getProviderId(), extractProviderUserId(accessGrant), accessGrant.getAccessToken(),
                accessGrant.getRefreshToken(), accessGrant.getExpireTime(), getOAuth2ServiceProvider(), getApiAdapter(extractProviderUserId(accessGrant)));
    }

    /**
     *
     * @param data
     * @return
     */
    public Connection<Weixin> createConnection(ConnectionData data) {
        return new OAuth2Connection<Weixin>(data, getOAuth2ServiceProvider(), getApiAdapter(data.getProviderUserId()));
    }

    /**
     *
     * @param providerUserId
     * @return
     */
    private ApiAdapter<Weixin> getApiAdapter(String providerUserId) {
        return new WeixinAdapter(providerUserId);
    }

    /**
     *
     * @return
     */
    private OAuth2ServiceProvider<Weixin> getOAuth2ServiceProvider() {
        return (OAuth2ServiceProvider<Weixin>) getServiceProvider();
    }


}

⒐創建微信登陸配置類

package cn.coreqi.social.weixin.config;

import cn.coreqi.social.weixin.connect.WeixinConnectionFactory;
import org.springframework.boot.autoconfigure.social.SocialAutoConfigurerAdapter;
import org.springframework.context.annotation.Configuration;
import org.springframework.social.connect.ConnectionFactory;

/**
 * 微信登錄配置
 */
@Configuration
public class WeixinAutoConfiguration extends SocialAutoConfigurerAdapter {

    @Override
    protected ConnectionFactory<?> createConnectionFactory() {
        String providerId = "weixin";   //第三方id，用來決定發起第三方登錄的url，默認是weixin
        String appId = "";
        String appSecret = "";
        return new WeixinConnectionFactory(providerId, appId,
                appSecret);
    }
    
}