工具类-JacksonUtils

本文介绍了JacksonUtils工具类,用于Java中快速进行对象与JSON之间的转换,支持实体对象转json、文件操作、JSON解析等功能,提升开发效率。
import com.fasterxml.jackson.annotation.JsonInclude.Include;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.core.JsonParser.Feature;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.*;
import com.fasterxml.jackson.databind.type.CollectionType;

import java.io.File;
import java.io.IOException;
import java.net.URL;
import java.text.SimpleDateFormat;
import java.util.List;
import java.util.Map;
import java.util.TimeZone;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * JacksonUtils
 *
 * @author ygr
 * @version 1.0
 * @date 2021/8/16 15:04
 */
public class JacksonUtils {

    static final Logger LOG = LoggerFactory.getLogger(JacksonUtils.class);

    private static final ObjectMapper MAPPER = new ObjectMapper();


    static {
        MAPPER.setTimeZone(TimeZone.getTimeZone("GMT+8"));
        MAPPER.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);
        MAPPER.setSerializationInclusion(Include.NON_NULL);
        MAPPER.configure(SerializationFeature.FAIL_ON_EMPTY_BEANS, false);
        MAPPER.configure(SerializationFeature.INDENT_OUTPUT, false);
        MAPPER.setDateFormat(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"));
        MAPPER.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
        MAPPER.configure(Feature.ALLOW_SINGLE_QUOTES, true);
    }

    private JacksonUtils() {
    }

    /**
     * 将实体对象转换为json字符串
     *
     * @param entity 实体对象
     * @param <T>    泛型
     * @return json string
     * @throws JsonProcessingException JsonProcessingException
     */
    public static <T> String obj2json(T entity) throws JsonProcessingException {
        return MAPPER.writeValueAsString(entity);
    }

    /**
     * 将实体对象转换为json字符串
     *
     * @param entity 实体对象
     * @param pretty 是否转换为美观格式
     * @param <T>    泛型
     * @return json string
     * @throws JsonProcessingException JsonProcessingException
     */
    public static <T> String obj2json(T entity, boolean pretty) throws JsonProcessingException {
        if (pretty) {
            return MAPPER.writerWithDefaultPrettyPrinter().writeValueAsString(entity);
        }
        return MAPPER.writeValueAsString(entity);
    }

    /**
     * 将实体对象转换为字节数组
     *
     * @param entity 实体对象
     * @param <T>    泛型
     * @return json string
     * @throws JsonProcessingException JsonProcessingException
     */
    public static <T> byte[] obj2jsonBytes(T entity) throws JsonProcessingException {
        return MAPPER.writeValueAsBytes(entity);
    }

    /**
     * 将实体类转换为JsonNode对象
     *
     * @param entity 实体对象
     * @param <T>    泛型
     * @return JsonNode
     */
    public static <T> JsonNode obj2node(T entity) {
        return MAPPER.valueToTree(entity);
    }

    /**
     * 将实体对象写入文件
     *
     * @param filepath 文件绝对路径
     * @param entity   实体对象
     * @param <T>      泛型
     * @return 写入成功:true,否则:false
     */
    public static <T> boolean write2jsonFile(String filepath, T entity) {
        File file = new File(filepath);
        if (!file.exists()) {
            try {
                boolean success = file.createNewFile();
                if (!success) {
                    LOG.error("[write2jsonFile]-创建文件失败!路径:{}", filepath);
                    return false;
                }
            } catch (IOException e) {
                LOG.error("[write2jsonFile]-创建文件失败!路径:{},失败原因:{}", filepath, e.getMessage());
                return false;
            }
        }
        return write2jsonFile(new File(filepath), entity);
    }

    /**
     * 将实体对象写入指定文件
     *
     * @param file   文件
     * @param entity 实体对象
     * @param <T>    泛型
     * @return 写入成功:true,否则:false
     */
    public static <T> boolean write2jsonFile(File file, T entity) {
        try {
            MAPPER.writeValue(file, entity);
            return true;
        } catch (IOException e) {
            LOG.error("[write2jsonFile]-写入文件失败!路径:{},失败原因:{}", file.getAbsolutePath(), e.getMessage());
        }
        return false;
    }

    /**
     * 将json字符串转换为实体类对象
     *
     * @param json json字符串
     * @param type 实体对象类型
     * @param <T>  泛型
     * @return 转换成功后的对象
     * @throws JsonProcessingException JsonProcessingException
     */
    public static <T> T json2obj(String json, Class<T> type) throws JsonProcessingException {
        return MAPPER.readValue(json, type);
    }

    /**
     * 将json字符串转换为map
     *
     * @param json json字符串
     * @return Map
     * @throws JsonProcessingException JsonProcessingException
     */
    @SuppressWarnings("unchecked")
    public static Map<String, Object> json2map(String json) throws JsonProcessingException {
        return (Map<String, Object>) MAPPER.readValue(json, Map.class);
    }
    

    /**
     * 泛化转换方式,此方式最为强大、灵活
     * <p>
     * example:
     * <p>
     * {@code Map<String, List<UserInfo>> listMap = genericConvert(jsonStr, new TypeReference<Map<String, List<UserInfo>>>() {});}
     *
     * @param json json字符串
     * @param type type
     * @param <T>  泛化
     * @return T
     * @throws JsonProcessingException JsonProcessingException
     */
    public static <T> T genericConvert(String json, TypeReference<T> type) throws JsonProcessingException {
        return MAPPER.readValue(json, type);
    }


    /**
     * 将map转换为实体类对象
     *
     * @param map  map
     * @param type 实体对象类型
     * @param <T>  泛型
     * @return 实体对象
     */
    public static <T> T map2obj(Map map, Class<T> type) {
        return MAPPER.convertValue(map, type);
    }

    /**
     * 将文件内容转为实体类对象
     *
     * @param file 文件
     * @param type 实体类类型
     * @param <T>  泛型
     * @return 实体类对象
     * @throws IOException IOException
     */
    public static <T> T file2obj(File file, Class<T> type) throws IOException {
        return MAPPER.readValue(file, type);
    }

    /**
     * 将url指向的资源转换为实体类对象
     *
     * @param url  url
     * @param type 实体类对象类型
     * @param <T>  泛型
     * @return 实体类对象
     * @throws IOException IOException
     */
    public static <T> T urlResource2obj(URL url, Class<T> type) throws IOException {
        return MAPPER.readValue(url, type);
    }

    /**
     * 将json字符串转换为实体类集合
     *
     * @param json json字符串
     * @param type 实体对象类型
     * @param <T>  泛型
     * @return list集合
     * @throws JsonProcessingException JsonProcessingException
     */
    public static <T> List<T> json2list(String json, Class<T> type) throws JsonProcessingException {
        CollectionType collectionType = MAPPER.getTypeFactory().constructCollectionType(List.class, type);
        return MAPPER.readValue(json, collectionType);
    }


    /**
     * 将json字符串转换为JsonNode对象
     *
     * @param json json字符串
     * @return JsonNode对象
     * @throws JsonProcessingException JsonProcessingException
     */
    public static JsonNode json2node(String json) throws JsonProcessingException {
        return MAPPER.readTree(json);
    }


    /**
     * 检查字符串是否是json格式
     *
     * @param str 待检查字符串
     * @return 是:true,否:false
     */
    public static boolean isJsonString(String str) {
        try {
            MAPPER.readTree(str);
            return true;
        } catch (Exception e) {
            if (LOG.isDebugEnabled()) {
                LOG.debug("[isJsonString]-检查字符串是否是json格式...{}", e.getMessage());
            }
            return false;
        }
    }

    /**
     * 打印json到控制台
     *
     * @param obj    需要打印的对象
     * @param pretty 是否打印美观格式
     * @param <T>    泛型
     */
    public static <T> void printJson(T obj, boolean pretty) {
        try {
            if (pretty) {
                System.out.println(MAPPER.writerWithDefaultPrettyPrinter().writeValueAsString(obj));
            } else {
                System.out.println(MAPPER.writeValueAsString(obj));
            }
        } catch (JsonProcessingException e) {
            e.printStackTrace();
        }
    }
}

<think>首先,用户的问题是关于Jackson工具类或常用工具方法的。用户说:“我想寻找与Jackson相关的工具类或工具方法 请问Jackson 工具类或常用工具方法”。这看起来像是用户想了解如何创建或使用Jackson的工具类,特别是用于JSON序列化和反序列化的实用方法。 在系统指令中,我有几个关键点需要遵守: 1. **行内数学表达式**:使用$...$格式。例如,如果有数学相关内容,比如在算法描述中,但在这个上下文中,可能不涉及数学。用户的问题是Java相关的,所以数学表达式可能不适用。但如果有,必须用$...$。 2. **独立公式**:使用$$...$$格式并单独成段。同样,可能不适用。 3. **LaTeX语法正确**:确保所有LaTeX正确。 4. **使用中文回答**:整个响应必须用中文。 5. **生成相关问题**:在回答后,生成相关问题。指令说“生成相关问题”,在示例中是“§§相关问题§§”,然后列出问题。所以,我需要在回答结束时添加相关问题。 6. **引用标识**:在回答中引用的段落末尾自然地添加引用标识,例如[^1]。在提供的引用中,有[^1]和[^2],但它们是基于站内引用的。指令说:“回答中引用的段落末尾自然地添加引用标识”,并提到“参考站内引用”。所以,我需要引用这些内容。 引用内容: - 引用[1]: 关于Jackson的介绍、优点和常用注解,如@JsonIgnore。 - 引用[2]: 关于一个Jackson工具类JacksonUtils,包含ObjectMapper的配置。 用户的问题是寻找Jackson工具类或工具方法,所以我应该基于这些引用构建回答。 回答结构: - 必须清晰,帮助用户逐步解决问题。 - 确保回答真实可靠。 用户需求:用户想寻找与Jackson相关的工具类或常用工具方法。所以,我需要提供信息: 1. 解释什么是Jackson工具类。 2. 提供示例代码或描述如何创建和使用工具类。 3. 基于引用,引用[2]提到了一个JacksonUtils工具类,所以我应该引用它。 步骤构建回答: 1. **介绍Jackson工具类**:解释为什么需要工具类,比如简化ObjectMapper的使用。 2. **描述常用工具方法**:基于引用,常见的方法包括序列化(对象转JSON)和反序列化(JSON转对象)。 3. **提供示例代码**:在引用[2]中,有一个JacksonUtils类。我可以基于此创建一个示例工具类。 4. **添加引用标识**:当引用这些内容时,在末尾添加[^1]或[^2]。 5. **生成相关问题**:在回答后,添加相关问题部分。 示例代码格式:在示例中,有代码块使用```python```,但这里是Java,所以用```java```。 系统指令说:“独立公式必须使用$$...$$格式”,但代码块不是公式,所以代码块应像示例一样使用```language```格式。 现在,构建回答大纲: - **开头**:简要介绍Jackson工具类的目的。 - **主体**:描述一个典型的Jackson工具类,包含静态方法如toJson和fromJson。 - 基于引用[2],提到ObjectMapper的配置。 - 提供代码示例。 - **结尾**:总结好处。 - **添加引用**:自然地添加引用标识。 - **相关问题**:生成相关问题。 相关问题示例:指令说“生成相关问题”,如示例中的“§§相关问题§§”。所以,我需要列出几个相关问题。 可能的回答结构: 1. 解释Jackson工具类的作用。 2. 展示一个简单的Jackson工具类实现。 3. 讨论常用工具方法。 4. 添加相关问题。 确保用中文。 最终响应: - 用中文写。 - 代码块用```java```。 - 添加相关问题。</think>### Jackson 工具类与常用工具方法 Jackson 是一个流行的 Java 库,用于 JSON 序列化(将 Java 对象转换为 JSON 字符串)和反序列化(将 JSON 字符串转换为 Java 对象)。为了简化开发,开发者通常会创建自定义工具类来封装 Jackson 的核心功能,避免重复代码。这些工具类通常基于 `ObjectMapper`(Jackson 的核心类),并提供静态方法用于常见操作。下面我将逐步介绍如何创建和使用 Jackson 工具类,以及常用工具方法。参考引用内容,我会基于 Jackson 的优势(如高性能、易扩展)和实际工具类实现进行说明[^1][^2]。 #### 步骤 1:理解 Jackson 工具类的目的 Jackson 工具类的核心是简化 `ObjectMapper` 的使用。`ObjectMapper` 需要配置(如忽略未知属性、设置日期格式),在多个地方重复创建和配置会降低效率。工具类通过静态方法和单例模式,确保 `ObjectMapper` 实例被共享和复用,从而提升性能和代码可维护性[^2]。 #### 步骤 2:创建 Jackson 工具类 一个典型的 Jackson 工具类(如 `JacksonUtils`)包含以下元素: - **静态 ObjectMapper 实例**:在类加载时初始化并配置。 - **常用工具方法**:如 `toJson()`(序列化)和 `fromJson()`(反序列化)。 - **配置选项**:例如忽略未知属性、启用缩进输出以提高可读性(基于引用[2]的说明)。 以下是一个完整的 `JacksonUtils` 工具类实现示例(使用 Java 编写)。这个类基于引用[2]的描述,但进行了扩展以覆盖常见用例: ```java import com.fasterxml.jackson.core.JsonProcessingException; import com.fasterxml.jackson.databind.ObjectMapper; import com.fasterxml.jackson.databind.SerializationFeature; public class JacksonUtils { // 静态 ObjectMapper 实例,确保全局唯一和线程安全 private static final ObjectMapper objectMapper = new ObjectMapper(); static { // 配置 ObjectMapper:忽略未知属性(避免 JSON 字段不匹配时报错) objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false); // 开启缩进输出,使 JSON 字符串更易读 objectMapper.enable(SerializationFeature.INDENT_OUTPUT); // 可选:添加日期格式配置,例如 objectMapper.setDateFormat(new SimpleDateFormat("yyyy-MM-dd")); } /** * 序列化方法:将 Java 对象转换为 JSON 字符串 * @param object 要序列化的 Java 对象 * @return JSON 字符串 */ public static String toJson(Object object) { try { return objectMapper.writeValueAsString(object); } catch (JsonProcessingException e) { throw new RuntimeException("序列化失败: " + e.getMessage(), e); } } /** * 反序列化方法:将 JSON 字符串转换为 Java 对象 * @param json JSON 字符串 * @param clazz 目标 Java 类的 Class 对象 * @param <T> 泛型类型 * @return 反序列化后的 Java 对象 */ public static <T> T fromJson(String json, Class<T> clazz) { try { return objectMapper.readValue(json, clazz); } catch (JsonProcessingException e) { throw new RuntimeException("反序列化失败: " + e.getMessage(), e); } } // 其他常用工具方法(可选) /** * 判断字符串是否为有效 JSON * @param json 输入的字符串 * @return 如果有效返回 true,否则 false */ public static boolean isValidJson(String json) { try { objectMapper.readTree(json); return true; } catch (Exception e) { return false; } } } ``` #### 步骤 3:常用工具方法详解 Jackson 工具类通常包含以下核心方法(基于上述代码): - **`toJson(Object object)`**:序列化方法。将任何 Java 对象(如 POJO、集合)转换为格式化的 JSON 字符串。例如,对一个 `User` 对象调用 `toJson(user)` 会输出类似以下内容: ```json { "name" : "张三", "age" : 30 } ``` - **`fromJson(String json, Class<T> clazz)`**:反序列化方法。将 JSON 字符串还原为 Java 对象。例如,`fromJson(jsonString, User.class)` 可以将 JSON 转换为 `User` 实例。 - **`isValidJson(String json)`**:辅助方法,用于验证 JSON 字符串的有效性。 - **其他扩展方法**:如配置日期格式、处理复杂类型(泛型集合),或使用 Jackson 注解(如 `@JsonIgnore` 来忽略字段)来定制序列化行为[^1]。 #### 步骤 4:使用工具类的示例 在实际代码中,调用工具类非常简单: ```java public class Main { public static void main(String[] args) { // 创建一个 Java 对象 User user = new User("李四", 25); // 序列化:对象转 JSON String json = JacksonUtils.toJson(user); System.out.println("序列化结果: " + json); // 反序列化:JSON 转对象 User newUser = JacksonUtils.fromJson(json, User.class); System.out.println("反序列化结果: " + newUser.getName()); } static class User { private String name; private int age; // 必须有无参构造器(Jackson 要求) public User() {} public User(String name, int age) { this.name = name; this.age = age; } // Getters and setters public String getName() { return name; } public void setName(String name) { this.name = name; } public int getAge() { return age; } public void setAge(int age) { this.age = age; } } } ``` **输出示例**: ``` 序列化结果: { "name" : "李四", "age" : 25 } 反序列化结果: 李四 ``` #### 优点与最佳实践 - **优点**:工具类减少了样板代码,提高了性能(通过复用 `ObjectMapper`),并支持定制化配置(如忽略未知属性,避免因 JSON 字段变化导致崩溃)[^2]。 - **最佳实践**: -工具类中使用静态块初始化 `ObjectMapper`,确保线程安全。 - 结合 Jackson 注解(如 `@JsonIgnore`)处理敏感字段[^1]。 - 对于大型项目,可以添加日志记录或异常处理增强健壮性。 通过这个工具类,您可以轻松集成 Jackson 到 Spring Boot 或其他 Java 应用中,提升开发效率[^1][^2]。
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值