Add product tag table and CRUD operations

---

For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/YunaiV/ruoyi-vue-pro?shareId=XXXX-XXXX-XXXX-XXXX).

yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/tag/ProductTagController.java

@@ -0,0 +1,94 @@
+package cn.iocoder.yudao.module.product.controller.admin.tag;
+
+import cn.iocoder.yudao.framework.common.pojo.CommonResult;
+import cn.iocoder.yudao.framework.common.pojo.PageResult;
+import cn.iocoder.yudao.module.product.controller.admin.tag.vo.ProductTagCreateReqVO;
+import cn.iocoder.yudao.module.product.controller.admin.tag.vo.ProductTagPageReqVO;
+import cn.iocoder.yudao.module.product.controller.admin.tag.vo.ProductTagRespVO;
+import cn.iocoder.yudao.module.product.controller.admin.tag.vo.ProductTagUpdateReqVO;
+import cn.iocoder.yudao.module.product.convert.tag.ProductTagConvert;
+import cn.iocoder.yudao.module.product.dal.dataobject.tag.ProductTagDO;
+import cn.iocoder.yudao.module.product.service.tag.ProductTagService;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.tags.Tag;
+import org.springframework.security.access.prepost.PreAuthorize;
+import org.springframework.validation.annotation.Validated;
+import org.springframework.web.bind.annotation.*;
+
+import javax.annotation.Resource;
+import javax.validation.Valid;
+import java.util.Collection;
+import java.util.List;
+
+import static cn.iocoder.yudao.framework.common.pojo.CommonResult.success;
+
+@Tag(name = "管理后台 - 商品标签")
+@RestController
+@RequestMapping("/product/tag")
+@Validated
+public class ProductTagController {
+
+    @Resource
+    private ProductTagService tagService;
+
+    @PostMapping("/create")
+    @Operation(summary = "创建商品标签")
+    @PreAuthorize("@ss.hasPermission('product:tag:create')")
+    public CommonResult<Long> createTag(@Valid @RequestBody ProductTagCreateReqVO createReqVO) {
+        return success(tagService.createTag(createReqVO));
+    }
+
+    @PutMapping("/update")
+    @Operation(summary = "更新商品标签")
+    @PreAuthorize("@ss.hasPermission('product:tag:update')")
+    public CommonResult<Boolean> updateTag(@Valid @RequestBody ProductTagUpdateReqVO updateReqVO) {
+        tagService.updateTag(updateReqVO);
+        return success(true);
+    }
+
+    @DeleteMapping("/delete")
+    @Operation(summary = "删除商品标签")
+    @Parameter(name = "id", description = "编号", required = true)
+    @PreAuthorize("@ss.hasPermission('product:tag:delete')")
+    public CommonResult<Boolean> deleteTag(@RequestParam("id") Long id) {
+        tagService.deleteTag(id);
+        return success(true);
+    }
+
+    @GetMapping("/get")
+    @Operation(summary = "获得商品标签")
+    @Parameter(name = "id", description = "编号", required = true, example = "1024")
+    @PreAuthorize("@ss.hasPermission('product:tag:query')")
+    public CommonResult<ProductTagRespVO> getProductTag(@RequestParam("id") Long id) {
+        ProductTagDO tag = tagService.getTag(id);
+        return success(ProductTagConvert.INSTANCE.convert(tag));
+    }
+
+    @GetMapping("/list-all-simple")
+    @Operation(summary = "获取商品标签精简信息列表", description = "只包含被开启的商品标签，主要用于前端的下拉选项")
+    public CommonResult<List<ProductTagRespVO>> getSimpleTagList() {
+        // 获用户列表，只要开启状态的
+        List<ProductTagDO> list = tagService.getTagList();
+        // 排序后，返回给前端
+        return success(ProductTagConvert.INSTANCE.convertList(list));
+    }
+
+    @GetMapping("/list")
+    @Operation(summary = "获得商品标签列表")
+    @Parameter(name = "ids", description = "编号列表", required = true, example = "1024,2048")
+    @PreAuthorize("@ss.hasPermission('product:tag:query')")
+    public CommonResult<List<ProductTagRespVO>> getProductTagList(@RequestParam("ids") Collection<Long> ids) {
+        List<ProductTagDO> list = tagService.getTagList(ids);
+        return success(ProductTagConvert.INSTANCE.convertList(list));
+    }
+
+    @GetMapping("/page")
+    @Operation(summary = "获得商品标签分页")
+    @PreAuthorize("@ss.hasPermission('product:tag:query')")
+    public CommonResult<PageResult<ProductTagRespVO>> getTagPage(@Valid ProductTagPageReqVO pageVO) {
+        PageResult<ProductTagDO> pageResult = tagService.getTagPage(pageVO);
+        return success(ProductTagConvert.INSTANCE.convertPage(pageResult));
+    }
+
+}

yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/tag/vo/ProductTagBaseVO.java

@@ -0,0 +1,23 @@
+package cn.iocoder.yudao.module.product.controller.admin.tag.vo;
+
+import io.swagger.v3.oas.annotations.media.Schema;
+import lombok.Data;
+
+import javax.validation.constraints.NotNull;
+
+/**
+ * 商品标签 Base VO，提供给添加、修改、详细的子 VO 使用
+ * 如果子 VO 存在差异的字段，请不要添加到这里，影响 Swagger 文档生成
+ */
+@Data
+public class ProductTagBaseVO {
+
+    @Schema(description = "标签名称", requiredMode = Schema.RequiredMode.REQUIRED, example = "电子产品")
+    @NotNull(message = "标签名称不能为空")
+    private String name;
+
+    @Schema(description = "状态", requiredMode = Schema.RequiredMode.REQUIRED, example = "1")
+    @NotNull(message = "状态不能为空")
+    private Integer status;
+
+}

yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/tag/vo/ProductTagCreateReqVO.java

@@ -0,0 +1,14 @@
+package cn.iocoder.yudao.module.product.controller.admin.tag.vo;
+
+import io.swagger.v3.oas.annotations.media.Schema;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.ToString;
+
+@Schema(description = "管理后台 - 商品标签创建 Request VO")
+@Data
+@EqualsAndHashCode(callSuper = true)
+@ToString(callSuper = true)
+public class ProductTagCreateReqVO extends ProductTagBaseVO {
+
+}

yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/tag/vo/ProductTagPageReqVO.java

@@ -0,0 +1,30 @@
+package cn.iocoder.yudao.module.product.controller.admin.tag.vo;
+
+import cn.iocoder.yudao.framework.common.pojo.PageParam;
+import io.swagger.v3.oas.annotations.media.Schema;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.ToString;
+import org.springframework.format.annotation.DateTimeFormat;
+
+import java.time.LocalDateTime;
+
+import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND;
+
+@Schema(description = "管理后台 - 商品标签分页 Request VO")
+@Data
+@EqualsAndHashCode(callSuper = true)
+@ToString(callSuper = true)
+public class ProductTagPageReqVO extends PageParam {
+
+    @Schema(description = "标签名称", example = "电子产品")
+    private String name;
+
+    @Schema(description = "状态", example = "1")
+    private Integer status;
+
+    @Schema(description = "创建时间")
+    @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND)
+    private LocalDateTime[] createTime;
+
+}

yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/tag/vo/ProductTagRespVO.java

@@ -0,0 +1,22 @@
+package cn.iocoder.yudao.module.product.controller.admin.tag.vo;
+
+import io.swagger.v3.oas.annotations.media.Schema;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.ToString;
+
+import java.time.LocalDateTime;
+
+@Schema(description = "管理后台 - 商品标签 Response VO")
+@Data
+@EqualsAndHashCode(callSuper = true)
+@ToString(callSuper = true)
+public class ProductTagRespVO extends ProductTagBaseVO {
+
+    @Schema(description = "编号", requiredMode = Schema.RequiredMode.REQUIRED, example = "1024")
+    private Long id;
+
+    @Schema(description = "创建时间", requiredMode = Schema.RequiredMode.REQUIRED)
+    private LocalDateTime createTime;
+
+}

yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/tag/vo/ProductTagUpdateReqVO.java

@@ -0,0 +1,20 @@
+package cn.iocoder.yudao.module.product.controller.admin.tag.vo;
+
+import io.swagger.v3.oas.annotations.media.Schema;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.ToString;
+
+import javax.validation.constraints.NotNull;
+
+@Schema(description = "管理后台 - 商品标签更新 Request VO")
+@Data
+@EqualsAndHashCode(callSuper = true)
+@ToString(callSuper = true)
+public class ProductTagUpdateReqVO extends ProductTagBaseVO {
+
+    @Schema(description = "编号", requiredMode = Schema.RequiredMode.REQUIRED, example = "1024")
+    @NotNull(message = "编号不能为空")
+    private Long id;
+
+}

yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/dal/dataobject/tag/ProductTagDO.java

@@ -0,0 +1,22 @@
+package cn.iocoder.yudao.module.product.dal.dataobject.tag;
+
+import cn.iocoder.yudao.framework.mybatis.core.dataobject.BaseDO;
+import com.baomidou.mybatisplus.annotation.TableId;
+import com.baomidou.mybatisplus.annotation.TableName;
+import lombok.*;
+
+@TableName("product_tag")
+@Data
+@EqualsAndHashCode(callSuper = true)
+@ToString(callSuper = true)
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+public class ProductTagDO extends BaseDO {
+
+    @TableId
+    private Long id;
+    private String name;
+    private Integer status;
+
+}

yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/dal/mysql/tag/ProductTagMapper.java

@@ -0,0 +1,23 @@
+package cn.iocoder.yudao.module.product.dal.mysql.tag;
+
+import cn.iocoder.yudao.framework.common.pojo.PageResult;
+import cn.iocoder.yudao.framework.mybatis.core.mapper.BaseMapperX;
+import cn.iocoder.yudao.framework.mybatis.core.query.LambdaQueryWrapperX;
+import cn.iocoder.yudao.module.product.controller.admin.tag.vo.ProductTagPageReqVO;
+import cn.iocoder.yudao.module.product.dal.dataobject.tag.ProductTagDO;
+import org.apache.ibatis.annotations.Mapper;
+
+@Mapper
+public interface ProductTagMapper extends BaseMapperX<ProductTagDO> {
+
+    default PageResult<ProductTagDO> selectPage(ProductTagPageReqVO reqVO) {
+        return selectPage(reqVO, new LambdaQueryWrapperX<ProductTagDO>()
+                .likeIfPresent(ProductTagDO::getName, reqVO.getName())
+                .eqIfPresent(ProductTagDO::getStatus, reqVO.getStatus())
+                .orderByDesc(ProductTagDO::getId));
+    }
+
+    default ProductTagDO selectByName(String name) {
+        return selectOne(ProductTagDO::getName, name);
+    }
+}

yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/service/tag/ProductTagService.java

@@ -0,0 +1,71 @@
+package cn.iocoder.yudao.module.product.service.tag;
+
+import cn.iocoder.yudao.framework.common.pojo.PageResult;
+import cn.iocoder.yudao.module.product.controller.admin.tag.vo.ProductTagCreateReqVO;
+import cn.iocoder.yudao.module.product.controller.admin.tag.vo.ProductTagPageReqVO;
+import cn.iocoder.yudao.module.product.controller.admin.tag.vo.ProductTagUpdateReqVO;
+import cn.iocoder.yudao.module.product.dal.dataobject.tag.ProductTagDO;
+
+import javax.validation.Valid;
+import java.util.Collection;
+import java.util.List;
+
+/**
+ * 商品标签 Service 接口
+ */
+public interface ProductTagService {
+
+    /**
+     * 创建商品标签
+     *
+     * @param createReqVO 创建信息
+     * @return 编号
+     */
+    Long createTag(@Valid ProductTagCreateReqVO createReqVO);
+
+    /**
+     * 更新商品标签
+     *
+     * @param updateReqVO 更新信息
+     */
+    void updateTag(@Valid ProductTagUpdateReqVO updateReqVO);
+
+    /**
+     * 删除商品标签
+     *
+     * @param id 编号
+     */
+    void deleteTag(Long id);
+
+    /**
+     * 获得商品标签
+     *
+     * @param id 编号
+     * @return 商品标签
+     */
+    ProductTagDO getTag(Long id);
+
+    /**
+     * 获得商品标签列表
+     *
+     * @param ids 编号
+     * @return 商品标签列表
+     */
+    List<ProductTagDO> getTagList(Collection<Long> ids);
+
+    /**
+     * 获得商品标签分页
+     *
+     * @param pageReqVO 分页查询
+     * @return 商品标签分页
+     */
+    PageResult<ProductTagDO> getTagPage(ProductTagPageReqVO pageReqVO);
+
+    /**
+     * 获取标签列表
+     *
+     * @return 标签列表
+     */
+    List<ProductTagDO> getTagList();
+
+}

yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/service/tag/ProductTagServiceImpl.java

@@ -0,0 +1,107 @@
+package cn.iocoder.yudao.module.product.service.tag;
+
+import cn.hutool.core.collection.CollUtil;
+import cn.hutool.core.collection.ListUtil;
+import cn.hutool.core.util.StrUtil;
+import cn.iocoder.yudao.framework.common.pojo.PageResult;
+import cn.iocoder.yudao.module.product.controller.admin.tag.vo.ProductTagCreateReqVO;
+import cn.iocoder.yudao.module.product.controller.admin.tag.vo.ProductTagPageReqVO;
+import cn.iocoder.yudao.module.product.controller.admin.tag.vo.ProductTagUpdateReqVO;
+import cn.iocoder.yudao.module.product.convert.tag.ProductTagConvert;
+import cn.iocoder.yudao.module.product.dal.dataobject.tag.ProductTagDO;
+import cn.iocoder.yudao.module.product.dal.mysql.tag.ProductTagMapper;
+import org.springframework.stereotype.Service;
+import org.springframework.validation.annotation.Validated;
+
+import javax.annotation.Resource;
+import java.util.Collection;
+import java.util.List;
+
+import static cn.iocoder.yudao.framework.common.exception.util.ServiceExceptionUtil.exception;
+import static cn.iocoder.yudao.module.product.enums.ErrorCodeConstants.*;
+
+@Service
+@Validated
+public class ProductTagServiceImpl implements ProductTagService {
+
+    @Resource
+    private ProductTagMapper productTagMapper;
+
+    @Override
+    public Long createTag(ProductTagCreateReqVO createReqVO) {
+        // 校验名称唯一
+        validateTagNameUnique(null, createReqVO.getName());
+        // 插入
+        ProductTagDO tag = ProductTagConvert.INSTANCE.convert(createReqVO);
+        productTagMapper.insert(tag);
+        // 返回
+        return tag.getId();
+    }
+
+    @Override
+    public void updateTag(ProductTagUpdateReqVO updateReqVO) {
+        // 校验存在
+        validateTagExists(updateReqVO.getId());
+        // 校验名称唯一
+        validateTagNameUnique(updateReqVO.getId(), updateReqVO.getName());
+        // 更新
+        ProductTagDO updateObj = ProductTagConvert.INSTANCE.convert(updateReqVO);
+        productTagMapper.updateById(updateObj);
+    }
+
+    @Override
+    public void deleteTag(Long id) {
+        // 校验存在
+        validateTagExists(id);
+        // 删除
+        productTagMapper.deleteById(id);
+    }
+
+    private void validateTagExists(Long id) {
+        if (productTagMapper.selectById(id) == null) {
+            throw exception(TAG_NOT_EXISTS);
+        }
+    }
+
+    private void validateTagNameUnique(Long id, String name) {
+        if (StrUtil.isBlank(name)) {
+            return;
+        }
+        ProductTagDO tag = productTagMapper.selectByName(name);
+        if (tag == null) {
+            return;
+        }
+
+        // 如果 id 为空，说明不用比较是否为相同 id 的标签
+        if (id == null) {
+            throw exception(TAG_NAME_EXISTS);
+        }
+        if (!tag.getId().equals(id)) {
+            throw exception(TAG_NAME_EXISTS);
+        }
+    }
+
+    @Override
+    public ProductTagDO getTag(Long id) {
+        return productTagMapper.selectById(id);
+    }
+
+    @Override
+    public List<ProductTagDO> getTagList(Collection<Long> ids) {
+        if (CollUtil.isEmpty(ids)) {
+            return ListUtil.empty();
+        }
+        return productTagMapper.selectBatchIds(ids);
+    }
+
+    @Override
+    public PageResult<ProductTagDO> getTagPage(ProductTagPageReqVO pageReqVO) {
+        return productTagMapper.selectPage(pageReqVO);
+    }
+
+    @Override
+    public List<ProductTagDO> getTagList() {
+        return productTagMapper.selectList();
+    }
+
+}

yudao-module-mall/yudao-module-product-biz/src/test/java/cn/iocoder/yudao/module/product/service/tag/ProductTagServiceImplTest.java

@@ -0,0 +1,122 @@
+package cn.iocoder.yudao.module.product.service.tag;
+
+import cn.iocoder.yudao.framework.common.pojo.PageResult;
+import cn.iocoder.yudao.framework.test.core.ut.BaseDbUnitTest;
+import cn.iocoder.yudao.module.product.controller.admin.tag.vo.ProductTagCreateReqVO;
+import cn.iocoder.yudao.module.product.controller.admin.tag.vo.ProductTagPageReqVO;
+import cn.iocoder.yudao.module.product.controller.admin.tag.vo.ProductTagUpdateReqVO;
+import cn.iocoder.yudao.module.product.dal.dataobject.tag.ProductTagDO;
+import cn.iocoder.yudao.module.product.dal.mysql.tag.ProductTagMapper;
+import org.junit.jupiter.api.Test;
+import org.springframework.context.annotation.Import;
+
+import javax.annotation.Resource;
+
+import static cn.iocoder.yudao.framework.common.util.date.LocalDateTimeUtils.buildBetweenTime;
+import static cn.iocoder.yudao.framework.common.util.date.LocalDateTimeUtils.buildTime;
+import static cn.iocoder.yudao.framework.common.util.object.ObjectUtils.cloneIgnoreId;
+import static cn.iocoder.yudao.framework.test.core.util.AssertUtils.assertPojoEquals;
+import static cn.iocoder.yudao.framework.test.core.util.AssertUtils.assertServiceException;
+import static cn.iocoder.yudao.framework.test.core.util.RandomUtils.randomLongId;
+import static cn.iocoder.yudao.framework.test.core.util.RandomUtils.randomPojo;
+import static cn.iocoder.yudao.module.product.enums.ErrorCodeConstants.TAG_NOT_EXISTS;
+import static org.junit.jupiter.api.Assertions.*;
+
+@Import(ProductTagServiceImpl.class)
+public class ProductTagServiceImplTest extends BaseDbUnitTest {
+
+    @Resource
+    private ProductTagServiceImpl tagService;
+
+    @Resource
+    private ProductTagMapper tagMapper;
+
+    @Test
+    public void testCreateTag_success() {
+        // 准备参数
+        ProductTagCreateReqVO reqVO = randomPojo(ProductTagCreateReqVO.class);
+
+        // 调用
+        Long tagId = tagService.createTag(reqVO);
+        // 断言
+        assertNotNull(tagId);
+        // 校验记录的属性是否正确
+        ProductTagDO tag = tagMapper.selectById(tagId);
+        assertPojoEquals(reqVO, tag);
+    }
+
+    @Test
+    public void testUpdateTag_success() {
+        // mock 数据
+        ProductTagDO dbTag = randomPojo(ProductTagDO.class);
+        tagMapper.insert(dbTag);// @Sql: 先插入出一条存在的数据
+        // 准备参数
+        ProductTagUpdateReqVO reqVO = randomPojo(ProductTagUpdateReqVO.class, o -> {
+            o.setId(dbTag.getId()); // 设置更新的 ID
+        });
+
+        // 调用
+        tagService.updateTag(reqVO);
+        // 校验是否更新正确
+        ProductTagDO tag = tagMapper.selectById(reqVO.getId()); // 获取最新的
+        assertPojoEquals(reqVO, tag);
+    }
+
+    @Test
+    public void testUpdateTag_notExists() {
+        // 准备参数
+        ProductTagUpdateReqVO reqVO = randomPojo(ProductTagUpdateReqVO.class);
+
+        // 调用, 并断言异常
+        assertServiceException(() -> tagService.updateTag(reqVO), TAG_NOT_EXISTS);
+    }
+
+    @Test
+    public void testDeleteTag_success() {
+        // mock 数据
+        ProductTagDO dbTag = randomPojo(ProductTagDO.class);
+        tagMapper.insert(dbTag);// @Sql: 先插入出一条存在的数据
+        // 准备参数
+        Long id = dbTag.getId();
+
+        // 调用
+        tagService.deleteTag(id);
+        // 校验数据不存在了
+        assertNull(tagMapper.selectById(id));
+    }
+
+    @Test
+    public void testDeleteTag_notExists() {
+        // 准备参数
+        Long id = randomLongId();
+
+        // 调用, 并断言异常
+        assertServiceException(() -> tagService.deleteTag(id), TAG_NOT_EXISTS);
+    }
+
+    @Test
+    public void testGetTagPage() {
+        // mock 数据
+        ProductTagDO dbTag = randomPojo(ProductTagDO.class, o -> { // 等会查询到
+            o.setName("test");
+            o.setCreateTime(buildTime(2023, 2, 18));
+        });
+        tagMapper.insert(dbTag);
+        // 测试 name 不匹配
+        tagMapper.insert(cloneIgnoreId(dbTag, o -> o.setName("ne")));
+        // 测试 createTime 不匹配
+        tagMapper.insert(cloneIgnoreId(dbTag, o -> o.setCreateTime(null)));
+        // 准备参数
+        ProductTagPageReqVO reqVO = new ProductTagPageReqVO();
+        reqVO.setName("test");
+        reqVO.setCreateTime(buildBetweenTime(2023, 2, 1, 2023, 2, 28));
+
+        // 调用
+        PageResult<ProductTagDO> pageResult = tagService.getTagPage(reqVO);
+        // 断言
+        assertEquals(1, pageResult.getTotal());
+        assertEquals(1, pageResult.getList().size());
+        assertPojoEquals(dbTag, pageResult.getList().get(0));
+    }
+
+}