Crane4j 开源项目教程

Crane4j 开源项目教程

crane4j 一个简单易用的数据映射框架，通过简单的注解配置快速根据外键/编码值填充相关字段，支持字典，枚举，方法等多种数据源。 A simple and easy-to-use data mapping framework, quickly populate relevant fields according to foreign keys/encoded values through simple annotation configuration, supports dictionaries, enumerations, methods and other data sources. 项目地址: https://gitcode.com/gh_mirrors/cr/crane4j

1. 项目介绍

Crane4j 是一个简单易用的关联字段填充框架，旨在通过简单的注解配置，优雅高效地完成不同数据源、不同类型、不同命名的字段填充任务。它支持字典、枚举、方法等多种数据源，帮助开发者专注于核心业务逻辑，避免繁琐的数据组装工作。

2. 项目快速启动

2.1 环境准备

• Java 8 或更高版本
• Maven 或 Gradle

2.2 添加依赖

在 pom.xml 中添加以下依赖：

<dependency>
    <groupId>cn.crane4j</groupId>
    <artifactId>crane4j-spring-boot-starter</artifactId>
    <version>最新版本</version>
</dependency>

2.3 配置注解

在需要填充字段的类上添加注解：

import cn.crane4j.annotation.Assemble;
import cn.crane4j.annotation.Mapping;

public class User {
    @Assemble(
        type = "dictionary",
        props = @Mapping(ref = "status", src = "statusName")
    )
    private String status;
    private String statusName;

    // Getters and Setters
}

2.4 启动应用

启动 Spring Boot 应用，Crane4j 会自动根据注解配置完成字段填充。

3. 应用案例和最佳实践

3.1 字典填充

在实际开发中，经常需要根据字典项填充字段。使用 Crane4j 可以轻松实现：

@Assemble(
    type = "dictionary",
    props = @Mapping(ref = "gender", src = "genderName")
)
private String gender;
private String genderName;

3.2 枚举填充

对于枚举类型的字段，Crane4j 同样支持：

@Assemble(
    type = "enum",
    props = @Mapping(ref = "role", src = "roleName")
)
private Role role;
private String roleName;

3.3 方法填充

通过方法返回值填充字段：

@Assemble(
    type = "method",
    props = @Mapping(ref = "age", src = "ageName")
)
private int age;
private String ageName;

4. 典型生态项目

4.1 Spring Boot 集成

Crane4j 提供了与 Spring Boot 的集成，通过 crane4j-spring-boot-starter 可以快速启用框架功能，避免繁琐的基本配置。

4.2 MyBatis-Plus 扩展

Crane4j 支持与 MyBatis-Plus 的集成，提供更强大的数据填充功能。

4.3 自定义数据源

开发者可以根据业务需求，自定义数据源，扩展 Crane4j 的功能。

通过以上步骤，您可以快速上手并使用 Crane4j 进行字段填充，提升开发效率。

crane4j 一个简单易用的数据映射框架，通过简单的注解配置快速根据外键/编码值填充相关字段，支持字典，枚举，方法等多种数据源。 A simple and easy-to-use data mapping framework, quickly populate relevant fields according to foreign keys/encoded values through simple annotation configuration, supports dictionaries, enumerations, methods and other data sources. 项目地址: https://gitcode.com/gh_mirrors/cr/crane4j