Mybatis的使用

矫情吗；* 2022-05-29 10:59 228阅读 0赞

**该文章基于《Spring+MyBatis企业应用实战》进行总结，旨在积累巩固**  
如果要使用mybatis，需要定义几个特别重要的xml，第一个文件为XXXMapper.xml文件（XXX是我们需要进行对应的domain类）

如果通过注解的方式可以代替对应的XXXMapper.xml文件，再面向接口编程的情况下，注解的位置位于接口的对应方法上，其示例如下：

public interface XXXMapper{ 
        @Select("该值于XXXMapper.xml文件中的SQL语句相同，不再赘述")
        @Options(useGeneratedKeys=true)
        //关于属性的设置都位于@Options中
        @Results({
            @Result(column="XXX",property="XXX",(id="true/false"))
            //其他结果的对应
        })
        public XXX XXX(@Param("XXX") XXX);
        //如果不使用@Param注解，那么将会按照参数顺序进行表达式的映射
    }

下面介绍一下<sql></sql>的用法

<sql id="SQLID">${占位符}.id</sql>
    
    <select id="SELECTID" resultType="map(列名为key，值为value)">
        
        <include refid="SQLID">
            
            <property name="占位符" value="XXX"/>
        </include>
    </select>

下面介绍<resultMap></resultMap>，resultMap和具体CRUD中的区别在于它可以更加细粒度的控制参数之间的转换，需要注意的是**resultMap的映射实际上是基于对列名的解析，如果列名出现重名，将会导致解析失败**：

除此之外还需要通过mybatis-config.xml进行配置：

可以看到我们并没有配置事务管理器，Mybatis中的事务管理器有两种选择，一种为JDBC一种为MANAGED，JDBC事务管理直接使用了JDBC的提交和回滚，MANAGED则是通过容器来管理整个生命周期  
实际的调用过程一共分为六步：

//第一步，解析mbatis-config.xml文件
    InputStream inputStream = Resources.getResourceAsStream("mybatis-config.xml");
    //第二部，通过解析后的mybatis-config.xml创建SqlSessionFactory实例
    SqlSessionFactory sqlsessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
    //第三步，通过SqlSessionFactory创建SqlSession对象
    SqlSession session = sqlSessionFactory.openSession();
    //第四步，通过XXXMapper的"namespace.id"调用已经写好的sql方法
    session.XXX("namespace.id",domain);
    //第五步，提交事务
    session.commit();
    //第六步，关闭Session
    session.close();

下面来介绍一下上面出现的几个类：  
**SqlSessionFactory**：单个数据库映射关系经过编译后的**内存镜像**，是**线程安全**的类，建议使用单例模式  
**SqlSession**：单线程对象（线程不安全）  
如果希望看见执行的过程，可以添加Log4j进行输出，在添加JAR包的前提下，通过在src路径下添加log4j.properties文件：

# Global logging configuration
    log4j.rootLogger=ERROR, stdout
    # MyBatis logging configuration...
    log4j.logger.org.fkit.mapper.UserMapper=DEBUG
    # Console output...
    log4j.appender.stdout=org.apache.log4j.ConsoleAppender
    log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
    log4j.appender.stdout.layout.ConversionPattern=%5p [%t] - %m%n

# 面向接口编程 #

Mybatis官方手册建议面向接口编程而不是面向类进行编程，如果我们要实现面向接口编程，那么我们就应该先定义一个接口：

public interface XXXMapper{ 
        XXX selectOne(Integer id);
    }

我们还需要同样的定义一个XXXMapper.xml的专用映射文件：

在使用的时候和我们之前的方式就不同了：

//获取session之前的代码都没有问题，但是我们现在不通过session进行查找，而是更进一步获得mapper
    XXXMapper mapper = session.getMapper(XXXMapper.class);

之后便可以针对接口进行编程了

# 一对一映射 #

一对一关系推荐使用唯一主外键关联，并且建议给外键列增加唯一约束，如果不再XXXMapper.xml中进行SQL的编写，而是使用注解的方式进行SQL编写，可以按照下面的方式及进行：

public interface XXXMapper{ 
        @Select("sql语句")
        @Results({
            @Result(id="XXX",property="XXX",column="XXX")
            @Result(column="XXX",property="XXX",
                one = @One(select="指定的select方法，同XXXMapper.xml",fetchType=FetchType.EAGER))
        XXX seletXXX();
        })
    }

# 一对多映射 #

一般需要在数据转换时通过<resultMap>进行数据的映射，并需要通过<collection>进行另外一次的查找，对多一方的映射同对一一方的映射：

public interface XXXMapper{ 
        @Select("sql语句")
        @Results({
            @Result(id="XXX",property="XXX",column="XXX")
            @Result(column="XXX",property="XXX",
                many = @Many(select="指定的select方法，同XXXMapper.xml",fetchType=FetchType.LAZY))
        XXX seletXXX();
        })
    }

# 多对多映射 #

多对多映射一般需要在两边都通过<collection>进行数据的抓取

# 延迟加载 #

延迟加载的目的一般是为了让一对多映射或者多对多映射时、第一次运行时不用加载所有的‘多’的一方，如果连接为多对一或者一对一，只用进行一次表连接就可以取出结果就不用再进行延迟加载，如果要使用延迟加载，需要在collection标签中将fetchType的值设置为lazy，并且还需要再mybatis-config.xml中添加配置：

# 动态SQL #

Mybatis使用了基于OGNL的表达式来完成动态的SQL，其中常用的动态元素有：

### *if* ###

示例：

<select ...>
        ...前一部分的SQL语句
        
        <if test="id != null">
            ...后一部分的SQL语句(例如 and id = #{id})
        </if>
    </select>

### *choose(when,otherwise)* ###

该标签组类似于if-else if-else  
示例：

### *where* ###

该标签主要用于where的断句，否则如果仅仅在where后面使用<if>很可能会造成空where  
示例：

### *set* ###

一般用于update标签中，用于动态更新，它所避免的也是<where>标签所尝试避免的，示例：

### *foreach* ###

场景主要是用于对集合进行遍历，主要用于select标签的in子句中，示例：

### *bind* ###

主要用于从OGNL表达式中创建一个变量并绑定到上下文：

<select>
        <bind name="name" value="%aaa%"/>
        select * from table where name like #{name}
    </select>

如果动态SQL需要通过注解的方式进行使用，必须通过org.apache.ibatis.jdbc.SQL进行，下面给出示例：

public class XXXDynaSqlProvider{ 
        //方法参数可以为：1.无参、2.java对象、3.Map类型
        public String selectXXX(Map<String,Object> param){
            return new SQL(){
                SELECT("参数名称");
                FROM("表名");
                if(param.get("xxx") != null){
                    WHERE("xxx = #{xxx}");  
                }
                //UPDATE("表名")
                //SET("xxx = #{xxx}")
            }.toString();
        }
    }

之后还需要在XXXMapper.xml中通过注解进行添加：

@(Insert/Select/Update/Delete)Provider(type="XXXDynaSqlProvider.class", method="方法名")
    @Options(useGeneratedKeys=true,...)
    @Results({
        @Result(..)
    })
    XXX insertXXX(XXX xxx);