MyBatis + Spring 基于SqlSessionDaoSupport的泛型基類

引官網一段話：

SqlSessionDaoSupport 是一個抽象的支持類, 用來為你提供 SqlSession 。調用 getSqlSession()方法你會得到一個 SqlSessionTemplate,之後可以用于執行 SQL 方法

SqlSessionDaoSupport 需要一個 sqlSessionFactory 或 sqlSessionTemplate 屬性來設置。這些被明确地設置或由 Spring 來自動裝配。如果兩者都被設置了 , 那麼 SqlSessionFactory 是被忽略的。

本次環境如下（基于Maven 中推薦版本）：

spring：4.2.5.RELEASE
mybatis：3.4.0
mybatis-spring：1.3.0
junit：4.12

表user_1，user_2，user_3 結構相同

以user_1為例：

CREATE TABLE `user_1` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `name` varchar(255) DEFAULT NULL,
  `create_time` datetime DEFAULT NULL,
  `create_id` int(11) DEFAULT NULL,
  `update_time` datetime DEFAULT NULL,
  `update_id` int(11) DEFAULT NULL,
  `deleted` bit(1) DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=3 DEFAULT CHARSET=utf8;

實體基類，封裝公共屬性：

public class BaseEntity {
    protected Integer id;
    protected Date createTime;
    protected Integer createId;
    protected Date updateTime;
    protected Integer updateId;
    protected Boolean deleted;
    //省略setter getter
}

userA實體繼承實體基類：

public class UserA extends BaseEntity implements Serializable {
    private static final long serialVersionUID = 1L;

    private String name;
    //省略setter getter
}

userB，userC類似

Mapper接口基類：

public interface BaseMapper<T> {
    int deleteByPrimaryKey(Integer id);

    int insert(T record);

    T selectByPrimaryKey(Integer id);

    List<T> selectAll();

    int updateByPrimaryKey(T record);
}

抽象Mapper類：

public abstract class AbstractBaseMapper<T extends BaseEntity> extends SqlSessionDaoSupport implements BaseMapper<T> {

    private static final String SQL_INSERT = "insert";
    private static final String SQL_DELETE_BY_PRIMARY_KEY = "deleteByPrimaryKey";
    private static final String SQL_UPDATE_BY_PRIMARY_KEY = "updateByPrimaryKey";
    private static final String SQL_SELECT_BY_PRIMARY_KEY = "selectByPrimaryKey";
    private static final String SQL_SELECT_ALL = "selectAll";


    @Override
    @Autowired
    public void setSqlSessionFactory(SqlSessionFactory sqlSessionFactory) {
        super.setSqlSessionFactory(sqlSessionFactory);
    }

    @Override
    @Autowired
    public void setSqlSessionTemplate(SqlSessionTemplate sqlSessionTemplate) {
        super.setSqlSessionTemplate(sqlSessionTemplate);
    }

    public String getStatement(String sqlId) {
        //決定了mapper.xml namespace中的值
        String name = this.getClass().getName();
        StringBuilder sb = new StringBuilder();
        sb.append(name).append(".").append(sqlId);
        return sb.toString();
    }

    @Override
    public int deleteByPrimaryKey(Integer id) {
        return getSqlSession().delete(getStatement(SQL_DELETE_BY_PRIMARY_KEY), id);
    }

    @Override
    public int insert(T record) {
        return getSqlSession().insert(getStatement(SQL_INSERT), record);
    }

    @Override
    public T selectByPrimaryKey(Integer id) {
        return getSqlSession().selectOne(getStatement(SQL_SELECT_BY_PRIMARY_KEY), id);
    }

    @Override
    public List<T> selectAll() {
        return getSqlSession().selectList(getStatement(SQL_SELECT_ALL));
    }

    @Override
    public int updateByPrimaryKey(T record) {
        return getSqlSession().update(getStatement(SQL_UPDATE_BY_PRIMARY_KEY), record);
    }
}

說明：

SqlSessionDaoSupport 需要一個 sqlSessionFactory 或 sqlSessionTemplate 屬性來設置

是以需做如下配置：

@Override
@Autowired
public void setSqlSessionFactory(SqlSessionFactory sqlSessionFactory) {
    super.setSqlSessionFactory(sqlSessionFactory);
}

或

@Override
@Autowired
public void setSqlSessionTemplate(SqlSessionTemplate sqlSessionTemplate) {
    super.setSqlSessionTemplate(sqlSessionTemplate);
}

兩個一起設定，sqlSessionFactory将被忽略

getStatement()方法用于定位具體需要執行的SQL，具體原理可參考MyBatis configuration.xml檔案解析相關知識，也正是因為該方法，mapper.xml namespace的值和正常整合時的值不一樣，正常整合時是Mapper接口的全限定類名，而此處将會是Mapper接口具體實作類的全限定類名

public String getStatement(String sqlId) {
    //決定了mapper.xml namespace中的值
    String name = this.getClass().getName();
    StringBuilder sb = new StringBuilder();
    sb.append(name).append(".").append(sqlId);
    return sb.toString();
}

此時UaerADao隻需要繼承BaseMapper，UserADaoImpl 繼承AbstractBaseMapper并實作UserADao接口即可，AbstractBaseMapper中實作了常見所需方法

public interface UserADao extends BaseMapper<UserA>{

}

public class UserADaoImpl extends AbstractBaseMapper<UserA> implements UserADao {

}

UserADao對應的Mapper.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.example.dao.impl.UserADaoImpl">
    <delete id="deleteByPrimaryKey" parameterType="java.lang.Integer">
        delete from user_1
        where id = #{id,jdbcType=INTEGER}
    </delete>
    <insert id="insert" useGeneratedKeys="true" keyProperty="id" parameterType="UserA">
        insert into user_1 (name, create_time,
        create_id, update_time, update_id,
        deleted)
        values (#{name,jdbcType=VARCHAR},
        #{createTime,jdbcType=TIMESTAMP},
        #{createId,jdbcType=INTEGER}, #{updateTime,jdbcType=TIMESTAMP}, #{updateId,jdbcType=INTEGER},
        #{deleted,jdbcType=BIT})
    </insert>
    <update id="updateByPrimaryKey" parameterType="UserA">
        update user_1
        set name = #{name,jdbcType=VARCHAR},
        create_time = #{createTime,jdbcType=TIMESTAMP},
        create_id = #{createId,jdbcType=INTEGER},
        update_time = #{updateTime,jdbcType=TIMESTAMP},
        update_id = #{updateId,jdbcType=INTEGER},
        deleted = #{deleted,jdbcType=BIT}
        where id = #{id,jdbcType=INTEGER}
    </update>
    <select id="selectByPrimaryKey" resultType="UserA"
        parameterType="java.lang.Integer">
        select id, name, create_time, create_id, update_time, update_id, deleted
        from user_1
        where id = #{id,jdbcType=INTEGER}
    </select>
    <select id="selectAll" resultType="UserA">
        select id, name, create_time, create_id, update_time, update_id, deleted
        from user_1
    </select>
</mapper>

該配置檔案直接利用駝峰命名轉換實作資料庫列與實體屬性的映射

spring配置檔案如下：

<!--配置資料庫相關參數 -->
<context:property-placeholder location="classpath:jdbc.properties"></context:property-placeholder>

<!-- Druid 連接配接池 的 資料源 -->
<bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource"
    init-method="init" destroy-method="close">
    <property name="url" value="${db.url}" />
    <property name="username" value="${db.username}" />
    <property name="password" value="${db.password}" />
</bean>

<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
    <property name="dataSource" ref="dataSource"></property>
    <!--掃描Entity包 使用别名 -->
    <property name="typeAliasesPackage" value="com.example.entity"></property>
    <!--掃描sql配置檔案 -->
    <property name="mapperLocations" value="classpath:mybatis/**/*.xml"></property>
    <!-- 需mybatis-spring 版本1.3.0 -->
    <property name="configuration">
        <bean class="org.apache.ibatis.session.Configuration">
            <!-- 開啟駝峰命名轉換 -->
            <property name="mapUnderscoreToCamelCase" value="true" />
        </bean>
    </property>
</bean>

<bean id="sqlSessionTemplate" class="org.mybatis.spring.SqlSessionTemplate">
    <constructor-arg index="0" ref="sqlSessionFactory" />
</bean>

若UserADao接口需要定義自己單獨的方法，如：

public interface UserADao extends BaseMapper<UserA>{

    UserA selectByName(String name);

}

實作類如下做即可：

public class UserADaoImpl extends AbstractBaseMapper<UserA> implements UserADao {

    @Override
    public UserA selectByName(String name) {
        return getSqlSession().selectOne("selectByName", name);
    }

}

注意上述selectOne(“selectByName”, name)中的selectByName即映射檔案中的sql id：

<select id="selectByName" resultType="UserA">
    select id, name, create_time, create_id, update_time, update_id, deleted
    from user_1
    where name = #{name,jdbcType=VARCHAR}
</select>

該方式與利用代碼生成器直接生成的方式各有利弊，看官自己選擇

MyBatis + Spring 基于SqlSessionDaoSupport的泛型基類

繼續閱讀

27 Best Free Eclipse Plug-ins for Java Developer to be ProductiveCode Quality PluginsText Editor PluginsDependency ManagementVersion Control Integration PluginsFramework Development Continuous Integration Related PluginsOther Utility Plugins

Java String.format方法的簡單使用

neo4j之cypher使用文檔

GitHub連夜封殺！這份阿裡 10W 字内部 Java 字面試手冊到底有多強？

用mybatis的generator插件在項目中自動生成dao及entity

spark/scala關于【資源檔案】加載方法概述外部檔案加載方案測試資源檔案打包入jar包中小結

mybatis_入門程式Mybatis入門

AOP程式設計_Android優雅權限架構(1)概念基礎，2021金三銀四前言正文大綱正文

sqlServer根據經緯查距離

Effective Java 8:通用程式設計

OOM三種類型

工廠模式-三種類型

【遞歸】高效率求2的n次幂

從mybatis到mybatis plus(mp)

win10本地scala和spark安裝安裝scala安裝spark

scala (3) Function 和 Method