带有 MyBatis 的 Spring Data JDBC 找不到自定义查询

Posted 2023-04-14

【中文标题】带有 MyBatis 的 Spring Data JDBC 找不到自定义查询

【英文标题】：Spring Data JDBC with MyBatis not finding custom query

【发布时间】：2019-04-13 10:52:09

【问题描述】：

我正在尝试将 Spring Data JDBC 与 MyBatis 一起使用。我对使用 CrudRepository 提供的开箱即用的 CRUD 方法以及编写在 MyBatis XML 文件中定义的附加自定义查询感兴趣。

通过阅读jdbc.mybatis 的说明，听起来我需要做的就是创建一个Mapper 来实现我想要的方法（遵守规则“语句的名称由将实体类型的完全限定名称与 Mapper") 连接起来，并将方法签名添加到我的 CrudRepository。我已经这样做了，但是 Spring Data 似乎从来没有找到我的方法并给出了这个错误：

org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'fooApplication': Invocation of init method failed; nested exception is org.springframework.dao.InvalidDataAccessApiUsageException: No query specified on findByChangeOwnerId; nested exception is java.lang.IllegalStateException: No query specified on findByChangeOwnerId
    at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.initializeBean(AbstractAutowireCapableBeanFactory.java:1778) ~[spring-beans-5.1.6.RELEASE.jar:5.1.6.RELEASE]
    at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.doCreateBean(AbstractAutowireCapableBeanFactory.java:593) ~[spring-beans-5.1.6.RELEASE.jar:5.1.6.RELEASE]
    at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.createBean(AbstractAutowireCapableBeanFactory.java:515) ~[spring-beans-5.1.6.RELEASE.jar:5.1.6.RELEASE]
    at org.springframework.beans.factory.support.AbstractBeanFactory.lambda$doGetBean$0(AbstractBeanFactory.java:320) ~[spring-beans-5.1.6.RELEASE.jar:5.1.6.RELEASE]
    at org.springframework.beans.factory.support.DefaultSingletonBeanRegistry.getSingleton(DefaultSingletonBeanRegistry.java:222) ~[spring-beans-5.1.6.RELEASE.jar:5.1.6.RELEASE]
    at org.springframework.beans.factory.support.AbstractBeanFactory.doGetBean(AbstractBeanFactory.java:318) ~[spring-beans-5.1.6.RELEASE.jar:5.1.6.RELEASE]
    at org.springframework.beans.factory.support.AbstractBeanFactory.getBean(AbstractBeanFactory.java:199) ~[spring-beans-5.1.6.RELEASE.jar:5.1.6.RELEASE]
    at org.springframework.beans.factory.support.DefaultListableBeanFactory.preInstantiateSingletons(DefaultListableBeanFactory.java:849) ~[spring-beans-5.1.6.RELEASE.jar:5.1.6.RELEASE]
    at org.springframework.context.support.AbstractApplicationContext.finishBeanFactoryInitialization(AbstractApplicationContext.java:877) ~[spring-context-5.1.6.RELEASE.jar:5.1.6.RELEASE]
    at org.springframework.context.support.AbstractApplicationContext.refresh(AbstractApplicationContext.java:549) ~[spring-context-5.1.6.RELEASE.jar:5.1.6.RELEASE]
    at org.springframework.boot.web.servlet.context.ServletWebServerApplicationContext.refresh(ServletWebServerApplicationContext.java:142) ~[spring-boot-2.1.3.RELEASE.jar:2.1.3.RELEASE]
    at org.springframework.boot.SpringApplication.refresh(SpringApplication.java:775) [spring-boot-2.1.3.RELEASE.jar:2.1.3.RELEASE]
    at org.springframework.boot.SpringApplication.refreshContext(SpringApplication.java:397) [spring-boot-2.1.3.RELEASE.jar:2.1.3.RELEASE]
    at org.springframework.boot.SpringApplication.run(SpringApplication.java:316) [spring-boot-2.1.3.RELEASE.jar:2.1.3.RELEASE]
    at org.springframework.boot.SpringApplication.run(SpringApplication.java:1260) [spring-boot-2.1.3.RELEASE.jar:2.1.3.RELEASE]
    at org.springframework.boot.SpringApplication.run(SpringApplication.java:1248) [spring-boot-2.1.3.RELEASE.jar:2.1.3.RELEASE]
    at com.xxx.fooApplication.main(fooApplication.java:42) [classes/:na]
Caused by: org.springframework.dao.InvalidDataAccessApiUsageException: No query specified on findByChangeOwnerId; nested exception is java.lang.IllegalStateException: No query specified on findByChangeOwnerId

我也遵循了mybatis-spring-boot-sample 中的示例，但我没有太多可以继续了解其中的内容。

问题是：

我可以向 CrudRepository 添加额外的方法来调用 MyBatis 吗？如果是这样可以解释我在下面缺少什么？ 我假设对于任何其他方法，我都可以传递我想要的任何参数，而不是总是必须传递 MyBatisContext?

我的 CrudRepository

package com.xxx.repository.jdbc;

import com.xxx.model.Foo;
import org.springframework.data.repository.CrudRepository;
import org.springframework.data.repository.query.Param;

import java.util.List;

public interface FooBmtRepository extends CrudRepository<Foo, String>   
  List<Foo> findByChangeOwnerId(@Param("id") String id);

src/main/resources/application.yml

mybatis:
  mapper-locations: classpath:/mapper/**/*.xml
  configuration:
    map-underscore-to-camel-case: true

映射器 XML

<?xml version="1.0" encoding="UTF-8" ?>

<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">

<mapper namespace="com.xxx.model.ItsmMapper">
    <!--<select id="findByChangeOwnerId" resultType="com.xxx.model.Itsm" parameterType="org.springframework.data.jdbc.mybatis.MyBatisContext">-->
    <!--where change_owner_id=#changeOwnerId-->
    <select id="findByChangeOwnerId" resultMap="itsmResultMap" parameterType="String">
        select *
        from [myschema].[tbl_itsms_bmt]
        where change_owner_id=#id
    </select>

    <resultMap id="itsmResultMap" type="com.xxx.model.Itsm">
        <result property="changeNumber" column="change_number"/>
        <result property="itsmUrl" column="itsm_url"/>
        <result property="changeTitle" column="change_title"/>
        <result property="category" column="category"/>
        <result property="status" column="status"/>
        <result property="createdDate" column="created_date"/>
    </resultMap>

</mapper>

依赖项（大多数是使用启动器导入的，因为我无法正确显示mvn dependency:tree，所以显示所有内容）

<dependency>
    <groupId>org.springframework.data</groupId>
    <artifactId>spring-data-jdbc</artifactId>
    <version>1.0.5.RELEASE</version>
</dependency>
<dependency>
    <groupId>org.springframework.data</groupId>
    <artifactId>spring-data-commons</artifactId>
    <version>2.1.5.RELEASE</version>
</dependency>
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-jdbc</artifactId>
    <version>5.1.6.RELEASE</version>
</dependency>
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-core</artifactId>
    <version>5.1.6.RELEASE</version>
    <scope>compile</scope>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot</artifactId>
    <version>2.1.3.RELEASE</version>
    <scope>compile</scope>
</dependency>
<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>2.0.0</version>
</dependency>
<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis</artifactId>
    <version>3.5.0</version>
</dependency>
<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis-spring</artifactId>
    <version>2.0.0</version>
</dependency>
<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-autoconfigure</artifactId>
    <version>2.0.0</version>
</dependency>
<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>2.0.0</version>
</dependency>

【参考方案1】：

您链接到的部分的开头是：

对于CrudRepository 中的每个操作，Spring Data JDBC 运行多个语句。如果应用程序上下文中存在SqlSessionFactory，Spring Data 会为每个步骤检查 SessionFactory 是否提供语句。如果找到，则使用该语句（包括其配置的到实体的映射）。

这仅适用于CrudRepository 中的方法。 其他方法不能这样工作。

你可以实现一个完整的自定义方法实现，调用 MyBatis。

或者，您可以为 MyBatis 支持的命名查询创建一个问题，甚至可能是一个 PR。

【讨论】：

我已阅读您所指出的内容，但不确定我是否正确解释了该声明 - 感谢您的澄清。现在我已经打开了一个增强请求。 jira.spring.io/browse/DATAJDBC-362

谢谢。如果您知道如何改进文档以使其更清晰，我也将不胜感激。