oauth常见问题我要提意见

OAuth模块管理客户端的用户登录鉴权功能，允许应用访问第三方平台的资源。

OAuth接口支持开发者调用当前环境中安装的三方客户端App（如微信、微博等）的授权登录页面进行鉴权操作。 若终端安装了对应的客户端App，则调用客户端的授权登录页面，否则调用WAP页面进行授权登录。

方法：

对象：

回调方法：

权限：

permissions


{
// ...
"permissions":{
	// ...
	"OAuth": {
		"description": "登录鉴权"
	}
}
}

getServices

获取登录鉴权列表


void plus.oauth.getServices( successCB, errorCB );

说明：

获取终端支持的权登录认证服务列表，可用于提示用户进行登录平台的选择。 获取登录鉴权成功后通过successCB回调返回支持的所有服务列表，获取服务失败则通过errorCB回调返回失败信息。

参数：

返回值：

void : 无

示例：


// 微信登录鉴权服务
var aweixin=null;
// 当前环境支持的所有登录鉴权服务
var auths = {};

// 获取登录鉴权服务列表，单独保存微信登录鉴权服务对象
// 5+APP在plusready事件中调用，uni-app在vue页面的onLoad中调用
function getService(){
	plus.oauth.getServices(function(services){
		for(var i in services){
			auths[service.id]=service;
		}
		aweixin = auths['weixin'];
	}, function(e){
		plus.nativeUI.alert("获取登录鉴权服务列表失败："+JSON.stringify(e));
	} );
}

uni-app使用plus注意事项

AuthService

登录鉴权服务对象


interface plus.oauth.AuthService {
	// Attributes
	attribute String id;
	attribute String description;
	attribute Boolean nativeClient;

	attribute AppleInfo appleInfo;
	attribute AuthInfo authResult;
	attribute UserInfo userInfo;
	attribute JSON extra;
	
	// Methods 
	function void authorize(successCallback, errorCallback, options);
	function void closeAuthView();
	function void login(successCallback, errorCallback, options);
	function void logout(successCallback, errorCallback);
	function void getUserInfo(successCallback, errorCallback);
	function void preLogin(successCallback, errorCallback);
}

说明：

AuthService对象用于表示登录鉴权服务，在JS中为对象，用于发起登录授权认证操作。

属性：

方法：

id

登录鉴权服务标识

说明：

String 类型 只读属性

用于表示登录鉴权服务标识：

description

登录鉴权服务描述

说明：

String 类型 只读属性 可选属性

用于描述登录鉴权服务的信息：

nativeClient

授权登录依赖的客户端App是否已安装

说明：

Boolean 类型 只读属性

对于某些登录鉴权服务，必须依赖相应客户端App才能实现授权操作；有些登录鉴权服务则无需客户端App，或者依赖的客户端App不存在时调用WAP页面进行授权操作。
具体情况如下：

注意：提交AppStore审核时没有安装相应的客户端App可能导致无法通过审核，此时需要判断相应的客户端App是否安装，如果没有安装则不显示对应的登录入口。
HBuilderX3.1.19及以上版本支持。

appleInfo

苹果登录认证数据

说明：

AppleInfo 类型 只读属性 可选属性

调用login登录认证成功后保存的苹果认证信息。

authResult

登录认证数据

说明：

AuthInfo 类型 只读属性 可选属性

调用login登录认证成功后保存的认证信息。 如果值为"undefined"则表示未进行登录认证或者登录认证失败。

userInfo

登录用户信息

说明：

UserInfo 类型 只读属性 可选属性

调用用于保存登录授权认证获取的用户信息，如果值为"undefined"则表示未获取过用户信息。

extra

登录授权认证扩展信息

说明：

JSON 类型 只读属性 可选属性

用于保存登录鉴权服务返回的扩展信息，具体内容由各登录平台决定，如果没有扩展信息则为undefined。 例如“微信”，则可保存以下数据： state - 用于保持请求和回调的状态参数。

authorize

请求授权认证


						
void obj.authorize(successCallback, errorCallback, options);

说明：

向开放平台请求进行授权认证，需提供授权域（scope），用户在终端确认后通过成功回调返回授权临时票据（code）。 开发者可以将授权临时票据（code）提交到业务服务器，由业务服务器从微信开放平台获取授权登录等相关信息，避免将appsecret等信息保存在客户端可能引起泄露的问题。 注意：目前仅微信平台支持请求授权认证，其它平台调用此方法将返回错误回调。

参数：

返回值：

void : 无

示例：


// 微信授权登录对象
var aweixin=null;	// 调用plus.oauth.getServices获取保存

// 获取微信登录授权对象后可进行授权操作
function authorize(){
	if(!aweixin){
		plus.nativeUI.alert("当前环境不支持微信登录");
		return;
	}
	aweixin.authorize(function(e){
		plus.nativeUI.alert("授权成功："+JSON.stringify(e));
	}, function(e){
		plus.nativeUI.alert("授权失败："+JSON.stringify(e));
	}, {scope:'snsapi_userinfo',state:'authorize test',appid:'WX**********'});
}

uni-app使用plus注意事项

closeAuthView

关闭授权登录界面


						
void obj.closeAuthView();

说明：

仅一键登录支持，请求登录认证操作完成后，不管成功或失败都不会关闭一键登录界面，需要主动调用此方法关闭。 客户端登录认证完成只是说明获取 access_token 成功，需要将此数据提交到服务器获取手机号码，完成业务服务登录逻辑后通知客户端关闭登录界面。 详情参考https://uniapp.dcloud.io/univerify

参数：

无

返回值：

void : 无

login

请求登录认证


						
void obj.login(successCallback, errorCallback, options);

说明：

在登录前可通过对象的authResult属性判断是否已经登录认证过，通常只需对没有登录认证过的服务进行此操作。 登录后可获取应用的基础信息（如用户昵称等）保存在authResult属性中。 登录操作成功后通过successCallback回调函数通知，失败则通过errorCallback回调函数通知。
注意，由于业务需求的差异，不同授权登录平台返回数据的处理逻辑可能不同：

参数：

返回值：

void : 无

示例：


// 微信授权登录对象
var aweixin=null;	// 调用plus.oauth.getServices获取保存

// 通常登录前需要先调用authorize方法进行授权

// 获取微信登录授权对象后可进行登录认证操作
function authLogin(){
	if(!aweixin){
		plus.nativeUI.alert("当前环境不支持微信登录");
		return;
	}
	if(!aweixin.authResult){
		aweixin.login(function(e){
			plus.nativeUI.alert("登录认证成功!");
		}, function(e){
			plus.nativeUI.alert("登录认证失败: "+JSON.stringify(e));
		} );
	}else{
		plus.nativeUI.alert("已经登录认证!");
	}
}

uni-app使用plus注意事项

logout

注销登录认证


void obj.logout(successCallback, errorCallback);

说明：

注销登录认证后，再次获取用户信息时需重新进行授权登录认证操作。 如果第三方平台不需要注销登录操作，则清空保存的登录认证等信息。

参数：

返回值：

void : 无

示例：


// 微信授权登录对象
var aweixin=null;	// 调用plus.oauth.getServices获取保存

// 调用authorize、login先授权登录认证

// 注销登录认证
function authLogout(){
	if(!aweixin){
		plus.nativeUI.alert("当前环境不支持微信登录");
		return;
	}
	aweixin.logout(function(e){
		plus.nativeUI.alert("注销登录认证成功!");
	}, function(e){
		plus.nativeUI.alert("注销登录认证失败: "+JSON.stringify(e));
	});
}

uni-app使用plus注意事项

getUserInfo

获取用户信息


void obj.getUserInfo(successCallback, errorCallback);

说明：

在获取用户信息前可通过对象的userInfo属性判断是否已经获取过，通常只需对没有获取过用户信息的服务进行此操作。 获取用户信息成功后通过successCallback回调函数通知，失败则通过errorCallback回调函数通知。

参数：

返回值：

void : 无

示例：


// 微信鉴权服务对象
var aweixin=null;	// 调用plus.oauth.getServices获取保存

// 通常登录前需要先调用authorize方法进行授权，调用login方法进行登录认证

// 获取微信登录授权对象后获取用户信息操作
function authUserInfo(){
	if(!aweixin){
		plus.nativeUI.alert("当前环境不支持微信登录");
		return;
	}
	if(aweixin.authResult){
		aweixin.getUserInfo( function(e){
			plus.nativeUI.alert("获取用户信息成功："+JSON.stringify(aweixin.userInfo));
		}, function(e){
			plus.nativeUI.alert("获取用户信息失败： "+JSON.stringify(e));
		} );
	}else{
		plus.nativeUI.alert("未登录认证!");
	}
}

uni-app使用plus注意事项

preLogin

预登录


						
void obj.preLogin(successCallback, errorCallback);

说明：

仅一键登录支持，在登录授权认证前调用，可以判断当前设备环境是否支持一键登录，如果能支持一键登录，此时可以显示一键登录选项，同时预登录会准备好相关环境，显著提升一键登录授权认证的操作速度。 如果预登录失败，表示当前设备环境可能不支持一键登录，此时应该显示其他登录选项。

参数：

返回值：

void : 无

AppleInfo

苹果登录认证信息


interface plus.oauth.AppleInfo {
	attribute String user;
	attribute String state;
	attribute String email:
	attribute JSON fullName;
	attribute String authorizationCode;
	attribute String identityToken;
	attribute Number realUserStatus;
	attribute String scope;
}

说明：

此对象仅在使用苹果登录时有效，用于保存苹果登录返回的数据。

属性：

平台支持：

AuthOptions

JSON对象，授权认证参数选项


interface plus.oauth.AuthOptions {
	attribute String scope;
	attribute String state;
	attribute String appid;
	attribute String appkey;
	attribute String appsecret;
	attribute String redirect_uri;
	attribute UniverifyStyles univerifyStyle;
}

说明：

此对象支持的属性值由登录授权认证服务定义。 例如“微信”，则可配置以下参数： scope - 应用授权作用域； state - 用于保持请求和回调的状态参数。

属性：

示例：


// 微信授权登录对象
var aweixin=null;	// 调用plus.oauth.getServices获取保存

// 获取微信登录授权对象后可进行授权操作
function authorize(){
	if(!aweixin){
		plus.nativeUI.alert("当前环境不支持微信登录");
		return;
	}
	aweixin.authorize(function(e){
		plus.nativeUI.alert("授权成功："+JSON.stringify(e));
	}, function(e){
		plus.nativeUI.alert("授权失败："+JSON.stringify(e));
	}, {scope:'snsapi_userinfo',appid:'WX**********'});
}

uni-app使用plus注意事项

AuthInfo

登录授权认证信息


interface plus.oauth.AuthInfo {
	attribute String access_token;
	attribute String openid;
	attribute String expires_in:
	attribute String refresh_token;
	attribute String scope;
}

说明：

此对象仅定义标准属性，登录授权认证服务可扩展自定义数据。 例如“微信”登录授权服务，则包括以下数据： unionid - 用户统一标识，针对一个微信开放平台帐号下的应用，同一用户的unionid是唯一的。

属性：

UserInfo

登录授权用户信息


interface plus.oauth.UserInfo {
	attribute String openid;
	attribute String headimgurl:
	attribute String nickname;
	attribute String email;
	attribute String phonenumber;
	attribute String sex;
	attribute String province;
	attribute String city;
	attribute String country;
	attribute String unionid;
}

说明：

用于保存登录授权用户的信息。 此对象仅定义标准属性，登录授权认证服务可扩展自定义数据。 例如“微信”登录授权服务，可能包括以下自定义数据：

unionid - ，。

属性：

UniverifyStyles

一键登录授权界面样式参数


interface plus.oauth.UniverifyStyles {
	attribute Boolean fullScreen;
	attribute String backgroundColor;
	attribute String backgroundImage;
	attribute UniverifyIconStyles icon;
	attribute UniverifyIconStyles closeIcon;
	attribute UniverifyPhoneNumStyles phoneNum;
	attribute UniverifySloganStyles slogan;
	attribute UniverifyAuthButtonStyles authButton;
	attribute UniverifyOtherButtonStyles otherLoginButton;
	attribute UniverifyPrivacyTermsStyles privacyTerms;
	attribute UniVerifyButtonsStyles buttons;
}

说明：

用于一键登录授权界面自定义样式。
HBuilderX3.0.0+版本支持，详情参考一键登录使用指南。

属性：

UniverifyIconStyles

一键登录授权界面图标样式参数


interface plus.oauth.UniverifyIconStyles {
	attribute String path;
	attribute String width;
	attribute String height;
}

属性：

UniverifyPhoneNumStyles

一键登录授权界面电话号码文本样式参数


interface plus.oauth.UniverifyPhoneNumStyles {
	attribute String color;
	attribute String fontSize;
}

属性：

UniverifySloganStyles

一键登录授权界面服务说明文字样式参数


interface plus.oauth.UniverifySloganStyles {
	attribute String color;
	attribute String fontSize;
}

属性：

UniverifyAuthButtonStyles

一键登录授权界面登录按钮样式参数


interface plus.oauth.UniverifyAuthButtonStyles {
	attribute String normalColor;
	attribute String highlightColor;
	attribute String disabledColor;
	attribute String width;
	attribute String height;
	attribute String textColor;
	attribute String title;
	attribute String borderRadius;
}

属性：

UniverifyOtherButtonStyles

一键登录授权界面其它按钮样式参数


interface plus.oauth.UniverifyOtherButtonStyles {
	attribute Boolean visible;
	attribute String normalColor;
	attribute String highlightColor;
	attribute String width;
	attribute String height;
	attribute String textColor;
	attribute String title;
	attribute String borderWidth;
	attribute String borderColor;
	attribute String borderRadius;
}

属性：

UniverifyPrivacyTermsStyles

一键登录服务协议样式参数


interface plus.oauth.UniverifyPrivacyTermsStyles {
	attribute Boolean defaultCheckBoxState;
	attribute String uncheckedImage;
	attribute String checkedImage;
	attribute String textColor;
	attribute String termsColor;
	attribute String prefix;
	attribute String suffix;
	attribute String fontSize;
	attribute Array<UniverifyPrivacyItemStyles> privacyItems;
}

属性：

UniverifyPrivacyItemStyles

自定义服务协议链接样式参数


interface plus.oauth.UniverifyPrivacyItemStyles {
	attribute String url;
	attribute String title;
}

属性：

UniVerifyButtonsStyles

自定义登录按钮列表样式


interface plus.oauth.UniVerifyButtonsStyles {
	attribute String iconWidth;
	attribute Array<UniVerifyButtonStyles> list;
}

属性：

UniVerifyButtonStyles

自定义登录按钮样式


interface plus.oauth.UniVerifyButtonStyles {
	attribute String iconPath;
	attribute Function onclick;
}

属性：

ServicesSuccessCallback

获取登录授权认证服务成功回调


void ServicesSuccessCallback( services ) {
	// Get oauth services success code
}

说明：

当获取登录授权认证服务列表成功时触发，并通过services参数返回运行环境支持的登录授权认证服务列表。

参数：

返回值：

void : 无

AuthorizeSuccessCallback

授权认证成功回调函数


void onAuthorizeSuccess(event){
	　　// authorize code
}

说明：

授权认证成功时触发，并返回操作结果。

参数：

返回值：

void : 无

LogoutSuccessCallback

注销登录授权认证操作成功回调函数


void onLogoutSuccess(event){
	　　// logout code
}

说明：

注销登录授权认证成功时触发，并返回操作结果。

参数：

返回值：

void : 无

SuccessCallback

登录授权认证服务操作成功回调函数


void onSuccess(event){
	　　// auth code
}

说明：

登录授权认证服务操作如请求登录授权认证、获取登录授权用户信息成功时触发，并返回操作结果。

参数：

返回值：

void : 无

ErrorCallback

登录授权认证服务操作失败回调函数


void onError(error){
	// Error code
}

说明：

登录授权认证服务操作如请求登录授权认证、注销登录授权认证、获取登录授权用户信息失败时触发，并返回错误信息。

参数：

返回值：

void : 无