实用API设计案例

简介: 实用API设计案例

艺术生永远不要把学技巧放在第一位,而要把怎么思考放在第一位。——灵遁者

今天为了偷懒,写了两个函数

/**
 * AR模式in查询
 *
 * @param page 分页参数
 * @param ids  ids
 * @param type Class
 * @return com.baomidou.mybatisplus.extension.plugins.pagination.Page<T>
 * @author <achao1441470436@gmail.com>
 * @since 2021/8/16 16:21
 */
@SneakyThrows
public static <T extends BaseEntity<T>> IPage<T> selectPageByIds(IPage<T> page, List<?> ids, Class<T> type) {
    if (ids.isEmpty()) {
        return page;
    }
    return type.newInstance().selectPage(page, new LambdaQueryWrapper<>(type.newInstance()).in(T::getId, ids));
}

这里用到了AR模式,AR模式我之前博客写过,就不赘述了

AR模式文章戳我

看上去就两三行,但这个函数能应对我此处的需求:查询我的关注企业/收藏资讯/收藏产品列表等

然后我在service中调用如下:

/**
 * 我的关注/收藏
 *
 * @param page          分页参数
 * @param userAttention 查询条件
 * @return com.ruben.zsxh.pojo.common.Result
 * @author <achao1441470436@gmail.com>
 * @since 2021/8/16 15:51
 */
@Override
@Transactional(readOnly = true, propagation = Propagation.NOT_SUPPORTED)
public Result mine(Page page, UserAttention userAttention) {
    userAttention.setUserId(Long.valueOf(ProfileHolder.getProfile().getId()));
    List<Long> ids = list(Wrappers.lambdaQuery(userAttention).select(UserAttention::getAttentionId)).parallelStream().map(UserAttention::getAttentionId).collect(Collectors.toList());
    return Result.ok().data(MybatisPlusUtils.selectPageByIds(page, ids, userAttention.getType().getTypeClass()));
}

这里第一行是给参数赋值,便于作为下方查询条件

userAttention.setUserId(Long.valueOf(ProfileHolder.getProfile().getId()));

第二行是从表内根据条件查询出关联数据

例如这里service的第二行是:在userAttention中调用UserAttention::getUserId,并以user_id=userId作为where条件,在对应的数据库表名为user_attention中取出attention_id,但mybatis-plusselectList返回的是UserAttention,所以我们再使用并行流转换为attentionId

List<Long> ids = list(Wrappers.lambdaQuery(userAttention).select(UserAttention::getAttentionId)).parallelStream().map(UserAttention::getAttentionId).collect(Collectors.toList());

最后拿到的返回值就是attentionId的集合,然后这个ids是用于关联其他表的

最后第三行中我们写法如下:

return Result.ok().data(MybatisPlusUtils.selectPageByIds(page, ids, userAttention.getType().getTypeClass()));

这里调用了我们上面的selectPageByIds,然后传入了

page:分页参数

ids:上方获取到attentionId的集合

userAttention.getType().getTypeClass():这个对应了一个枚举如下:

package com.ruben.zsxh.enumration.type;
import com.ruben.zsxh.entity.ArticleInfo;
import com.ruben.zsxh.entity.MemberInfo;
import com.ruben.zsxh.entity.ProductInfo;
import com.ruben.zsxh.pojo.common.BaseEntity;
import lombok.AllArgsConstructor;
import lombok.Getter;
/**
 * 用户关注类型
 *
 * @author <achao1441470436@gmail.com>
 * @since 2021/8/16 14:46
 */
@Getter
@AllArgsConstructor
public enum UserAttentionTypeEnum {
    /**
     * Cheating the compiler.
     */
    MEMBER("关注企业", MemberInfo.class),
    NEWS("收藏资讯", ArticleInfo.class),
    PRODUCT("收藏商品", ProductInfo.class);
    private final String desc;
    private final Class<? extends BaseEntity> typeClass;
}

然后我们再配置mvc配置fastjson序列化枚举以及Mybatis-plus通用枚举之后

再到Controller中调用service

/**
 * 查询我的列表
 *
 * @param page 分页参数?size=10&current=1
 * @return 分页结果
 * @author <achao1441470436@gmail.com>
 * @since 2021-08-09
 */
@GetMapping("mine")
public Result mine(Page page, UserAttention userAttention) {
    return userAttentionService.mine(page, userAttention);
}

最后就能实现传入不同的type,分页拿到不同表的数据

例如传入MEMBER

传入NEWS

传入PRODUCT

这样就能用最少的代码做最多的事,达到事半功倍的效果

相关文章
|
1月前
|
监控 前端开发 JavaScript
实战篇:商品API接口在跨平台销售中的有效运用与案例解析
随着电子商务的蓬勃发展,企业为了扩大市场覆盖面,经常需要在多个在线平台上展示和销售产品。然而,手工管理多个平台的库存、价格、商品描述等信息既耗时又容易出错。商品API接口在这一背景下显得尤为重要,它能够帮助企业在不同的销售平台之间实现商品信息的高效同步和管理。本文将通过具体的淘宝API接口使用案例,展示如何在跨平台销售中有效利用商品API接口,以及如何通过代码实现数据的统一管理。
|
4月前
|
缓存 JavaScript Serverless
一些可能被忽视的 Vue3 API 附带案例
一些可能被忽视的 Vue3 API 附带案例
112 0
|
3月前
|
API
GEE案例分析——利用sentinel-3数据计算空气污染指数(Air Pollution Index,简称API)
GEE案例分析——利用sentinel-3数据计算空气污染指数(Air Pollution Index,简称API)
117 0
|
10月前
|
JSON 监控 前端开发
python对接API二次开发高级实战案例解析:Zabbix API封装类实现获取认证密钥、所有主机组、所有主机、所有监控项和历史数据
python对接API二次开发高级实战案例解析:Zabbix API封装类实现获取认证密钥、所有主机组、所有主机、所有监控项和历史数据
318 0
|
10月前
|
JavaScript 前端开发 API
python对接API二次开发高级实战案例解析:百度地图Web服务API封装函数(行政区划区域检索、地理编码、国内天气查询、IP定位、坐标转换)
python对接API二次开发高级实战案例解析:百度地图Web服务API封装函数(行政区划区域检索、地理编码、国内天气查询、IP定位、坐标转换)
242 0
|
2月前
|
Linux API 网络架构
Rest API请求管理最佳实践:RestClient-cpp库的应用案例
Rest API请求管理最佳实践:RestClient-cpp库的应用案例
|
4月前
|
缓存 供应链 安全
淘宝API接口调用:案例分析与最佳实践(续)
淘宝API接口是连接商家与淘宝平台强大功能的重要桥梁。通过案例分析和最佳实践的分享,我们希望商家能够更深入地理解如何有效地使用这些API来优化电商业务。随着技术的不断进步,淘宝API的功能将会越来越丰富,而商家面临的挑战也会越来越大。因此,商家需要不断地学习新技术、探索新方法,并且不断完善自己的API使用策略,以便更好地适应市场的变化,赢得竞争的优势。
|
4月前
|
供应链 搜索推荐 API
淘宝API接口调用:案例分析与最佳实践
在电子商务迅猛发展的今天,淘宝作为中国最大的在线购物平台之一,为商家们提供了强大的数据分析和市场洞察工具——淘宝API。有效的API调用不仅可以提升商家的运营效率,还可以帮助商家更好地理解消费者需求、优化商品布局、提高用户满意度等。本文将通过案例分析和最佳实践探讨如何高效利用淘宝API接口。
|
4月前
|
机器学习/深度学习 安全 数据挖掘
电商API接口的最佳实践与案例分析
随着电商行业的快速发展,越来越多的企业开始将业务拓展到线上。为了提高用户体验和运营效率,电商平台提供了丰富的API接口,方便商家进行商品管理、订单处理、营销活动等操作。本文将介绍电商API接口的最佳实践和案例分析。
|
10月前
|
移动开发 JavaScript 前端开发
数据可视化大屏百度地图手机端标注开发实战案例解析(jsAPI接口、标注分类图片、文本标签、分类筛选、自适应高度信息弹窗、PHP后端API)
数据可视化大屏百度地图手机端标注开发实战案例解析(jsAPI接口、标注分类图片、文本标签、分类筛选、自适应高度信息弹窗、PHP后端API)
148 0