pjq.weibo.openapi.apis.WeiboApiFriendShips Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of weibo-openapi-4java Show documentation
Show all versions of weibo-openapi-4java Show documentation
基于微博开放平台官网的weibo4j-oauth2-beta3.1.1包及新版接口做二次开发
The newest version!
/*
* Copyright © 2021 pengjianqiang
* All rights reserved.
* 项目名称：微博开放平台API-JAVA SDK
* 项目描述：基于微博开放平台官网的weibo4j-oauth2-beta3.1.1包及新版接口做二次开发
* 项目地址：https://github.com/qqxadyy/weibo-openapi-4java
* 许可证信息：见下文
*
* ======================================================================
*
* The MIT License
* Copyright © 2021 pengjianqiang
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package pjq.weibo.openapi.apis;
import java.util.List;
import lombok.AccessLevel;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;
import lombok.experimental.Accessors;
import pjq.commons.utils.CheckUtils;
import pjq.weibo.openapi.constant.ParamConstant.MoreUseParamNames;
import pjq.weibo.openapi.constant.ParamConstant.TrimStatus;
import pjq.weibo.openapi.constant.WeiboConfigs;
import pjq.weibo.openapi.support.WeiboApiParamScope;
import weibo4j.Weibo;
import weibo4j.http.Response;
import weibo4j.model.PostParameter;
import weibo4j.model.User;
import weibo4j.model.UserIdsPager;
import weibo4j.model.UserPager;
import weibo4j.model.WeiboException;
import weibo4j.model.WeiboResponse;
import weibo4j.org.json.JSONObject;
/**
* FriendShips相关接口
* 使用Weibo.of({@link WeiboApiFriendShips}.class,accessToken)生成对象
* 1.相关接口好像有如下问题：即使实际有多个对象也只能返回一个对象信息，page、count等参数也控制不了
*
* @author pengjianqiang
* @date 2021年1月21日
*/
@SuppressWarnings("serial")
@Getter
@Accessors(fluent = true)
@NoArgsConstructor(access = AccessLevel.PRIVATE)
public class WeiboApiFriendShips extends Weibo {
/**
* 单页返回的记录条数，默认为5，最大不超过5
*/
@Setter(onMethod_ = {@WeiboApiParamScope(WeiboApiParamScope.PAGER)})
private Integer count;
/**
* 返回结果的页码，默认为1
*/
@Setter(onMethod_ = {@WeiboApiParamScope(WeiboApiParamScope.PAGER)})
private Integer page;
/**
* 返回结果的游标，下一页用返回值里的next_cursor，上一页用previous_cursor，默认为0
*/
@Setter(onMethod_ = {@WeiboApiParamScope(WeiboApiParamScope.PAGER)})
private String cursor;
/**
* 返回值中user字段中的status字段开关，0：返回完整status字段、1：status字段仅返回status_id，默认为1
*/
@Setter(onMethod_ = {@WeiboApiParamScope(WeiboApiParamScope.FRIENDSHIPS_QUEYR_USER)})
private TrimStatus trimStatus;
/**
* 开发者上报的操作用户真实IP
*/
@Setter(onMethod_ = {@WeiboApiParamScope(WeiboApiParamScope.FRIENDSHIPS_QUEYR_USER)})
private String rip;
/**
* 根据用户ID获取授权用户的关注列表
*
* @param uid
* 必须是当前授权的用户ID
* @return
* @throws WeiboException
*/
public UserPager apiGetMyFriendsById(String uid) throws WeiboException {
return getMyFriends(MoreUseParamNames.UID, uid);
}
/**
* 根据用户昵称获取授权用户的关注列表
*
* @param screenName
* 必须是当前授权的用户昵称
* @return
* @throws WeiboException
*/
public UserPager apiGetMyFriendsByScreenName(String screenName) throws WeiboException {
return getMyFriends(MoreUseParamNames.SCREEN_NAME, screenName);
}
private UserPager getMyFriends(String uidOrScreenName, String val) throws WeiboException {
return new UserPager(commonGet(WeiboConfigs.FRIENDSHIPS_FRIENDS, uidOrScreenName, val));
}
/**
* 根据用户ID获取授权用户的关注用户的ID列表
*
* @param uid
* 必须是当前授权的用户ID
* @return
* @throws WeiboException
*/
public UserIdsPager apiGetMyFriendsIdsById(String uid) throws WeiboException {
return getMyFriendsIds(MoreUseParamNames.UID, uid);
}
/**
* 根据用户昵称获取授权用户的关注用户的ID列表
*
* @param screenName
* 必须是当前授权的用户昵称
* @return
* @throws WeiboException
*/
public UserIdsPager apiGetMyFriendsIdsByScreenName(String screenName) throws WeiboException {
return getMyFriendsIds(MoreUseParamNames.SCREEN_NAME, screenName);
}
private UserIdsPager getMyFriendsIds(String uidOrScreenName, String val) throws WeiboException {
return new UserIdsPager(commonGet(WeiboConfigs.FRIENDSHIPS_FRIENDS_IDS, uidOrScreenName, val));
}
/**
* 根据用户ID获取授权用户的粉丝列表
*
* @param uid
* 必须是当前授权的用户ID
* @return
* @throws WeiboException
*/
public UserPager apiGetMyFansById(String uid) throws WeiboException {
return getMyFans(MoreUseParamNames.UID, uid);
}
/**
* 根据用户昵称获取授权用户的粉丝列表
*
* @param screenName
* 必须是当前授权的用户昵称
* @return
* @throws WeiboException
*/
public UserPager apiGetMyFansByScreenName(String screenName) throws WeiboException {
return getMyFans(MoreUseParamNames.SCREEN_NAME, screenName);
}
private UserPager getMyFans(String uidOrScreenName, String val) throws WeiboException {
return new UserPager(commonGet(WeiboConfigs.FRIENDSHIPS_FOLLOWERS, uidOrScreenName, val));
}
/**
* 根据用户ID获取授权用户的粉丝的ID列表
*
* @param uid
* 必须是当前授权的用户ID
* @return
* @throws WeiboException
*/
public UserIdsPager apiGetMyFansIdsById(String uid) throws WeiboException {
return getMyFansIds(MoreUseParamNames.UID, uid);
}
/**
* 根据用户昵称获取授权用户的粉丝的ID列表
*
* @param screenName
* 必须是当前授权的用户昵称
* @return
* @throws WeiboException
*/
public UserIdsPager apiGetMyFansIdsByScreenName(String screenName) throws WeiboException {
return getMyFansIds(MoreUseParamNames.SCREEN_NAME, screenName);
}
private UserIdsPager getMyFansIds(String uidOrScreenName, String val) throws WeiboException {
return new UserIdsPager(commonGet(WeiboConfigs.FRIENDSHIPS_FOLLOWERS_IDS, uidOrScreenName, val));
}
private Response commonGet(String apiName, String uidOrScreenName, String val) throws WeiboException {
if (CheckUtils.isEmpty(val)) {
throw WeiboException.ofParamCanNotNull(uidOrScreenName);
}
List paramList = commonParam();
paramList.add(new PostParameter(uidOrScreenName, val));
return client.get(WeiboConfigs.getApiUrl(apiName), paramListToArray(paramList), accessToken());
}
/**
* 根据用户ID获取两个用户之间的详细关注关系情况
*
* @param uid
* 用户ID
* @return
* @throws WeiboException
*/
public JSONObject apiShowFriendShipBetweenUsersById(String sourceUid, String targetUid) throws WeiboException {
return showFriendShipBetweenUsers("source_id", sourceUid, "target_id", targetUid);
}
/**
* 根据用户昵称获取两个用户之间的详细关注关系情况
*
* @param screenName
* 用户昵称
* @return
* @throws WeiboException
*/
public JSONObject apiShowFriendShipBetweenUsersBySereenName(String sourceScreenName, String targetScreenName)
throws WeiboException {
return showFriendShipBetweenUsers("source_screen_name", sourceScreenName, "target_screen_name",
targetScreenName);
}
private JSONObject showFriendShipBetweenUsers(String sourceUidOrScreenName, String sourceVal,
String targetUidOrScreenName, String targetVal) throws WeiboException {
if (CheckUtils.isEmpty(sourceVal)) {
throw WeiboException.ofParamCanNotNull(sourceUidOrScreenName);
}
if (CheckUtils.isEmpty(targetVal)) {
throw WeiboException.ofParamCanNotNull(targetUidOrScreenName);
}
List paramList = newParamList();
paramList.add(new PostParameter(sourceUidOrScreenName, sourceVal));
paramList.add(new PostParameter(targetUidOrScreenName, targetVal));
return client
.get(WeiboConfigs.getApiUrl(WeiboConfigs.FRIENDSHIPS_SHOW), paramListToArray(paramList), accessToken())
.asJSONObject();
}
/**
* 获取用户的活跃粉丝列表
*
* @param uid
* 必须是当前授权的用户ID
* @return
* @throws WeiboException
*/
public List apiGetActiveFollowers(String uid) throws WeiboException {
if (CheckUtils.isEmpty(uid)) {
throw WeiboException.ofParamCanNotNull(MoreUseParamNames.UID);
}
List paramList = commonParam();
paramList.add(new PostParameter(MoreUseParamNames.UID, uid));
return WeiboResponse.buildList(client.get(WeiboConfigs.getApiUrl(WeiboConfigs.FRIENDSHIPS_FOLLOWERS_ACTIVE),
paramListToArray(paramList), accessToken()), User.class);
}
private List commonParam() {
List paramList = newParamList();
if (CheckUtils.isNotNull(count) && count >= 0) {
paramList.add(new PostParameter("count", count));
}
if (CheckUtils.isNotNull(page) && page >= 1) {
paramList.add(new PostParameter("page", page));
} else {
// friendships类接口有问题，官网没有写page参数，如果不传page参数则接口的记录列表不能正常获取，需要指定默认传1
paramList.add(new PostParameter("page", 1));
}
if (CheckUtils.isNotEmpty(cursor)) {
paramList.add(new PostParameter("cursor", cursor));
}
if (CheckUtils.isNotNull(trimStatus)) {
paramList.add(new PostParameter("trim_status", trimStatus.value()));
}
return paramList;
}
/**
* 根据用户ID关注用户
*
* @param uid
* 用户ID
* @return
* @throws WeiboException
*/
public User apiFollowerUserById(String uid) throws WeiboException {
return followerUser(MoreUseParamNames.UID, uid);
}
/**
* 根据用户昵称关注用户
*
* @param screenName
* 用户昵称
* @return
* @throws WeiboException
*/
public User apiFollowerUserByScreenName(String screenName) throws WeiboException {
return followerUser(MoreUseParamNames.SCREEN_NAME, screenName);
}
private User followerUser(String uidOrScreenName, String val) throws WeiboException {
if (CheckUtils.isEmpty(val)) {
throw WeiboException.ofParamCanNotNull(uidOrScreenName);
}
List paramList = newParamList();
paramList.add(new PostParameter(uidOrScreenName, val));
if (CheckUtils.isNotEmpty(rip)) {
paramList.add(new PostParameter(MoreUseParamNames.REAL_IP, rip));
}
return new User(client.post(WeiboConfigs.getApiUrl(WeiboConfigs.FRIENDSHIPS_CREATE),
paramListToArray(paramList), accessToken()));
}
/**
* 根据用户ID取关用户
*
* @param uid
* 用户ID
* @return
* @throws WeiboException
*/
public User apiUnFollowerUserById(String uid) throws WeiboException {
return unFollowerUser(MoreUseParamNames.UID, uid);
}
/**
* 根据用户昵称取关用户
*
* @param screenName
* 用户昵称
* @return
* @throws WeiboException
*/
public User apiUnFollowerUserByScreenName(String screenName) throws WeiboException {
return unFollowerUser(MoreUseParamNames.SCREEN_NAME, screenName);
}
private User unFollowerUser(String uidOrScreenName, String val) throws WeiboException {
if (CheckUtils.isEmpty(val)) {
throw WeiboException.ofParamCanNotNull(uidOrScreenName);
}
List paramList = newParamList();
paramList.add(new PostParameter(uidOrScreenName, val));
return new User(client.post(WeiboConfigs.getApiUrl(WeiboConfigs.FRIENDSHIPS_DESTROY),
paramListToArray(paramList), accessToken()));
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy