Maven项目集成MyBatis框架

  看前必读：本人目前正在学习SSM框架的相关内容，此博客多为博主的笔记。基于Maven项目构建SSM的顺序分别是：① Spring； ② Spring MVC；③ MyBatis，所以在开始读本篇博客之前，可以先去看一看本人所写的集成Spring和Spring MVC框架的两篇博客。
Maven项目集成Spring框架：https://blog.youkuaiyun.com/zqq_2016/article/details/114703395
Maven项目集成Spring MVC框架：https://blog.youkuaiyun.com/zqq_2016/article/details/114703983

一、MyBatis简述

MyBatis是一款优秀的持久层框架，它支持定制化SQL、存储过程及高级映射。MyBatis避免了几乎所有的JDBC代码和手动设置参数以及获取结果集。MyBatis可以使用简单的XML或注解来配置和映射原生信息，将接口和Java的POJOs映射成数据库中的记录。

二、在Web项目中集成MyBatis框架

1. 把集成MyBatis框架所需要的依赖包添加到pom.xml文件中，具体代码如下：

<properties>
        <mybatis.version>3.4.6</mybatis.version>
        <mysql.connector.java.version>8.0.19</mysql.connector.java.version>
        <druid.version>1.1.5</druid.version>
        <mybatis.spring.version>1.3.2</mybatis.spring.version>
    </properties>
	
	<!--    MyBatis start    -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>${mysql.connector.java.version}</version>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
            <version>${druid.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-jdbc</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>${mybatis.version}</version>
        </dependency>
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis-spring</artifactId>
            <version>${mybatis.spring.version}</version>
        </dependency>
        <!--    MyBatis end    -->

注：
    （1）mysql-connector-java：是MySQL的JDBC驱动包，用JDBC连接MySQL数据库时必须使用该jar包。
    （2）druid：Druid是阿里巴巴开源平台上一个数据库连接池实现，它结合了C3P0、DBCP、PROXOOL等DB连接池的优点，同时加入了日志监控，可以很好地监控DB连接池和SQL的执行情况，可以说是针对监控而生的DB连接池，据说是目前最好的连接池。
    （3）mybatis-spring：mybatis-spring会帮助你将MyBatis代码无缝地整合到Spring中。使用这个类库中的类，Spring将会加载必要的MyBatis工厂类和Session类。

2. 在src/main/resources目录下创建jdbc.properties配置文件，具体代码如下：

##驱动
jdbc.driverClassName=com.mysql.cj.jdbc.Driver
##mysql连接信息
jdbc.url=jdbc:mysql://xxxx.sql.tencentcdb.com:28256/ssm?useUnicode=true&characterEncoding=UTF-8
##用户名
jdbc.username=root
##密码
jdbc.password=xxxxxx

注意：本人使用的腾讯mysql云数据库，所以配置如上。如果其他小伙伴使用的mysql本地数据库（主要是url的区别），可配置如下：

##驱动
jdbc.driverClassName=com.mysql.cj.jdbc.Driver
##mysql连接信息
jdbc.url=jdbc:mysql://localhost:3306/ssm?useUnicode=true&characterEncoding=UTF-8
##用户名
jdbc.username=root
##密码
jdbc.password=xxxxxx

注：jdbc.properties配置，主要配置驱动和连接数据库的配置信息。

3. 在applicationContext.xml配置文件添加如下的配置，具体代码如下：

<!--  1. 配置数据库相关参数  -->
    <context:property-placeholder location="classpath:jdbc.properties" ignore-unresolvable="true"/>

    <!--  2. 数据源druid  -->
    <bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource"
          init-method="init" destroy-method="close">
        <property name="driverClassName" value="${jdbc.driverClassName}"/>
        <property name="url" value="${jdbc.url}"/>
        <property name="username" value="${jdbc.username}"/>
        <property name="password" value="${jdbc.password}"/>
    </bean>

    <!--  3. 配置SqlSessionFactory对象  -->
    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <!--    注入数据库连接池    -->
        <property name="dataSource" ref="dataSource"/>
        <!--    扫描sql配置文件：mapper需要的xml文件    -->
        <property name="mapperLocations" value="classpath:mapper/*.xml"/>
    </bean>

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

    <!--  扫描basePackage下所有以@MyBatisDao注解的接口  -->
    <bean id="mapperScannerConfigurer" class="org.mybatis.spring.mapper.MapperScannerConfigurer">
        <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory"/>
        <property name="basePackage" value="zqq.trys.dao"/>
    </bean>

注：
    （1）<context:property-placeholder/>：标签提供了一种优雅的外在化参数配置的方式，location表示属性文件位置，多个属性文件之间通过“逗号”分隔。ignore-unresolvable表示是否忽略解析不到的属性，如果不忽略，找不到将抛出异常。
    （2）DruidDataSource：阿里巴巴Druid数据源，该数据源会读取jdbc.properties配置文件的数据库连接信息和驱动。
    （3）SqlSessionFactoryBean：在基本的MyBatis中，Session工厂可以使用SqlSessionFactoryBuilder来创建。而在MyBatis-Spring中，则使用SqlSessionFactoryBean来替代。
    SqlSessionFactoryBean需要依赖数据源dataSource。mapperLocations属性可以用来指定MyBatis的XML映射器文件的位置，值为mapper/*.xml代表扫描classpath路径下mapper文件夹下的所有XML文件。
    （4）MapperScannerConfigurer：我们没有必要在Spring的XML配置文件中注册所有的映射器。相反，可以使用MapperScannerConfigurer，它将会查找类路径下的映射器并自动将它们创建成MapperFactoryBean。
    basePackage属性是让你为映射器接口文件设置基本的包路径。可以使用分号或逗号作为分隔符设置多于一个的包路径中递归地被搜索到。这里设置的值是zqq.trys.dao这个包。 

4.  在MySQL数据库创建表sys_user，并插入两条数据。

在IDEA中创建数据库，参考：https://blog.youkuaiyun.com/zqq_2016/article/details/114831679

书写测试类，一次性往数据库中插入多条数据，参考：https://blog.youkuaiyun.com/zqq_2016/article/details/114841362

5. 在src/main/java/zqq.trys.model目录下创建数据库表对应的实体类对象SysUser，具体代码如下：

public class SysUser {
    private Integer id;
    private String username;
    private String password;

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }
}

6. 在src/main/java/zqq.trys.dao目录下创建对应的DAO对象SysUserDao，SysUserDao是一个接口，提供了findAll方法用来查询所有的用户。代码如下：

@Repository
public interface SysUserDao {
    List<SysUser> findAll();
}

7. 在src/main/java/zqq.trys.service目录下创建对应的服务层接口SysUserService，提供了一个查询所有用户的方法findAll()，代码如下：

public interface SysUserService {
    List<SysUser> findAll();
}

8. 在src/main/java/zqq.trys.service.impl开发对应的服务层实现类SysUserServiceImpl，实现类主要是注入SysUserDao接口，并实现findAll()方法，在findAll()方法中调用SysUserDao的findAll()方法，代码如下：

@Service
public class SysUserServiceImpl implements SysUserService {
    @Resource
    private SysUserDao sysUserDao;

    @Override
    public List<SysUser> findAll() {
        return sysUserDao.findAll();
    }
}

9. 在src/main/java/zqq.trys.Controller目录下创建控制层类SysUserController，并注入服务层接口。SysUserController类只有一个findAll()方法。在SysUserController类上添加映射路径/user，在findAll()方法上添加映射路径/findAll。

@Controller
@RequestMapping("/user")
public class SysUserController {
    @Resource
    private SysUserService sysUserService;

    @GetMapping("/findAll")
    public String findAll(Model model) {
        List<SysUser> sysUserList = sysUserService.findAll();
        for (SysUser sysUser : sysUserList) {
            System.out.println("id=" + sysUser.getId());
            System.out.println("name=" + sysUser.getUsername());
        }
        return "test/hello";
    }
}

10. 在src/main/resources目录下创建mapper/SysUserMappper.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="zqq.trys.dao.SysUserDao">
    <sql id="userField">
    a.id as "id",
    a.username as "username",
    a.password as "password"
</sql>
    <!--获取所有用户-->
    <select id="findAll" resultType="zqq.trys.model.SysUser">
        select
        <include refid="userField"/>
        from sys_user as a
    </select>
</mapper>

注：
    （1）< mapper />：namespace主要用于绑定Dao接口，这里绑定zqq.trys.dao.SysUserDao接口。
    （2）< select id="findAll" >：select标签，用来编写select查询语句，id属性值与SysUserDao接口中的方法名一一对应。在select标签中，查询了sys_user表中的所有数据，并返回。

  到此为止，Maven项目集成Spring、Spring MVC、MyBatis已经全部完成，现在重新启动Tomcat服务器，在浏览器输入访问地址：http://localhost:8088/user/findAll，如果能看到下图所示的信息，代表整合成功。

控制台打印如下：