java：一个简单的 Jimmer 使用小案例

简介

本文使用 Jimmer 写了一个小案例，不和任何框架耦合，即没有使用任何其它熟知的 Java/Kotlin 框架。如果集成框架，那么整合后使用更加方便、简单。

本文使用 Gradle + Kotlin 编写 Demo。源代码示例见：https://github.com/jhlzlove/gradle-project-example/tree/main/jimmer-example

Action！

依赖

build.gradle.kts 内容如下：

build.gradle.kts

plugins {
    kotlin("jvm") version "1.9.23"
    // ksp 插件
    id("com.google.devtools.ksp") version "1.9.23-1.0.20"
}

val jimmerVersion = "0.8.132"
dependencies {
    ksp("org.babyfish.jimmer:jimmer-ksp:${jimmerVersion}")
    implementation("org.babyfish.jimmer:jimmer-sql-kotlin:${jimmerVersion}")
    runtimeOnly("org.postgresql:postgresql:42.7.3")
    implementation("ch.qos.logback:logback-classic:1.5.6")
    testImplementation(kotlin("test"))
}

kotlin {
    jvmToolchain(21)
}

// 将生成的代码添加到编译路径中。
// 没有这个配置，gradle命令仍然可以正常执行，
// 但是, Intellij无法找到生成的源码。
kotlin {
    sourceSets.main {
        kotlin.srcDir("build/generated/ksp/main/kotlin")
    }
}

注意：

Jimmer 的 ksp 插件需要和自己使用的 Kotlin 版本一致或者兼容；

如果使用的 Java + Maven

pom.xml


<dependencies>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <version>${lombok.version}</version>
    </dependency>

    <dependency>
        <groupId>org.babyfish.jimmer</groupId>
        <artifactId>jimmer-spring-boot-starter</artifactId>
        <version>${jimmer.version}</version>
    </dependency>
</dependencies>

<build>

    <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>
        <version>3.10.1</version>
        <configuration>
            <annotationProcessorPaths>
                <!-- 如果使用了 lombok，需要添加该内容 -->
                <path>
                    <groupId>org.projectlombok</groupId>
                    <artifactId>lombok</artifactId>
                    <version>${lombok.version}</version>
                </path>

                <path>
                    <groupId>org.babyfish.jimmer</groupId>
                    <artifactId>jimmer-apt</artifactId>
                    <version>${jimmer.version}</version>
                </path>
            </annotationProcessorPaths>
        </configuration>
    </plugin>

    ...
</build>

若是多模块项目，plugin 部分请放在实体类所在的 pom 文件中。~~当然你想都放也是没问题哒！~~

数据库脚本

数据库名称为 db_jimmer：

CREATE TABLE public.db_test (
	id bigserial NOT NULL,
	username varchar NOT NULL,
	gender varchar NOT NULL,
	birthday date NULL,
	address varchar NULL,
	create_time timestamptz DEFAULT CURRENT_TIMESTAMP NULL,
	update_time timestamptz DEFAULT CURRENT_TIMESTAMP NULL,
	remark varchar NULL,
	CONSTRAINT db_test_pk PRIMARY KEY (id)
);
COMMENT ON COLUMN public.db_test.username IS '姓名';
COMMENT ON COLUMN public.db_test.gender IS '性别';
COMMENT ON COLUMN public.db_test.birthday IS '生日';
COMMENT ON COLUMN public.db_test.address IS '住址';

代码

Jimmer 这款 ORM 可以与任何框架集成，由于本文的 demo 没有任何的框架集成，所以这里的实现非常的简单粗暴。如果想要自己实现数据库连接池，可以自己编写 DataSource 的实现。

Jimmer 配置

class JimmerConfig {

    companion object {
        fun connect(): Connection {
            // 这里需要改为和自己地址相同
            val url = "jdbc:postgresql://localhost:5432/db_jimmer"
            val username = "postgres"
            val password = "postgres"
            return DriverManager.getConnection(url, username, password)
        }

        fun sqlClient(): KSqlClient = newKSqlClient {
            // 打印 SQL 并自动美化（需要集成日志框架）
            setExecutor(Executor.log())
            setSqlFormatter(SqlFormatter.PRETTY)
            // 设置连接管理
            setConnectionManager {
                connect().use {
                    proceed(it)
                }
            }
            // 指定数据库方言
            setDialect(PostgresDialect())
            // 数据库与实体验证，验证失败直接抛出错误，程序无法运行
            setDatabaseValidationMode(DatabaseValidationMode.ERROR)
            // 数据库命名策略，默认大写
            setDatabaseNamingStrategy(DefaultDatabaseNamingStrategy.LOWER_CASE)
        }
    }
}

实体

@Entity
@Table(name = "db_test")
interface User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    val id: Int
    @Key
    val username: String
    val gender: String

    val birthday: LocalDate?
    val address: String?
    val createTime: LocalDateTime?
    val updateTime: LocalDateTime?
    val remark: String?
}

主函数运行

fun main() {
    val sqlClient = JimmerConfig.sqlClient()

    val user = new(User::class).by {
        username = "江湖浪子"
        gender = "MALE"
        address = "地球"
        birthday = LocalDate.parse("2000-10-01")
    }
    
    sqlClient.save(user)

    val list = sqlClient.createQuery(User::class) {
        select(table)
    }.execute()
    println(list)
}