MyBatis框架中@ResultType注解的正确使用方法是什么？

DDD 2025-03-17 00:00:00 次阅读

MyBatis框架中@ResultType注解的正确用法常常令人困惑。本文将深入探讨@ResultType注解的实际应用场景，并通过代码示例阐明其作用。

MyBatis源码揭示，@ResultType注解仅在方法返回类型为void时生效。源码片段如下：

//源码参考: org.apache.ibatis.builder.annotation.MapperAnnotationBuilder#getReturnType
if (void.class.equals(returnType)) {
    ResultType rt = method.getAnnotation(ResultType.class);
    if (rt != null) {
        returnType = rt.value();
    }
}

这意味着@ResultType用于指定void方法的返回结果类型。例如：

@Select("select * from student")
@ResultType(Student.class)
void queryStudent();

那么，如何获取queryStudent

方法的Student对象呢？ @ResultType注解的关键在于与ResultHandler的配合使用。MyBatis官方文档指出，当使用ResultHandler时，方法返回类型必须为void，因为ResultHandler负责逐行处理结果集。@ResultType在此情况下指定每一行数据映射成的对象类型。如果已在XML映射文件中定义结果类型，则无需@ResultType注解。

正确的@ResultType注解使用方法如下：

@Select("select * from Student")
@ResultType(Student.class)
void queryStudent(StudentResultHandler resultHandler);

public class StudentResultHandler implements ResultHandler {
    private final List students = new ArrayList<>();

    @Override
    public void handleResult(ResultContext context) {
        Student student = (Student) context.getResultObject();
        students.add(student);
    }

    public List getStudents() {
        return students;
    }
}

此例中，queryStudent方法返回void，但通过StudentResultHandler处理结果集。ResultHandler的handleResult方法每次处理一行结果，将Student对象添加到students列表中。最终，通过StudentResultHandler的getStudents()方法即可访问查询结果。

综上所述，@ResultType注解主要用于void方法，配合ResultHandler使用，明确结果集的映射类型。这在无需XML映射文件或需要更精细化结果处理时非常有用。