SpringとMyBatisの統合設定と基本構成

SpringとMyBatisを統合することで、依存性注入やトランザクション管理といったSpringの強力な機能を活用しながら、データアクセス層を効率的に構築できます。

1. 必要なライブラリの追加

プロジェクトにmybatis-springおよび関連する依存を追加します。これにより、MyBatisのコンポーネントがSpringコンテナで管理可能になります。

2. MyBatis設定ファイル(任意)

従来のmybatis-config.xmlは省略可能です。ただし、特定の設定(例:キャメルケース変換、エイリアス定義)を明示したい場合は以下のように記述します:

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <settings>
        <setting name="mapUnderscoreToCamelCase" value="true"/>
    </settings>

    <typeAliases>
        <package name="com.example.model"/>
    </typeAliases>

    <databaseIdProvider type="DB_VENDOR">
        <property name="MySQL" value="mysql"/>
        <property name="Oracle" value="oracle"/>
    </databaseIdProvider>
</configuration>

3. データベース接続情報の外部化

接続情報をdb.propertiesとして分離し、柔軟な環境切り替えを実現します:

db.driver=com.mysql.cj.jdbc.Driver
db.url=jdbc:mysql://localhost:3306/sample_db
db.user=admin
db.pass=secret

4. MapperインターフェースとXMLの作成

Mapperインターフェースと対応するXMLマッピングファイルを作成します。XMLファイルは任意のクラスパス下に配置可能です:

<?xml version="1.0" encoding="UTF-8"?>
<mapper namespace="com.example.dao.UserMapper">
    <select id="getUserById" resultType="User">
        SELECT * FROM users WHERE user_id = #{id}
    </select>
</mapper>

5. Spring設定ファイルの構成

applicationContext.xmlでデータソース、トランザクション、MyBatisファクトリーを定義します:

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

    <context:property-placeholder location="classpath:db.properties"/>

    <bean id="dataSource" class="com.zaxxer.hikari.HikariDataSource">
        <property name="driverClassName" value="${db.driver}"/>
        <property name="jdbcUrl" value="${db.url}"/>
        <property name="username" value="${db.user}"/>
        <property name="password" value="${db.pass}"/>
    </bean>

    <bean id="transactionManager" 
          class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
        <property name="dataSource" ref="dataSource"/>
    </bean>

    <tx:annotation-driven/>

    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <property name="dataSource" ref="dataSource"/>
        <property name="configLocation" value="classpath:mybatis-config.xml"/>
        <property name="mapperLocations" value="classpath:mappers/*.xml"/>
    </bean>

    <mybatis:scan base-package="com.example.dao"/>
</beans>

6. Spring MVC設定の分離

コントローラ専用のスキャン設定を行い、Web層とビジネス層を明確に分離します:

<context:component-scan base-package="com.example" 
                         use-default-filters="false">
    <context:include-filter type="annotation" 
                            expression="org.springframework.stereotype.Controller"/>
</context:component-scan>

<bean class="org.springframework.web.servlet.view.JstlViewResolver">
    <property name="prefix" value="/WEB-INF/views/"/>
    <property name="suffix" value=".jsp"/>
</bean>

<mvc:annotation-driven/>
<mvc:default-servlet-handler/>

7. Webアプリケーション初期化

web.xmlでSpringコンテキストとDispatcherServletを起動順に設定します:

<web-app>
    <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>classpath:applicationContext.xml</param-value>
    </context-param>

    <listener>
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
    </listener>

    <servlet>
        <servlet-name>appServlet</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>/WEB-INF/spring-servlet.xml</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>

    <servlet-mapping>
        <servlet-name>appServlet</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>
</web-app>

タグ: MyBatis Spring JavaEE

7月26日 00:49 投稿