web-dev-qa-db-ja.com

MyBatis-Spring + @ Configuration-マッパーBeanを自動配線できません

チームの概念実証として、データアクセス層にMyBatisを使用するSpringプロジェクトを作成しようとしています。可能な限りXML構成を避けたいので、注釈付きの@ Configurationクラスを使用してすべてを相互に接続しようとしています。

すべては正しく配線されているようですが、マッパーBeanがサービスレイヤーに自動配線されていません。

私の例では、UserDao、Userエンティティ、およびUserServiceを相互に接続しようとしています。

serDao

public interface UserDao {
    @Select("SELECT * FROM users WHERE id = #{userId}")
    User get(@Param("userId") Integer userId);
}

ユーザー

@Component("User")
public class User implements Entity {
    public Integer userId;
    public String username;

    /** ... getters/setters ommitted **/
}

serServiceImpl

@Service("UserService")
public class UserServiceImpl {
    private UserDao userDao = null;  

    public User getUserDetails(Integer userId) {
        return userDao.get(userId);        
    }

    @Autowired
    public void setUserDao(UserDao userDao) {
        this.userDao = userDao;
    }
}

2つの構成クラスを使用してこれらを相互に配線しています。

ApplicationContextConfig

@Configuration
@EnableLoadTimeWeaving(aspectjWeaving=AspectJWeaving.ENABLED)
@Import(DefaultDataAccessConfig.class) // I'm importing this because I thought ordering might be important, otherwise I was hoping to just let the component scanning pull in additional configuration files
@ComponentScan(basePackages="com.example.gwtspringpoc.server",
               excludeFilters=@Filter(type=FilterType.ANNOTATION,
                                      value=Controller.class))
public class ApplicationContextConfig {
    /** No bean definitions needed here **/
}

DefaultDataAccessConfig

@Configuration
@EnableTransactionManagement
public class DefaultDataAccessConfig implements TransactionManagementConfigurer {    
    @Bean
    public DataSource dataSource() {
        OracleDataSource ods = null;
        try {
            ods = new OracleDataSource();
        } catch (SQLException e) {
            throw new RuntimeException(e);
        }

        ods.setURL("jdbc:Oracle:thin:@//localhost:9601/sid");
        ods.setUser("user");
        ods.setPassword("pass");        

        return ods;       
    }

    @Override
    @Bean(name="transactionManager")
    public PlatformTransactionManager annotationDrivenTransactionManager() {
        return new DataSourceTransactionManager(dataSource());
    }

    @Bean
    public SqlSessionFactory sqlSessionFactory() {
        SqlSessionFactoryBean sf = new SqlSessionFactoryBean();        
        sf.setDataSource(dataSource());    
        try {
            return (SqlSessionFactory) sf.getObject();
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }

    @Bean
    public SqlSession sqlSessionTemplate() {
        return new SqlSessionTemplate(sqlSessionFactory());
    }    

    /*
     * This did not work at all. It seems to be configured correctly, but the UserDao bean never
     * got created at any stage, which was very disappointing as I was hoping not to have to
     * create a bean definition for each DAO manually
     */
    /*@Bean
    public static MapperScannerConfigurer mapperScannerConfig() {
        MapperScannerConfigurer msc = new MapperScannerConfigurer();
        msc.setBasePackage("com.ca.spna.gwtspringpoc.server.model.dao");      
        msc.setAnnotationClass(Repository.class);      

        return msc;
    }*/

    /*
     * Because the above code did not work, I decided to create the mapping manually.
     * This is most likely my problem - something about this setup. My understanding
     * is that the MapperFactoryBean once instantiated by Spring, will create a proxy
     * object of type UserDao with the name "userDao" that can be injected elsewhere.
     */
    @Bean
    public MapperFactoryBean<UserDao> userDao() {
        MapperFactoryBean<UserDao> mfb = new MapperFactoryBean<UserDao>();        
        mfb.setMapperInterface(UserDao.class);
        return mfb;
    }
}

上記のコードスニペットの最後の2つのメソッドの上のコメントを読んで、UserDaoBeanを作成する方法についてさらに詳しく知ることができます。

すべての構成セットアップを取得したら、AnnotationConfigContextLoaderを使用してserServiceをテストしようとする単体テストを作成しましたが、実行しようとするとすぐに次の例外が発生しました。テスト：

例外

Caused by: org.springframework.beans.factory.BeanCreationException: Could not autowire method: public void com.example.gwtspringpoc.server.service.UserServiceImpl.setUserDao(com.example.gwtspringpoc.server.model.dao.UserDao); nested exception is org.springframework.beans.factory.NoSuchBeanDefinitionException: No matching bean of type [com.example.gwtspringpoc.server.model.dao.UserDao] found for dependency: expected at least 1 bean which qualifies as autowire candidate for this dependency. Dependency annotations: {}

それを見た後、serServiceの@ Autowiredをコメントアウトし、ユニットテストに戻ってApplicationContextを挿入したので、それを検査できました。 、および「userDao」という名前のBeanは、実際にはMapperProxyインスタンスです。

それで、MapperFactoryBeanがどのように軌道から外れて機能するかについての私の理解ですか、それともアノテーション駆動型構成とあまり互換性がありませんか？さらに、MapperScannerConfigurerを正しく機能させる方法を誰かが知っているなら、私はそれを大いに感謝します！

springmybatis
11
Jason McClellan

しばらくして理解できたので、情報があまりなくて検索が必要だったので、他の人が似たようなものに出くわした場合に備えて、自分の質問に答えます。

問題は、MapperScannerConfigurerがBeanDefinitionRegistryPostProcessorであるという事実に帰着します。実は、これは@ Configurationファイルを処理し、@ Beanアノテーション付きメソッドを登録するために使用されるのと同じメカニズムです。残念ながら、このSpring Jiraチケットによると、1つのBeanDefinitionRegistryPostProcessorは別のBeanDefinitionRegistryPostProcessor（---）を利用できません： https://jira.springsource.org/browse/SPR-7868 =

ここでの提案は、プロセッサのXML構成を作成し、それをプルするためにJavaベースの構成に@ ImportResourceアノテーションを含めることでした。まあ、その提案は完全に正確ではありません。構成を経由してブートストラップすることをまだ計画している場合は、構成を使用してXMLファイルを作成し、それをJavaベースの構成にプルすることはできません。 anAnnotationConfigContextLoader。代わりに、最初にXMLを介して構成をロードしてから、構成ファイルのBeanを「昔ながらの」方法で作成するように戻す必要があります。私はこれ、かなり些細なことでした。

新しいアプリケーションコンテキスト

<beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-3.1.xsd         http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.1.xsd         http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.1.xsd         http://www.springframework.org/schema/jee http://www.springframework.org/schema/jee/spring-jee-3.1.xsd         http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-3.1.xsd">

    <!--
        Because MapperScannerConfigurer is a BeanDefinitionRegistryPostProcessor, it cannot be 
        configured via @Configuration files with a @Bean annotaiton, because those files are
        themselves configured via a BeanDefinitionRegistryPostProcessor which cannot spawn
        another one.
    -->
    <bean id="myBatisMapperScanner" class="org.mybatis.spring.mapper.MapperScannerConfigurer">
       <property name="basePackage" value="com.example.gwtspringpoc.server.model.dao"/>
       <property name="annotationClass" value="org.springframework.stereotype.Repository"/>
    </bean>

    <!-- 
        Load the rest of our configuration via our base configuration class
     -->
     <bean class="com.example.gwtspringpoc.server.spring.config.ApplicationContextConfig" />
</beans>

次に、ContextConfigLocationを提供することにより、従来の方法でbootstrapコンテキストコンテナを使用します。ApplicationContextConfigのため、これは機能します。上記のXMLで参照しているは、他のすべてを処理します-他のすべての@ Configurationファイルを取得するコンポーネントスキャンを含みます。

これを行うと、私の問題はすべて解消されました。期待どおりにUserDaoを@ Autowireすることができ、すべてが素晴らしかった。

注：

元の質問のコード例のように、MapperFactoryBeanを作成してUserDaoを手動で定義しようとすると、UserDao Beanが作成されましたが、タイプはMapperProxyでした。 そしてしません@ Autowire。ただし、@ Repository（ "userDao"）を使用して、名前でロードすることができます。 MapperFactoryBeanはMapperScannerConfigurerと同様の問題を抱えており、単にと互換性がないと思います。 @Configurationファイル、残念ながら。

14
Jason McClellan

Mybatis.3.2.0およびmybatis-spring.1.2.0から、MapperFactoryBeanの代わりにMapperScanを使用できます。

@Configuration 
@MapperScan("org.mybatis.spring.sample.mapper") 
public class AppConfig 
{   
    @Bean   
    public DataSource dataSource() 
    {     
      return new EmbeddedDatabaseBuilder().addScript("schema.sql").build();   
    }   
   @Bean   
   public DataSourceTransactionManager transactionManager() 
   {     
        return new DataSourceTransactionManager(dataSource());   
   }   
   @Bean   
   public SqlSessionFactory sqlSessionFactory() throws Exception 
   {     
       SqlSessionFactoryBean sessionFactory = new SqlSessionFactoryBean();
       sessionFactory.setDataSource(dataSource());    
       return sessionFactory.getObject();   
   } 
}
5
pavanlapr

別の可能な解決策は、ジェイソンが言及したチェックされたjiraにあります。私の問題を解決し、絶対に避けようとしているXML構成を使用する必要はありませんでした...

https://jira.spring.io/browse/SPR-7868

@Configuration 
public class A implements BeanDefinitionRegistryPostProcessor, PriorityOrdered {

    @Override
    public void postProcessBeanDefinitionRegistry(...) {
         ...
    }

    @Override
    public void postProcessBeanFactory(...) {
        ...
    }

    @Override
    public int getOrder() {
        return 0;
    }
}
2
Amit Goldstein