12月26, 2018

MyBatis手把手跟我做(二) 基本CRUD操作

MyBatis(二) 基本CRUD操作

在上一章中,已经实现了将数据库表中的内容读取出来,但是结果却是不对的

仔细观察上面的截图,发现数据库t_user表中的字段和User类中的属性完全一样的,数据是赋值进去了的,但是user_tel,registration_time这两个字段在User表中是以驼峰形式命名的属性,找到问题所在,其实数据库字段名和类名中的属性不匹配,引起的问题,这种问题当然很常见,所以Mybatis中有很多种办法来解决这种字段和属性不匹配的问题

一.数据库字段和Java Bean类属性不匹配问题的设置

这个问题我们常见的有三种办法都可以解决

1.在MyBatis全局配置中进行设置,打开驼峰规则匹配

这个也就是在mybatis-configuration.xml文件中,加入下面的配置

<!--开启自动驼峰命名规则(camel case)映射,
    即从经典数据库列名 A_COLUMN 到经典 Java 属性名 aColumn 的类似映射。-->
<settings>
        <setting name="mapUnderscoreToCamelCase" value="true"/>
</settings>

注意这段代码的位置,MyBatis的全局配置,对于配置标签的位置是有限制的,不能随便改变设置标签的位置. 现在我们将<settings></settings>标签直接放在<configuration>标签下方 -w648

只需要这么设置之后,我们这里的代码就可以正确获取数据库中的值了 -w974

<settings></settings>标签中,还有很多我们日常常用的设置

设置参数 描述 有效值 默认值
cacheEnabled 全局地开启或关闭配置文件中的所有映射器已经配置的任何缓存。 true false true
lazyLoadingEnabled 延迟加载的全局开关。当开启时,所有关联对象都会延迟加载。 特定关联关系中可通过设置fetchType属性来覆盖该项的开关状态。 true false false
aggressiveLazyLoading 当开启时,任何方法的调用都会加载该对象的所有属性。否则,每个属性会按需加载(参考lazyLoadTriggerMethods). true false false (true in ≤3.4.1)
multipleResultSetsEnabled 是否允许单一语句返回多结果集(需要兼容驱动)。 true false true
useColumnLabel 使用列标签代替列名。不同的驱动在这方面会有不同的表现, 具体可参考相关驱动文档或通过测试这两种不同的模式来观察所用驱动的结果。 true false true
useGeneratedKeys 允许 JDBC 支持自动生成主键,需要驱动兼容。 如果设置为 true 则这个设置强制使用自动生成主键,尽管一些驱动不能兼容但仍可正常工作(比如 Derby)。 true false false
autoMappingBehavior 指定 MyBatis 应如何自动映射列到字段或属性。 NONE 表示取消自动映射;PARTIAL 只会自动映射没有定义嵌套结果集映射的结果集。 FULL 会自动映射任意复杂的结果集(无论是否嵌套)。 NONE, PARTIAL, FULL PARTIAL
autoMappingUnknownColumnBehavior 指定发现自动映射目标未知列(或者未知属性类型)的行为。NONE: 不做任何反应 WARNING: 输出提醒日志 ('org.apache.ibatis.session.AutoMappingUnknownColumnBehavior' 的日志等级必须设置为 WARN) FAILING: 映射失败 (抛出 SqlSessionException) NONE, WARNING, FAILING NONE
defaultExecutorType 配置默认的执行器。SIMPLE 就是普通的执行器;REUSE 执行器会重用预处理语句(prepared statements); BATCH 执行器将重用语句并执行批量更新。 SIMPLE REUSE BATCH SIMPLE
defaultStatementTimeout 设置超时时间,它决定驱动等待数据库响应的秒数。 任意正整数 Not Set (null)
defaultFetchSize 为驱动的结果集获取数量(fetchSize)设置一个提示值。此参数只可以在查询设置中被覆盖。 任意正整数 Not Set (null)
safeRowBoundsEnabled 允许在嵌套语句中使用分页(RowBounds)。如果允许使用则设置为false。 true false false
safeResultHandlerEnabled 允许在嵌套语句中使用分页(ResultHandler)。如果允许使用则设置为false。 true false true
mapUnderscoreToCamelCase 是否开启自动驼峰命名规则(camel case)映射,即从经典数据库列名 A_COLUMN 到经典 Java 属性名 aColumn 的类似映射。 true false false
localCacheScope MyBatis 利用本地缓存机制(Local Cache)防止循环引用(circular references)和加速重复嵌套查询。 默认值为 SESSION,这种情况下会缓存一个会话中执行的所有查询。 若设置值为 STATEMENT,本地会话仅用在语句执行上,对相同 SqlSession 的不同调用将不会共享数据。 SESSION STATEMENT SESSION
jdbcTypeForNull 当没有为参数提供特定的 JDBC 类型时,为空值指定 JDBC 类型。 某些驱动需要指定列的 JDBC 类型,多数情况直接用一般类型即可,比如 NULL、VARCHAR 或 OTHER。 JdbcType 常量. 大多都为: NULL, VARCHAR and OTHER OTHER
lazyLoadTriggerMethods 指定哪个对象的方法触发一次延迟加载。 用逗号分隔的方法列表。 equals,clone,hashCode,toString
defaultScriptingLanguage 指定动态 SQL 生成的默认语言。 一个类型别名或完全限定类名。 org.apache.ibatis.scripting.xmltags.XMLLanguageDriver
defaultEnumTypeHandler 指定 Enum 使用的默认 TypeHandler 。 (从3.4.5开始) 一个类型别名或完全限定类名。 org.apache.ibatis.type.EnumTypeHandler
callSettersOnNulls 指定当结果集中值为 null 的时候是否调用映射对象的 setter(map 对象时为 put)方法,这对于有 Map.keySet() 依赖或 null 值初始化的时候是有用的。注意基本类型(int、boolean等)是不能设置成 null 的。 true false false
returnInstanceForEmptyRow 当返回行的所有列都是空时,MyBatis默认返回null。 当开启这个设置时,MyBatis会返回一个空实例。 请注意,它也适用于嵌套的结果集 (i.e. collectioin and association)。(从3.4.2开始) true false false
logPrefix 指定 MyBatis 增加到日志名称的前缀。 任何字符串 Not set
logImpl 指定 MyBatis 所用日志的具体实现,未指定时将自动查找。 SLF4J LOG4J LOG4J2 JDK_LOGGING COMMONS_LOGGING STDOUT_LOGGING NO_LOGGING Not set
proxyFactory 指定 Mybatis 创建具有延迟加载能力的对象所用到的代理工具。 CGLIB JAVASSIST JAVASSIST (MyBatis 3.3 or above)
vfsImpl 指定VFS的实现 自定义VFS的实现的类全限定名,以逗号分隔。 Not set
useActualParamName 允许使用方法签名中的名称作为语句参数名称。 为了使用该特性,你的工程必须采用Java 8编译,并且加上-parameters选项。(从3.4.1开始) true false false
configurationFactory 指定一个提供Configuration实例的类。 这个被返回的Configuration实例用来加载被反序列化对象的懒加载属性值。 这个类必须包含一个签名方法static Configuration getConfiguration(). (从 3.2.3 版本开始) 类型别名或者全类名. Not set

上面是<settings></settings>中全部的相关配置,不用特意去记住他们,有需要的时候再来查找就行了,其实常用了,也就那几个

2.修改mapper中SQL语句

上面<settings></settings>驼峰规则转换的配置,其实已经能够完美解决我们现在出现的问题,但是如果出现了数据库中字段是username,而java类中的属性是name,那么刚刚配置的转换规则肯定就不匹配了.这种情况也是很常见的,要解决最简单的办法就是直接给数据库字段取一个别名,和java实体类中属性值一致就行了 -w685

当然,这种只是临时的处理,一般情况下,如果出现字段的不匹配,最常用的是下面的办法

3.添加关联映射

在Mapper文件中添加关联映射,这种方式是处理字段不匹配是最常用的手段 -w872

上面的两张截图显示了关联映射应该注意的事情,下面是完整的代码

<?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.yingside.mapper.UserMapper">
    <resultMap id="userMap" type="com.yingside.bean.User">
        <id column="id" property="id" />
        <result column="user_tel" property="userTel"/>
        <result column="username" property="username"/>
        <result column="password" property="password"/>
        <result column="registration_time" property="registrationTime"/>
    </resultMap>

    <select id="getUser" parameterType="int"
            resultMap="userMap">
        select * from t_user where id=#{id}
    </select>
</mapper>

所以,我们在工作中,常常都会使用1,3种办法来处理这种不匹配的情况,一般情况下,驼峰规则映射一下就行了,如果出现特殊情况,这种情况在关联查询的时候还是挺常见的,我们就使用resultMap标签进行一下字段映射

二.加入log4j

如果觉得代码提示过少,我们也可以加入日志,跟踪我们的代码执行过程,使用方式也很简单 1.导入log4j的jar包,这对于我们Maven工程来说,只需要修改POM.xml,加入log4j的包依赖

<!--引入log4j-->
<dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.17</version>
</dependency>

2.在Maven工程的resources目录下加入log4j.properties配置文件,在文件中加入log4j相关配置内容

log4j.rootLogger=DEBUG,Console
log4j.logger.com.yingside.mapper=TRACE
log4j.appender.Console=org.apache.log4j.ConsoleAppender
log4j.appender.Console.layout=org.apache.log4j.PatternLayout
log4j.appender.Console.layout.ConversionPattern=%d [%t] %-5p [%c] - %m%n
log4j.logger.org.apache=INFO

就现在这样做的话,我们现在简单的测试工程,已经可以看到log4j的日志效果了 -w1135

不过要注意的是,MyBatis内置的日志工厂提供日志功能,具体的日志实现有以下几种工具:

  • SLF4J
  • Apache Commons Logging
  • Log4j 2
  • Log4j
  • JDK logging

具体选择哪个日志实现工具由MyBatis的内置日志工厂确定。它会使用最先找到的(按上文列举的顺序查找)。 如果一个都未找到,日志功能就会被禁用。

我们现在配置了log4j之后,MyBatis顺利找到了log4j,但是不少应用服务器的classpath中已经包含Commons Logging,如我们熟悉的Tomcat, 所以MyBatis会把它作为具体的日志实现。记住这点非常重要。这将意味着,在Tomcat的环境中提供了Commons Logging的私有实现,你的Log4J配置将被忽略。所以,在以后的使用中,我们最好在MyBatis的全局配置的中,再加上log4j日志文件的配置

<configuration>  
  <settings>  
    ...  
    <setting name="logImpl" value="LOG4J"/>  
    ...  
  </settings>  
</configuration>

最终目录结构效果: 2018-12-26_09-42-56

三.加入其它CRUD代码

1.查询 select 标签

之前只有一个根据id查询对象的方法,现在在mapper文件中加入常见的增删改查的方法,首先加入一个查询所有的方法,查询,在UserMapper.xml配置中,使用的都是<select></select>标签

<!-- 查询 t_user 表中所有用户数据 -->
<select id="getAll" resultType="com.yingside.bean.User">
    select * from t_user
</select>

如果我们这么写了之后,你会发现打印的效果其实和之前一样,userTel和registrationTime得到的结果是null,其实原因是一样的,这是最好还是应该使用resultMap

2018-12-26_10-43-14

在测试文件中测试一下效果,在Test中添加testGetAllUsers()方法

@org.junit.Test
public void testGetAllUsers(){
    String stmt = "com.yingside.mapper.UserMapper.getAll";
    List<User> users = sqlSession.selectList(stmt);
    log.info(users);
    sqlSession.close();
}

2018-12-26_10-49-32

2.新增 insert 标签

先在UserMapper.xml中加入对应的SQL语句标签,新增语句使用<insert></insert>标签

注意新增语句肯定是要带参数的,而且参数一般都很多,所以直接以面向对象的方式插入一个User对象,然后在sql语句中调用的都是对象的属性值,在insert标签中,使用parameterType属性表示要新增对象的类型

UserMapper.xml:

<!-- 向 t_user 表插入一条数据 -->
<insert id="insertUser" parameterType="com.yingside.bean.User">
    insert into t_user(id,user_tel,username,password,registration_time)
        value(null,#{userTel},#{username},#{password},#{registrationTime})
</insert>

Test.java:

@org.junit.Test
    public void testInsertUser(){
        String stmt = "com.yingside.mapper.UserMapper.insertUser";
        User user = new User();
        user.setUsername("韦小宝");
        user.setPassword("aaaaaa");
        user.setUserTel("13880000008");
        user.setRegistrationTime("2018-12-12");
        int n = sqlSession.insert(stmt,user);
        log.info(n);
        sqlSession.close();
    }

2018-12-26_11-40-16

上图表明了整个查询执行的过程和结果

2.1. 新增数据返回主键id值

不过这里的结果是一般数据库DML语句表示几行受影响的结果,一般我们的新增操作要求都比较特殊,需要知道最新插入的数据主键id是多少,如果这样的话,可以在<insert>标签中加入下面的代码

<!-- 向 t_user 表插入一条数据 -->
<insert id="insertUser" parameterType="com.yingside.bean.User">
    <!--将插入的数据主键返回到 user 对象中
       keyProperty:将查询到的主键设置到parameterType 指定到对象的那个属性
       select LAST_INSERT_ID():查询上一次执行insert 操作返回的主键id值,只适用于自增主键
       resultType:指定 select LAST_INSERT_ID() 的结果类型
       order:AFTER,相对于 select LAST_INSERT_ID()操作的顺序
    -->
    <selectKey keyProperty="id" resultType="int" order="AFTER">
        select LAST_INSERT_ID()
    </selectKey>
    insert into t_user(id,user_tel,username,password,registration_time)
        value(null,#{userTel},#{username},#{password},#{registrationTime})
</insert>

重新测试一下看看执行效果 2018-12-26_14-04-23

当然,mysql数据库是支持主键自增id的,上面这种办法,也只是主键自增id的写法,如果是非自增主键机制,比如使用UUID,就需要换一种写法

<insert id="insertUser" parameterType="com.yingside.bean.User">
    <!-- 将插入的数据主键返回到 user 对象中
         首先通过 select UUID()得到主键值,然后设置到 user 对象的id中,再进行 insert 操作
         keyProperty: 将查询到的主键设置到parameterType 指定到对象的那个属性
         select UUID():得到主键的id值,注意这里是字符串
         resultType: 指定 select UUID() 的结果类型
         order: BEFORE,相对于 select UUID()操作的顺序
         注意先后顺序和自增主键机制是不一样的
     -->
    <selectKey keyProperty="id" resultType="String" order="BEFORE">
        select UUID()
    </selectKey>
    insert into t_user(id,user_tel,username,password,registration_time)
        value(#{id},#{userTel},#{username},#{password},#{registrationTime})
</insert>

3.删除 delete 标签

删除使用<delete>标签,一般情况下,我们删除都根据主键id进行删除

UserMapper.xml:

<!-- 根据 id 删除 user 表的数据 -->
<delete id="deleteUserById" parameterType="int">
    delete from t_user where id=#{id}
</delete>

Test.java:

@org.junit.Test
public void testDeleteUser(){
    String stmt = "com.yingside.mapper.UserMapper.deleteUserById";
    int id = 13;
    int n = sqlSession.delete(stmt,id);
    //提交新增的数据
    sqlSession.commit();
    log.info(n);
    sqlSession.close();
}

2018-12-26_14-42-23

4.更新 update 标签

更新使用<update>标签,一般情况下,是根据主键id,更新数据

UserMapper.xml:

<!-- 根据 id 更新 user 表的数据 -->
<update id="updateUserById" parameterType="com.yingside.bean.User">
  update t_user set user_tel=#{userTel},username=#{username},
  password=md5(#{password}),registration_time=#{registrationTime}
  where id=#{id}
</update>

Test.java:

@org.junit.Test
public void testUpdateUser(){
    String stmt = "com.yingside.mapper.UserMapper.updateUserById";
    User user = new User();
    user.setId(8);
    user.setUsername("令狐冲");
    user.setPassword("abcdefg");
    user.setUserTel("13880000009");
    user.setRegistrationTime("2018-12-20");
    int n = sqlSession.insert(stmt,user);
    //提交修改的数据
    sqlSession.commit();
    sqlSession.close();
}

2018-12-26_15-18-37

四.配置别名 typeAliases 标签

这就是最基本的数据库CRUD操作,不过上面的xml配置中,有一个的重复很烦躁,那就是 parameterType="com.yingside.bean.User"如果是自定义的类型,就必须跟上类的包名全路径,那这个其实只需要在全局环境中配置一下别名就可以了

<configuration>
   ...
    <typeAliases>
        <!--给com.yingside.bean包下的所有类起一个别名,默认就是类名 com.yingside.bean.User === User
        (注意低版本的MyBatis 别名默认是类名首字母小写,相当于 com.yingside.bean.User === user)
        这样在每个mapper文件中如果出现自定义的类,就不必再写成 包路径 + 类名 的形式了,直接写这里定义的别名就ok
        -->
        <package name="com.yingside.bean"/>
        <!--单独的给每个类别名-->
        <!--<typeAlias type="com.yingside.bean.User" alias="user" />-->
    </typeAliases>
    ...
 </configuration>

2018-12-26_16-01-00

本文链接:http://www.yanhongzhi.com/post/mybatis-crud.html

-- EOF --

Comments