开发分类功能
样品数据导入
表图示:
字段说明:
id: 主键
name: 显示在页面上的分类名称
parentId: 父分类的id 如果是一级分类父分类id为0
depth: 分类深度,当前项目就是3级分类,1\2\3 分别代表它的等级
keyword: 搜索关键字
sort: 排序依据 正常查询时,根据此列进行排序,数字越小越出现在前面(升序)
icon: 图标地址
enable: 是否可用
isparent: 是否为父分类 0 假 1真
isdisplay: 是否显示在导航栏 0不显示 1显示
表数据源:
DROP TABLE IF EXISTS `pms_category`;
CREATE TABLE `pms_category` (
`id` bigint(20) UNSIGNED NOT NULL AUTO_INCREMENT COMMENT '记录id',
`name` varchar(50) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '类别名称',
`parent_id` bigint(20) UNSIGNED NULL DEFAULT 0 COMMENT '父级类别id,如果无父级,则为0',
`depth` tinyint(3) UNSIGNED NULL DEFAULT 1 COMMENT '深度,最顶级类别的深度为1,次级为2,以此类推',
`keywords` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '关键词列表,各关键词使用英文的逗号分隔',
`sort` tinyint(3) UNSIGNED NULL DEFAULT 0 COMMENT '自定义排序序号',
`icon` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '图标图片的URL',
`enable` tinyint(3) UNSIGNED NULL DEFAULT 0 COMMENT '是否启用,1=启用,0=未启用',
`is_parent` tinyint(3) UNSIGNED NULL DEFAULT 0 COMMENT '是否为父级(是否包含子级),1=是父级,0=不是父级',
`is_display` tinyint(3) UNSIGNED NULL DEFAULT 0 COMMENT '是否显示在导航栏中,1=启用,0=未启用',
`gmt_create` datetime NULL DEFAULT NULL COMMENT '数据创建时间',
`gmt_modified` datetime NULL DEFAULT NULL COMMENT '数据最后修改时间',
PRIMARY KEY (`id`) USING BTREE,
INDEX `idx_category_name`(`name`) USING BTREE
) ENGINE = InnoDB AUTO_INCREMENT = 10 CHARACTER SET = utf8mb4 COLLATE = utf8mb4_general_ci COMMENT = '类别' ROW_FORMAT = Dynamic;
-- ----------------------------
-- Records of pms_category
-- ----------------------------
INSERT INTO `pms_category` VALUES (1, '手机 / 运营商 / 数码', 0, 1, NULL, 0, NULL, 1, 1, 1, NULL, '2022-08-14 22:43:58');
INSERT INTO `pms_category` VALUES (2, '手机通讯', 1, 2, '手机,电话', 0, NULL, 1, 1, 1, NULL, '2022-08-14 22:11:45');
INSERT INTO `pms_category` VALUES (3, '智能手机', 2, 3, NULL, 0, NULL, 1, 0, 1, NULL, NULL);
INSERT INTO `pms_category` VALUES (4, '非智能手机', 2, 3, NULL, 0, NULL, 1, 0, 1, NULL, NULL);
INSERT INTO `pms_category` VALUES (5, '电脑 / 办公', 0, 1, NULL, 0, NULL, 1, 1, 1, NULL, NULL);
INSERT INTO `pms_category` VALUES (6, '电脑整机', 5, 2, '电脑,计算机,微机,服务器,工作站', 0, NULL, 1, 1, 1, NULL, NULL);
INSERT INTO `pms_category` VALUES (7, '电脑配件', 5, 2, '配件,组装,CPU,内存,硬盘', 0, NULL, 1, 1, 1, NULL, NULL);
INSERT INTO `pms_category` VALUES (8, '笔记本', 6, 3, '电脑,笔记本,微机,便携', 0, NULL, 1, 0, 1, NULL, NULL);
INSERT INTO `pms_category` VALUES (9, '台式机 / 一体机', 6, 3, '台式机,一体机', 0, NULL, 1, 0, 1, NULL, NULL);
SET FOREIGN_KEY_CHECKS = 1;
分类功能实现逻辑
我们category表使用自关联实现了三级分类
当前使用固定的三级分类
1.从数据库中查询出所有分类信息,一次性全查
2.构建分类信息的父子结构,实现查询返回父子结构的分类信息
3.将查询到的结果保存在Redis中,以备后续用户直接获取
代码中要判断Redis中是否包含全部分类数据,不包含的话做上面操作
包含分类数据的话直接获得之后返回
业务分析
查询全部分类的业务重点在构建三级分类树结构
我们需要将从数据库中查询出的分类对象构成下面的结构
[
{id:1,name:"手机/运行商/数码",parentId:0,depth:1,children:[
{id:2,name:"手机通讯",parentId:1,depth:2,children:[
{id:3,name:"智能手机",parentId:2,depth:3,children:null},
{id:4,name:"非智能手机",parentId:2,depth:3,children:null}
]}
]},
{id:5,name:"电脑/办公",parentId:0,depth:1,children:[....]}
]
上面是我们需要获得的对象的结构
相关类
@ApiModel(value = "商品分类树")
@Data
public class FrontCategoryTreeVO<T> implements Serializable {
@ApiModelProperty(value="分类列表,包含下级分类")
private List<T> categories;
}
@Data
@ApiModel(value="商品分类树实体")
public class FrontCategoryEntity implements Serializable {
private static final long serialVersionUID = 1L;
/**
* 类别id®
*/
@ApiModelProperty(value = "类别id")
private Long id;
/**
* 类别名称
*/
@ApiModelProperty(value = "类别名称")
private String name;
/**
* 父级类别id,如果无父级,则为0
*/
@ApiModelProperty(value = "父级类别id,如果无父级,则为0")
private Long parentId;
/**
* 深度,最顶级类别的深度为1,次级为2,以此类推
*/
@ApiModelProperty(value = "深度,最顶级类别的深度为1,次级为2,以此类推,如果parent是1,rank就是2,parents是2,rank就是3,parent的rank不能是3", required = true)
private Integer depth;
/**
* 关键词列表,各关键词使用英文的逗号分隔
*/
@ApiModelProperty(value = "关键词列表,各关键词使用英文的逗号分隔")
private String keywords;
/**
* 自定义排序序号
*/
@ApiModelProperty(value = "自定义排序序号")
private Integer sort;
/**
* 图标图片的URL
*/
@ApiModelProperty(value = "图标图片的URL")
private String icon;
/**
* 是否为父级(是否包含子级),1=是父级,0=不是父级
*/
@ApiModelProperty(value = "是否为父级(是否包含子级),1=是父级,0=不是父级")
private Integer parent;
/**
* 是否启用,1=启用,0=未启用
*/
@ApiModelProperty(value = "是否启用,1=启用,0=未启用")
private Integer active;
/**
* 是否显示在导航栏中,1=启用,0=未启用
*/
@ApiModelProperty(value = "是否显示在导航栏中,1=启用,0=未启用")
private Integer display;
/**
* 如果当前isParent是1,则需要下级分类
*/
private List<FrontCategoryEntity> childrens;
}
CategoryStandardVO
@Data
public class CategoryStandardVO implements Serializable {
/**
* 类别id
*/
@ApiModelProperty(value = "类别id", position = 1)
private Long id;
/**
* 父级类别id,如果无父级,则为0
*/
@ApiModelProperty(value = "父级类别id,如果无父级,则为0", position = 2)
private Long parentId;
/**
* 类别名称
*/
@ApiModelProperty(value = "类别名称", position = 3)
private String name;
/**
* 深度,最顶级类别的深度为1,次级为2,以此类推
*/
@ApiModelProperty(value = "深度,最顶级类别的深度为1,次级为2,以此类推", position = 4)
private Integer depth;
/**
* 关键词列表,各关键词使用英文的逗号分隔
*/
@ApiModelProperty(value = "关键词列表,各关键词使用英文的逗号分隔", position = 5)
private String keywords;
/**
* 图标图片的URL
*/
@ApiModelProperty(value = "图标图片的URL", position = 6)
private String icon;
/**
* 是否启用,1=启用,0=未启用
*/
@ApiModelProperty(value = "是否启用,1=启用,0=未启用", position = 7)
private Integer enable;
/**
* 是否为父级(是否包含子级),1=是父级,0=不是父级
*/
@ApiModelProperty(value = "是否为父级(是否包含子级),1=是父级,0=不是父级", position = 8)
private Integer parent;
/**
* 是否显示在导航栏中,1=启用,0=未启用
*/
@ApiModelProperty(value = "是否显示在导航栏中,1=启用,0=未启用", position = 9)
private Integer display;
/**
* 自定义排序序号
*/
@ApiModelProperty(value = "自定义排序序号", position = 10)
private Integer sort;
}
实施开发
@DubboService
@Service
@Slf4j
public class FrontCategoryServiceImpl implements IFrontCategoryService {
// 开过程中使用Redis的规范:为了降低Redis的Key拼写错误的风险,我们会定义常量使用
public static final String CATEGORY_TREE_KEY="category_tree";
// 当前front模块没有连接数据库的操作,所有数据均来源于Dubbo调用product模块
// 所有要消费product模块具备对应功能的接口
@DubboReference
private IForFrontCategoryService dubboCategoryService;
// 操作Redis的对象
@Autowired
private RedisTemplate redisTemplate;
@Override
public FrontCategoryTreeVO categoryTree() {
// 我们先检查Redis中是否包含已经查询出的三级分类树
if(redisTemplate.hasKey(CATEGORY_TREE_KEY)){
// redis中已经包含了三级分类树,直接获取后返回即可
FrontCategoryTreeVO<FrontCategoryEntity> treeVO=
(FrontCategoryTreeVO<FrontCategoryEntity>)
redisTemplate.boundValueOps(CATEGORY_TREE_KEY).get();
// 千万别忘了返回!
return treeVO;
}
// Redis中没有三级分类树信息,表示当前请求可能是第一次请求
// dubbo调用查询pms数据库所有分类对象的方法
List<CategoryStandardVO> categoryStandardVOs=
dubboCategoryService.getCategoryList();
// 需要将没有关联关系的分类列表CategoryStandardVO类型
// 转换为具备关联关系的分类树列表FrontCategoryEntity类型
// 自定义一个转换三级分类树的方法,减少当前业务代码的冗余度
FrontCategoryTreeVO<FrontCategoryEntity> treeVO=
initTree(categoryStandardVOs);
// 上面方法完成了转换,已经获得了最后要返回的treeVO数据
// 但是为了下次访问更方便,我们项目设计将它保存在Redis中
redisTemplate.boundValueOps(CATEGORY_TREE_KEY)
.set(treeVO,1, TimeUnit.MINUTES);
// 上面定的时间是针对学习使用的,正常开发分类数据一般都24小时以上
// 这里也得返回!!!treeVO
return treeVO;
}
private FrontCategoryTreeVO<FrontCategoryEntity> initTree(List<CategoryStandardVO> categoryStandardVOs) {
// 第一部分,确定所有分类对象的父分类
// 声明一个Map,这个Map的key是分类对象的父Id,value是这个父分类Id下的所有子分类对象
// 一个父分类Id可以包含多个子分类对象,所以value是个list
Map<Long,List<FrontCategoryEntity>> map=new HashMap<>();
log.info("当前分类对象总数为:{}",categoryStandardVOs.size());
// 遍历categoryStandardVOs
for(CategoryStandardVO categoryStandardVO: categoryStandardVOs){
// categoryStandardVO是没有children属性的,不能保存分类关系
// 所以我们先要把它转换为能够保存父子关系的FrontCategoryEntity
FrontCategoryEntity frontCategoryEntity=new FrontCategoryEntity();
// 将同名属性赋值到frontCategoryEntity对象中
BeanUtils.copyProperties(categoryStandardVO,frontCategoryEntity);
// 因为后面会频繁使用父分类id,所以现在取出
Long parentId=frontCategoryEntity.getParentId();
// 向map中新增当前分类对象到对应的map的key中
// 要先判断这个key是否已经存在
if(map.containsKey(parentId)){
// 如果已经存在这个key,就只需要将新对象保存在这个key对应的value的list中
map.get(parentId).add(frontCategoryEntity);
}else{
// 如果当前map没有这个key
// 我们要创建一个List对象,保存当前分类对象后,最后当做map的value
List<FrontCategoryEntity> value=new ArrayList<>();
value.add(frontCategoryEntity);
// map中使用put方法新增元素,parentId为key,list为值
map.put(parentId,value);
}
}
// 第二部分,将子分类对象关联到父分类对象的children属性中
// 第一部分中,我们确定了每个父分类下的所有子分类
// 下面我们从一级分类来开始,将所有对应的子分类赋值到当前父分类的children属性中
// 我们项目设计数据库中父分类id为0,是一级分类,所以我们先获得所有一级分类对象
List<FrontCategoryEntity> firstLevels=map.get(0L);
// 判断当前一级分类是否为null
if (firstLevels==null || firstLevels.isEmpty()){
throw new CoolSharkServiceException(
ResponseCode.INTERNAL_SERVER_ERROR,"当前数据没有根分类");
}
//遍历所有一级分类对象
for(FrontCategoryEntity oneLevel:firstLevels){
// 确定了一级分类对象,可以根据当前一级分类的id,获得它包含的二级分类
Long secondLevelParentId=oneLevel.getId();
// 获得当前分类的所有子分类对象
List<FrontCategoryEntity> secondLevels=map.get(secondLevelParentId);
// 判断secondLevels是否为空
if(secondLevels==null || secondLevels.isEmpty()){
log.warn("当前分类没有二级分类内容:{}",secondLevelParentId);
// 如果当前一级分类没有二级分类对象,跳过本次循环,继续其它一级分类的遍历
continue;
}
// 遍历二级分类集合
for(FrontCategoryEntity twoLevel : secondLevels){
// 二级分类的对象的id是三级分类的父id
// ↓↓↓↓↓↓↓
Long thirdLevelParentId=twoLevel.getId();
// 根据这个二级父分类id获得所有该分类下的三级分类对象集合
List<FrontCategoryEntity> thirdLevels=map.get(thirdLevelParentId);
// 判断三级分类集合是否为空
if(thirdLevels==null || thirdLevels.isEmpty()){
log.warn("当前分类没有三级分类内容:{}",thirdLevelParentId);
continue;
}
// 将三级分类对象集合赋值到二级分类对象的children属性中
twoLevel.setChildrens(thirdLevels);
}
// 将二级分类对象集合赋值到一级分类对象的children属性中
oneLevel.setChildrens(secondLevels);
}
// 到此为止,所有对象的父子分类关系都已经构建完成
// 最后要按照方法要求的返回值来返回
FrontCategoryTreeVO<FrontCategoryEntity> treeVO=
new FrontCategoryTreeVO<>();
// 最后将包含所有分类对象的一级分类树集合赋值到该对象中
treeVO.setCategories(firstLevels);
// 千万别忘了返回!!! treeVO
return treeVO;
}
}