• No9.【spring-cloud-alibaba】添加字典业务，这一模块就是纯业务

    PigUserDetailsService  代码地址与接口文档看总目录：【学习笔记】记录冷冷-pig项目的学习过程，大概包括Authorization Server、springcloud、Mybatis Plus~~~_清晨敲代码的博客-CSDN博客

    终于结束从零搭建springcloud的部分了，目前也仅仅是学习了最最基本的逻辑，同时包含了开发系统的一些基本的逻辑。接下来就按照 pig 文档将其余基本的内容再熟悉一下，看一遍和写一遍真的不一样呐~~~

    那接下来就一小模块一小模块的学习啦，加油吧少年！

    本文及以后的文章还是基于前面的No6系列文章开发的，可以看之前文章顶部的内容总结，简单了解详情~

    目录

    A1.添加字典功能

    B1.步骤

    B2.编码

    B3.测试

    遇到的问题：

    1.基础增删改查需要判断是否存在

    2.增删改查业务添加一个同意逻辑处理模块

    A1.添加字典功能

    字典，又分为字典和字典项，每个字典项属于某一个字典，每个字典有多个字典项。这样前端就可以根据字典拿到字典项。

    获取到的字典的属性，要尽可能适用于前端的组件，方便前端使用。

    B1.步骤

    首先，我们需要提供一个字典的增删改查功能，然后再提供一个字典项的增删改查功能，同时字典项必须要关联一个字典，并且字典项要有值和标签，值对应业务操作，标签对应用户展示。

     由于没有复杂业务，所以不需要关联表操作，不需要写 mapper 语句~

    B2.编码

    确定好数据结构之后，一定要先写接口文档，梳理编码逻辑！

    1.新建两个数据表，一个字典sys_dict，一个字典项sys_dict_item，设置 id 自增；

    2.新建表对应的实体类，要设置 mps 的id自增，和逻辑删除注解；

    3.新建 mapper 接口，继承 mps 的 BaseMapper ，不需要新增方法；

    4.新建 service 接口及实现类，继承 mps 的 IService、IServiceImpl ；

    5.新建 controller 类，编写接口端点方法，并确定好需要调用的 service 方法；

    【我习惯了解数据接口和接口文档后，就针对他们编写 controller 中的接口端点，然后再编写 service 业务方法】

    6.有些复杂的业务需要增加业务方法，所以修改 service 类，编写 controller 需要的方法；

    1. -- 1.新建两个数据表，一个字典sys_dict，一个字典项sys_dict_item，设置 id 自增；
    2.  
    3. CREATE TABLE `sys_dict` (
    4.   `id` bigint(20) NOT NULL AUTO_INCREMENT,
    5.   `dict_type` varchar(100) DEFAULT NULL COMMENT '标识',
    6.   `description` varchar(100) DEFAULT NULL COMMENT '描述',
    7.   `remark` varchar(255) DEFAULT NULL COMMENT '备注',
    8.   `system_flag` char(1) DEFAULT '0' COMMENT '是否是系统内置',
    9.   `del_flag` char(1) DEFAULT '0' COMMENT '删除标记',
    10.   `create_time` datetime DEFAULT NULL COMMENT '创建时间',
    11.   `create_by` varchar(64) DEFAULT NULL COMMENT '创建人',
    12.   `update_by` varchar(64) DEFAULT NULL COMMENT '更新人',
    13.   `update_time` datetime DEFAULT NULL COMMENT '更新时间',
    14.   PRIMARY KEY (`id`) USING BTREE,
    15.   KEY `sys_dict_del_flag` (`del_flag`) USING BTREE
    16. ) ENGINE=InnoDB AUTO_INCREMENT=10 DEFAULT CHARSET=utf8mb4 COMMENT='字典表'
    17.  
    18. CREATE TABLE `sys_dict_item` (
    19.   `id` bigint(20) NOT NULL AUTO_INCREMENT,
    20.   `dict_id` bigint(20) NOT NULL COMMENT '字典ID',
    21.   `dict_type` varchar(100) DEFAULT NULL COMMENT '字典标识',
    22.   `value` varchar(100) DEFAULT NULL COMMENT '值',
    23.   `label` varchar(100) DEFAULT NULL COMMENT '标签',
    24.   `description` varchar(100) DEFAULT NULL COMMENT '描述',
    25.   `sort_order` int(11) NOT NULL DEFAULT '0' COMMENT '排序（升序）',
    26.   `remark` varchar(255) DEFAULT ' ' COMMENT '备注',
    27.   `del_flag` char(1) DEFAULT '0' COMMENT '删除标记',
    28.   `create_time` datetime DEFAULT NULL COMMENT '创建时间',
    29.   `create_by` varchar(64) DEFAULT NULL COMMENT '创建人',
    30.   `update_by` varchar(64) DEFAULT NULL COMMENT '修改人',
    31.   `update_time` datetime DEFAULT NULL COMMENT '更新时间',
    32.   PRIMARY KEY (`id`) USING BTREE,
    33.   KEY `sys_dict_value` (`value`) USING BTREE,
    34.   KEY `sys_dict_label` (`label`) USING BTREE,
    35.   KEY `sys_dict_del_flag` (`del_flag`) USING BTREE
    36. ) ENGINE=InnoDB AUTO_INCREMENT=33 DEFAULT CHARSET=utf8mb4 COMMENT='字典项'
    1. //2.新建表对应的实体类，要设置 mps 的id自增，和逻辑删除注解；
    2.  
    3. //新增
    4. com.pig4cloud.pig.admin.api.entity.SysDict extends BaseEntity
    5. com.pig4cloud.pig.admin.api.entity.SysDictItem extends BaseEntity
    1. //3.新建 mapper 接口，继承 mps 的 BaseMapper ，不需要新增方法；
    2.  
    3. @Mapper
    4. public interface SysDictMapper extends BaseMapper {
    5. }
    6.  
    7. @Mapper
    8. public interface SysDictItemMapper extends BaseMapper {
    9. }
    1. //4.新建 service 接口及实现类，继承 mps 的 IService、IServiceImpl ；
    2.  
    3. public class SysDictServiceImpl extends ServiceImpl implements SysDictService {
    4. }
    5.  
    6. public class SysDictItemServiceImpl extends ServiceImpl implements SysDictItemService {
    7. }
    1. //5.新建 controller 类，编写接口端点方法，并确定好需要调用的 service 方法；
    2.  
    3. //其中只有两个更新和两个删除的需要重写对应的 service 方法，因为需要判断是否能删除，并且涉及到关联删除~
    4. //其余的使用 mps 提供的 service 方法就行
    5.  
    6. @RestController
    7. @RequestMapping("/dict")
    8. @RequiredArgsConstructor
    9. public class DictController {
    10.  
    11.     private final SysDictService sysDictService;
    12.  
    13.     private final SysDictItemService sysDictItemService;
    14.  
    15.     /**
    16.      * @Description: 添加
    17.      * @param: [dict]
    18.      * @return: com.pig4cloud.pig.common.core.util.R
    19.      **/
    20.     @SysLog("添加字典")
    21.     @PostMapping
    22.     @PreAuthorize("@pms.hasPermission('sys_dict_add')")
    23.     public R save(@RequestBody SysDict dict) {
    24.  
    25.         //标签必须唯一，先判断是否已存在
    26.         SysDict sysDict = sysDictService.getOne(Wrappers.lambdaQuery().eq(SysDict::getDictType, dict.getDictType()));
    27.         if ( sysDict != null){
    28.             return R.failed("标签已存在");
    29.         }
    30.  
    31.         return R.ok(sysDictService.save(dict));
    32.     }
    33.  
    34.  
    35.     /**
    36.      * @Description: 分页查询字典
    37.      * @param: [page, dict]
    38.      * @return: com.pig4cloud.pig.common.core.util.R>
    39.      **/
    40.     @SysLog("分页查询字典")
    41.     @GetMapping("/page")
    42.     @PreAuthorize("@pms.hasPermission('sys_dict_list')")
    43.     public R> getPage(Page page, SysDict dict) {
    44.  
    45.         LambdaQueryWrapper wrapper = Wrappers.lambdaQuery();
    46.         wrapper.eq(SysDict::getDelFlag, CommonConstants.NOT_DELETE);
    47.  
    48.         if(StrUtil.isNotBlank(dict.getDictType())){
    49.             wrapper.like(SysDict::getDictType, dict.getDictType());
    50.         }
    51.         if(StrUtil.isNotBlank(dict.getDictType())){
    52.             wrapper.like(SysDict::getSystemFlag, dict.getSystemFlag());
    53.         }
    54.  
    55.         return R.ok(sysDictService.page(page, wrapper));
    56.     }
    57.  
    58.     /**
    59.      * @Description: 通过ID查询字典
    60.      * @param: [id]
    61.      * @return: com.pig4cloud.pig.common.core.util.R
    62.      **/
    63.     @SysLog("通过ID查询字典")
    64.     @GetMapping("/{id}")
    65.     public R getById(@PathVariable Long id) {
    66.         return R.ok(sysDictService.getById(id));
    67.     }
    68.  
    69.     /**
    70.      * @Description: 添加
    71.      * @param: [dictItem]
    72.      * @return: com.pig4cloud.pig.common.core.util.R
    73.      **/
    74.     @SysLog("添加字典项")
    75.     @PostMapping("/item")
    76.     public R save(@RequestBody SysDictItem dictItem) {
    77.  
    78.         //value 必须唯一，先判断当前字典中是否已存在该 value
    79.         SysDictItem sysDictItem = sysDictItemService.getOne(
    80.                 Wrappers.lambdaQuery().eq(SysDictItem::getDictType, dictItem.getDictType()).eq(SysDictItem::getValue, dictItem.getValue()));
    81.         if ( sysDictItem != null){
    82.             return R.failed("值已存在");
    83.         }
    84.  
    85.         return R.ok(sysDictItemService.save(dictItem));
    86.     }
    87.  
    88.  
    89.     /**
    90.      * @Description: 分页查询某个字典的字典项
    91.      * @param: [page, dictItem]
    92.      * @return: com.pig4cloud.pig.common.core.util.R>
    93.      **/
    94.     @SysLog("分页查询某个字典的字典项")
    95.     @GetMapping("/item/page")
    96.     @PreAuthorize("@pms.hasPermission('sys_dictItem_list')")
    97.     public R> getDictItemPage(Page page, SysDictItem dictItem) {
    98.         return R.ok(sysDictItemService.page(page,
    99.                 Wrappers.lambdaQuery().eq(SysDictItem::getDictType, dictItem.getDictType())
    100.                         .eq(SysDictItem::getDelFlag, CommonConstants.NOT_DELETE)));
    101.     }
    102.  
    103.     /**
    104.      * @Description: 通过ID查询字典项
    105.      * @param: [id]
    106.      * @return: com.pig4cloud.pig.common.core.util.R
    107.      **/
    108.     @SysLog("通过ID查询字典项")
    109.     @GetMapping("/item/{id}")
    110.     public R getDictItemById(@PathVariable Long id) {
    111.         return R.ok(sysDictItemService.getById(id));
    112.     }
    113.  
    114.     /**
    115.      * @Description: 通过字典标识查找字典项
    116.      * @param: [type]
    117.      * @return: com.pig4cloud.pig.common.core.util.R>
    118.      **/
    119.     @GetMapping("/dictType/{dictType}")
    120.     public R> getDictByType(@PathVariable String dictType) {
    121.         return R.ok(sysDictItemService.list(
    122.                 Wrappers.query().lambda().eq(SysDictItem::getDictType, dictType).eq(SysDictItem::getDelFlag, CommonConstants.NOT_DELETE)));
    123.     }
    124. }
    1. //6.有些复杂的业务需要增加业务方法，所以修改 service 类，编写 controller 需要的方法；
    2.  
    3. @Service
    4. @RequiredArgsConstructor
    5. public class SysDictServiceImpl extends ServiceImpl implements SysDictService {
    6.  
    7.     private final SysDictItemMapper dictItemMapper;
    8.  
    9.  
    10.     @Override
    11.     public Boolean updateDict(SysDict sysDict) {
    12.         //1.先拿到对应的存储的信息
    13.         SysDict dict = this.getById(sysDict.getId());
    14.  
    15.         // 判断是不是系统内置的，如果是则抛异常不能修改
    16.         if(!DictTypeEnum.SYSTEM.getType().equals(dict.getSystemFlag())){
    17.             throw new RuntimeException("系统内置字典不能修改");
    18.         }
    19.  
    20.         //不是系统内置，则进行修改
    21.         this.updateById(sysDict);
    22.  
    23.         return Boolean.TRUE;
    24.     }
    25.  
    26.     @Override
    27.     public Boolean deleteDict(Long id) {
    28.         //先拿到对应的存储的信息
    29.         SysDict dict = this.getById(id);
    30.         // 判断是不是系统内置的，如果是则抛异常不能删除
    31.         if(!DictTypeEnum.SYSTEM.getType().equals(dict.getSystemFlag())){
    32.             throw new RuntimeException("系统内置字典不允许删除");
    33.         }
    34.         //不是系统内置，则进行修改
    35.         baseMapper.deleteById(id);
    36.         //同时删除字典项
    37.         dictItemMapper.delete(Wrappers.lambdaQuery().eq(SysDictItem::getDictId, id));
    38.  
    39.         return Boolean.TRUE;
    40.     }
    41.  
    42.  
    43. }
    44.  
    45. @Service
    46. @RequiredArgsConstructor
    47. public class SysDictItemServiceImpl extends ServiceImpl implements SysDictItemService {
    48.  
    49.     private final SysDictService dictService;
    50.  
    51.     @Override
    52.     public Boolean updateDictItem(SysDictItem dictItem) {
    53.         //先获取字典的系统内置信息
    54.         SysDict dict = dictService.getById(dictItem.getDictId());
    55.  
    56.         // 判断是不是系统内置的，如果是则抛异常不能修改
    57.         if(!DictTypeEnum.SYSTEM.getType().equals(dict.getSystemFlag())){
    58.             throw new RuntimeException("系统内置字典不能修改");
    59.         }
    60.         //不是系统内置，则进行修改
    61.         this.updateById(dictItem);
    62.  
    63.         return Boolean.TRUE;
    64.     }
    65.  
    66.     @Override
    67.     public Boolean deleteDictItem(Long id) {
    68.         // 先根据ID查询字典ID
    69.         SysDictItem dictItem = this.getById(id);
    70.         //再获取字典的系统内置信息
    71.         SysDict dict = dictService.getById(dictItem.getDictId());
    72.  
    73.         // 判断是不是系统内置的，如果是则抛异常不能修改
    74.         if(!DictTypeEnum.SYSTEM.getType().equals(dict.getSystemFlag())){
    75.             throw new RuntimeException("系统内置字典不允许删除");
    76.         }
    77.         this.removeById(id);
    78.  
    79.         return Boolean.TRUE;
    80.     }
    81. }
    82.  
    83. @RestController
    84. @RequestMapping("/dict")
    85. @RequiredArgsConstructor
    86. public class DictController {
    87.  
    88.     private final SysDictService sysDictService;
    89.  
    90.     private final SysDictItemService sysDictItemService;
    91.  
    92.  
    93.     /**
    94.      * @Description: 修改
    95.      * @param: [dict]
    96.      * @return: com.pig4cloud.pig.common.core.util.R
    97.      **/
    98.     @SysLog("修改字典")
    99.     @PutMapping
    100.     @PreAuthorize("@pms.hasPermission('sys_dict_update')")
    101.     public R update(@RequestBody SysDict dict) {
    102.  
    103.         //标签必须唯一，先判断是否已存在未删除的、该标签
    104.         SysDict sysDict = sysDictService.getOne(Wrappers.lambdaQuery().eq(SysDict::getDictType, dict.getDictType()).ne(SysDict::getId, dict.getId()));
    105.         if ( sysDict != null){
    106.             return R.failed("标签已存在");
    107.         }
    108.  
    109.         return R.ok(sysDictService.updateDict(dict));
    110.     }
    111.  
    112.     /**
    113.      * @Description: 删除
    114.      * @param: [dict]
    115.      * @return: com.pig4cloud.pig.common.core.util.R
    116.      **/
    117.     @SysLog("删除字典")
    118.     @DeleteMapping("/{id:\\d+}")
    119.     @PreAuthorize("@pms.hasPermission('sys_dict_del')")
    120.     public R deleteDictById(@PathVariable Long id) {
    121.         return R.ok(sysDictService.deleteDict(id));
    122.     }
    123.  
    124.  
    125.     /**
    126.      * @Description: 修改
    127.      * @param: [dictItem]
    128.      * @return: com.pig4cloud.pig.common.core.util.R
    129.      **/
    130.     @SysLog("修改字典项")
    131.     @PutMapping("/item")
    132.     public R update(@RequestBody SysDictItem dictItem) {
    133.  
    134.         //value 必须唯一，先判断当前字典中是否已存在该 value
    135.         SysDictItem sysDictItem = sysDictItemService.getOne(
    136.                 Wrappers.lambdaQuery().eq(SysDictItem::getDictType, dictItem.getDictType()).eq(SysDictItem::getValue, dictItem.getValue()).ne(SysDictItem::getId, dictItem.getId()));
    137.         if ( sysDictItem != null){
    138.             return R.failed("值已存在");
    139.         }
    140.  
    141.         return R.ok(sysDictItemService.updateDictItem(dictItem));
    142.     }
    143.  
    144.     /**
    145.      * @Description: 删除
    146.      * @param: [id]
    147.      * @return: com.pig4cloud.pig.common.core.util.R
    148.      **/
    149.     @SysLog("删除字典项")
    150.     @DeleteMapping("/item/{id:\\d+}")
    151.     public R deleteDictItemById(@PathVariable Long id) {
    152.         return R.ok(sysDictItemService.deleteDictItem(id));
    153.     }
    154.  
    155. }

    B3.测试

    然后就按照 api 接口测试吧，后面要学一下 api 自动化测试~ 

    遇到的问题：

    1.基础增删改查需要判断是否存在

    对于普通的单表，增删改查的业务中，如果遇到非正常操作怎么办？

    例如，单表中有唯一数据时，改中要校验唯一数据是否存在(自己本身包含不算)。如果入参的 id 不存在或者已删除怎么办？还需要修改么？

    从单账号操作的设计上来说，不会出现这种情况，毕竟操作的数据一定是未删除的。但是如果是多账号使用时，就会多个帐号同时删除此条数据，总有一个人成功，而其余人会失败，失败的人也要收到反馈信息。

    此时的反馈信息不应该是 500 报错的。

    看下图，我用多个线程来调用删除字典的操作，就有一个报错了，虽然最终的数据是对的。

    原因是 controller 里面的判断，他通过，但是 service 里面再获取时就获取到了 null。所以还是要处理一下该异常。

    新建一个业务异常处理类，然后可以在此处用 try catch 异常并抛出新增的业务异常处理类。

    1. @Slf4j
    2. @Order(10000)
    3. @RestControllerAdvice
    4. @ConditionalOnExpression("!'${security.oauth2.client.clientId}'.isEmpty()")
    5. public class GlobalBizExceptionHandler {
    6.  
    7. 	/**
    8. 	 * 全局异常.
    9. 	 * @param e the e
    10. 	 * @return R
    11. 	 */
    12. 	@ExceptionHandler(Exception.class)
    13. 	@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    14. 	public R handleGlobalException(Exception e) {
    15. 		log.error("全局异常信息 ex={}", e.getMessage(), e);
    16.  
    17. 		// 业务异常交由 sentinel 记录
    18. 		Tracer.trace(e);
    19. 		return R.failed(e.getLocalizedMessage());
    20. 	}
    21.  
    22. }

     这样就不会报错 500 了

     

    2.增删改查业务添加一个同意逻辑处理模块

    写这一块儿的时候，总是修修改改，写某个接口时总感觉逻辑缺少，所以，整理一个基础的单表增删改查逻辑，方便开发理解。

    开个新文章，到时粘个链接~

  • 相关阅读:
    CSS3自定义滚动条的颜色等样式 - hover显示切换 - 伪类::-webkit-scrollbar的样式控制
    Linux 网络虚拟化 Macvlan(基于物理网络接口虚拟网络接口) 认知
    如何依据环境试验标准开展试验？
    jQuery 选择器
    河北邯郸：拓展基层就业空间 助力高校毕业生就业
    java 处理树形结构数据
    Tauri 2.0.0 beta环境搭建
    【JavaEE初阶】多线程 _ 基础篇 _ 线程池（案例四）
    远距离双目视觉测量系统纵深方向测量精度较低原因分析
    LVS(Linux Virtual Server)集群,(1)NAT模式
  • 原文地址：https://blog.csdn.net/vaevaevae233/article/details/127789564