黑名单

This commit is contained in:
Owen 2025-01-06 23:47:13 +08:00
parent 05d3849c58
commit 6268aa1d86
13 changed files with 637 additions and 1 deletions

View File

@ -44,5 +44,5 @@ public interface ErrorCodeConstants {
ErrorCode SUPERIOR_API_LOG_NOT_EXISTS = new ErrorCode(1_823_003_005, "订单接口记录不存在");
ErrorCode BLACK_LIST_NOT_EXISTS = new ErrorCode(1_824_003_005, "黑名单不存在");
}

View File

@ -0,0 +1,95 @@
package cn.iocoder.yudao.module.haoka.controller.admin.blacklist;
import org.springframework.web.bind.annotation.*;
import jakarta.annotation.Resource;
import org.springframework.validation.annotation.Validated;
import org.springframework.security.access.prepost.PreAuthorize;
import io.swagger.v3.oas.annotations.tags.Tag;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.Operation;
import jakarta.validation.constraints.*;
import jakarta.validation.*;
import jakarta.servlet.http.*;
import java.util.*;
import java.io.IOException;
import cn.iocoder.yudao.framework.common.pojo.PageParam;
import cn.iocoder.yudao.framework.common.pojo.PageResult;
import cn.iocoder.yudao.framework.common.pojo.CommonResult;
import cn.iocoder.yudao.framework.common.util.object.BeanUtils;
import static cn.iocoder.yudao.framework.common.pojo.CommonResult.success;
import cn.iocoder.yudao.framework.excel.core.util.ExcelUtils;
import cn.iocoder.yudao.framework.apilog.core.annotation.ApiAccessLog;
import static cn.iocoder.yudao.framework.apilog.core.enums.OperateTypeEnum.*;
import cn.iocoder.yudao.module.haoka.controller.admin.blacklist.vo.*;
import cn.iocoder.yudao.module.haoka.dal.dataobject.blacklist.BlackListDO;
import cn.iocoder.yudao.module.haoka.service.blacklist.BlackListService;
@Tag(name = "管理后台 - 黑名单")
@RestController
@RequestMapping("/haoka/black-list")
@Validated
public class BlackListController {
@Resource
private BlackListService blackListService;
@PostMapping("/create")
@Operation(summary = "创建黑名单")
@PreAuthorize("@ss.hasPermission('haoka:black-list:create')")
public CommonResult<Long> createBlackList(@Valid @RequestBody BlackListSaveReqVO createReqVO) {
return success(blackListService.createBlackList(createReqVO));
}
@PutMapping("/update")
@Operation(summary = "更新黑名单")
@PreAuthorize("@ss.hasPermission('haoka:black-list:update')")
public CommonResult<Boolean> updateBlackList(@Valid @RequestBody BlackListSaveReqVO updateReqVO) {
blackListService.updateBlackList(updateReqVO);
return success(true);
}
@DeleteMapping("/delete")
@Operation(summary = "删除黑名单")
@Parameter(name = "id", description = "编号", required = true)
@PreAuthorize("@ss.hasPermission('haoka:black-list:delete')")
public CommonResult<Boolean> deleteBlackList(@RequestParam("id") Long id) {
blackListService.deleteBlackList(id);
return success(true);
}
@GetMapping("/get")
@Operation(summary = "获得黑名单")
@Parameter(name = "id", description = "编号", required = true, example = "1024")
@PreAuthorize("@ss.hasPermission('haoka:black-list:query')")
public CommonResult<BlackListRespVO> getBlackList(@RequestParam("id") Long id) {
BlackListDO blackList = blackListService.getBlackList(id);
return success(BeanUtils.toBean(blackList, BlackListRespVO.class));
}
@GetMapping("/page")
@Operation(summary = "获得黑名单分页")
@PreAuthorize("@ss.hasPermission('haoka:black-list:query')")
public CommonResult<PageResult<BlackListRespVO>> getBlackListPage(@Valid BlackListPageReqVO pageReqVO) {
PageResult<BlackListDO> pageResult = blackListService.getBlackListPage(pageReqVO);
return success(BeanUtils.toBean(pageResult, BlackListRespVO.class));
}
@GetMapping("/export-excel")
@Operation(summary = "导出黑名单 Excel")
@PreAuthorize("@ss.hasPermission('haoka:black-list:export')")
@ApiAccessLog(operateType = EXPORT)
public void exportBlackListExcel(@Valid BlackListPageReqVO pageReqVO,
HttpServletResponse response) throws IOException {
pageReqVO.setPageSize(PageParam.PAGE_SIZE_NONE);
List<BlackListDO> list = blackListService.getBlackListPage(pageReqVO).getList();
// 导出 Excel
ExcelUtils.write(response, "黑名单.xls", "数据", BlackListRespVO.class,
BeanUtils.toBean(list, BlackListRespVO.class));
}
}

View File

@ -0,0 +1,34 @@
package cn.iocoder.yudao.module.haoka.controller.admin.blacklist.vo;
import lombok.*;
import java.util.*;
import io.swagger.v3.oas.annotations.media.Schema;
import cn.iocoder.yudao.framework.common.pojo.PageParam;
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 BlackListPageReqVO extends PageParam {
@Schema(description = "运营商")
private Integer operation;
@Schema(description = "收货地址电话")
private String addressPhone;
@Schema(description = "身份证")
private String personIdCard;
@Schema(description = "部门ID", example = "21276")
private Long deptId;
@Schema(description = "创建时间")
@DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND)
private LocalDateTime[] createTime;
}

View File

@ -0,0 +1,42 @@
package cn.iocoder.yudao.module.haoka.controller.admin.blacklist.vo;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.*;
import java.util.*;
import org.springframework.format.annotation.DateTimeFormat;
import java.time.LocalDateTime;
import com.alibaba.excel.annotation.*;
import cn.iocoder.yudao.framework.excel.core.annotations.DictFormat;
import cn.iocoder.yudao.framework.excel.core.convert.DictConvert;
@Schema(description = "管理后台 - 黑名单 Response VO")
@Data
@ExcelIgnoreUnannotated
public class BlackListRespVO {
@Schema(description = "ID", requiredMode = Schema.RequiredMode.REQUIRED, example = "19320")
@ExcelProperty("ID")
private Long id;
@Schema(description = "运营商")
@ExcelProperty(value = "运营商", converter = DictConvert.class)
@DictFormat("haoka_operator") // TODO 代码优化建议设置到对应的 DictTypeConstants 枚举类中
private Integer operation;
@Schema(description = "收货地址电话", requiredMode = Schema.RequiredMode.REQUIRED)
@ExcelProperty("收货地址电话")
private String addressPhone;
@Schema(description = "身份证", requiredMode = Schema.RequiredMode.REQUIRED)
@ExcelProperty("身份证")
private String personIdCard;
@Schema(description = "部门ID", example = "21276")
@ExcelProperty("部门ID")
private Long deptId;
@Schema(description = "创建时间", requiredMode = Schema.RequiredMode.REQUIRED)
@ExcelProperty("创建时间")
private LocalDateTime createTime;
}

View File

@ -0,0 +1,29 @@
package cn.iocoder.yudao.module.haoka.controller.admin.blacklist.vo;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.*;
import java.util.*;
import jakarta.validation.constraints.*;
@Schema(description = "管理后台 - 黑名单新增/修改 Request VO")
@Data
public class BlackListSaveReqVO {
@Schema(description = "ID", requiredMode = Schema.RequiredMode.REQUIRED, example = "19320")
private Long id;
@Schema(description = "运营商")
private Integer operation;
@Schema(description = "收货地址电话", requiredMode = Schema.RequiredMode.REQUIRED)
@NotEmpty(message = "收货地址电话不能为空")
private String addressPhone;
@Schema(description = "身份证", requiredMode = Schema.RequiredMode.REQUIRED)
@NotEmpty(message = "身份证不能为空")
private String personIdCard;
@Schema(description = "部门ID", example = "21276")
private Long deptId;
}

View File

@ -0,0 +1,49 @@
package cn.iocoder.yudao.module.haoka.dal.dataobject.blacklist;
import lombok.*;
import java.util.*;
import java.time.LocalDateTime;
import java.time.LocalDateTime;
import com.baomidou.mybatisplus.annotation.*;
import cn.iocoder.yudao.framework.mybatis.core.dataobject.BaseDO;
/**
* 黑名单 DO
*
* @author 超级管理员
*/
@TableName("haoka_black_list")
@KeySequence("haoka_black_list_seq") // 用于 OraclePostgreSQLKingbaseDB2H2 数据库的主键自增如果是 MySQL 等数据库可不写
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)
@Builder
@NoArgsConstructor
@AllArgsConstructor
public class BlackListDO extends BaseDO {
/**
* ID
*/
@TableId
private Long id;
/**
* 运营商
*
* 枚举 {@link TODO haoka_operator 对应的类}
*/
private Integer operation;
/**
* 收货地址电话
*/
private String addressPhone;
/**
* 身份证
*/
private String personIdCard;
/**
* 部门ID
*/
private Long deptId;
}

View File

@ -0,0 +1,30 @@
package cn.iocoder.yudao.module.haoka.dal.mysql.blacklist;
import java.util.*;
import cn.iocoder.yudao.framework.common.pojo.PageResult;
import cn.iocoder.yudao.framework.mybatis.core.query.LambdaQueryWrapperX;
import cn.iocoder.yudao.framework.mybatis.core.mapper.BaseMapperX;
import cn.iocoder.yudao.module.haoka.dal.dataobject.blacklist.BlackListDO;
import org.apache.ibatis.annotations.Mapper;
import cn.iocoder.yudao.module.haoka.controller.admin.blacklist.vo.*;
/**
* 黑名单 Mapper
*
* @author 超级管理员
*/
@Mapper
public interface BlackListMapper extends BaseMapperX<BlackListDO> {
default PageResult<BlackListDO> selectPage(BlackListPageReqVO reqVO) {
return selectPage(reqVO, new LambdaQueryWrapperX<BlackListDO>()
.eqIfPresent(BlackListDO::getOperation, reqVO.getOperation())
.eqIfPresent(BlackListDO::getAddressPhone, reqVO.getAddressPhone())
.eqIfPresent(BlackListDO::getPersonIdCard, reqVO.getPersonIdCard())
.eqIfPresent(BlackListDO::getDeptId, reqVO.getDeptId())
.betweenIfPresent(BlackListDO::getCreateTime, reqVO.getCreateTime())
.orderByDesc(BlackListDO::getId));
}
}

View File

@ -0,0 +1,55 @@
package cn.iocoder.yudao.module.haoka.service.blacklist;
import java.util.*;
import jakarta.validation.*;
import cn.iocoder.yudao.module.haoka.controller.admin.blacklist.vo.*;
import cn.iocoder.yudao.module.haoka.dal.dataobject.blacklist.BlackListDO;
import cn.iocoder.yudao.framework.common.pojo.PageResult;
import cn.iocoder.yudao.framework.common.pojo.PageParam;
/**
* 黑名单 Service 接口
*
* @author 超级管理员
*/
public interface BlackListService {
/**
* 创建黑名单
*
* @param createReqVO 创建信息
* @return 编号
*/
Long createBlackList(@Valid BlackListSaveReqVO createReqVO);
/**
* 更新黑名单
*
* @param updateReqVO 更新信息
*/
void updateBlackList(@Valid BlackListSaveReqVO updateReqVO);
/**
* 删除黑名单
*
* @param id 编号
*/
void deleteBlackList(Long id);
/**
* 获得黑名单
*
* @param id 编号
* @return 黑名单
*/
BlackListDO getBlackList(Long id);
/**
* 获得黑名单分页
*
* @param pageReqVO 分页查询
* @return 黑名单分页
*/
PageResult<BlackListDO> getBlackListPage(BlackListPageReqVO pageReqVO);
}

View File

@ -0,0 +1,74 @@
package cn.iocoder.yudao.module.haoka.service.blacklist;
import org.springframework.stereotype.Service;
import jakarta.annotation.Resource;
import org.springframework.validation.annotation.Validated;
import org.springframework.transaction.annotation.Transactional;
import java.util.*;
import cn.iocoder.yudao.module.haoka.controller.admin.blacklist.vo.*;
import cn.iocoder.yudao.module.haoka.dal.dataobject.blacklist.BlackListDO;
import cn.iocoder.yudao.framework.common.pojo.PageResult;
import cn.iocoder.yudao.framework.common.pojo.PageParam;
import cn.iocoder.yudao.framework.common.util.object.BeanUtils;
import cn.iocoder.yudao.module.haoka.dal.mysql.blacklist.BlackListMapper;
import static cn.iocoder.yudao.framework.common.exception.util.ServiceExceptionUtil.exception;
import static cn.iocoder.yudao.module.haoka.enums.ErrorCodeConstants.*;
/**
* 黑名单 Service 实现类
*
* @author 超级管理员
*/
@Service
@Validated
public class BlackListServiceImpl implements BlackListService {
@Resource
private BlackListMapper blackListMapper;
@Override
public Long createBlackList(BlackListSaveReqVO createReqVO) {
// 插入
BlackListDO blackList = BeanUtils.toBean(createReqVO, BlackListDO.class);
blackListMapper.insert(blackList);
// 返回
return blackList.getId();
}
@Override
public void updateBlackList(BlackListSaveReqVO updateReqVO) {
// 校验存在
validateBlackListExists(updateReqVO.getId());
// 更新
BlackListDO updateObj = BeanUtils.toBean(updateReqVO, BlackListDO.class);
blackListMapper.updateById(updateObj);
}
@Override
public void deleteBlackList(Long id) {
// 校验存在
validateBlackListExists(id);
// 删除
blackListMapper.deleteById(id);
}
private void validateBlackListExists(Long id) {
if (blackListMapper.selectById(id) == null) {
throw exception(BLACK_LIST_NOT_EXISTS);
}
}
@Override
public BlackListDO getBlackList(Long id) {
return blackListMapper.selectById(id);
}
@Override
public PageResult<BlackListDO> getBlackListPage(BlackListPageReqVO pageReqVO) {
return blackListMapper.selectPage(pageReqVO);
}
}

View File

@ -0,0 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="cn.iocoder.yudao.module.haoka.dal.mysql.blacklist.BlackListMapper">
<!--
一般情况下,尽可能使用 Mapper 进行 CRUD 增删改查即可。
无法满足的场景,例如说多表关联查询,才使用 XML 编写 SQL。
代码生成器暂时只生成 Mapper XML 文件本身,更多推荐 MybatisX 快速开发插件来生成查询。
文档可见https://www.iocoder.cn/MyBatis/x-plugins/
-->
</mapper>

View File

@ -0,0 +1,146 @@
package cn.iocoder.yudao.module.haoka.service.blacklist;
import org.junit.jupiter.api.Disabled;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.mock.mockito.MockBean;
import jakarta.annotation.Resource;
import cn.iocoder.yudao.framework.test.core.ut.BaseDbUnitTest;
import cn.iocoder.yudao.module.haoka.controller.admin.blacklist.vo.*;
import cn.iocoder.yudao.module.haoka.dal.dataobject.blacklist.BlackListDO;
import cn.iocoder.yudao.module.haoka.dal.mysql.blacklist.BlackListMapper;
import cn.iocoder.yudao.framework.common.pojo.PageResult;
import jakarta.annotation.Resource;
import org.springframework.context.annotation.Import;
import java.util.*;
import java.time.LocalDateTime;
import static cn.hutool.core.util.RandomUtil.*;
import static cn.iocoder.yudao.module.haoka.enums.ErrorCodeConstants.*;
import static cn.iocoder.yudao.framework.test.core.util.AssertUtils.*;
import static cn.iocoder.yudao.framework.test.core.util.RandomUtils.*;
import static cn.iocoder.yudao.framework.common.util.date.LocalDateTimeUtils.*;
import static cn.iocoder.yudao.framework.common.util.object.ObjectUtils.*;
import static cn.iocoder.yudao.framework.common.util.date.DateUtils.*;
import static org.junit.jupiter.api.Assertions.*;
import static org.mockito.Mockito.*;
/**
* {@link BlackListServiceImpl} 的单元测试类
*
* @author 超级管理员
*/
@Import(BlackListServiceImpl.class)
public class BlackListServiceImplTest extends BaseDbUnitTest {
@Resource
private BlackListServiceImpl blackListService;
@Resource
private BlackListMapper blackListMapper;
@Test
public void testCreateBlackList_success() {
// 准备参数
BlackListSaveReqVO createReqVO = randomPojo(BlackListSaveReqVO.class).setId(null);
// 调用
Long blackListId = blackListService.createBlackList(createReqVO);
// 断言
assertNotNull(blackListId);
// 校验记录的属性是否正确
BlackListDO blackList = blackListMapper.selectById(blackListId);
assertPojoEquals(createReqVO, blackList, "id");
}
@Test
public void testUpdateBlackList_success() {
// mock 数据
BlackListDO dbBlackList = randomPojo(BlackListDO.class);
blackListMapper.insert(dbBlackList);// @Sql: 先插入出一条存在的数据
// 准备参数
BlackListSaveReqVO updateReqVO = randomPojo(BlackListSaveReqVO.class, o -> {
o.setId(dbBlackList.getId()); // 设置更新的 ID
});
// 调用
blackListService.updateBlackList(updateReqVO);
// 校验是否更新正确
BlackListDO blackList = blackListMapper.selectById(updateReqVO.getId()); // 获取最新的
assertPojoEquals(updateReqVO, blackList);
}
@Test
public void testUpdateBlackList_notExists() {
// 准备参数
BlackListSaveReqVO updateReqVO = randomPojo(BlackListSaveReqVO.class);
// 调用, 并断言异常
assertServiceException(() -> blackListService.updateBlackList(updateReqVO), BLACK_LIST_NOT_EXISTS);
}
@Test
public void testDeleteBlackList_success() {
// mock 数据
BlackListDO dbBlackList = randomPojo(BlackListDO.class);
blackListMapper.insert(dbBlackList);// @Sql: 先插入出一条存在的数据
// 准备参数
Long id = dbBlackList.getId();
// 调用
blackListService.deleteBlackList(id);
// 校验数据不存在了
assertNull(blackListMapper.selectById(id));
}
@Test
public void testDeleteBlackList_notExists() {
// 准备参数
Long id = randomLongId();
// 调用, 并断言异常
assertServiceException(() -> blackListService.deleteBlackList(id), BLACK_LIST_NOT_EXISTS);
}
@Test
@Disabled // TODO 请修改 null 为需要的值然后删除 @Disabled 注解
public void testGetBlackListPage() {
// mock 数据
BlackListDO dbBlackList = randomPojo(BlackListDO.class, o -> { // 等会查询到
o.setOperation(null);
o.setAddressPhone(null);
o.setPersonIdCard(null);
o.setDeptId(null);
o.setCreateTime(null);
});
blackListMapper.insert(dbBlackList);
// 测试 operation 不匹配
blackListMapper.insert(cloneIgnoreId(dbBlackList, o -> o.setOperation(null)));
// 测试 addressPhone 不匹配
blackListMapper.insert(cloneIgnoreId(dbBlackList, o -> o.setAddressPhone(null)));
// 测试 personIdCard 不匹配
blackListMapper.insert(cloneIgnoreId(dbBlackList, o -> o.setPersonIdCard(null)));
// 测试 deptId 不匹配
blackListMapper.insert(cloneIgnoreId(dbBlackList, o -> o.setDeptId(null)));
// 测试 createTime 不匹配
blackListMapper.insert(cloneIgnoreId(dbBlackList, o -> o.setCreateTime(null)));
// 准备参数
BlackListPageReqVO reqVO = new BlackListPageReqVO();
reqVO.setOperation(null);
reqVO.setAddressPhone(null);
reqVO.setPersonIdCard(null);
reqVO.setDeptId(null);
reqVO.setCreateTime(buildBetweenTime(2023, 2, 1, 2023, 2, 28));
// 调用
PageResult<BlackListDO> pageResult = blackListService.getBlackListPage(reqVO);
// 断言
assertEquals(1, pageResult.getTotal());
assertEquals(1, pageResult.getList().size());
assertPojoEquals(dbBlackList, pageResult.getList().get(0));
}
}

View File

@ -0,0 +1,15 @@
DROP TABLE IF EXISTS `haoka_black_list`;
CREATE TABLE `haoka_black_list`
(
`id` bigint(20) NOT NULL PRIMARY KEY COMMENT 'ID',
`operation` int(11) COMMENT '运营商',
`address_phone` varchar(512) NOT NULL COMMENT '收货地址电话',
`person_id_card` varchar(512) NOT NULL COMMENT '身份证',
`dept_id` bigint(20) COMMENT '部门ID',
`creator` varchar(64) NOT NULL DEFAULT '' COMMENT '创建者',
`create_time` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
`updater` varchar(64) NOT NULL DEFAULT '' COMMENT '更新者',
`update_time` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '更新时间',
`deleted` bit(1) NOT NULL DEFAULT b'0' COMMENT '是否删除',
`tenant_id` bigint(20) NOT NULL DEFAULT 0 COMMENT '租户编号'
) COMMENT = '黑名单';

View File

@ -0,0 +1,55 @@
-- 菜单 SQL
INSERT INTO system_menu(
name, permission, type, sort, parent_id,
path, icon, component, status, component_name
)
VALUES (
'黑名单管理', '', 2, 0, 2912,
'black-list', '', 'haoka/blacklist/index', 0, 'BlackList'
);
-- 按钮父菜单ID
-- 暂时只支持 MySQL。如果你是 Oracle、PostgreSQL、SQLServer 的话,需要手动修改 @parentId 的部分的代码
SELECT @parentId := LAST_INSERT_ID();
-- 按钮 SQL
INSERT INTO system_menu(
name, permission, type, sort, parent_id,
path, icon, component, status
)
VALUES (
'黑名单查询', 'haoka:black-list:query', 3, 1, @parentId,
'', '', '', 0
);
INSERT INTO system_menu(
name, permission, type, sort, parent_id,
path, icon, component, status
)
VALUES (
'黑名单创建', 'haoka:black-list:create', 3, 2, @parentId,
'', '', '', 0
);
INSERT INTO system_menu(
name, permission, type, sort, parent_id,
path, icon, component, status
)
VALUES (
'黑名单更新', 'haoka:black-list:update', 3, 3, @parentId,
'', '', '', 0
);
INSERT INTO system_menu(
name, permission, type, sort, parent_id,
path, icon, component, status
)
VALUES (
'黑名单删除', 'haoka:black-list:delete', 3, 4, @parentId,
'', '', '', 0
);
INSERT INTO system_menu(
name, permission, type, sort, parent_id,
path, icon, component, status
)
VALUES (
'黑名单导出', 'haoka:black-list:export', 3, 5, @parentId,
'', '', '', 0
);