8.5 SpringBoot集成ElasticSearch之查询文档

1.condition开发
在项目目录“/src/main/java/com/example/es”下新建condition目录，并在condition目录下新建SampleEmployeeCondition查询条件类，具体代码如下。

@Data
public class SampleEmployeeCondition {
    @Must
    @Field("employeeId")
    private String employeeId;

    @Must
    @Field("name")
    private String name;

    @Must
    @Field("age")
    private Integer age;

    @Must
    @Field("birthday")
    private String birthday;

    @Must
    @Field("job")
    private String job;

    @Must
    @Field("salary")
    private Float salary;
}

2.mapper开发
在项目目录“/src/main/java/com/example/es”的EmployeeMapper类中新增查询员工信息接口，具体代码如下。

@EasyMapper(indices = "employee", clusterRouter = "sampleCluster")
public interface EmployeeMapper {
    /**
     * 查询员工
     *
     * @param sampleEmployeeCondition 员工
     * @return Employee,可能为null
     */
    @Get
    EmployeeEntity getEmployee(SampleEmployeeCondition sampleEmployeeCondition);

    /**
     * 查询员工
     *
     * @param id 员工文档id
     * @return Employee,可能为null
     */
    @Get
    EmployeeEntity getEmployee(String id);

    /**
     * 查询员工
     *
     * @param id 员工文档id
     * @return Option
     */
    @Get
    Optional<EmployeeEntity> getEmployeeOptional(String id);

    /**
     * 查询员工
     *
     * @param id 员工文档id
     * @return GetResponse
     */
    @Get
    GetResponse getEmployeeGetResponse(String id);

    /**
     * 查询员工
     *
     * @param id 员工文档id
     * @return 异步Optional
     */
    @Get
    CompletableFuture<Optional<EmployeeEntity>> getEmployeeCompletableFuture(String id);
}

3.controller开发
在项目目录“/src/main/java/com/example/es”下的EmployeeController类中新增查询员工信息接口，以indexEmployeeString接口为例演示开发步骤，具体代码如下。

@RestController
@RequestMapping("/employee")
public class EmployeeController {
    @Resource
    private EmployeeMapper employeeMapper;

    @ResponseBody
    @RequestMapping(value = "/getEmployee", method = RequestMethod.POST)
    public EmployeeEntity getEmployee(@RequestParam String id) {
        return employeeMapper.getEmployee(id);
    }
}

4.测试
启动项目，然后在postman中请求“http://localhost:8080/employee/getEmployee?id=4SB70X0B68NPz8Jszbaa”，成功后返回文档id所对应的文档信息。

{
    "id": null,
    "employeeId": "10000002",
    "name": "Stephen Curry",
    "age": 27,
    "birthday": "1995-08-06",
    "job": "Java engineer",
    "salary": 20000.0
}

5.@Get属性说明

序号	属性名	默认值	说明
1	preference		设置查询偏好，影响查询的分片策略
2	refresh	false	设置是否刷新，默认不刷新
3	realtime	true	设置是否实时查询，默认实时

6.Multi Get API
(1).mapper开发
在项目目录“/src/main/java/com/example/es”的EmployeeMapper类中新增批量查询员工信息接口，具体代码如下。

@EasyMapper(indices = "employee", clusterRouter = "sampleCluster")
public interface EmployeeMapper {
    /**
     * 多员工查询
     *
     * @param ids 多员工id
     * @return MultiGetResponse
     */
    @MultiGet
    MultiGetResponse getEmployeesResponse(String... ids);

    /**
     * 多员工查询
     *
     * @param ids 多员工id
     * @return 员工集合
     */
    @MultiGet
    List<EmployeeEntity> getEmployees(String... ids);

    /**
     * 多员工查询
     *
     * @param ids 多员工id
     * @return MultiGetItemResponse[]
     */
    @MultiGet
    MultiGetItemResponse[] getEmployeesItemResponse(String... ids);

    /**
     * 多员工查询
     *
     * @param sampleEmployeeConditionList 多员工
     * @return 员工数组
     */
    @MultiGet
    EmployeeEntity[] getEmployees(List<SampleEmployeeCondition> sampleEmployeeConditionList);

    /**
     * 多员工查询
     *
     * @param sampleEmployeeConditionList 多员工id
     * @return List<MultiGetItemResponse>
     */
    @MultiGet
    List<MultiGetItemResponse> getEmployeesItemResponse(List<SampleEmployeeCondition> sampleEmployeeConditionList);

    /**
     * 多员工查询
     *
     * @param ids 多员工id
     * @return List<Optional < EmployeeEntity>>
     */
    @MultiGet
    List<Optional<EmployeeEntity>> getEmployeesOptional(String... ids);

    /**
     * 多员工查询
     *
     * @param sampleEmployeeConditionList 多员工
     * @return Optional<RecentOrder>[]
     */
    @MultiGet
    Optional<EmployeeEntity>[] getEmployeesOptional(List<SampleEmployeeCondition> sampleEmployeeConditionList);

    /**
     * 多员工异步查询
     *
     * @param sampleEmployeeConditionList 多员工
     * @return CompletableFuture<Optional < EmployeeEntity>[]>
     */
    @MultiGet
    CompletableFuture<Optional<EmployeeEntity>[]> getEmployeesOptionalFuture(List<SampleEmployeeCondition> sampleEmployeeConditionList);
}

(2).controller开发
在项目目录“/src/main/java/com/example/es”下的EmployeeController类中新增批量查询员工信息接口，以接口getEmployeesResponse为例演示开发步骤，具体代码如下。

@RestController
@RequestMapping("/employee")
public class EmployeeController {
    @Resource
    private EmployeeMapper employeeMapper;

    @ResponseBody
    @RequestMapping(value = "/getEmployeesResponse", method = RequestMethod.POST)
    public MultiGetResponse getEmployeesResponse(@RequestBody List<String> integerList) {
        return employeeMapper.getEmployeesResponse(integerList.toArray(new String[integerList.size()]));
    }
}

(3).测试
启动项目，然后在postman中请求“http://localhost:8080/employee/getEmployeesResponse”，成功后返回对应的信息。

["4iB70X0B68NPz8Js6rb3","5iB80X0B68NPz8JsY7aI"]

{
    "responses": [
        {
            "response": {
                "fields": {},
                "id": "4iB70X0B68NPz8Js6rb3",
                "type": "_doc",
                "index": "employee",
                "source": {
                    "birthday": "1987-12-25",
                    "name": "LeBron James",
                    "employeeId": 10000003,
                    "job": "Technical director",
                    "salary": 50000.0,
                    "age": 35
                },
                "version": 2,
                "primaryTerm": 1,
                "seqNo": 18,
                "sourceAsBytes": "eyJlbXBsb3llZUlkIjoxMDAwMDAwMywibmFtZSI6IkxlQnJvbiBKYW1lcyIsImpvYiI6IlRlY2huaWNhbCBkaXJlY3RvciIsImFnZSI6MzUsInNhbGFyeSI6NTAwMDAuMCwiYmlydGhkYXkiOiIxOTg3LTEyLTI1In0=",
                "exists": true,
                "sourceEmpty": false,
                "sourceAsMap": {
                    "birthday": "1987-12-25",
                    "name": "LeBron James",
                    "employeeId": 10000003,
                    "job": "Technical director",
                    "salary": 50000.0,
                    "age": 35
                },
                "sourceInternal": {
                    "fragment": true
                },
                "sourceAsString": "{\"employeeId\":10000003,\"name\":\"LeBron James\",\"job\":\"Technical director\",\"age\":35,\"salary\":50000.0,\"birthday\":\"1987-12-25\"}",
                "sourceAsBytesRef": {
                    "fragment": true
                },
                "fragment": false
            },
            "failure": null,
            "id": "4iB70X0B68NPz8Js6rb3",
            "type": "_doc",
            "index": "employee",
            "failed": false
        },
        {
            "response": {
                "fields": {},
                "id": "5iB80X0B68NPz8JsY7aI",
                "type": "_doc",
                "index": "employee",
                "source": {
                    "birthday": "1997-08-02",
                    "name": "Jason Tatum",
                    "employeeId": 10000007,
                    "job": "Java engineer",
                    "salary": 15000.0,
                    "age": 24
                },
                "version": 3,
                "primaryTerm": 1,
                "seqNo": 4,
                "sourceAsBytes": "eyJlbXBsb3llZUlkIjoxMDAwMDAwNywibmFtZSI6Ikphc29uIFRhdHVtIiwiam9iIjoiSmF2YSBlbmdpbmVlciIsImFnZSI6MjQsInNhbGFyeSI6MTUwMDAuMCwiYmlydGhkYXkiOiIxOTk3LTA4LTAyIn0=",
                "exists": true,
                "sourceEmpty": false,
                "sourceAsMap": {
                    "birthday": "1997-08-02",
                    "name": "Jason Tatum",
                    "employeeId": 10000007,
                    "job": "Java engineer",
                    "salary": 15000.0,
                    "age": 24
                },
                "sourceInternal": {
                    "fragment": true
                },
                "sourceAsString": "{\"employeeId\":10000007,\"name\":\"Jason Tatum\",\"job\":\"Java engineer\",\"age\":24,\"salary\":15000.0,\"birthday\":\"1997-08-02\"}",
                "sourceAsBytesRef": {
                    "fragment": true
                },
                "fragment": false
            },
            "failure": null,
            "id": "5iB80X0B68NPz8JsY7aI",
            "type": "_doc",
            "index": "employee",
            "failed": false
        }
    ],
    "fragment": false
}