当前位置:

首页 > 编程开发 > SpringBoot中通用工具类库(Utils)封装与使用实践

SpringBoot中通用工具类库(Utils)封装与使用实践

SpringBoot项目中封装通用工具类库,涵盖空值判断、日期时间处理、JSON序列化、加密解密、线程上下文、国际化及网络工具等核心功能,通过统一静态方法调用减少重复代码,提升开发效率,并支持灵活扩展与集成,适用于各类业务场景。

本文目录

    一、涉及的技术知识点

    在实际的SpringBoot项目里,工具类库的封装几乎是每个团队都会遇到的命题。一套设计得当的工具类,能显著减少重复代码,让业务逻辑更清爽。下面我们就从几个核心维度来拆解常见的封装思路。

    1.1 空值判断与防御性编程

    知识点说明
    多类型空值判断对 String/Collection/Map/Array/Optional/Object 统一判空
    可变参数(varargs)isOrEmpty(Object...) 任一为空返回 true,isAndEmpty(Object...) 全部为空返回 true
    Null Safety替代手写 != null && !"" 链式判断

    1.2 日期时间处理

    知识点说明
    ja va.util.Date(旧 API)DateUtil 基于旧 API 兼容存量代码
    ja va.time.LocalDate/LocalDateTime(新 API)DateTimeUtil 基于 Ja va 8 时间 API
    智能日期解析根据字符串长度自动识别格式(10位时间戳/13位时间戳/19位标准格式/23位含毫秒)
    正则模式匹配用正则判断日期字符串格式(标准 yyyy-MM-dd/斜杠 yyyy/MM/dd)
    TemporalAdjusters获取月初/月末/年初/年末/上月/下月等时间点
    时区枚举ZoneEnums 定义时区常量
    日期格式枚举DateTimeFormat 枚举统一管理 20+ 种日期格式

    1.3 JSON 序列化/反序列化

    知识点说明
    Jackson ObjectMapper配置好的全局单例,线程安全
    TypeReference 泛型反序列化解决 Ja va 泛型擦除问题
    Snake Case 支持snakeMapper 自动驼峰 ↔ 下划线转换
    容错处理序列化/反序列化异常不抛出,返回 null 并记录日志

    1.4 加密工具

    知识点说明
    AES 对称加密AesUtil 提供简单的 AES 加解密(ECB 模式)
    MD5 摘要Md5Utils 提供 MD5 哈希(签名校验场景)
    ThreadLocal MessageDigestMD5 计算使用 ThreadLocal 避免多线程竞争
    Hex 编码字节数组转十六进制字符串

    1.5 线程上下文管理

    知识点说明
    ThreadLocalAuth2SessionIdUtil 使用 ThreadLocal 存储请求级别的用户信息
    Token 传递在请求处理链中透传 OAuth2 Token
    请求级隔离每个请求有独立的 sessionId/token/loginName
    清理机制delete() 方法清理 ThreadLocal 防止内存泄漏

    1.6 国际化(i18n)

    知识点说明
    MessageSourceSpring 国际化消息源
    资源文件messages.properties / messages_zh_CN.properties
    参数化消息getMsg(key, args...) 支持占位符

    1.7 网络工具

    知识点说明
    客户端 IP 获取从 X-Forwarded-For / X-Real-IP 等 Header 解析
    内网 IP 判断isIntranetIp() 判断是否为 10.x/172.16-31.x/192.168.x
    主机名获取getHostName() 获取当前服务器主机名
    ThreadLocal IP请求级别缓存客户端 IP

    二、包结构

    xxx.xxx.xxx.utils
    ├── CheckEmptyUtil.ja va          // 空值判断工具(使用频率最高)
    ├── DateUtil.ja va                // 日期工具(旧API,ja va.util.Date)
    ├── StringUtil.ja va              // 字符串/JSON工具(序列化+特殊字符处理)
    ├── JsonUtil.ja va                // JSON 序列化工具(支持 Snake Case)
    ├── Auth2SessionIdUtil.ja va      // OAuth2 会话上下文(ThreadLocal)
    ├── IpUtil.ja va                  // IP 地址工具
    ├── AesUtil.ja va                 // AES 加解密工具
    ├── Md5Utils.ja va                // MD5 摘要工具
    ├── xxxI18nUtil.ja va             // 国际化消息工具
    ├── FileUtil.ja va                // 文件操作工具
    ├── JasperUtil.ja va              // 报表导出工具(Jasper)
    ├── PdfUtil.ja va                 // PDF 生成工具
    ├── ClassNameUtil.ja va           // 类名处理工具
    ├── xxxSerializationUtils.ja va   // Ja va 序列化工具
    ├── PackageUtil.ja va             // 包扫描工具
    ├── UrlUtil.ja va                 // URL 处理工具
    ├── cloud/
    │   ├── AdapterHeader.ja va       // 适配器 Header 工具
    │   └── LoginToken.ja va          // 登录 Token 封装
    └── time/
        ├── DateTimeUtil.ja va        // 日期时间工具(新API,ja va.time)
        ├── DateTimeFormat.ja va      // 日期格式枚举(20+种预定义格式)
        ├── DateTimeConverter.ja va   // 日期转换器
        └── ZoneEnums.ja va           // 时区枚举
    

    无 spring.factories:纯工具类库,不涉及自动配置,直接引入静态方法调用。

    SpringBoot中通用工具类库(Utils)封装与使用实践

    三、通用示例代码

    3.1 CheckEmptyUtil(空值判断工具)

    package com.example.utils;
    
    import ja va.lang.reflect.Array;
    import ja va.util.Collection;
    import ja va.util.Map;
    import ja va.util.Optional;
    
    /**
     * 通用空值判断工具.
     * 统一处理各种类型的空值判断,替代业务代码中的 != null && !isEmpty() 链式判断.
     * 
     * 支持类型:
     * - null
     * - String(空字符串)
     * - Collection(空集合)
     * - Map(空Map)
     * - Array(空数组)
     * - Optional(空Optional)
     * - 其他 Object(仅判null)
     */
    public class CheckEmptyUtil {
    
        /**
         * 判断对象是否为空.
         * 根据实际类型自动选择判空策略.
         */
        public static boolean isEmpty(Object obj) {
            if (obj == null) {
                return true;
            }
            if (obj instanceof String) {
                return ((String) obj).trim().isEmpty();
            }
            if (obj instanceof Collection) {
                return ((Collection) obj).isEmpty();
            }
            if (obj instanceof Map) {
                return ((Map) obj).isEmpty();
            }
            if (obj.getClass().isArray()) {
                return Array.getLength(obj) == 0;
            }
            if (obj instanceof Optional) {
                return !((Optional) obj).isPresent();
            }
            return false;
        }
    
        /**
         * 判断对象是否非空.
         */
        public static boolean isNotEmpty(Object obj) {
            return !isEmpty(obj);
        }
    
        /**
         * 任一参数为空返回true.
         * 常用于参数校验:if (isOrEmpty(a, b)) throw ...
         */
        public static boolean isOrEmpty(Object... objs) {
            if (objs == null) {
                return true;
            }
            for (Object obj : objs) {
                if (isEmpty(obj)) {
                    return true;
                }
            }
            return false;
        }
    
        /**
         * 全部参数都为空返回true.
         * 常用于条件判断:if (isAndEmpty(a, b)) 都没传
         */
        public static boolean isAndEmpty(Object... objs) {
            if (objs == null) {
                return true;
            }
            for (Object obj : objs) {
                if (isNotEmpty(obj)) {
                    return false;
                }
            }
            return true;
        }
    }
    

    3.2 DateUtil(旧版日期工具)

    package com.example.utils;
    
    import ja va.text.SimpleDateFormat;
    import ja va.util.Calendar;
    import ja va.util.Date;
    import ja va.util.regex.Pattern;
    
    /**
     * 日期工具类(基于 ja va.util.Date).
     * 
     * 核心特性:
     * 1. 智能日期解析 - 根据字符串格式自动识别
     * 2. 常用日期操作 - 月初/月末/日始/日终
     * 3. 日期格式化 - 标准格式输出
     */
    public class DateUtil {
    
        private static final Pattern UNIX_TIMESTAMP = Pattern.compile("^\d{10}$");
        private static final Pattern JA VA_TIMESTAMP = Pattern.compile("^\d{13}$");
        private static final String STANDARD_DATETIME = "yyyy-MM-dd HH:mm:ss";
        private static final String STANDARD_DATE = "yyyy-MM-dd";
    
        /**
         * 智能日期解析.
         * 支持:时间戳(10位/13位)、标准格式、斜杠格式.
         * 
         * @param text 日期字符串
         * @return Date 对象,解析失败返回 null
         */
        public static Date convertToDate(String text) {
            if (text == null || text.trim().isEmpty()) {
                return null;
            }
            text = text.trim();
            try {
                switch (text.length()) {
                    case 10:
                        // Unix 时间戳 或 yyyy-MM-dd
                        if (UNIX_TIMESTAMP.matcher(text).matches()) {
                            return new Date(Long.parseLong(text) * 1000);
                        }
                        return new SimpleDateFormat(STANDARD_DATE).parse(text);
                    case 13:
                        // Ja va 时间戳
                        if (JA VA_TIMESTAMP.matcher(text).matches()) {
                            return new Date(Long.parseLong(text));
                        }
                        return null;
                    case 19:
                        // yyyy-MM-dd HH:mm:ss
                        return new SimpleDateFormat(STANDARD_DATETIME).parse(text);
                    case 23:
                        // yyyy-MM-dd HH:mm:ss.SSS
                        return new SimpleDateFormat("yyyy-MM-dd HH:mm:ss.SSS").parse(text);
                    default:
                        return new SimpleDateFormat(STANDARD_DATETIME).parse(text);
                }
            } catch (Exception e) {
                return null;
            }
        }
    
        /** 获取日期的起始时刻(00:00:00.000). */
        public static Date getDayBegin(Date date) {
            Calendar cal = Calendar.getInstance();
            cal.setTime(date);
            cal.set(Calendar.HOUR_OF_DAY, 0);
            cal.set(Calendar.MINUTE, 0);
            cal.set(Calendar.SECOND, 0);
            cal.set(Calendar.MILLISECOND, 0);
            return cal.getTime();
        }
    
        /** 获取日期的结束时刻(23:59:59.999). */
        public static Date getDayEnd(Date date) {
            Calendar cal = Calendar.getInstance();
            cal.setTime(date);
            cal.set(Calendar.HOUR_OF_DAY, 23);
            cal.set(Calendar.MINUTE, 59);
            cal.set(Calendar.SECOND, 59);
            cal.set(Calendar.MILLISECOND, 999);
            return cal.getTime();
        }
    
        /** 格式化为标准日期时间字符串. */
        public static String formatStandardDateTime(Date date) {
            if (date == null) return null;
            return new SimpleDateFormat(STANDARD_DATETIME).format(date);
        }
    
        /** 获取 N 天后的日期. */
        public static Date getDateAfter(Date date, int days) {
            Calendar cal = Calendar.getInstance();
            cal.setTime(date);
            cal.add(Calendar.DAY_OF_MONTH, days);
            return cal.getTime();
        }
    }
    

    3.3 StringUtil(字符串/JSON 工具)

    package com.example.utils;
    
    import com.fasterxml.jackson.core.type.TypeReference;
    import com.fasterxml.jackson.databind.DeserializationFeature;
    import com.fasterxml.jackson.databind.ObjectMapper;
    import com.fasterxml.jackson.databind.SerializationFeature;
    import ja va.util.regex.Pattern;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    
    /**
     * 字符串和JSON工具类.
     * 
     * 核心功能:
     * 1. JSON 序列化/反序列化(容错模式)
     * 2. 特殊字符检测和替换(中文/Emoji/符号)
     * 3. 驼峰拆分
     */
    public class StringUtil {
    
        private static final Logger logger = LoggerFactory.getLogger(StringUtil.class);
        private static final Pattern CHINESE_CHAR = Pattern.compile("[\u4e00-\u9fa5]");
        private static final Pattern EMOJI_CHAR = Pattern.compile("[\ud800-\udfff]");
    
        // 全局单例 ObjectMapper(线程安全)
        private static final ObjectMapper READ_MAPPER = new ObjectMapper()
            .configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
        private static final ObjectMapper WRITE_MAPPER = new ObjectMapper()
            .configure(SerializationFeature.FAIL_ON_EMPTY_BEANS, false);
    
        /**
         * 对象序列化为 JSON 字符串.
         * 异常时返回空字符串,不抛出异常.
         */
        public static String getJsonString(Object obj) {
            if (obj == null) {
                return "";
            }
            if (obj instanceof String) {
                return (String) obj;
            }
            try {
                return WRITE_MAPPER.writeValueAsString(obj);
            } catch (Exception e) {
                logger.error("JSON序列化失败", e);
                return "";
            }
        }
    
        /**
         * JSON 字符串反序列化为对象.
         */
        public static  T parseJsonString(String json, Class clazz) {
            if (json == null || json.isEmpty()) {
                return null;
            }
            try {
                return READ_MAPPER.readValue(json, clazz);
            } catch (Exception e) {
                logger.error("JSON反序列化失败", e);
                return null;
            }
        }
    
        /**
         * JSON 字符串反序列化(泛型支持).
         */
        public static  T parseJsonString(String json, TypeReference typeRef) {
            if (json == null || json.isEmpty()) {
                return null;
            }
            try {
                return READ_MAPPER.readValue(json, typeRef);
            } catch (Exception e) {
                logger.error("JSON反序列化失败", e);
                return null;
            }
        }
    
        /** 是否包含中文字符. */
        public static boolean containsChinese(String str) {
            return str != null && CHINESE_CHAR.matcher(str).find();
        }
    
        /** 是否包含 Emoji 字符. */
        public static boolean containsEmoji(String str) {
            return str != null && EMOJI_CHAR.matcher(str).find();
        }
    
        /** 替换 Emoji 为指定字符. */
        public static String replaceEmoji(String str, String replacement) {
            if (str == null) return null;
            return EMOJI_CHAR.matcher(str).replaceAll(replacement);
        }
    }
    

    3.4 Auth2SessionIdUtil(请求上下文工具)

    package com.example.utils;
    
    /**
     * OAuth2 请求级别上下文工具.
     * 通过 ThreadLocal 存储当前请求的用户信息,在同一请求内全局可访问.
     * 
     * 使用场景:
     * - Filter/Interceptor 中设置(请求进入时)
     * - Service 层中读取(业务处理时)
     * - Filter 中清理(请求结束时)
     * 
     * 注意:必须在请求结束时调用 delete() 清理,防止线程池复用导致数据串线.
     */
    public final class Auth2SessionIdUtil {
    
        private static final ThreadLocal sessionIdLocal = new ThreadLocal<>();
        private static final ThreadLocal tokenLocal = new ThreadLocal<>();
        private static final ThreadLocal loginNameLocal = new ThreadLocal<>();
    
        /** 获取当前请求的会话ID. */
        public static String getSessionId() {
            return sessionIdLocal.get();
        }
    
        public static void setSessionId(String sessionId) {
            sessionIdLocal.set(sessionId);
        }
    
        /** 获取当前请求的 OAuth2 Token. */
        public static String getToken() {
            return tokenLocal.get();
        }
    
        public static void setToken(String token) {
            tokenLocal.set(token);
        }
    
        /** 获取当前登录用户名. */
        public static String getLoginName() {
            return loginNameLocal.get();
        }
    
        public static void setLoginName(String loginName) {
            loginNameLocal.set(loginName);
        }
    
        /**
         * 清理所有 ThreadLocal 数据.
         * 必须在请求结束时调用!防止线程池复用导致数据泄露.
         */
        public static void delete() {
            sessionIdLocal.remove();
            tokenLocal.remove();
            loginNameLocal.remove();
        }
    }
    

    3.5 pom.xml(工具库)

    
        com.example
        example-utils
        1.0.0
        jar
        
            
            
                com.fasterxml.jackson.core
                jackson-databind
                provided
            
            
            
                ja vax.servlet
                ja vax.servlet-api
                provided
            
            
            
                org.springframework
                spring-context
                provided
            
            
            
                org.slf4j
                slf4j-api
                provided
            
        
    

    四、引入方使用

    4.1 添加依赖

    
        com.example
        example-utils
        1.0.0
    

    4.2 使用示例

    @Service
    public class OrderService {
    
        public void processOrder(OrderDto dto) {
            // 参数校验
            if (CheckEmptyUtil.isOrEmpty(dto.getOrderCode(), dto.getMemberId())) {
                throw new IllegalArgumentException("参数不能为空");
            }
    
            // 日期处理
            Date deliveryDate = DateUtil.convertToDate(dto.getDeliveryTime());  // 自动识别格式
            Date deadline = DateUtil.getDateAfter(deliveryDate, 3);            // 3天后
    
            // JSON 序列化(记日志)
            log.info("处理订单入参: {}", StringUtil.getJsonString(dto));
    
            // 空值安全操作
            if (CheckEmptyUtil.isNotEmpty(dto.getItemList())) {
                dto.getItemList().forEach(item -> {
                    // 业务逻辑...
                });
            }
        }
    }
    

    五、关键设计总结

    设计要点实现方式收益
    多类型统一判空instanceof 分发一个方法覆盖所有类型,减少重复代码
    智能日期解析按字符串长度 + 正则分发无需调用方关心日期格式
    JSON 容错序列化/反序列化异常返回 null不会因为一个字段异常导致整个请求失败
    全局 ObjectMapper静态单例 + 线程安全配置避免每次创建实例的开销
    ThreadLocal 上下文请求级隔离用户信息Service 层无需传参即可获取当前用户
    ThreadLocal 清理delete() 方法防止线程池复用导致数据串线
    纯静态工具类无 spring.factories,无 Bean 注册任何项目引入即用,零配置
    provided scope核心依赖由引入方提供不引入版本冲突
    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
    作者最新文章
    编程开发
    相关文章 更多
    QQ影音怎么加速播放视频课程
    QQ影音怎么加速播放视频课程

    播放时右键选播放速度,或点控制条倍速,1.25 到 1.5 倍看课最舒服;公式代码类内容别超过 1.25 倍。

    企业微信创建企业提示失败怎么办 实名与填写检查
    企业微信创建企业提示失败怎么办 实名与填写检查

    先看提示属于哪类:名称占用就加后缀,实名不一致就重填本人信息,证件不清晰就重拍。统一社会信用代码逐位核对,连续三次失败别改材料重投,直接联系客服人工核。

    Modern Web Guidance 的 legacy-scan 反转建议应该怎样判断?
    Modern Web Guidance 的 legacy-scan 反转建议应该怎样判断?

    说明源码提交对字符串、生成器和数组的识别边界,以及扫描命令与发行包核验限制。

    Codex 0.170.0 正式版的语音与连接更新,适用范围有哪些限制?
    Codex 0.170.0 正式版的语音与连接更新,适用范围有哪些限制?

    0.170.0 的语音更新限于终端通话协商能力的明确新增,同名工具服务器跨环境支持仍标注实验性质;连接部分则修复大请求回退、认证竞态和云端重连等具体问题。这份正式版公告不足以证明所有账户、所有客户端都已具备完整语音功能。

    Hy4 flash 三种权重怎么选,安装和授权要注意哪些条件?
    Hy4 flash 三种权重怎么选,安装和授权要注意哪些条件?

    了解Hy4 flash、FP8与base的适用任务,阅读官方安装及图文代码,并核对资源和MaaS许可条件。

    OpenAI Python SDK 3.55.0 升级看点:Live MCP 服务配置与预算接口变化
    OpenAI Python SDK 3.55.0 升级看点:Live MCP 服务配置与预算接口变化

    OpenAI Python SDK 3.55.0 升级看点:Live MCP 服务配置与预算接口变化。说明已核实的更新范围、类型兼容性和本地版本确认方法。

    OpenAI Java SDK 4.108.0 的两项新增能力适合哪些项目?
    OpenAI Java SDK 4.108.0 的两项新增能力适合哪些项目?

    OpenAI Java SDK 4.108.0 面向 Live MCP 工具接入与 Managed Agents 预算状态处理,说明新增模型、事件含义、正式发布范围和适用限制。

    Free Claude Code 6.19.37 如何兼顾网页搜索与普通工具调用?
    Free Claude Code 6.19.37 如何兼顾网页搜索与普通工具调用?

    Free Claude Code 6.19.37 在自动搜索时保留客户端工具及选择条件,代理执行搜索后仍返回普通调用。说明适用场景、历史信息保留、请求约束与第三方项目的版本边界。

    Google GenAI Go SDK 1.78.0 的 v1beta 配置优先级怎样判断?
    Google GenAI Go SDK 1.78.0 的 v1beta 配置优先级怎样判断?

    Google GenAI Go SDK 1.78.0 将 Gemini Developer API 默认改为 v1,可用 HTTPOptions.APIVersion 或环境变量保留 v1beta,Vertex AI 默认值不变。

    Google GenAI SDK 3.5.0实时交互值得哪些项目升级评估?
    Google GenAI SDK 3.5.0实时交互值得哪些项目升级评估?

    解释实验性实时支持、环境检查与生产评估中需要验证的条件。

    查看更多
    精品专题 更多
    装机必备
    装机必备

    正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

    Windows
    Windows

    正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

    PDF教程
    PDF教程

    正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

    Mac软件 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    Aperty macOS版
    Aperty macOS版
    macOS

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    WINDOWS 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    PixTV 网页版
    PixTV 网页版
    Windows

    PixTV 是一款在浏览器中使用的 AI 视觉内容创作平台,提供图片、视频、音频、文字生成、AI 分镜、局部重绘、提示词反推和无限画布等工具,适合短剧、漫剧、广告及社交媒体内容制作。