Java 17使用Record结构对接Firestore遇序列化问题求解决方案

核心思路 #

Firestore的Java SDK默认遵循JavaBean规范（依赖setter/getter），而Java Record是不可变结构，仅生成组件的访问器（如name()而非getName()），且无setter方法。要继续使用Record，需调整Firestore的映射规则，让SDK识别Record的字段与构造逻辑。

具体方案 #

1. 自定义Firestore转换器（Converter） #

手动实现Record与Firestore DocumentSnapshot/Map的转换逻辑，完全控制映射过程，灵活性最高。

示例代码：

public record User(String id, String name, int age) {}

public class UserConverter implements FirestoreDataConverter<User> {
    @Override
    public User fromFirestore(DocumentSnapshot snapshot, FirestoreDataConverterOptions options) {
        Map<String, Object> data = snapshot.getData();
        return new User(
            (String) data.get("id"),
            (String) data.get("name"),
            ((Long) data.get("age")).intValue() // Firestore数字默认存为Long，需转类型
        );
    }

    @Override
    public Map<String, Object> toFirestore(User user, FirestoreDataConverterOptions options) {
        return Map.of(
            "id", user.id(),
            "name", user.name(),
            "age", user.age()
        );
    }
}

使用时指定转换器：

// 保存Record
firestore.collection("users")
        .document("user1")
        .set(new User("user1", "Alice", 30), SetOptions.merge())
        .addOnSuccessListener(aVoid -> System.out.println("Record saved"));

// 查询并转换为Record
firestore.collection("users")
        .document("user1")
        .get()
        .addOnSuccessListener(snapshot -> {
            User user = snapshot.toObject(User.class, new UserConverter());
            System.out.println(user);
        });

2. 启用Firestore SDK原生Record支持 #

Firestore SDK 24.0.0及以上版本已内置Java Record支持，只需配置FirestoreOptions开启该功能，无需手动写转换器。

示例代码：

FirestoreOptions options = FirestoreOptions.newBuilder()
        .setProjectId("your-project-id")
        .setFirestoreSettings(FirestoreSettings.newBuilder()
                .setEnableJavaRecordSupport(true)
                .build())
        .build();

Firestore firestore = options.getService();

启用后SDK会自动处理：

• 序列化：读取Record的所有组件字段（通过recordComponentAccessor()）
• 反序列化：调用Record的全参构造器实例化对象

3. 借助Jackson模块（项目已依赖Jackson时） #

若项目使用Jackson处理JSON，可通过jackson-modules-java14模块让Firestore通过Jackson序列化Record。

步骤：

• 添加Maven依赖：

<dependency>
    <groupId>com.fasterxml.jackson.module</groupId>
    <artifactId>jackson-module-jdk14</artifactId>
    <version>2.15.2</version>
</dependency>

• 配置Firestore使用Jackson作为序列化器：

ObjectMapper objectMapper = new ObjectMapper()
        .registerModule(new Jdk14Module());

FirestoreOptions options = FirestoreOptions.newBuilder()
        .setProjectId("your-project-id")
        .setJsonSerializer(objectMapper::writeValueAsString)
        .setJsonDeserializer((json, type) -> objectMapper.readValue(json, type))
        .build();

Firestore firestore = options.getService();

Jackson原生支持Java Record，配置后Firestore会通过它完成Record的序列化/反序列化。

注意事项 #

• 确保Firestore SDK版本≥24.0.0，旧版本无内置Record支持
• Record组件字段名需与Firestore文档字段名一致，或通过转换器手动映射别名
• 反序列化时，若Firestore文档缺失字段，Record全参构造器会抛出异常，需在转换器中处理默认值或保证字段完整性

内容的提问来源于stack exchange，提问作者Daniel Gini