SprintBoot学习日记（四）——数据库操作之整合mybatis

前段时间，有点忙；一周没更新了，今天有空，继续学习。说句题外话，学习真的要持之以恒，共勉之！

不知道是否还记得之前我们返回给前端的数据，都是我们在配置文件写死的，真实的业务场景肯定不会这么做，而是放在数据库中的，所以我们肯定要从数据库中提取数据。这次学习我就把目前大家比较常用的orm框架mybatis 整合进我们的项目中。

首先在pom中添加数据库操作的依赖，分别为mybatis的依赖包和数据库连接的mysql-connertor依赖包  ,我自己电脑上装的是mysql ，如果你使用的是oracle，则需要把mysql依赖改为oracle的依赖包。

<dependency>
   <groupId>org.mybatis.spring.boot</groupId>
   <artifactId>mybatis-spring-boot-starter</artifactId>
   <version>1.1.1</version>
</dependency>
<dependency>
   <groupId>mysql</groupId>
   <artifactId>mysql-connector-java</artifactId>
</dependency>

添加完成 重新导入即可在你项目的library中看到。

接着我先简单介绍下mybatis 三剑客：

1、mybatis generator  数据库持久化java对象 、mapper

2、mybatis plugin  自动检测mapper 和跳转  方便开发维护。 目前已收费，我选用的是free版。

安装方式：在idea >plugin>mybatis plugin 搜索安装 重启

3、mybatis pagehelper   分页工具 

我这里直接使用了，大家如果不熟悉，有兴趣的可以百度 、谷歌了解下。

我在本地先建一张表：

CREATE TABLE userlogin
(
  userID   INT AUTO_INCREMENT
    PRIMARY KEY,
  userName VARCHAR(200)    NOT NULL,
  password VARCHAR(200)    NOT NULL,
  role     INT DEFAULT '2' NOT NULL
  COMMENT '角色权限'
);
CREATE INDEX role
  ON userlogin (role);

然后使用mybatis generator 生成数据表对应的实体类、mapper和mapper.xml  ,这里奉上我的mybatis config 文件 方便大家快速使用（个人感觉学一样的东西 ，尽量不要抓太细的东西，先把总项目跑通，细节的东西可以在后面慢慢理解，不然真的你学习进度会很慢），注意里面的注释信息。

<?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>
    <!-- 数据库驱动:选择你的本地硬盘上面的数据库驱动包-->
    <classPathEntry
            location="/Users/zhangxue/repository/mysql/mysql-connector-java/5.1.42/mysql-connector-java-5.1.42.jar"/>
    <context id="DB2Tables" targetRuntime="MyBatis3">
        <commentGenerator>
            <property name="suppressDate" value="true"/>
            <!-- 是否去除自动生成的注释 true：是 ： false:否 -->
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>
        <!--数据库链接URL，用户名、密码 -->
        <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql://127.0.0.1:3306/zx" userId="root"
                        password="111111">
        </jdbcConnection>
        <javaTypeResolver>
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>
        <!-- 生成模型的包名和位置-->
        <javaModelGenerator targetPackage="cn.sevendream.springbootstudy.model" targetProject="src/main/java">
            <property name="enableSubPackages" value="true"/>
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>
        <!-- 生成映射文件的包名和位置-->
        <sqlMapGenerator targetPackage="mapper" targetProject="src/main/resources">
            <property name="enableSubPackages" value="true"/>
        </sqlMapGenerator>
        <!-- 生成DAO的包名和位置-->
        <javaClientGenerator type="XMLMAPPER" targetPackage="cn.sevendream.springbootstudy.dao"
                             targetProject="src/main/java">
            <property name="enableSubPackages" value="true"/>
        </javaClientGenerator>
        <!-- 要生成的表 tableName是数据库中的表名或视图名 domainObjectName是实体类名-->
        <table tableName="userlogin" domainObjectName="UserLogin" enableCountByExample="false" enableUpdateByExample="false"
               enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"></table>
    </context>
</generatorConfiguration>

生成的文件如下：

bean文件：

package cn.sevendream.springbootstudy.model;

public class UserLogin {
    private Integer userid;

    private String username;

    private String password;

    private Integer role;

    public Integer getUserid() {
        return userid;
    }

    public void setUserid(Integer userid) {
        this.userid = userid;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username == null ? null : username.trim();
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password == null ? null : password.trim();
    }

    public Integer getRole() {
        return role;
    }

    public void setRole(Integer role) {
        this.role = role;
    }
}

mapper: 注意手动添加@mapper 。否则你是没法调用的。

package cn.sevendream.springbootstudy.dao;

import cn.sevendream.springbootstudy.model.UserLogin;
import org.apache.ibatis.annotations.Mapper;

@Mapper
public interface UserLoginMapper {
    int deleteByPrimaryKey(Integer userid);

    int insert(UserLogin record);

    int insertSelective(UserLogin record);

    UserLogin selectByPrimaryKey(Integer userid);

    int updateByPrimaryKeySelective(UserLogin record);

    int updateByPrimaryKey(UserLogin record);
}

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="cn.sevendream.springbootstudy.dao.UserLoginMapper" >
  <resultMap id="BaseResultMap" type="cn.sevendream.springbootstudy.model.UserLogin" >
    <id column="userID" property="userid" jdbcType="INTEGER" />
    <result column="userName" property="username" jdbcType="VARCHAR" />
    <result column="password" property="password" jdbcType="VARCHAR" />
    <result column="role" property="role" jdbcType="INTEGER" />
  </resultMap>
  <sql id="Base_Column_List" >
    userID, userName, password, role
  </sql>
  <select id="selectByPrimaryKey" resultMap="BaseResultMap" parameterType="java.lang.Integer" >
    select 
    <include refid="Base_Column_List" />
    from userlogin
    where userID = #{userid,jdbcType=INTEGER}
  </select>
  <delete id="deleteByPrimaryKey" parameterType="java.lang.Integer" >
    delete from userlogin
    where userID = #{userid,jdbcType=INTEGER}
  </delete>
  <insert id="insert" parameterType="cn.sevendream.springbootstudy.model.UserLogin" >
    insert into userlogin (userID, userName, password, 
      role)
    values (#{userid,jdbcType=INTEGER}, #{username,jdbcType=VARCHAR}, #{password,jdbcType=VARCHAR}, 
      #{role,jdbcType=INTEGER})
  </insert>
  <insert id="insertSelective" parameterType="cn.sevendream.springbootstudy.model.UserLogin" >
    insert into userlogin
    <trim prefix="(" suffix=")" suffixOverrides="," >
      <if test="userid != null" >
        userID,
      </if>
      <if test="username != null" >
        userName,
      </if>
      <if test="password != null" >
        password,
      </if>
      <if test="role != null" >
        role,
      </if>
    </trim>
    <trim prefix="values (" suffix=")" suffixOverrides="," >
      <if test="userid != null" >
        #{userid,jdbcType=INTEGER},
      </if>
      <if test="username != null" >
        #{username,jdbcType=VARCHAR},
      </if>
      <if test="password != null" >
        #{password,jdbcType=VARCHAR},
      </if>
      <if test="role != null" >
        #{role,jdbcType=INTEGER},
      </if>
    </trim>
  </insert>
  <update id="updateByPrimaryKeySelective" parameterType="cn.sevendream.springbootstudy.model.UserLogin" >
    update userlogin
    <set >
      <if test="username != null" >
        userName = #{username,jdbcType=VARCHAR},
      </if>
      <if test="password != null" >
        password = #{password,jdbcType=VARCHAR},
      </if>
      <if test="role != null" >
        role = #{role,jdbcType=INTEGER},
      </if>
    </set>
    where userID = #{userid,jdbcType=INTEGER}
  </update>
  <update id="updateByPrimaryKey" parameterType="cn.sevendream.springbootstudy.model.UserLogin" >
    update userlogin
    set userName = #{username,jdbcType=VARCHAR},
      password = #{password,jdbcType=VARCHAR},
      role = #{role,jdbcType=INTEGER}
    where userID = #{userid,jdbcType=INTEGER}
  </update>
</mapper>

如此我们mybatis 相关文件就都有了 ，这里我们只有手工添加@Mapper ,其他都是借用mybatis generator 生成的。大大提高效率。

既然要从数据库中取数据，接着 我们需要在配置文件中，添加数据库的相关配置，以及这些mybatis文件扫描

server:
  port: 8080
  context-path: /study
spring:
    datasource:
        name: dev
        url: jdbc:mysql://127.0.0.1:3306/zx
        username: root
        password: 111111
        driver-class-name: com.mysql.jdbc.Driver
        filters: stat
        maxActive: 20
        initialSize: 1
        maxWait: 60000
        minIdle: 1
        timeBetweenEvictionRunsMillis: 60000
        minEvictableIdleTimeMillis: 300000
        validationQuery: select 'x'
        testWhileIdle: true
        testOnBorrow: false
        testOnReturn: false
        poolPreparedStatements: true
        maxOpenPreparedStatements: 20
mybatis:
# MyBatis XML形式配置文件路径
  mapper-locations: classpath:mapper/*.xml
# MyBatis注解形式扫描实体类路径
  type-aliases-package: cn.sevendream.springbootstudy.model

到了这一步我们数据库操作就真正完成了。接下来我们做下测试。

package cn.sevendream.springbootstudy;

import cn.sevendream.springbootstudy.dao.UserLoginMapper;
import cn.sevendream.springbootstudy.model.UserLogin;
import org.junit.Assert;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

@RunWith(SpringRunner.class)
@SpringBootTest
public class SpringbootStudyApplicationTests {
   @Autowired
   private UserLoginMapper userLoginMapper;
   @Test
   public void contextLoads() {
      UserLogin userLogin = userLoginMapper.selectByPrimaryKey(11);
      Assert.assertEquals("10005", userLogin.getUsername());
   }

}

run 一下测试方法 发现是成功的

和数据库的数据肯定也是一致的。

上面是使用xml的方式，这里再补充一下另外一种写法。至于哪种更优秀，仁者见仁智者见智。

我新建一个teacher表：

CREATE TABLE teacher
(
  userID   INT AUTO_INCREMENT
    PRIMARY KEY,
  userName VARCHAR(200) NOT NULL
);

然后mybatis generator 生成相关文件，这里我直接删掉*mapper.xml,将sql直接写在注解里，方便维护。

package cn.sevendream.springbootstudy.dao;

import cn.sevendream.springbootstudy.model.Teacher;
import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Select;

@Mapper
public interface TeacherMapper {

    @Select("select * from teacher where userID = #{userid}")
    Teacher selectByPrimaryKey(Integer userid);

}

package cn.sevendream.springbootstudy.model;

public class Teacher {
    private Integer userid;

    private String username;

    public Integer getUserid() {
        return userid;
    }

    public void setUserid(Integer userid) {
        this.userid = userid;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username == null ? null : username.trim();
    }
}

然后测试一下通过：

查询结果和数据库也是一致的：

另外把项目分享到GitHub上，也方便参考，此节代码在db-mybatis分支上。

https://github.com/SimonVampire/springboot-study.git