Jimmer 为 Kotlin 提供了特化的 API 风格
-
实体映射: 参考
references/entity-mapping.md -
DSL 查询: 参考
references/dsl-queries.md -
实体模板: 参考
assets/EntityTemplate.kt
关键注解速查
-
@Entity- 标记实体类型 -
@Id- 标记主键 -
@GeneratedValue- 主键生成策略 -
@Key- 业务键 -
@ManyToOne/@OneToMany/@ManyToMany/@OneToOne- 关联映射 -
@JoinColumn- 自定义外键列名 -
@JoinTable- 自定义中间表 -
@Column- 自定义列名(仅用于非关联字段) -
@Table- 自定义表名 -
?(Kotlin) - 标记可空属性
命名约定
-
实体名 → 表名:
BookStore→BOOK_STORE -
属性名 → 列名:
firstName→FIRST_NAME -
多对一外键:
store→STORE_ID
工作流程
- 定义实体时:
使用 interface 而非 class
-
根据项目语言参考对应的实体模板和映射文档
-
参考
assets/EntityTemplate.kt和references/entity-mapping.md -
参考
references/dto.md完成 DTO 定义 -
编写查询时:
优先使用动态谓词(Kotlin: ilike?/between?)
-
使用动态表连接处理关联查询
-
使用隐式子查询处理集合关联
-
根据项目语言参考对应的 DSL 查询文档
-
参考
references/dsl-queries.md -
遇到问题时:
检查实体是否使用 interface 定义
-
检查关联映射的
mappedBy配置 -
检查动态谓词的参数是否正确
-
确认表连接路径是否正确