一个轻量级的 Java ORM 库，提供了一组语法可以将查询字符串直接转换为 SQL 查询，并且提供了一组 NLP 友好的数据操作接口。
- 🔄 将查询字符串自动转换为 SQL 查询
- 🔍 支持丰富的查询操作符和函数
- 📦 易于集成到现有项目中
- ⚡ 高性能的数据访问层
- 🛠️ 灵活的扩展机制
确保你的项目使用 Gradle 或 Maven 构建，然后添加依赖：
dependencies {
implementation 'me.karboom.java:filaments:1.1.16'
}<dependency>
<groupId>me.karboom.java</groupId>
<artifactId>filaments</artifactId>
<version>1.1.16</version>
</dependency>// 创建 Filaments 实例
var userFilament = new Filaments<>(User.class);
// 使用查询字符串进行查询
var users = userFilament.get(db, new HashMap<>() {{
put("age|in", List.of(22, 23));
}});
// 分页查询
var page = userFilament.pages(db, new HashMap(){{
put("name", "x");
}});| 字段名称 | 功能 | 默认值 | 查询字符串 | 对应SQL |
|---|---|---|---|---|
| rt | 指定返回字段 | * | ?rt=name,age | select `name`, `age` |
| p | 指定当前页码 | 1 | ?p=3 | limit 20 offset 40 |
| pc | 指定页内行数 | 20 | ?pc=18 | limit 18 offset 0 |
| od | 指定排序规则 | Null | ?id,-height | order by `id` asc, `height` desc |
| pg | 是否需要计算分页(仅分页函数生效) | 0 | ?pg=1 | limit ? offset ? |
字段名|函数(参数)...|操作符=数值
| 查询字符串 | 对应SQL |
|---|---|
| ?type=dog | where `type` = 'dog' |
| ?type|in=dog,cat | where `type` in ( 'dog', 'cat') |
| ?type|substr(1,2)|in=dog,cat | where substr(`type`, 1, 2) in ( 'dog', 'cat') |
| ?type|lower|substr(1,2)|in=dog,cat | where substr(lower(`type`), 1, 2) in ( 'dog', 'cat') |
| ?data.type=dog | where `data`->'$.type' = 'dog' |
| ?data[0].type=cat | where `data`->'$[0].type' = 'cat' |
| ?data[0]=dog | where `data`->'$[0]' = 'dog' |
| 查询字符串 | 别名 | 对应SQL |
|---|---|---|
| ?id|gt=1 | where `id` > 1 |
|
| ?id|ge=1 | where `id` >= 1 |
|
| ?id|lt=1 | where `id` < 1 |
|
| ?id|le=1 | where `id` <= 1 |
|
| ?id|in=1 | where `id` in (1) |
|
| ?id|not_in=1 | nin | where `id` not in (1) |
| ?id|between=1,2 | bt | where `id` between 1 and 2 |
| ?id|not_between=1,2 | nbt | where `id` not between 1 and 2 |
| ?id|like=k% | lk | where `id` like 'k%' |
| ?id|not_like=k% | nlk | where `id` not like 'k%' |
| ?id|is_null=1 | nl | where `id` is null |
| ?id|is_not_null=1 | nnl | where `id` is not null |
对于复杂的查询需求，可以通过 sub 参数传入子查询：
var subQuery = dsl.selectQuery();
var users = userFilament.get(db, new HashMap<>() {{
put("role", "admin");
}}, subQuery);继承 Filaments 类，扩展自定义方法：
public class UserFilaments extends Filaments<User> {
public UserFilaments() {
super(User.class);
}
public List<Record> getByOrgId(DSLContext db, Long orgId) {
return db.raw();
}
}- 在数据库中编写视图
- 通过
sub参数传入构造的子查询 - 继承
Filaments类，扩展自定义方法，通过db.raw()直接编写语句
- 根据业务需求灵活选择数据库连接（主库或从库）
- 灵活选择事务上下文
欢迎提交 Issue 和 Pull Request！