Spring下的Mybatis配置

J2EE开发界中一个永远避免不了的争论就是Hibernate与Mybatis哪个好。虽然我自己倾向Hibernate，但这两种ORM框架我也都没有在比较大型的场景上使用过，没有资格做评价。

最近公司有一个项目，主程让我用Spring与Mybatis搭建服务端框架，这里就做一下简单的学习记录。

Java Config方式的Mybatis启动配置

首先在maven中加上Mybatis与mybatis-spring的依赖：

<dependency>
   <groupId>org.mybatis</groupId>
   <artifactId>mybatis-spring</artifactId>
   <version>1.2.2</version>
</dependency>

<dependency>
   <groupId>org.mybatis</groupId>
   <artifactId>mybatis</artifactId>
   <version>3.2.8</version>
</dependency>

前一篇中提到，公司推荐Spring使用Java Config的方式进行配置，所以Mybatis也不例外。
先看一段网上找到比较常见的xml方式配置：

<bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource">
    <property name="driverClassName" value="${jdbc.driverClassName}" />
    <property name="url" value="${jdbc.url}" />
</bean>

<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
    <!--指定实体类映射文件，可以指定同时指定某一包以及子包下面的所有配置文件 -->  
    <property name="mapperLocations"  value="classpath*:com/nd/mathlearning/server/*/dao/mapper/*.xml"/>
    <!--mybatis全局配置文件 -->  
    <property name="configLocation" value="classpath:mybatis/mybatis-config.xml" />
    <property name="dataSource" ref="dataSource" />
</bean>

配置的核心是sqlSessionFactory，将dataSource数据源注入就完成了Mybatis会话工厂的实例化了。
接着把这段配置翻译成Java config版本：

@Configuration
@PropertySource("classpath:druid-config.properties")
public class JdbcConfig {
    @Value("${druid.driverClassName}")
    private String driverClassName;
    @Value("${druid.url}")
    private String url;
    @Value("${druid.user}")
    private String username;
    @Value("${druid.password}")
    private String password;
    @Value("${druid.maxActive}")
    private int maxActive;

    @Bean
    public DataSource dataSource(){
        DruidDataSource ds = new DruidDataSource();
        ds.setDriverClassName(driverClassName);
        ds.setUrl(url);
        ds.setUsername(username);
        ds.setPassword(password);
        ds.setMaxActive(maxActive);
        ds.setMinIdle(0);
        return ds;
    }

    @Bean
    public SqlSessionFactoryBean sqlSessionFactory() throws IOException {
        ResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
        //加载匹配到的xml映射配置
        Resource[] resources =  resolver.getResources("classpath*:com/nd/mathlearning/server/*/dao/mapper/*.xml");
        SqlSessionFactoryBean bean = new SqlSessionFactoryBean();
        bean.setDataSource(dataSource());
        bean.setMapperLocations(resources);
        //加载Mybatis配置
        bean.setConfigLocation(resolver.getResource("classpath:mybatis/mybatis-config.xml"));
        return bean;
    }

    @Bean
    public SqlSessionTemplate sqlSessionTemplate() throws Exception {
        SqlSessionTemplate bean = new SqlSessionTemplate(sqlSessionFactory().getObject());
        return bean;
    }
}
  • @Configuration表明此类用作Spring配置
  • @PropertySource说明读取哪个配置文件
  • @Value将properties中的配置项注入进变量
  • @Bean注解的方法表明实例化对象。
  • ResourcePatternResolver是用来加载工程配置文件。

Mybatis的xml映射文件

与Hibernate类似，Mybatis需要写xml配置来实现Java类与数据库表之间的映射关系，更多的，Mybatis框架执行的所有sql也都配置在xml中。
来看一段完整的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.nd.mathlearning.server.personal.dao.UcUseridMapMapper" >
  <resultMap id="BaseResultMap" type="com.nd.mathlearning.server.personal.dto.UcUseridMapEntity" >
    <id column="uc_user_id" property="ucUserId" jdbcType="BIGINT" />
    <result column="user_id" property="userId" jdbcType="BIGINT" />
    <result column="user_name" property="userName" jdbcType="VARCHAR" />
  </resultMap>
  <sql id="Base_Column_List" >
    uc_user_id, user_id, user_name
  </sql>
  <select id="selectByPrimaryKey" resultMap="BaseResultMap" parameterType="java.lang.Long" >
    select
    <include refid="Base_Column_List" />
    from uc_userid_map
    where uc_user_id = #{ucUserId,jdbcType=BIGINT}
  </select>
  <delete id="deleteByPrimaryKey" parameterType="java.lang.Long" >
    delete from uc_userid_map
    where uc_user_id = #{ucUserId,jdbcType=BIGINT}
  </delete>
  <insert id="insert" parameterType="com.nd.mathlearning.server.personal.dto.UcUseridMapEntity" >
    insert into uc_userid_map (uc_user_id, user_id, user_name
      )
    values (#{ucUserId,jdbcType=BIGINT}, #{userId,jdbcType=BIGINT}, #{userName,jdbcType=VARCHAR}
      )
  </insert>
  <update id="updateByPrimaryKeySelective" parameterType="com.nd.mathlearning.server.personal.dto.UcUseridMapEntity" >
    update uc_userid_map
    <set >
      <if test="userId != null" >
        user_id = #{userId,jdbcType=BIGINT},
      </if>
      <if test="userName != null" >
        user_name = #{userName,jdbcType=VARCHAR},
      </if>
    </set>
    where uc_user_id = #{ucUserId,jdbcType=BIGINT}
  </update>
</mapper>
  • 根节点mapper中的namespace声明了此配置的唯一编号，在此后的java的api调用就需要用到此属性。
  • resultMap定义表到java实体类之间的字段映射关系
  • column是表字段
  • property是类属性
  • jdbcType是表字段类型。
  • sql节点在这里定义了一个sql查询片段，使用include语法拼接，用于简化配置。
  • select，insert，update，delete节点定义四种sql操作的方法。id定义方法的标识；
  • parameterType说明方法的参数类型，可以是javabean，但一个方法只能有一个输入参数。

更详细的mapper配置说明参考官网：

mapper与实体生成工具

既然Mybatis所有的逻辑操作都是配置在xml中，那就把原来在java中的sql开发工作转换到了xml上。
与Hibernate一样，Mybatis提供了一个简易的逆向工程工具，帮助我们根据已有数据表生成对应的javabean和基本操作xml配置。
在maven中增加生成器依赖：

<dependency>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-core</artifactId>
    <version>1.3.2</version>
</dependency>

编写生成配置xml

<!DOCTYPE generatorConfiguration PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN" "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd" >
<generatorConfiguration>
    <!-- classPathEntry:数据库的JDBC驱动 -->
    <classPathEntry location="F:\mylib\mysql-connector-java-5.1.30.jar" />

    <!--生成映射的类型，也可以生成ibatis的。具体参看mybatis-generator -->
    <context id="DB2Tables3" targetRuntime="MyBatis3">
        <plugin type="org.mybatis.generator.plugins.CaseInsensitiveLikePlugin"></plugin>
        <plugin type="org.mybatis.generator.plugins.SerializablePlugin"></plugin>
        <!-- 去除自动生成的注释 -->
        <commentGenerator>
            <property name="suppressDate" value="true" />
            <property name="suppressAllComments" value="true" />
        </commentGenerator>
        <!-- 数据库配置 -->
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
            connectionURL="jdbc:mysql://172.24.133.201:3306/mylearning" userId="user_account"
            password="user_account">
        </jdbcConnection>
        <javaTypeResolver>
            <property name="forceBigDecimals" value="false" />
        </javaTypeResolver>
        <!--以下三个标签主要解析targetPackage和targetProject。其它的具体参看mybatis-generator -->
        <!-- targetProject:自动生成代码的位置 -->
        <javaModelGenerator targetPackage="com.nd.mathlearning.server.microclass.dto" targetProject="src/main/java/">
            <property name="enableSubPackages" value="true" />
            <property name="trimStrings" value="true" />
        </javaModelGenerator>
        <sqlMapGenerator targetPackage="com.nd.mathlearning.server.microclass.dao" targetProject="src/main/java/">
            <property name="enableSubPackages" value="true" />
        </sqlMapGenerator>
    <!-- 要生成的表配置 -->
        <table tableName="mc_note" domainObjectName="McNoteEntity" enableCountByExample="false" enableUpdateByExample="false"
               enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"></table>
    </context>
</generatorConfiguration>

有了生成配置xml后就可以调用api生成实体javabean，dao和mapper：

public class MyBatisGenerator {
    public static void main(String args[]){
        String config ="";
        try {
            config = MyBatisGenerator.class.getResource("generator.xml").toURI().getPath();
        } catch (URISyntaxException e) {
            e.printStackTrace();
        }
        String[] arg = { "-configfile", config, "-overwrite" };
        ShellRunner.main(arg);
    }
}

参考文章：

与Spring整合

在j2ee的各种开源框架中，我们最关心的可能就是怎么与Spring做整合。

数据映射器 MapperFactoryBean

Mybatis提供了一种简易的整合方式，使用class的方式定义mapper，而不需要配置xml。
例如定义一个interface的mapper：

public interface UserMapper {
    @Select("SELECT * FROM user WHERE id = #{userId}")
    User getUser(@Param("userId") long id);
}

然后在spring中定义：

<bean id="userMapper" class="org.mybatis.spring.mapper.MapperFactoryBean">
      <property name="mapperInterface" value="com.xxt.ibatis.dbcp.dao.UserMapper" />
      <property name="sqlSessionFactory" ref="sqlSessionFactory" />
</bean>

Spring容器中就产生了userMapper实例可以来执行我们想要的数据操作。这种方式有点类似spring data中CrudRepository的@Query用法。

抽象类SqlSessionDaoSupport的整合方式

从前面的启动配置我们知道了，Mybatis的api入口是sqlSessionFactory。Mybatis提供SqlSessionDaoSupport抽象类来方便获取sqlSession。
先看一个UserDao的实现：

public class UserDao extends SqlSessionDaoSupport{  
  @Autowired
  public void setSqlSessionTemplate(SqlSessionTemplate sqlSessionTemplate) {
    super.setSqlSessionTemplate(sqlSessionTemplate);
  }

  public User getUserById(User user) {  
     return (User) getSqlSession().selectOne("com.xxt.ibatis.dbcp.domain.User.getUser", user);  
  }  
}

继承SqlSessionDaoSupport可以获得getSqlSession方法来得到sqlSession。然后通过sqlSession的api最终调用到mapper里配置的sql程序。
sqlSession几个常用的api：

<T> T selectOne(String statement, Object parameter)  
<E> List<E> selectList(String statement, Object parameter)  
<K,V> Map<K,V> selectMap(String statement, Object parameter, String mapKey)  
int insert(String statement, Object parameter)  
int update(String statement, Object parameter)  
int delete(String statement, Object parameter)

第一个参数表示mapper中方法的唯一标识，结构为：mapper标识 + . + 方法标识。

mybatis-spring 1.2版本中SqlSessionDaoSupport的变化

首先看1.2版本中SqlSessionDaoSupport的注释信息：

/**
 * Convenient super class for MyBatis SqlSession data access objects.
 * It gives you access to the template which can then be used to execute SQL methods.
 * <p>
 * This class needs a SqlSessionTemplate or a SqlSessionFactory.
 * If both are set the SqlSessionFactory will be ignored.
 * <p>
 * {code Autowired} was removed from setSqlSessionTemplate and setSqlSessionFactory
 * in version 1.2.0.
 *
 * @author Putthibong Boonbong
 *
 * @see #setSqlSessionFactory
 * @see #setSqlSessionTemplate
 * @see SqlSessionTemplate
 * @version $Id$
 */

之前版本中setSqlSessionTemplate和setSqlSessionFactory是Autowired，1.2之后需要我们手动注入。
这个改动应该是为了支持一个项目中建立多数据源的场景，我们可以用SqlSessionDaoSupport创建多个DAO层基类，选择不同的数据源注入。

参考文章：

Mybatis插件配置

Mybatis提供了插件机制实现了功能扩展

分页插件PageHelper

数据库列表查询少不了分页功能，怎么在代码级别上简单有效地处理分页逻辑总是一大挑战。
实现分页功能关键是根据 两个参数 得到 两个数据：

  • 两个参数：数据偏移量 和 页面大小（或者通过 当前页码 和 页面大小 进行转换）
  • 两个数据：当前页面的列表数据 和 总记录数

在sql层面上讲，需要两次查询：

  1. 根据查询条件用limit参数(在oracle用rownum)得到当前请求页面数据。
  2. 用相同的条件count(*)查询数据库中存在的总数。

回到Mybatis，我们可以利用它的插件机制实现分页功能。
首先加上PageHelper的maven配置：

<dependency>
    <groupId>com.github.pagehelper</groupId>
    <artifactId>pagehelper</artifactId>
    <version>3.7.1</version>
</dependency>

在初始化sqlSessionFactory时加上插件配置：

@Bean
public SqlSessionFactoryBean sqlSessionFactory() throws IOException {
    ResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
    Resource[] resources =  resolver.getResources("classpath*:com/nd/mathlearning/server/*/dao/mapper/*.xml");
    Interceptor[] plugings = new Interceptor[1];

    PageHelper pageHelper = new PageHelper();//mybatis分页插件
    Properties p = new Properties();//插件属性配置
    p.put("dialect", "mysql"); //数据库言
    p.put("reasonable", "true");//参数合理化，如果pageNum<1会查询第一页，如果pageNum>pages会查询最后一页
    p.put("offsetAsPageNum", "trsue"); //将RowBounds第一个参数offset当成pageNum页码使用
    pageHelper.setProperties(p);
    plugings[0] = pageHelper;

    SqlSessionFactoryBean bean = new SqlSessionFactoryBean();
    bean.setDataSource(dataSource());
    bean.setMapperLocations(resources);
    bean.setPlugins(plugings); //插件注入到sqlSessionFactory
    bean.setConfigLocation(resolver.getResource("classpath:mybatis/mybatis-config.xml"));
    return bean;
}

其中属性配置详细信息参考项目主页。

在调用Mybatis的api时增加RowBounds参数实现分页：

List<Country> list = sqlSession.selectList("x.y.selectIf", null, new RowBounds(1, 10));

项目主页:

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 202,529评论 5赞 475
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 85,015评论 2赞 379
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 149,409评论 0赞 335
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 54,385评论 1赞 273
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 63,387评论 5赞 364
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 48,466评论 1赞 281
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 37,880评论 3赞 395
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 36,528评论 0赞 256
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 40,727评论 1赞 295
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,528评论 2赞 319
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,602评论 1赞 329
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 33,302评论 4赞 318
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 38,873评论 3赞 306
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,890评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,132评论 1赞 259
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 42,777评论 2赞 349
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 42,310评论 2赞 342

推荐阅读更多精彩内容

  • MarkDown
    1. 简介 1.1 什么是 MyBatis ？ MyBatis 是支持定制化 SQL、存储过程以及高级映射的优秀的...
    笨鸟慢飞阅读 5,422评论 0赞 4
  • Spring升级计划
    Spring 技术笔记Day 1 预热知识一、 基本术语Blob类型，二进制对象Object Graph：对象图...
    OchardBird阅读 961评论 0赞 2
  • Spring Cloud
    Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具（例如配置管理，服务发现，断路器，智...
    卡卡罗2017阅读 134,579评论 18赞 139
  • 雨声
    （第三稿） 是谁告诉你我这里在下雨呢 听 今夜月华如水
    雅不知阅读 336评论 6赞 2
  • 我们好像在哪见过
    【一】康城 康城的夜色有着那种路灯昏暗的黑，才不过8点临街的店铺就在陆续打烊，只有街角一家穆斯林的餐馆还在营业。赶...
    兰卡公子阅读 431评论 2赞 1