08 Spring 操作持久层 （融合 Mybatis）最简使用（使用 Mybatis Generator）

转载请注明来源 赖赖的博客

导语

对接越多，耦合约松，系统越复杂。

如果这章学习有困难，可以先参考番外 02： Spring 之使用 JAVA 操作Mysql数据库（为何要用ORM）Spring整合 Mybatis前基础

Mybatis作为最近比较流行的ORM框架（Object Relation Mapping），ORM的功能也就是把数据库的表映射为对象便于操作。
本章介绍Mybatis与Spring的融合和推荐一种入手使用的方式，你不需要对Mybatis有很深刻的了解，只需要知道他是一个ORM框架即可，但是你需要知道数据库的基本知识。
数据库的使用是不可避免的，在学习本章之前，你需要：

  • 了解数据库的基本知识
  • 使用过mysql数据库
  • 熟悉SQL语句
  • 电脑已经安装mysql数据库（建议学习可以使用WAMP套件）

实例

项目工程目录结构和代码获取地址

获取地址（版本Log将会注明每一个版本对应的课程）

https://github.com/laiyijie/SpringLearning

目录结构&数据库

工程目录结构
工程目录结构
数据库
数据库

创建语句：
CREATE TABLE account (
username varchar(45) NOT NULL,
password varchar(45) NOT NULL,
name varchar(45) NOT NULL,
create_time bigint(20) NOT NULL
) ENGINE=MyISAM DEFAULT CHARSET=utf8;
ALTER TABLE account
ADD PRIMARY KEY (username);

运行工程（与之前不同，请注意）

运行方式
  • 右键App.java
  • Run as
  • Java Application
运行结果

Account [username=laiyijie, password=123456, name=赖赖, create_time=1480595033430]
Account [username=laiyijie, password=123456, name=赖赖, create_time=1480595033430]

项目详解

从 App.java 入手：

App.java

package me.laiyijie.demo;

import java.util.List;

import org.springframework.context.support.ClassPathXmlApplicationContext;

import me.laiyijie.demo.domain.Account;
import me.laiyijie.demo.service.UserService;

public class App {

    public static void main(String[] args) {
        ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext("root-context.xml");

        UserService service = context.getBean(UserService.class);

        Account account = service.createAccount("laiyijie", "123456", "赖赖");

        System.out.println(account);

        List<Account> accounts = service.getAccountsByCreateTime(0L, System.currentTimeMillis());

        for (Account account2 : accounts) {
            System.out.println(account2);
        }

        context.close();
    }

}
  • 加载ApplicationContext
  • 取出UserService的实现对象
  • 调用UserService的createAccount方法
  • 输出account
  • 调用UserService的getAccountsByCreateTime方法
  • 循环输出accounts
  • 关闭ApplicationContext

Account类是一个纯数据类，也就是说，Account类中的字段与数据库中的字段完全对应：

Account.java（没有给出 getter和setter以及toString方法）

package me.laiyijie.demo.domain;

public class Account {
    private String username;

    private String password;

    private String name;

    private Long create_time;
    
}

果然与数据库中的字段完全一样！！

CREATE TABLE `account` (
  `username` varchar(45) NOT NULL,
  `password` varchar(45) NOT NULL,
  `name` varchar(45) NOT NULL,
  `create_time` bigint(20) NOT NULL
) ENGINE=MyISAM DEFAULT CHARSET=utf8;

那让我们继续看看UserService都定义了一些什么：

UserService.java

package me.laiyijie.demo.service;

import java.util.List;

import me.laiyijie.demo.domain.Account;

public interface UserService {
    Account createAccount(String username ,String password,String name);
    List<Account> getAccountsByCreateTime(Long start,Long end);
}

定义了两个方法

  1. 创建账号
  2. 取出两个时间之间创建的所有账号

其实现类为 UserServiceImpl

UserServiceImpl.java

package me.laiyijie.demo.service;

import java.util.List;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import me.laiyijie.demo.dao.AccountMapper;
import me.laiyijie.demo.domain.Account;
import me.laiyijie.demo.domain.AccountExample;

@Service
public class UserServiceImpl implements UserService {

    @Autowired
    private AccountMapper accountMapper;
    
    public Account createAccount(String username, String password, String name) {
        
        Account account = new Account();
        account.setCreate_time(System.currentTimeMillis());
        account.setName(name);
        account.setPassword(password);
        account.setUsername(username);
        
        accountMapper.insert(account);
        return account;
    }

    public List<Account> getAccountsByCreateTime(Long start, Long end) {
        AccountExample accountExample = new AccountExample();
        accountExample.or().andCreate_timeGreaterThan(start).andCreate_timeLessThanOrEqualTo(end);
        return accountMapper.selectByExample(accountExample);
    }
}

关键来了！
此处引入了依赖 private AccountMapper accountMapper 并且调用了此接口的一些方法！

我们不妨看一下这个类：

AccountMapper.java

package me.laiyijie.demo.dao;

import java.util.List;
import me.laiyijie.demo.domain.Account;
import me.laiyijie.demo.domain.AccountExample;
import org.apache.ibatis.annotations.Param;

public interface AccountMapper {
    long countByExample(AccountExample example);

    int deleteByExample(AccountExample example);

    int deleteByPrimaryKey(String username);

    int insert(Account record);

    int insertSelective(Account record);

    List<Account> selectByExample(AccountExample example);

    Account selectByPrimaryKey(String username);

    int updateByExampleSelective(@Param("record") Account record, @Param("example") AccountExample example);

    int updateByExample(@Param("record") Account record, @Param("example") AccountExample example);

    int updateByPrimaryKeySelective(Account record);

    int updateByPrimaryKey(Account record);
}

可以看到，AccountMapper定义了对Account数据表的所有操作（CRUD），其中有一部分以ByExample结尾的不容易理解，我们详细讲解！

List<Account> selectByExample(AccountExample example)

我们看其用法：
public List<Account> getAccountsByCreateTime(Long start, Long end) {
AccountExample accountExample = new AccountExample();
accountExample.or().andCreate_timeGreaterThan(start).andCreate_timeLessThanOrEqualTo(end);
return accountMapper.selectByExample(accountExample);
}

这段代码摘自UserServiceImpl中，这个方法的目的是取出start到end时间内创建的所有账号

AccountExample的目的是为了组合一个where语句，其组合出的语句结构如下 where（xxx and xxx）or （xxx and xxx）
所以:

accountExample.or().andCreate_timeGreaterThan(start).andCreate_timeLessThanOrEqualTo(end);
等于
where create_time > xxx and create_time<=xxx

如果进一步的，我们增加一行代码accountExample.or().andUsernameEqualTo("laiyijie");

那么就是相当于:

accountExample.or().andCreate_timeGreaterThan(start).andCreate_timeLessThanOrEqualTo(end);
accountExample.or().andUsernameEqualTo("laiyijie");
等于
where (create_time > xxx and create_time<=xxx) or username="laiyijie"

就是如此简单！相信信息可以查看MybatisGenerator关于Example使用的文档

说了这么多，是不是还是觉得代码太多？
其实me.laiyijie.demo.dao、me.laiyijie.demo.domain和me.laiyijie.demo.Mapper都是自动生成的。 这个神器就是MybatisGenerator。

也就是说，在现在这个项目中，其实我只书写了UserService.java、UserServiceImpl.java和App.java三个类！

MybatisGenerator（创建 domain，mapper，dao，Example对象，ORM自动解决）

介绍一下怎么使用MybatisGenerator（官方文档位置）

  • 下载MybatisGenerator的Eclipse插件
    • 打开MarketPlace并搜索mybatis并且安装
安装MybatisGenerator插件
  • 配置mybatisGenerator.xml（用于配置如何生成源文件）
mybatisGenerator.xml
    <?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE generatorConfiguration PUBLIC
          "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
          "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
    <generatorConfiguration>
        <!-- 填写mysql-connector-java的驱动类 -->
        <classPathEntry
            location="C:\Users\admin\.m2\repository\mysql\mysql-connector-java\5.1.38\mysql-connector-java-5.1.38.jar" />
    
        <context id="context1">
            <commentGenerator>
                <!-- 是否去除自动生成的注释 true：是 ： false:否 -->
                <property name="suppressAllComments" value="true" />
            </commentGenerator>
            <!-- 配置连接类和数据库账号密码 -->
            <jdbcConnection connectionURL="jdbc:mysql://127.0.0.1:3306/myspring"
                driverClass="com.mysql.jdbc.Driver" userId="test" password="o34rWayJPPHgudtL" />
            <!-- 配置生成类的存放包名 -->
            <javaModelGenerator targetPackage="me.laiyijie.demo.domain"
                targetProject="demo" />
            <sqlMapGenerator targetPackage="me.laiyijie.demo.mapper"
                targetProject="demo" />
            <javaClientGenerator targetPackage="me.laiyijie.demo.dao"
                targetProject="demo" type="XMLMAPPER" />
    
            <!-- 需要生成表 -->
            <table schema="myspring" tableName="account" domainObjectName="Account">
                <property name="useActualColumnNames" value="true" />
            </table>
    
        </context>
    </generatorConfiguration>
  • 右键mybatisGenerator.xml> Run as> Mybatis Generator 生成成功！

详细配置请参考MybatisGenerator官方文档

下面这一步就是配置Spring连接数据库：

root-context.xml

<?xml version="1.0" encoding="UTF-8"?>
<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:aop="http://www.springframework.org/schema/aop" xmlns:task="http://www.springframework.org/schema/task"
    xmlns:p="http://www.springframework.org/schema/p"
    xsi:schemaLocation="http://www.springframework.org/schema/task http://www.springframework.org/schema/task/spring-task-4.3.xsd
        http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.3.xsd
        http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-4.3.xsd">

    <context:component-scan base-package="me.laiyijie.demo"></context:component-scan>

    <bean id="mysqlDataSource" class="org.apache.commons.dbcp.BasicDataSource"
        p:driverClassName="com.mysql.jdbc.Driver"
        p:url="jdbc:mysql://127.0.0.1:3306/myspring"
        p:username="test" p:password="o34rWayJPPHgudtL" />
        
    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean"
        p:dataSource-ref="mysqlDataSource" p:mapperLocations="classpath:me/laiyijie/demo/mapper/*.xml" />

    <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer"
        p:sqlSessionFactoryBeanName="sqlSessionFactory" p:basePackage="me.laiyijie.demo.dao" />

</beans>

新增的配置的解释如下：

  • 配置数据源（数据库账密等）

    <bean id="mysqlDataSource" class="org.apache.commons.dbcp.BasicDataSource"
    p:driverClassName="com.mysql.jdbc.Driver"
    p:url="jdbc:mysql://127.0.0.1:3306/myspring"
    p:username="test" p:password="o34rWayJPPHgudtL" />

  • 配置Mybatis的sqlSessionFactory和MapperScannerConfigurer（其实就是用于扫描所有*.xml配置文件并且生成与接口*Mapper对应的实现类的Bean，这也是为什么可以使用@Autowired来加载AccountMapper这个接口的原因！

      <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean"
  p:dataSource-ref="mysqlDataSource" p:mapperLocations="classpath:me/laiyijie/demo/mapper/*.xml" />  

  <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer"
      p:sqlSessionFactoryBeanName="sqlSessionFactory" p:basePackage="me.laiyijie.demo.dao" />

三条配置，一点儿也不麻烦！

pom.xml

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>me.laiyijie</groupId>
    <artifactId>demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>

    <dependencies>

        <!-- https://mvnrepository.com/artifact/org.springframework/spring-context -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
            <version>4.3.2.RELEASE</version>
        </dependency>

        <!-- https://mvnrepository.com/artifact/org.springframework/spring-jdbc -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-jdbc</artifactId>
            <version>4.3.2.RELEASE</version>
        </dependency>

        <!-- mybatis-Spring -->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis-spring</artifactId>
            <version>1.3.0</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/org.mybatis/mybatis -->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.4.1</version>
        </dependency>

        <!-- https://mvnrepository.com/artifact/commons-dbcp/commons-dbcp -->
        <dependency>
            <groupId>commons-dbcp</groupId>
            <artifactId>commons-dbcp</artifactId>
            <version>1.4</version>
        </dependency>

        <!-- https://mvnrepository.com/artifact/mysql/mysql-connector-java -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.38</version>
        </dependency>
    </dependencies>
</project>

新增依赖：

  • spring-jdbc spring对数据库查询的支持
  • commons-dbcp 配置数据源中的org.apache.commons.dbcp.BasicDataSource来源，数据连接池
  • mybatis-spring root-context.xml 中的使用的两个类出自这里
  • mybatis mybatis框架
  • mysql-connector-java 连接mysql数据库用的驱动

小结

  • Mybatis是一种ORM框架，ORM的功能也就是把数据库的表映射为对象便于操作。
  • 通过 mybatis-spring包使得Mybatis可以在Spring中使用
  • 数据源的连接是依赖于实用的数据库，本文使用的Mysql因此需要引入 mysql-connector
  • MybatisGenerator产生的类和方法涵盖了单表的所有操作，可以解决绝大部分数据库操作问题

附：

数据源配置建议如下（解决Mysql八小时问题以及utf-8编码问题）：

<bean id="mysqlDataSource" class="org.apache.commons.dbcp.BasicDataSource"
    destroy-method="close" p:driverClassName="com.mysql.jdbc.Driver"
    p:url="jdbc:mysql://127.0.0.1:3306/myspring?useUnicode=true&characterEncoding=utf8"
    p:username="test" p:password="o34rWayJPPHgudtL" p:testWhileIdle="true"
    p:testOnBorrow="false" p:validationQuery="SELECT 1"
    p:timeBetweenEvictionRunsMillis="7200000" p:numTestsPerEvictionRun="50" />
最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 215,463评论 6赞 497
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 91,868评论 3赞 391
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 161,213评论 0赞 351
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 57,666评论 1赞 290
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 66,759评论 6赞 388
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 50,725评论 1赞 294
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 39,716评论 3赞 415
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 38,484评论 0赞 270
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 44,928评论 1赞 307
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,233评论 2赞 331
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,393评论 1赞 345
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 35,073评论 5赞 340
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 40,718评论 3赞 324
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,308评论 0赞 21
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,538评论 1赞 268
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 47,338评论 2赞 368
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 44,260评论 2赞 352

推荐阅读更多精彩内容

  • Spring Cloud
    Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具（例如配置管理，服务发现，断路器，智...
    卡卡罗2017阅读 134,647评论 18赞 139
  • Spring boot参考指南
    Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,801评论 6赞 342
  • 无标题文章
    jHipster - 微服务搭建 CC_简书[https://www.jianshu.com/u/be0d56c4...
    quanjj阅读 804评论 0赞 2
  • 他其实没那么喜欢你
    （在一个心理电台听到的这篇文章，当时正好看了这部电影，个人很喜欢，于是分享一下） 梁朝伟说过：男人如果爱你，那你就...
    木橙小姐阅读 451评论 0赞 1
  • 对象转化为数组
    /** * 对象转化为数组 * @param object $obj 对象 * @return array 数组 ...
    上善若水_900e阅读 167评论 0赞 0