检索参数 #

Map<String, Object> params = MapUtils.builder()
        .page(0, 15)                    // 第 0 页，每页 15 条（推荐写法）
        .put("page", 0)                 // 等效写法
        .put("size", 15)                // 等效写法
        .build();
SearchResult<User> result = searcher.search(User.class, params);

Map<String, Object> params = MapUtils.builder()
        .limit(0, 15)                   // 偏移 0 条，查询 15 条（推荐写法）
        .put("offset", 0)               // 等效写法
        .put("size", 15)                // 等效写法
        .build();
SearchResult<User> result = searcher.search(User.class, params);

Map<String, Object> params = MapUtils.builder()
        .orderBy(User::getAge).desc()               // age 字段，降序（since v3.7.1）（推荐写法）
        .orderBy(User::getAge, "desc")              // 等效写法 1
        .put("sort", "age")                         // 等效写法 2
        .put("order", "desc")                       // 等效写法 2
        .build();
SearchResult<User> result = searcher.search(User.class, params);

Map<String, Object> params = MapUtils.builder()
        .orderBy(User::getAge).asc()                // age 字段 升序
        .orderBy(User::getTime).desc()              // time 字段 降序（多次调佣 orderBy 方法）
        .put("orderBy", "age:asc,time:desc")        // 等效写法      
        .build();
SearchResult<User> result = searcher.search(User.class, params);

public class User {
    private String name;
    // 省略其它..
}

Map<String, Object> params = MapUtils.builder()
        .field("name", "Jack")          // (1) 字段 name 的值为 Jack
        .field(User::getName, "Jack")   // 等效写法 == (1) 
        .op("eq")                       // (2) 指定 name 字段的运算符为 eq (默认就是 eq, 所以也可以省略)
        .op("Equal")                    // 等效写法 == (2) 
        .op(Operator.Equal)             // 等效写法 == (2) 
        .op(Equal.class)                // 等效写法 == (2) 
        .build();
User jack = searcher.searchFirst(User.class, params);           // 执行查询

Map<String, Object> params = MapUtils.builder()
        .group("A")             // A 组开始
        .field(User::getName, "Jack").ic()
        .field(User::getGender, "Male")
        .group("B")             // B 组开始
        .field(User::getName, "Alice")
        .field(User::getGender, "Female")
        .group("C")             // C 组开始
        .field(User::getAge, "20").op(GreateEqual.class)
        .groupExpr("(A|B)&C")   // 组间逻辑关系（组表达式）
        .build();

Map<String, Object> params = MapUtils.builder()
        // 未显示指定组 之前调用 field 方法
        .field(User::getAge, 20) 
        // 等效于下面的两行代码：
        //   .put("age", 20) 
        //   .put("$.age", 20) 
        .group("A")
        // 显示指定组 之后调用 field 方法
        .field(User::getName, "Jack") 
        // 只等效于：
        //   .put("A.name", "Jack")
        .build()

@Bean
public ExprParser.Factory myExprParserFactory() {
    DefaultParserFactory factory = new DefaultParserFactory();
    factory.setOrKey('/');      // 设置或逻辑符
    factory.setAndKey('+');     // 设置且逻辑符
    return factory;
}

@SearchBean(where = "age = :age") 
public class Student {
    // 省略 ...
}

Map<String, Object> params = MapUtils.builder()
        // 注意：这里不能使用 field 方法，因为 age 字段不是实体类的属性
        .put("age", 20)         // 指定内嵌参数 age 的值为 20  
        .build();
List<User> users = searcher.searchList(User.class, params);

Map<String, Object> params = MapUtils.builder()
        .onlySelect(User::getId, User::getName)     // （1）只查询 id 与 name 字段
        .onlySelect("id", "name")                   // 等效写法 =（1）
        .onlySelect("id,name")                      // 等效写法 =（1）（since v3.7.1）
        .selectExclude(User::getAge, User::getDate) // （2）不查询 age 与 date 字段
        .selectExclude("age", "date")               // 等效写法 =（2）
        .selectExclude("age,date")                  // 等效写法 =（2）（since v3.7.1）
        .build();
List<User> users = searcher.searchList(User.class, params);

Map<String, Object> params = MapUtils.builder()
       // 生成 SQL 条件：u.id in (select user_id from xxx)
       .field(User::getId).sql("$1 in (select user_id from xxx)")
       .build();
List<User> users = searcher.searchList(User.class, params);

Map<String, Object> params = MapUtils.builder()
       // 生成 SQL 条件：id < 100 or age > 10
       .field(User::getId, User::getAge).sql("$1 < 100 or $2 > 10")
       .build();
List<User> users = searcher.searchList(User.class, params);

 Map<String, Object> params = MapUtils.builder()
       // 生成 SQL 条件：id < ? or age > ?，两个占位符参数分别为：100，10
       .field(User::getId, User::getAge).sql("$1 < ? or $2 > ?", 100, 10)
       .build();
List<User> users = searcher.searchList(User.class, params);

// page 分页，与 offset 分页 配置一个即可
PageSizeExtractor pageSizeExtractor = new PageSizeExtractor();
pageSizeExtractor.setSizeName("size");          // 每页大小参数名
pageSizeExtractor.setPageName("page");          // 页码参数名
pageSizeExtractor.setStart(0);                  // 起始页码
pageSizeExtractor.setMaxAllowedSize(100);       // 允许的最大页大小
pageSizeExtractor.setDefaultSize(15);           // 默认分页大小
// offset 分页，与 page 分页 配置一个即可
PageOffsetExtractor pageOffsetExtractor = new PageOffsetExtractor();
pageOffsetExtractor.setSizeName("size");        // 每页大小参数名
pageOffsetExtractor.setOffsetName("offset");    // 偏移条数参数名
pageOffsetExtractor.setStart(0);                // 起始页码
pageOffsetExtractor.setMaxAllowedSize(100);     // 允许的最大页大小
pageOffsetExtractor.setDefaultSize(15);         // 默认分页大小
// 参数解析器
DefaultParamResolver paramResolver = new DefaultParamResolver();
paramResolver.setPageExtractor(pageSizeExtractor);      // 分页方式：pageSizeExtractor / pageOffsetExtractor
paramResolver.setSortName("sort");                      // 排序字段参数名
paramResolver.setOrderName("order");                    // 排序方法参数名
paramResolver.setSeparator("-");                        // 参数名分割符
paramResolver.setOperatorSuffix("op");                  // 字段运算符参数名后缀
paramResolver.setIgnoreCaseSuffix("ic");                // 忽略大小写参数名后缀
paramResolver.setOnlySelectName("onlySelect");          // onlySelect 参数名
paramResolver.setSelectExcludeName("selectExclude");    // selectExclude 参数名
// 构建 MapSearcher 检索器
MapSearcher mapSearcher = SearcherBuilder.mapSearcher()
        // 省略其它配置，BeanSearcher 检索器也同此配置
        .paramResolver(paramResolver)
        .build();