这篇博客主要是记录Mybatis的基本用法，包括Mybatis的入参形式、返回参数形式以及resultMap的使用方法的介绍。

mapper接口代理实现编写规则

1. 映射文件中namespace要等于接口的全路径名称
2. 映射文件中sql语句id要等于接口的方法名称
3. 映射文件中传入参数类型要等于接口方法的传入参数类型
4. 映射文件中返回结果集类型要等于接口方法的返回值类型

select用法

XML中的select标签的id属性值和定义在接口方法名是一样的。

<mapper namespace="trace.db.mapper.SupervisionMapper">
    <!--扫描SupervisionMapper下的所有接口-->
    <select id="getDepartmentNameTest" parameterType="java.lang.String"
            resultType="java.lang.String">
            select county_name from dic_county where county_code = #{countyCode}
    </select>
    
    <!-- 
    如果返回结果为集合,可以调用selectList方法,这个方法返回的结果就是一个集合,所以映射文件中应该配置成集合泛型的类型
    #{} 会进行安全性处理
    ${}拼接符:字符串原样拼接,如果传入的参数是基本类型(string,long,double,int,boolean,float等),那么${}中的变量名称必须是value
    注意:拼接符有sql注入的风险,所以慎重使用
     -->
    
</mapper>

先来了解一下XML中一些标签和属性的作用。

• select：映射查询语句使用的标签
• id：命名空间中的唯一标识符，可用来代表这条语句
• parameterType：指定输入参数的类型
• resultType：指定sql输出结果的所映射的java对象类型。select指定resultType表示将单条记录映射成的Java对象。
• #{countyCode}：MybatisSQL中使用预编译参数的一种方式，大括号中的countyCode是传入的参数名。（如果输入参数是简单类型(string,long,double,int,boolean,float等)，#{}中的参数名可以任意，可以value或者其他）
• resultMap：用于配置Java对象的属性和查询结果列的对应关系，通过resultMap中配置的column和property可以将查询列的值映射到type对象的属性上。

多个接口参数的方法

1.直接使用POJO类参数

直接使用#{对象的属性名}即可引用对象的property属性。Mybatis通过getter()来获取值.

<!--插入用户-->
<insert id="insertUser" useGeneratedKeys="true" parameterType="com.zhojian.pojo.User" keyColumn="id" keyProperty="id">
        INSERT INTO users (name, sex, p)
                VALUES (#{name},
                        #{sex}
                );
 </insert>

接口文件

public interface UserDao {
    public void insertUser(User user);
}

2.使用Map传递参数，直接设置parameterType为map

<select id="findRoleByMap" parameterType="map" resultMap="roleMap">
    select id,role_name ,note from t_role where role_name like concat('%',#{roleName},'%');
</select>

这个方法虽然简单易用，但是有一个弊端：这样设置的参数使用了Map，而Map需要键值对应，由于业务关联性不强，你需要深入到程序中看代码，造成可读性下降。Mybatis为我们提供了更好的是实现方法，它就是注解参数的形式，让我们看看如何实现

3.在代码中使用@Param注解

boolean updateModuleStatus(@Param("companySid") int companySid, @Param("moduleStatus") int moduleStatus);

<update id="updateModuleStatus" >
      UPDATE t_module SET
           module_status = #{moduleStatus}
      WHERE company_sid = #{companySid}
</update>

使用@Param注解传递多个参数，这种方式的使用受到参数个数(n)的影响。当n<=5时，它是最佳的传参方式，它比用JavaBean更好，因为它更加直观，当n>5时，建议使用JavaBean方式。

resultMap与resultType详解

我们虽然有自动映射，但是在某些时候，我们需要处理更为复杂的映射，resultMap为我们提供了这样的模式。我们需要在映射器中定义resultMap，这也是我们常见的场景。

Insert用法

insert元素，相对于select元素而言要简单许多。Mybatis会在执行插入之后返回一个整数，以表示你进行操作后插入的记录数。

<insert id="insertAuthor">
  insert into Author (id,username,password,email,bio)
  values (#{id},#{username},#{password},#{email},#{bio})
</insert>

int insertAuthor(Author author)

主键回填和自定义

现实中有许多我们需要处理的问题，例如，主键自增字段，MySQL里面的主键需要根据一些特殊的规则去生成，在插入后我们往往需要获得这个主键，以便于未来的操作，而Mybatis提供了实现的方法。

首先我们可以使用keyProperty属性指定的哪个是主键字段，同时使用useGenerateKeys属性告诉Mybatis这个主键是否使用数据库内置策略生成。

我们的例子中t_role表就是指定id列为自增字段。因此我们建立POJO，它能提供setter和getter方法，这样便能够使用Mybatis的主键回填功能了。那么我们可以在XML中进行如下配置：

<insert id="insertRole" parameterType="role" useGenerateKeys="true" keyProperty="id">
    insert into t_role(role_name,note) values (#{roleName},#{note})
</insert>

这样我们传入的role对象就无需设置id的值，Mybatis会用数据库的设置进行处理。这样做的好处是在Mybatis插入的时候，它会回填JavaBean的id值。我们进行调试，在插入后，它自动填充主键，方便以后使用。

//回填之后取出id值
role.getId()

实际工作往往不是我们想象的那么简单，需要根据一些特殊的关系设置主键id的值。假设我们取消表t_role的id自增的规则，我们的要求是：如果表t_role没有记录，则我们需要设置id=1，否则我们就去最大id加2，来设置新的主键，对于一些特殊要求，Mybatis也提供了对应的方法。这个时候我们可以使用selectKey元素处理，操作方法如下：

<insert id="insertRole" parameterType="role" useGeneratedKeys="true" keyProperty="id">
    <selectKey keyProperty="id" resultType="int" order="BEFORE">
        select if(max(id) is null ,1,max(id)+2 ) as newId from t_role
    </selectKey>
    insert into t_role(role_name,note) values (#{roleName},#{note})
</insert>

update用法和delete用法

<update id="updateAuthor">
  update Author set
    username = #{username},
    password = #{password},
    email = #{email},
    bio = #{bio}
  where id = #{id}
</update>

<delete id="deleteAuthor">
  delete from Author where id = #{id}
</delete>

resultMap结果映射集

resultMap是Mybatis里面最复杂的元素。它的作用是定义映射规则、级联的更新、定制类型转化器等。resultMap定义的主要是一个结果集的映射关系。

image.png

image.png

image.png

resultMap元素的属性id代表这个resultMap的标志，type代表着需要映射的pojo。我们可以使用mybatis定义好的类的别名，也可以使用自定义的类的权限定名。

<resultMap id="LogReceiveMap" type="com.trace.app.framework.toolsmodel.LogReceive">
    <!-- 映射关系中，id元素表示这个对象的主键，property代表着pojo的属性名称
                ，column表示数据库sql的列名，于是pojo就和数据库sql的结果一一对应起来了-->
    <id property="id" column="id"/>
    <result property="companySid" column="company_sid"/>
    <result property="version" column="version"/>
    <result property="types" column="types"/>
</resultMap>
    

使用map存储结果集

一般而言，任何select语句都可以使用map存储。

<select id="findColorByNote" parameterType="string" resultType="map">
    select id,color,note from t_color where note like concat('%',#{note},'%')
</select>

使用map的原则上是可以匹配所有的结果集的，但是使用map接口就意味着可读性的下降，所以这不是一种推荐的方式。更多的时候我们使用的是POJO方式。

使用POJO存储结果集

使用map方式就意味着可读性的下降。POJO是我们最常用的方式，也是我们推荐的方式。一方面我们可以使用自动映射，正如select语句里论述的一样。我们还可以使用select语句的属性resultMap配置映射集合，只是使用前需要配置类似的resultMap。

<select id="selectByPrimaryKey" parameterType="java.lang.Integer"
        resultType="com.trace.app.framework.toolsmodel.LogResult">
        SELECT * FROM t_logs WHERE company_sid = #{companySid}
</select>

resultMap元素的属性id代表这个resultMap的标识，type代表着你需要映射的POJO。我们可以使用Mybatis定义好的类的别名，也可以使用自定义的类的全限定名。

映射关系中，id元素表示这个对象的主键，property代表POJO的属性名称，column表示数据库SQL的列名，于是POJO就和数据库SQL的结果一一对应起来了。接着我们在映射文件中的select元素里面做下面的配置，便可以使用了。

别名设置

在mybatis.xml设置要添加的别名，如下：

 <!--为实体类设置别名-->
<typeAliases>
        <typeAlias type="com.trace.app.framework.toolsmodel.Environment" alias="Environment"></typeAlias>
</typeAliases>

然后在Mapper.xml在parameterType中设置为别名就可以了

<select id="getAllInfo" parameterType="Environment"
            resultMap="BaseResultMap">
        SELECT * FROM t_module ,t_company WHERE t_module.company_sid = t_company.company_sid
</select>

参考资料

https://www.jianshu.com/p/7ac818945c2f

https://www.jianshu.com/p/9a3c8e3a63bf

http://www.mybatis.org/mybatis-3/zh/sqlmap-xml.html