码农知识堂 - 1000bd
  •   Python
  •   PHP
  •   JS/TS
  •   JAVA
  •   C/C++
  •   C#
  •   GO
  •   Kotlin
  •   Swift

  • Spring Boot 实现字段唯一校验

    目录

    1 Maven依赖

    2 实现代码

    2.1 UniqueCheck

    2.2 UniqueCheckDetail

    2.3 UniqueCheckArgs

    2.4 UniqueCheckService 

    2.5 AbstractUniqueCheckService

    3 调试代码

    3.1 UserCheckArgs 

    3.2 UserUniqueCheckVo 

    3.3 UserUniqueCheckService 

    3.4 UniqueCheckEnum 

    3.5 单元测试代码

    4 调试结果

     注：

    1 Maven依赖

    1.         
    2.         <dependency>
    3.             <groupId>org.apache.commonsgroupId>
    4.             <artifactId>commons-lang3artifactId>
    5.             <version>3.9version>
    6.         dependency>

    2 实现代码

    2.1 UniqueCheck

    1. package com.xudongbase.uniquecheck.annotation;
    2.  
    3. import java.lang.annotation.ElementType;
    4. import java.lang.annotation.Retention;
    5. import java.lang.annotation.RetentionPolicy;
    6. import java.lang.annotation.Target;
    7.  
    8. /**
    9.  * 在指定的字段用此注解
    10.  * 用来唯一校验
    11.  *
    12.  * @author xudongmaster
    13.  */
    14. @Target({ElementType.FIELD})
    15. @Retention(RetentionPolicy.RUNTIME)
    16. public @interface UniqueCheck {
    17.     /**
    18.      * 字段的中文名
    19.      *
    20.      * @return
    21.      */
    22.     String cnName();
    23.  
    24.     /**
    25.      * 提示
    26.      *
    27.      * @return
    28.      */
    29.     String tip() default "存在重复";
    30. }

    2.2 UniqueCheckDetail

    1. package com.xudongbase.uniquecheck;
    2.  
    3. import lombok.Builder;
    4. import lombok.Data;
    5.  
    6. /**
    7.  * 唯一校验明细信息
    8.  *
    9.  * @author xudongmaster
    10.  */
    11. @Data
    12. @Builder
    13. public class UniqueCheckDetail {
    14.     /**
    15.      * 字段中文名
    16.      */
    17.    private String fileCnName;
    18.     /**
    19.      * 提示
    20.      */
    21.    private String tip;
    22. }

    2.3 UniqueCheckArgs

    1. package com.xudongbase.uniquecheck.args;
    2.  
    3. /**
    4.  * 唯一校验参数类
    5.  *
    6.  * @author xudongmaster
    7.  */
    8. public interface UniqueCheckArgs {
    9. }

    2.4 UniqueCheckService 

    1. package com.xudongbase.uniquecheck;
    2.  
    3.  
    4. import com.xudongbase.uniquecheck.args.UniqueCheckArgs;
    5.  
    6. import java.util.List;
    7.  
    8. /**
    9.  * 唯一校验类
    10.  *
    11.  * @author xudongmaster
    12.  */
    13. public interface UniqueCheckService {
    14.     /**
    15.      * 唯一校验
    16.      *
    17.      * @param args
    18.      * @return
    19.      */
    20.     List uniqueCheck(UniqueCheckArgs args);
    21. }

    2.5 AbstractUniqueCheckService

    1. package com.xudongbase.uniquecheck;
    2.  
    3. import cn.hutool.core.collection.CollUtil;
    4. import com.google.common.collect.Lists;
    5. import com.xudongbase.uniquecheck.annotation.UniqueCheck;
    6. import com.xudongbase.uniquecheck.args.UniqueCheckArgs;
    7. import org.apache.commons.lang3.reflect.FieldUtils;
    8.  
    9. import java.lang.reflect.Field;
    10. import java.util.List;
    11.  
    12. /**
    13.  * 抽象唯一校验类
    14.  *
    15.  * @author xudongmaster
    16.  */
    17. public abstract class AbstractUniqueCheckService implements UniqueCheckService {
    18.  
    19.     /**
    20.      * 唯一校验
    21.      *
    22.      * @param args
    23.      * @return
    24.      */
    25.     @Override
    26.     public List uniqueCheck(UniqueCheckArgs args) {
    27.         //获取用来校验的数据
    28.         List dataList = getCheckData(args);
    29.         //进行唯一校验
    30.         return implementsUniqueCheck(dataList, args);
    31.     }
    32.  
    33.     /**
    34.      * 获取用来校验的数据
    35.      *
    36.      * @param args 传参
    37.      * @return
    38.      */
    39.     abstract List getCheckData(UniqueCheckArgs args);
    40.  
    41.     /**
    42.      * 需要实现的唯一校验
    43.      *
    44.      * @param dataList 用来校验的数据
    45.      * @param args     传参
    46.      * @return
    47.      */
    48.     abstract List implementsUniqueCheck(List dataList, UniqueCheckArgs args);
    49.  
    50.  
    51.     /**
    52.      * 通用唯一校验方法
    53.      *
    54.      * @param dataList         用来校验的数据
    55.      * @param needUniqueTarget 需要校验的对象
    56.      * @return
    57.      */
    58.     public static  List commonUniqueCheck(List dataList, T needUniqueTarget) {
    59.         List uniqueCheckDetailList = Lists.newLinkedList();
    60.         if (CollUtil.isEmpty(dataList) || needUniqueTarget == null) {
    61.             return uniqueCheckDetailList;
    62.         }
    63.         Class clazz = needUniqueTarget.getClass();
    64.         //获取需要进行唯一校验的字段
    65.         List fieldList = FieldUtils.getFieldsListWithAnnotation(clazz, UniqueCheck.class);
    66.         if (CollUtil.isEmpty(fieldList)) {
    67.             return uniqueCheckDetailList;
    68.         }
    69.         List checkFieldValueList;
    70.         Object needUniqueFieldValue;
    71.         Object checkFieldValue;
    72.         UniqueCheckDetail uniqueCheckDetail;
    73.         UniqueCheck uniqueCheck;
    74.         for (Field field : fieldList) {
    75.             field.setAccessible(true);
    76.             checkFieldValueList = Lists.newLinkedList();
    77.             needUniqueFieldValue = null;
    78.             //获取需要校验的字段值
    79.             try {
    80.                 needUniqueFieldValue = field.get(needUniqueTarget);
    81.             } catch (Exception e) {
    82.             }
    83.             if (needUniqueFieldValue == null) {
    84.                 continue;
    85.             }
    86.             Object filterNeedUniqueFieldValue = needUniqueFieldValue;
    87.             //获取用来校验的对象的字段值
    88.             for (T data : dataList) {
    89.                 checkFieldValue = null;
    90.                 try {
    91.                     checkFieldValue = field.get(data);
    92.                 } catch (Exception e) {
    93.                 }
    94.                 if (checkFieldValue == null) {
    95.                     continue;
    96.                 }
    97.                 checkFieldValueList.add(checkFieldValue);
    98.             }
    99.             if (CollUtil.isEmpty(checkFieldValueList)) {
    100.                 continue;
    101.             }
    102.             //存在重复的字段值
    103.             if (checkFieldValueList.stream().filter(x -> x.equals(filterNeedUniqueFieldValue)).count() > 0) {
    104.                 uniqueCheck = field.getAnnotation(UniqueCheck.class);
    105.                 uniqueCheckDetail = UniqueCheckDetail.builder()
    106.                         .fileCnName(uniqueCheck.cnName())
    107.                         .tip(uniqueCheck.cnName() + uniqueCheck.tip()).build();
    108.                 uniqueCheckDetailList.add(uniqueCheckDetail);
    109.             }
    110.         }
    111.         return uniqueCheckDetailList;
    112.     }
    113. }
      114.  

      3 调试代码
       

      3.1 UserCheckArgs 
       

      1. package com.xudongbase.uniquecheck.args;
      2.  
      3. import com.xudongbase.uniquecheck.vo.UserUniqueCheckVo;
      4. import lombok.Data;
      5.  
      6. /**
      7.  * 用户唯一校验参数类
      8.  *
      9.  * @author xudongmaster
      10.  */
      11. @Data
      12. public class UserCheckArgs implements UniqueCheckArgs {
      13.     /**
      14.      * 需要进行唯一校验的用户信息
      15.      */
      16.     private UserUniqueCheckVo needUniqueTarget;
      17. }
       

      3.2 UserUniqueCheckVo 
       

      1. package com.xudongbase.uniquecheck.vo;
      2.  
      3. import com.xudongbase.uniquecheck.annotation.UniqueCheck;
      4. import lombok.Data;
      5.  
      6. /**
      7.  * 用户唯一校验vo
      8.  *
      9.  * @author xudongmaster
      10.  */
      11. @Data
      12. public class UserUniqueCheckVo {
      13.     @UniqueCheck(cnName = "用户id")
      14.     private Long id;
      15.  
      16.     /**
      17.      * 用户名
      18.      */
      19.     @UniqueCheck(cnName = "用户名")
      20.     private String username;
      21. }
       

      3.3 UserUniqueCheckService 
       

      1. package com.xudongbase.uniquecheck;
      2.  
      3. import com.google.common.collect.Lists;
      4. import com.xudongbase.uniquecheck.args.UniqueCheckArgs;
      5. import com.xudongbase.uniquecheck.args.UserCheckArgs;
      6. import com.xudongbase.uniquecheck.vo.UserUniqueCheckVo;
      7. import org.springframework.stereotype.Service;
      8.  
      9. import java.util.List;
      10.  
      11. /**
      12.  * 用户唯一校验类
      13.  *
      14.  * @author xudongmaster
      15.  */
      16. @Service("UserUniqueCheckService")
      17. public class UserUniqueCheckService extends AbstractUniqueCheckService {
      18.  
      19.     /**
      20.      * 获取用来校验的数据
      21.      *
      22.      * @param args 传参
      23.      * @return
      24.      */
      25.     @Override
      26.     List getCheckData(UniqueCheckArgs args) {
      27.         List userUniqueCheckVoList=Lists.newLinkedList();
      28.         UserUniqueCheckVo userUniqueCheckVo=new UserUniqueCheckVo();
      29.         userUniqueCheckVo.setId(1L);
      30.         userUniqueCheckVo.setUsername("xudongmaster");
      31.         userUniqueCheckVoList.add(userUniqueCheckVo);
      32.         return userUniqueCheckVoList;
      33.     }
      34.  
      35.  
      36.     /**
      37.      * 需要实现的唯一校验
      38.      *
      39.      * @param dataList 用来校验的数据
      40.      * @param args     传参
      41.      * @return
      42.      */
      43.     @Override
      44.     List implementsUniqueCheck(List dataList, UniqueCheckArgs args) {
      45.         UserCheckArgs userCheckArgs = (UserCheckArgs) args;
      46.         UserUniqueCheckVo needUniqueTarget = userCheckArgs.getNeedUniqueTarget();
      47.         return commonUniqueCheck(dataList, needUniqueTarget);
      48.     }
      49.  
      50. }
       

      3.4 UniqueCheckEnum 
       

      1. package com.xudongbase.uniquecheck.enums;
      2.  
      3. import lombok.AllArgsConstructor;
      4. import lombok.Getter;
      5.  
      6. /**
      7.  * 唯一校验实例枚举类
      8.  *
      9.  * @author Xudongmaster
      10.  */
      11. @Getter
      12. @AllArgsConstructor
      13. public enum UniqueCheckEnum {
      14.     USER("UserUniqueCheckService", "用户唯一校验");
      15.     private final String value;
      16.     private final String name;
      17.  
      18. }
       

      3.5 单元测试代码
       

      1. package com.xudongbase.uniquecheck;
      2.  
      3. import com.alibaba.fastjson.JSONObject;
      4. import com.google.gson.JsonObject;
      5. import com.xudongbase.uniquecheck.args.UserCheckArgs;
      6. import com.xudongbase.uniquecheck.enums.UniqueCheckEnum;
      7. import com.xudongbase.uniquecheck.vo.UserUniqueCheckVo;
      8. import lombok.extern.slf4j.Slf4j;
      9. import org.junit.jupiter.api.Test;
      10. import org.springframework.beans.factory.annotation.Autowired;
      11. import org.springframework.boot.test.context.SpringBootTest;
      12.  
      13. import java.util.List;
      14. import java.util.Map;
      15.  
      16. @SpringBootTest
      17. @Slf4j
      18. public class UniqueCheckTest {
      19.     @Autowired
      20.     private Map uniqueCheckServiceMap;
      21.  
      22.     /**
      23.      * 测试用户唯一校验
      24.      */
      25.     @Test
      26.     public void testUserUniqueCheck() {
      27.         UserCheckArgs userCheckArgs = new UserCheckArgs();
      28.         UserUniqueCheckVo userUniqueCheckVo = new UserUniqueCheckVo();
      29.         userUniqueCheckVo.setId(2L);
      30.         userUniqueCheckVo.setUsername("xudongmaster");
      31.         userCheckArgs.setNeedUniqueTarget(userUniqueCheckVo);
      32.         List uniqueCheckDetailList = uniqueCheckServiceMap.get(UniqueCheckEnum.USER.getValue()).uniqueCheck(userCheckArgs);
      33.         log.info(JSONObject.toJSONString(uniqueCheckDetailList));
      34.     }
      35.  
      36. }
       

      4 调试结果
       

       

       注：
       

      觉得这篇博客写的不错的可以前往Gitee/GitCode点个Star，源码请查看Gitee/GitCode的xudongbase项目unique_check分支。 
       

      文件 · unique_check · 旭东怪 / Xudongbase · GitCode主要是项目中可以用到的共通方法，现有easyexcel分支在持续更新中。 欢迎大家Star和提交Issues。 easyexcel分支：批量设置样式，批量添加批注，批量合并单元格，设置冻结行和列，设置行高列宽，隐藏行和列，绑定下拉框数据，设置水印，插入图片https://gitcode.net/qq_38974638/xudongbase/-/tree/unique_checkxudongbase: 主要是项目中可以用到的共通方法，现有easyexcel分支在持续更新中。欢迎大家Star和提交Issues。easyexcel分支：批量设置样式，批量添加批注，批量合并单元格，设置冻结行和列，设置行高列宽，隐藏行和列，绑定下拉框数据，设置水印，插入图片 - Gitee.comhttps://gitee.com/xudong_master/xudongbase/tree/unique_check
      
                
                    
                

                
    114. 

                    相关阅读:
      
                    
智慧风电 | 图扑软件数字孪生风机设备，3D 可视化智能运维                            
      
Go学习笔记 -- fmt常用打印方法及占位符介绍                            
      
数据库实践 Hw05                            
      
2023最新SSM计算机毕业设计选题大全（附源码+LW）之java宠物寄养平台设计03zp5                            
      
HTML做一个简单漂亮的旅游网页（纯html代码）重庆旅游 7页                            
      
Apache解析漏洞实验                            
      
【学习总结】Python transformers AutoTokenizer encode 出现的 101 和 102                            
      
微软宣布 S2C2F 已被 OpenSSF 采用                            
      
Django报错：RuntimeError at /home/ 解决办法                            
      
腾讯云轻量数据库是什么？轻量数据库测评详细介绍                            
      
                          
                
      115. 
                
    115. 
                    原文地址：https://blog.csdn.net/qq_38974638/article/details/126336186
                
      116. 

            
        

        
      
            
        
                
      • 
                    最新文章
                
        • 
                
      • 
                    
攻防演习之三天拿下官网站群                            
        
数据安全治理学习——前期安全规划和安全管理体系建设                            
        
企业安全 | 企业内一次钓鱼演练准备过程                            
        
内网渗透测试 | Kerberos协议及其部分攻击手法                            
        
0day的产生 | 不懂代码的"代码审计"                            
        
安装scrcpy-client模块av模块异常，环境问题解决方案                            
        
leetcode hot100【LeetCode 279. 完全平方数】java实现                            
        
OpenWrt下安装Mosquitto                            
        
AnatoMask论文汇总                            
        
【AI日记】24.11.01 LangChain、openai api和github copilot                            
        
                            
                
        • 
            
      

            
        
                
      • 
                    热门文章
                
        • 
                
      • 
                    
十款代码表白小特效 一个比一个浪漫 赶紧收藏起来吧！！！                            
        
奉劝各位学弟学妹们，该打造你的技术影响力了！                            
        
五年了，我在 CSDN 的两个一百万。                            
        
Java俄罗斯方块，老程序员花了一个周末，连接中学年代！                            
        
面试官都震惊，你这网络基础可以啊！                            
        
你真的会用百度吗？我不信 — 那些不为人知的搜索引擎语法                            
        
心情不好的时候，用 Python 画棵樱花树送给自己吧                            
        
通宵一晚做出来的一款类似CS的第一人称射击游戏Demo！原来做游戏也不是很难，连憨憨学妹都学会了！                            
        
13 万字 C 语言从入门到精通保姆级教程2021 年版                            
        
10行代码集2000张美女图，Python爬虫120例，再上征途                            
        
                            
                
        • 
            
      

        
      
    




    
    
    
    

      
    
      
        
      
            
      
                
      
                    Copyright © 2022 侵权请联系2656653265@qq.com   
                    京ICP备2022015340号-1
                
      
                
      
                    正则表达式工具
                    cron表达式工具
                    密码生成工具
                
      
                
      
                    
                    
      京公网安备 11010502049817号