当前位置 : 首页 » 文章分类 :  开发  »  MyBatis

MyBatis

MyBatis笔记

MyBatis 官方中文文档
http://www.mybatis.org/mybatis-3/zh/index.html

MyBatis是一个支持普通SQL查询,存储过程和高级映射的优秀持久层框架,即ORM(Object Relational Mapping 对象关系映射)框架。MyBatis消除了几乎所有的JDBC代码和参数的手工设置以及对结果集的检索封装。MyBatis可以使用简单的XML或注解用于配置和原始映射,将接口和Java的POJO(Plain Old Java Objects,普通的Java对象)映射成数据库中的记录。

springboot(六):如何优雅的使用mybatis
http://www.ityouknow.com/springboot/2016/11/06/spring-boo-mybatis.html


Java API

通用Mapper

轻松搞定增删改查 - Mybatis通用Mapper介绍与使用
http://www.ciphermagic.cn/mybatis-mapper.html

问题

text类型为空

mybatis selectByExample() 方法返回的text类型字段为空,但数据库里有值,后来发现还有个 selectByExampleWithBLOBs() , 只有后缀带WithBLOBs的select方法才能查到text类型内容。

Invalid bound statement (not found)

一开始以为是没有配 maven 的 <build> <resources> <resource>,导致mapper.xml没有打包进去,从而找不到xml,后来仔细检查发现.xml在包中,但还是提示这个错误。
https://blog.csdn.net/hello_world_qwp/article/details/79030823
https://blog.csdn.net/k469785635/article/details/77532512

后来发现是application.properties中没有配置 mybatis.mapperLocations 属性

mybatis.mapperLocations=classpath:mapper/*.xml

mybatis.mapperLocations 属性

当mybatis的xml文件和mapper接口不在相同包下时,需要用mapperLocations属性指定xml文件的路径。*是个通配符,代表所有的文件,**代表所有目录下

如果Mapper.xml与Mapper.class在同一个包下且同名,spring扫描Mapper.class的同时会自动扫描同名的Mapper.xml并装配到Mapper.class。
如果Mapper.xml与Mapper.class不在同一个包下或者不同名,就必须使用配置mapperLocations指定mapper.xml的位置。
此时spring是通过识别mapper.xml中的 <mapper namespace="com.fan.mapper.UserDao"> namespace的值来确定对应的Mapper.class的。

官方文档:
如果 MyBatis 映射器 XML 文件在和映射器类相同的路径下不存在,那么另外一个需要 配置文件的原因就是它了。使用这个配置,有两种选择。第一是手动在 MyBatis 的 XML 配 置文件中使用<mappers>部分来指定类路径。第二是使用工厂 bean 的 mapperLocations 属 性。
mapperLocations 属性使用一个资源位置的 list。 这个属性可以用来指定 MyBatis 的 XML 映射器文件的位置。 它的值可以包含 Ant 样式来加载一个目录中所有文件, 或者从基路径下 递归搜索所有路径。比如:

<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
  <property name="dataSource" ref="dataSource" />
  <property name="mapperLocations" value="classpath*:sample/config/mappers/**/*.xml" />
</bean>

这会从类路径下加载在 sample.config.mappers 包和它的子包中所有的 MyBatis 映射器 XML 文件。

或者设置 SqlSessionFactoryBean 的对应属性:

ResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
sqlSessionFactoryBean.setMapperLocations(resolver.getResources("classpath*:mapper/*.xml"));

或者在spring配置文件中:

mybatis.mapperLocations=classpath:mapper/*.xml

Springboot mybatis集成 Invalid bound statement (not found)
https://blog.csdn.net/qq_35981283/article/details/78590090

SqlSessionFactoryBean
http://www.mybatis.org/spring/zh/factorybean.html


@Mapper 和 @MapperScan

自定义mapper接口后,为了让mybatis将他扫描成bean,需要在每个接口上加 @Mapper 注解,如果嫌在每个接口上加太麻烦可以使用 @MapperScan 注解指定要扫描的包

使用@Mapper注解

为了让DemoMapper能够让别的类进行引用,我们可以在DemMapper类上添加@Mapper注解:

@Mapper
public interface DemoMapper {
    @Insert("insert into Demo(name) values(#{name})")
    @Options(keyProperty="id",keyColumn="id",useGeneratedKeys=true)
    public void save(Demo demo);
}

直接在Mapper类上面添加注解@Mapper,这种方式要求每一个mapper类都需要添加此注解,麻烦。

使用@MapperScan注解

通过使用@MapperScan可以指定要扫描的Mapper类的包的路径,可以用*通配符,也可以同时指定多个包路径

@SpringBootApplication
@MapperScan({
  "com.kfit.*.mapper",
  "com.kfit.user"
})
public class App {
    public static void main(String[] args) {
       SpringApplication.run(App.class, args);
    }
}

@MapperScan 扫描不同包中的同名Mapper导致冲突

例如我们应用有两个数据源,mysql和tidb,要把这两个库的mapper都扫描上:

@MapperScan({"com.mysql.mapper", "com.tidb.mapper"})
@SpringBootApplication
public class Application implements ApplicationRunner {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

但如果这两个包中都有 UserInfoMapper, 就会导致冲突而无法启动,如下:

@2019-01-08 19:33:28,602 [ERROR] RID= UID= AID= MOBILE= -- [main] org.springframework.boot.SpringApplication [771]: Application startup failed
org.springframework.context.annotation.ConflictingBeanDefinitionException: Annotation-specified bean name 'userInfoMapper' for bean class [com.masikkk.tidb.mapper.UserMapper] conflicts with existing, non-compatible bean definition of same name and class [org.mybatis.spring.mapper.MapperFactoryBean]
    at org.springframework.context.annotation.ClassPathBeanDefinitionScanner.checkCandidate(ClassPathBeanDefinitionScanner.java:345) ~[spring-context-4.3.16.RELEASE.jar:4.3.16.RELEASE]
    at org.mybatis.spring.mapper.ClassPathMapperScanner.checkCandidate(ClassPathMapperScanner.java:237) ~[mybatis-spring-1.3.0.jar:1.3.0]
    at org.springframework.context.annotation.ClassPathBeanDefinitionScanner.doScan(ClassPathBeanDefinitionScanner.java:283) ~[spring-context-4.3.16.RELEASE.jar:4.3.16.RELEASE]
    at org.mybatis.spring.mapper.ClassPathMapperScanner.doScan(ClassPathMapperScanner.java:164) ~[mybatis-spring-1.3.0.jar:1.3.0]
    at org.mybatis.spring.annotation.MapperScannerRegistrar.registerBeanDefinitions(MapperScannerRegistrar.java:105) ~[mybatis-spring-1.3.0.jar:1.3.0]
    at org.springframework.context.annotation.ConfigurationClassBeanDefinitionReader.loadBeanDefinitionsFromRegistrars(ConfigurationClassBeanDefinitionReader.java:359) ~[spring-context-4.3.16.RELEASE.jar:4.3.16.RELEASE]

网上有人问过这个问题,问 @MapperScan 是否可以增加一个 排除列表,像 Spring的 @ComponentScanexcludeFilters 参数一样,结果是支持不了。解决方法只能是改表名,两个数据源的mapper包中不能有重名的mapper

could @MapperScan annotaion support excludeFilter?
I write a base abstract mapper and put it into my mapper package, but i don’t want it to be scanned as a bean.
I can only figure out three solutions:
1.move the abstract mapper to another package, which seems stupid
2.similar to 1,put the abstract mapper to mapper.base and others to mapper.whateverlelse
2.add@Component or @Repository to every mapper rather than using @MapperScan automatically

MapperScan excludeFilters support
http://mybatis-user.963551.n3.nabble.com/MapperScan-excludeFilters-support-td4029831.html


SqlSession

MyBatis常用对象SqlSessionFactory和SqlSession介绍和运用
https://blog.csdn.net/u013412772/article/details/73648537

SqlSession创建过程

(1)定义一个Configuration对象,其中包含数据源、事务、mapper文件资源以及影响数据库行为属性设置settings
(2)通过配置对象,则可以创建一个SqlSessionFactoryBuilder对象 或者 SqlSessionFactoryBean
(3)通过 SqlSessionFactoryBuilder 或 SqlSessionFactoryBean 获得SqlSessionFactory 的实例。
(4)SqlSessionFactory 的实例可以获得操作数据的SqlSession实例,通过这个实例对数据库进行操作

构建SqlSession并操作数据库实例

package com.cn.testIUserService;

import java.io.IOException;
import java.io.InputStream;
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;

import com.cn.entity.User;

public class MyBatisTest {

    public static void main(String[] args) {
        try {
            //读取mybatis-config.xml文件
            InputStream resourceAsStream = Resources.getResourceAsStream("mybatis-config.xml");
            //初始化mybatis,创建SqlSessionFactory类的实例
            SqlSessionFactory sqlSessionFactory =  new SqlSessionFactoryBuilder().build(resourceAsStream);
            //创建session实例
            SqlSession session = sqlSessionFactory.openSession();
            /*
             * 接下来在这里做很多事情,到目前为止,目的已经达到得到了SqlSession对象.通过调用SqlSession里面的方法,
             * 可以测试MyBatis和Dao层接口方法之间的正确性,当然也可以做别的很多事情,在这里就不列举了
             */
            //插入数据
            User user = new User();
            user.setC_password("123");
            user.setC_username("123");
            user.setC_salt("123");
            //第一个参数为方法的完全限定名:位置信息+映射文件当中的id
            session.insert("com.cn.dao.UserMapping.insertUserInformation", user);
            //提交事务
            session.commit();
            //关闭session
            session.close();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

SqlSessionFactoryBean

在基础的 MyBatis 用法中,是通过 SqlSessionFactoryBuilder 来创建 SqlSessionFactory 的。 而在 MyBatis-Spring 中,则使用 SqlSessionFactoryBean 来创建。

方式一、XML中通过 SqlSessionFactoryBean 配置 sqlSessionFactory bean

<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
  <property name="dataSource" ref="dataSource" />
  <property name="mapperLocations" value="classpath*:sample/config/mappers/**/*.xml" />
</bean>

方式二、java 代码中通过 SqlSessionFactoryBean 配置 sqlSessionFactory bean

@Bean
public SqlSessionFactory sqlSessionFactory() {
  SqlSessionFactoryBean sqlSessionFactoryBean = new SqlSessionFactoryBean();
  sqlSessionFactoryBean.setDataSource(dataSource());
  sqlSessionFactoryBean.setMapperLocations(new PathMatchingResourcePatternResolver().getResources("classpath*:mapper/*.xml"));
  return factoryBean.getObject();
}

通常,在 MyBatis-Spring 中,你不需要直接使用 SqlSessionFactoryBean 或对应的 SqlSessionFactory。相反,session 的工厂 bean 将会被注入到 MapperFactoryBean 或其它继承于 SqlSessionDaoSupport 的 DAO(Data Access Object,数据访问对象)中。

SqlSessionFactoryBean
http://www.mybatis.org/spring/zh/factorybean.html


sql日志

所有通过 mybatis 执行的sql,都会打出相关 debug 日志,能看到预编译sql和传入的动态参数
必须开启debug级别日志才能看到,例如:

2019-06-03 12:04:40,412 [DEBUG] [XNIO-1 task-1] com.masikkk.mapper.UserMapper.countUserByUserUuids [145]: ==>  Preparing: SELECT ur.user_uuid, COUNT(*) AS amount FROM user_register ur INNER JOIN user_type ut ON ur.user_type_id = ut.id WHERE ur.user_uuid IN ( ? ) AND ut.type IN ( ? ) GROUP BY ur.user_uuid
2019-06-03 12:04:40,413 [DEBUG] [XNIO-1 task-1] com.masikkk.mapper.UserMapper.countUserByUserUuids [145]: ==> Parameters: 6824186360112128(Long), 4(Byte)
2019-06-03 12:04:40,428 [DEBUG] [XNIO-1 task-1] com.masikkk.mapper.UserMapper.countUserByUserUuids [145]: <==      Total: 1

SQL语句

注意事项

内部类作为返回结果必须是静态类

假如有如下sql

// 统计user的地址数
@Select("SELECT user_id, COUNT(*) FROM user_address GROUP BY user_uuid")
List<UserAddressCount> countAddressNum();

其中返回结果是个内部类

class ResultBean {
    private String name;
    ...

    class UserAddressCount {
        private Long userId;
        private Integer count;
    }

    getter...
    setter...
}

执行时会报错:

No constructor found in com.masikkk.ResultBean$UserAddressCount matching [java.lang.Long, java.lang.Integer]

原因是 UserAddressCount 非静态类,构造函数中的第一个参数是 父类的this指针,所以构造函数的签名是 (ResultBean, Long, Integer) 自然和mybatis期望的 (Long, Integer) 匹配不上,所以报找不到构造函数的错误。
解决方法可以将 UserAddressCount 拿出来单独写成一个类,或者写成静态内部类: public static class UserAddressCount

mybatis支持返回内部类吗?如果是,该如何实现?
https://segmentfault.com/q/1010000010436451/

集合判空中必须用小写and

比如根据user_ids列表批量查询user信息,在mybatis动态sql中进行集合判空

// 根据user_ids查询user信息
@Select("<script>" +
        "SELECT * FROM user WHERE status = 'enable'" +
        "<if test = 'user_ids != null and user_ids.size() > 0'>" +
        "AND id IN " +
        "  <foreach item='user_id' collection='user_ids' open='(' separator=',' close=')'>" +
        "      #{user_id}" +
        "  </foreach>" +
        "</if>" +
        "</script>")
List<Long> queryUsersByIds(@Param("user_ids") List<Long> userIds);

注意 test 表达式中的 and 必须小写,如果改成大写mybatis会报如下错误,提示 AND 是非法表达式

org.mybatis.spring.MyBatisSystemException: nested exception is org.apache.ibatis.builder.BuilderException: Error evaluating expression 'user_ids != null AND user_ids.size() > 0'. Cause: org.apache.ibatis.ognl.ExpressionSyntaxException: Malformed OGNL expression: user_ids != null AND user_ids.size() > 0 [org.apache.ibatis.ognl.ParseException: Encountered " <IDENT> "AND "" at line 1, column 23.
Was expecting one of:
    <EOF>
    "," ...
    "=" ...
    "?" ...
    "||" ...
    "or" ...
    "&&" ...
    "and" ...
    "|" ...
    "bor" ...
    "^" ...
    "xor" ...
    "&" ...
    "band" ...
    "==" ...
    "eq" ...
    "!=" ...
    "neq" ...
    "<" ...
    "lt" ...
    ">" ...
    "gt" ...
    "<=" ...
    "lte" ...
    ">=" ...
    "gte" ...
    "in" ...
    "not" ...
    "<<" ...
    "shl" ...
    ">>" ...
    "shr" ...
    ">>>" ...
    "ushr" ...
    "+" ...
    "-" ...
    "*" ...
    "/" ...
    "%" ...
    "instanceof" ...
    "." ...
    "(" ...
    "[" ...
    <DYNAMIC_SUBSCRIPT> ...
    ]
    at org.mybatis.spring.MyBatisExceptionTranslator.translateExceptionIfPossible(MyBatisExceptionTranslator.java:79) ~[mybatis-spring-1.3.0.jar:1.3.0]
    at org.mybatis.spring.SqlSessionTemplate$SqlSessionInterceptor.invoke(SqlSessionTemplate.java:447) ~[mybatis-spring-1.3.0.jar:1.3.0]
    at com.sun.proxy.$Proxy121.selectList(Unknown Source) ~[?:?]
    at org.mybatis.spring.SqlSessionTemplate.selectList(SqlSessionTemplate.java:231) ~[mybatis-spring-1.3.0.jar:1.3.0]
    at org.apache.ibatis.binding.MapperMethod.executeForMany(MapperMethod.java:128) ~[mybatis-3.4.0.jar:3.4.0]
    at org.apache.ibatis.binding.MapperMethod.execute(MapperMethod.java:68) ~[mybatis-3.4.0.jar:3.4.0]
    at org.apache.ibatis.binding.MapperProxy.invoke(MapperProxy.java:53) ~[mybatis-3.4.0.jar:3.4.0]
    at com.sun.proxy.$Proxy125.queryCarOrderRelationsByCarOrderIds(Unknown Source) ~[?:?]

大于小于号

普通字符串sql中直接写小于号<

无动态sql语句的字符串中直接写小于号

@Select("SELECT car_order_id FROM car_order_relation WHERE user_id = #{user_id} AND relation = #{relation} AND create_time <= #{create_time} ")
List<CarOrder> queryCarOrderIdNoStatusByUserIdAndTime(@Param("user_id") long userId, @Param("relation") byte relation, @Param("create_time") Date createTime);

如果写成 &lt; 反而报错:
bad SQL grammar []; nested exception is com.mysql.jdbc.exceptions.jdbc4.MySQLSyntaxErrorException: You have an error in your SQL syntax; check the manual that corresponds to your MariaDB server version for the right syntax to use near ‘;= ‘2018-11-24 14:53:47’ )’ at line 1

动态sql标签中小于号必须转义为&lt;

动态sql中则必须使用 &lt; 代替小于号,否则报错
大于号不用动

org.xml.sax.SAXParseException: 元素内容必须由格式正确的字符数据或标记组成。
// 根据用户id,关系,起止时间查询用户历史
@Select({ "<script>"
        + "SELECT * FROM user_transaction"
        + "  <trim prefix = 'WHERE' prefixOverrides = 'AND |OR'>"
        + "    <if test = 'user_id != null'> AND user_id = #{user_id} </if>"
        + "    <if test = 'start_time != null'> AND create_time &gt;= #{start_time} </if>"
        + "    <if test = 'end_time != null'> AND create_time &lt;= #{end_time} </if>"
        + "    <if test = 'relations != null and relations.size() > 0'>"
        + "       AND relation IN "
        + "       <foreach item='item' collection='relations' open='(' separator=',' close=')'>"
        + "           #{item}"
        + "       </foreach>"
        + "    </if>"
        + "  </trim>"
        + "ORDER BY create_time DESC LIMIT #{offset},#{count}"
        + "</script>"
})
List<FellowUserRelationshipTransaction> queryFellowUserRelationshipTransaction(@Param("user_id") Long userId,
        @Param("relations") List<Short> relations, @Param("start_time") Date startTime, @Param("end_time") Date endTime,
        @Param("offset") long offset, @Param("count") int count);

insert和insertSelective区别

看MyBatis自动生成的mapper.xml很容易看出区别:
insertSelective对应的sql语句加入了NULL校验,即只会插入数据不为null的字段值。
insert则会插入所有字段,会插入null。

updateByPrimaryKey和updateByPrimaryKeySelective区别

updateByPrimaryKey对你注入的字段全部更新(不判断是否为Null)
updateByPrimaryKeySelective会对字段进行判断再更新(如果为Null就忽略更新)

select

<!-- 查询学生,根据id -->
<select id="getStudent" parameterType="String" resultMap="studentResultMap">
    SELECT ST.STUDENT_ID,
           ST.STUDENT_NAME,
           ST.STUDENT_SEX,
           ST.STUDENT_BIRTHDAY,
           ST.CLASS_ID
    FROM STUDENT_TBL ST
    WHERE ST.STUDENT_ID = #{studentID}
</select>

这条语句就叫做getStudent,有一个String参数,并返回一个StudentEntity类型的对象。

select语句的参数

属性 是否必须 描述
id 必须 在这个模式下唯一的标识符,可被其它语句引用。这个id也应该对应dao里面的某个方法(相当于方法的实现),因此id应该与方法名一致。
parameterType 可选 传给此语句的参数的完整类名或别名。如果不配置,mybatis会通过ParameterHandler根据参数类型默认选择合适的typeHandler进行处理。parameterType指定参数类型,可以是int,string等简单类型,也可以是复杂类型(如对象)
resultType 与resultMap二选一 语句返回值类型的整类名或别名。指定的类型可以是基本类型,可以是java容器,也可以是javabean(resultType与resultMap不能并用)
resultMap 与resultType二选一 resultMap用于引用我们通过resultMap标签定义的映射类型,这也是mybatis组件高级复杂映射的关键(resultType与resultMap不能并用)
flushCache 可选 将其设置为true,任何时候只要语句被调用,都会导致本地缓存和二级缓存都会被清空,select语句默认设为false
useCache 可选 将其设置为true,将会导致本条语句的结果被二级缓存,默认值:对select元素为true
timeout 可选 正整数值,这个设置是在抛出异常之前,驱动程序等待数据库返回请求结果的秒数,默认为不设值,由驱动器自己决定
fetchSize 可选 正整数值,设置一个值后,驱动器会在结果集数目达到此数值后,激发返回,默认为不设值,由驱动器自己决定
statementType 可选 取值为STATEMENT,PREPARED或CALLABLE中的一个。这会让MyBatis分别使用 Statement,PreparedStatement或CallableStatement,默认值为PREPARED
resultSetType 可选 取值为FORWARD_ONLY,SCROLL_SENSITIVE或SCROLL_INSENSITIVE中的一个,默认值为unset(依赖驱动)

sql

sql元素用来定义一个可以复用的SQL 语句段,供其它语句调用。比如:

<!-- 复用sql语句  查询student表所有字段 -->
<sql id="selectStudentAll">
        SELECT ST.STUDENT_ID,
               ST.STUDENT_NAME,
               ST.STUDENT_SEX,
               ST.STUDENT_BIRTHDAY,
               ST.CLASS_ID
        FROM STUDENT_TBL ST
</sql>

这样,在select的语句中就可以直接引用使用了,将上面select语句改成:

<!-- 查询学生,根据id -->
<select id="getStudent" parameterType="String" resultMap="studentResultMap">
    <include refid="selectStudentAll"/>
    WHERE ST.STUDENT_ID = #{studentID}
</select>

参数类型

MyBatis可以使用的参数包括基本数据类型和Java的复杂数据类型。
基本数据类型,如String,int,Date等,但是使用基本数据类型,只能提供一个参数
使用Java实体类,或Map类型做参数类型,通过#{}可以直接得到其属性。

基本类型参数

根据入学时间,检索学生列表:
SQL:

<!-- 查询学生list,根据入学时间  -->
<select id="getStudentListByDate"  parameterType="Date" resultMap="studentResultMap">
    SELECT *
    FROM STUDENT_TBL ST LEFT JOIN CLASS_TBL CT ON ST.CLASS_ID = CT.CLASS_ID
    WHERE CT.CLASS_YEAR = #{classYear};
</select>

java调用

List<StudentEntity> studentList = studentMapper.getStudentListByClassYear(StringUtil.parse("2007-9-1"));
for (StudentEntity entityTemp : studentList) {
    System.out.println(entityTemp.toString());
}

Java实体类型参数

根据姓名和性别,检索学生列表,使用实体类做参数,通过#{}可以直接得到实体中的字段
SQL:

<!-- 查询学生list,like姓名、=性别,参数entity类型 -->
<select id="getStudentListWhereEntity" parameterType="StudentEntity" resultMap="studentResultMap">
    SELECT * from STUDENT_TBL ST
    WHERE ST.STUDENT_NAME LIKE CONCAT(CONCAT('%', #{studentName}),'%')
          AND ST.STUDENT_SEX = #{studentSex}
</select>

java调用:

StudentEntity entity = new StudentEntity();
entity.setStudentName("李");
entity.setStudentSex("男");
List<StudentEntity> studentList = studentMapper.getStudentListWhereEntity(entity);
for (StudentEntity entityTemp : studentList) {
    System.out.println(entityTemp.toString());
}

Map参数

根据姓名和性别,检索学生列表,使用Map做参数:
SQL:

<!-- 查询学生list,=性别,参数map类型 -->
<select id="getStudentListWhereMap" parameterType="Map" resultMap="studentResultMap">
    SELECT * from STUDENT_TBL ST
    WHERE ST.STUDENT_SEX = #{sex}
          AND ST.STUDENT_NAME = #{name}
</select>

java调用:

Map<String, String> map = new HashMap<String, String>();
map.put("sex", "女");
map.put("name", "李");
List<StudentEntity> studentList = studentMapper.getStudentListWhereMap(map);
for (StudentEntity entityTemp : studentList) {
    System.out.println(entityTemp.toString());
}

多参数

如果想传入多个参数,则需要在接口的参数上添加@Param注解,给出一个实例:
接口写法:

public List<StudentEntity> getStudentListWhereParam(@Param(value = "name") String name, @Param(value = "sex") String sex, @Param(value = "birthday") Date birthday, @Param(value = "classEntity") ClassEntity classEntity);

SQL写法:

<!-- 查询学生list,like姓名、=性别、=生日、=班级,多参数方式 -->
<select id="getStudentListWhereParam" resultMap="studentResultMap">
    SELECT * from STUDENT_TBL ST
    <where>
        <if test="name!=null and name!='' ">
            ST.STUDENT_NAME LIKE CONCAT(CONCAT('%', #{name}),'%')
        </if>
        <if test="sex!= null and sex!= '' ">
            AND ST.STUDENT_SEX = #{sex}
        </if>
        <if test="birthday!=null">
            AND ST.STUDENT_BIRTHDAY = #{birthday}
        </if>
        <if test="classEntity!=null and classEntity.classID !=null and classEntity.classID!='' ">
            AND ST.CLASS_ID = #{classEntity.classID}
        </if>
    </where>
</select>

进行查询:

List<StudentEntity> studentList = studentMapper.getStudentListWhereParam("", "",StringUtil.parse("1985-05-28"), classMapper.getClassByID("20000002"));
for (StudentEntity entityTemp : studentList) {
    System.out.println(entityTemp.toString());
}

Mybatis中#$的区别

  • #{} 是预编译处理, MyBatis在处理#{}时,它会将sql中的#{}替换为?,然后调用PreparedStatementset方法来赋值,传入字符串后,会在值两边加上单引号,比如值”4,44,514”就会变成 “‘4,44,514’”;
    ${} 是字符串替换, MyBatis在处理${}时,它会将sql中的${}替换为变量的值,传入的数据不会加两边加上单引号。

  • #{}: 解析为一个 JDBC 预编译语句(prepared statement)的参数标记符,一个 #{ } 被解析为一个参数占位符 。
    ${}: 仅仅为一个纯碎的 string 替换,在动态 SQL 解析阶段将会进行变量替换。

  • #{}会在变量的值外面加引号
    ${}不对变量值进行任何更改直接拼接

  • #{}是将传入的值当做字符串的形式,例如select id,name,age from student where id =#{id},当前端把id值1,传入到后台的时候,就相当于select id,name,age from student where id ='1'
    ${}是将传入的数据直接显示生成sql语句,例如select id,name,age from student where id =${id},当前端把id值1,传入到后台的时候,就相当于select id,name,age from student where id = 1

  • #{}方式可以很大程度上防止sql注入(语句的拼接)。
    ${}方式无法防止sql注入

  • 使用#{}就等于使用了PrepareStatement这种占位符的形式。可以防止sql注入等等问题,所以在大多数情况下还是经常使用#{}
    类似group by 字段 ,order by 字段,表名,字段名等没法使用占位符的就需要使用${}

比如拼凑了一个逗号分隔的id字符串,想要直接用IN在这个字符串中查询,就得用${},例如:

@Select("SELECT * FROM user WHERE id IN (${ids_str})")
List<User> queryUsersByIds(@Param("ids_str") String idsStr);

这时如果用 #{} 就会出错,比如传入拼接好的逗号分隔id字符串为 "1,12,33" , 如果写成 id IN (#{ids_str}), 就会变成 id IN ("1,12,33"), 即在变量外加了一层引号。

其实IN语句更推荐用 foreach 动态sql来拼装:

@Select("<script>"
        + "SELECT * FROM user WHERE id IN "
        + " <foreach collection='ids' item='item' open='(' separator=',' close=')'>"
        + "   #{item}"
        + " </foreach>"
        + "</script>")
List<User> queryUsersByIds(@Param("ids") Collection<Long> ids);

使用PrepareStatement的好处

数据库有个功能叫绑定变量,就是针对一条sql预编译生成多个执行计划,如果只是参数改变的重复sql,绑定变量则会提高很大的性能。PrepareStatement就会使用数据库的绑定变量的功能。

${}引起sql注入示例

加入有sql语句:

SELECT * FROM ${tableName}

如果用户给tableName参数传入值user WHERE username ='xx',则组成sql为:

SELECT * FROM user WHERE username ='xx'

即实现了sql注入


注解形式的动态SQL

group by count查询

根据cityIds集合查询people表中各个city id的人数:

public interface MyMapper {
  // 统计people表中各个city id的人数
  @Select({
          "<script>",
          "   SELECT city_id, COUNT(*) AS amount FROM people WHERE city_id IN",
          "   <foreach item='item' collection='city_ids' open='(' separator=',' close=')'>#{item}</foreach>",
          "   GROUP BY city_id",
          "</script>"
  })
  List<CountResult> countByCityId(@Param("city_ids") Collection<Long> cityIds);
}

其中结果类 CountResult 如下:

public class CountResult {
    private Long cityId;
    private Integer amount;
}

@Select 查询语句

可以给 @Select 传入可变参数,比如:

import org.apache.ibatis.annotations.Delete;
import org.apache.ibatis.annotations.Param;
import org.apache.ibatis.annotations.Select;
import org.apache.ibatis.annotations.Update;

public interface MyMapper {
  // 根据id批量查询user信息
  @Select({
          "<script>",
          "   SELECT *",
          "   FROM user",
          "   WHERE",
          "   <if test='user_ids == null or user_ids.size() == 0'> 1 = 2 </if>",
          "   <if test='user_ids != null and user_ids.size() > 0'>",
          "    id IN",
          "       <foreach item='each_id' collection='user_ids' open='(' separator=',' close=')'>",
          "           #{each_id}",
          "       </foreach>",
          "   </if>",
          "</script>"
  })
  List<User> queryUserByIds(@Param("user_ids") List<Long> userIds);
}

这个sql做了userIds为空时的处理,即使传入null也不会报错。传入null或空集合时,where条件是1=2,恒为false

或者可以直接用加号做字符串拼接:

// 根据orderNos批量查询Order
@Select("<script>" +
        "SELECT * FROM order " +
        "<if test='order_nos != null and order_nos.size() > 0' >" +
        "  WHERE order_no IN" +
        "     <foreach item='order_no' collection='order_nos' open='(' separator=',' close=')'>" +
        "         #{order_no}" +
        "     </foreach>" +
        "</if>" +
        "ORDER BY update_time DESC" +
        "</script>")
List<Order> queryOrdersByOrderNos(@Param("order_nos") List<String> orderNos);

这个sql就需要在调用时加判断了,orderNos参数不为空时再调用。

@Update 更新语句

//根据userId更新user手机号
@Update("UPDATE user SET country_code = #{country_code}, mobile = #{mobile} WHERE id = #{user_id}")
void updateUserCountryCodeAndMobile(@Param("user_id") long userId, @Param("country_code") String countryCode, @Param("mobile") String mobile);

//更新user表UpdateTime
@Update("UPDATE user SET update_time = NOW() WHERE id = #{user_id}")
void updateUserUpdateTime(@Param("user_id") long userId);

TRUNCATE清空表

// 清空user表
@Update("TRUNCATE TABLE user")
void truncateUserTable();

@Insert 插入语句

//新建user, 避免插入重复记录报错
@Insert("INSERT INTO user (mobile, country_code, name, create_time) VALUES (#{user.mobile}, #{user.countryCode}, #{user.name}, #{user.createTime}) ON DUPLICATE KEY UPDATE id = LAST_INSERT_ID(id), update_time = CURRENT_TIMESTAMP")
@SelectKey(statement = "SELECT LAST_INSERT_ID()", keyProperty = "user.id", before = false, resultType = Long.class)
int insertUserIgnoreDuplicateKey(@Param("user") User user);

@Delete 删除语句

//根据userId删除用户
@Delete("DELETE FROM user WHERE user_id = #{user_id}")
void deleteUserByUserId(@Param("user_id") long userId);

@NotEmpty 非空校验不起作用

比如写一个mapper,不希望入参集合 userIds 为空,可以加上 @NotEmpty 注解,但一定要在类上加 @Validated 注解,否则不起作用。

import java.util.List;
import org.apache.ibatis.annotations.Param;
import org.apache.ibatis.annotations.Select;
import org.hibernate.validator.constraints.NotEmpty;
import org.springframework.validation.annotation.Validated;

@Validated
public interface BaseUserMapper {
  // 根据User ID列表查询用户列表
  @Select("<script>"
          + "SELECT * FROM user WHERE user_id IN "
          + " <foreach collection = 'user_ids' item = 'user_id' open = '(' separator = ',' close = ')'>"
          + "     #{user_id}"
          + " </foreach>"
          + "</script>")
  List<User> queryUsersByUserIds(@Param("user_ids") @NotEmpty(message = "Param 'userIds' can not be empty.") List<Long> userIds);
}

原因:没有使用 @Validated 或者 @Valid 注解,原因如下:对JavaBean的属性值进行校验前会首先判断是否存在@Validated或者@Valid注解,只有存在才会执行具体的校验逻辑;

通用语句抽取为公共字符串

public interface MyCampaignMapper {
    String CAMPAIGNS_FROM_CLAUSE = "FROM campaign AS c"
            + " <if test = 'city_ids != null and city_ids.size() > 0'> LEFT JOIN campaign_city_mapping AS ccm ON c.id = ccm.campaign_id </if>"
            + " <if test = 'channel_ids != null and channel_ids.size() > 0'> LEFT JOIN campaign_channel_mapping AS ccm2 ON c.id = ccm2.campaign_id </if>";

    String CAMPAIGNS_WHERE_CLAUSE = "WHERE c.enabled = TRUE "
            + " <if test = \"key_word != null and key_word != ''\"> AND ( c.name LIKE CONCAT('%',#{key_word},'%') OR c.code LIKE CONCAT('%',#{key_word},'%') ) </if>"
            + " <if test = 'status != null'> AND c.status = #{status} </if>"
            + " <if test = 'from_time != null'> AND ( c.end_time &gt;= #{from_time} OR c.time_limit = FALSE ) </if>"
            + " <if test = 'to_time != null'> AND ( c.begin_time &lt;= #{to_time} OR c.time_limit = FALSE ) </if>"
            + " <if test = 'area_limit != null'>"
            + "    <if test = 'area_limit == false'>"
            + "        AND c.area_limit = FALSE "
            + "    </if>"
            + "    <if test = 'area_limit == true'>"
            + "        <if test = 'city_ids != null and city_ids.size() > 0'>"
            + "           AND ( ccm.city_id IN "
            + "           <foreach item='item' collection='city_ids' open='(' separator=',' close=')'>"
            + "               #{item}"
            + "           </foreach>"
            + "               OR c.area_limit = FALSE ) "
            + "        </if>"
            + "    </if>"
            + " </if>"
            + " <if test = 'channel_ids != null and channel_ids.size() > 0'>"
            + "    AND ccm2.leads_channel_id IN "
            + "    <foreach item='item' collection='channel_ids' open='(' separator=',' close=')'>"
            + "        #{item}"
            + "    </foreach>"
            + " </if>";

    @Select("<script>"
            + "SELECT DISTINCT c.* "
            + CAMPAIGNS_FROM_CLAUSE
            + CAMPAIGNS_WHERE_CLAUSE
            + "ORDER BY FIELD(c.status, 2, 1, 3), c.id DESC"
            + "<if test = 'offset != null and count != null'> LIMIT #{offset}, #{count} </if>"
            + "</script>"
    )
    List<Campaign> queryCampaigns(
            @Param("key_word") String keyWord,
            @Param("status") Byte status,
            @Param("channel_ids") List<Long> channel_ids,
            @Param("area_limit") Boolean areaLimit,
            @Param("city_ids") List<Long> city_ids,
            @Param("from_time") Date fromTime,
            @Param("to_time") Date toTime,
            @Param("offset") Long offset,
            @Param("count") Integer count
    );
}

动态SQL

if

if就是简单的条件判断,利用if语句我们可以实现某些简单的条件选择。先来看如下一个例子:

<select id="dynamicIfTest" parameterType="Blog" resultType="Blog">
    select * from t_blog where 1 = 1
    <if test="title != null">
        and title = #{title}
    </if>
    <if test="content != null">
        and content = #{content}
    </if>
    <if test="owner != null">
        and owner = #{owner}
    </if>
</select>

这条语句的意思非常简单,如果你提供了title参数,那么就要满足title=#{title},同样如果你提供了Content和Owner的时候,它们也需要满足相应的条件,之后就是返回满足这些条件的所有Blog,这是非常有用的一个功能,以往我们使用其他类型框架或者直接使用JDBC的时候, 如果我们要达到同样的选择效果的时候,我们就需要拼SQL语句,这是极其麻烦的,比起来,上述的动态SQL就要简单多了。


choose

choose元素的作用就相当于JAVA中的switch语句,基本上跟JSTL中的choose的作用和用法是一样的,通常都是与when和otherwise搭配的。看如下一个例子:

<select id="dynamicChooseTest" parameterType="Blog" resultType="Blog">
    select * from t_blog where 1 = 1
    <choose>
        <when test="title != null">
            and title = #{title}
        </when>
        <when test="content != null">
            and content = #{content}
        </when>
        <otherwise>
            and owner = "owner1"
        </otherwise>
    </choose>
</select>

when元素表示当when中的条件满足的时候就输出其中的内容,跟JAVA中的switch效果差不多的是按照条件的顺序,当when中有条件满足的时候,就会跳出choose,即所有的when和otherwise条件中,只有一个会输出,当所有的when条件都不满足的时候就输出otherwise中的内容。所以上述语句的意思非常简单, 当title!=null的时候就输出and titlte = #{title},不再往下判断条件,当title为空且content!=null的时候就输出and content = #{content},当所有条件都不满足的时候就输出otherwise中的内容。


where

where语句的作用主要是简化SQL语句中where中的条件判断的,先看一个例子,再解释一下where的好处。

<select id="dynamicWhereTest" parameterType="Blog" resultType="Blog">
    select * from t_blog
    <where>
        <if test="title != null">
            title = #{title}
        </if>
        <if test="content != null">
            and content = #{content}
        </if>
        <if test="owner != null">
            and owner = #{owner}
        </if>
    </where>
</select>

where元素的作用是会在写入where元素的地方输出一个where,另外一个好处是你不需要考虑where元素里面的条件输出是什么样子的,MyBatis会智能的帮你处理,如果所有的条件都不满足那么MyBatis就会查出所有的记录,如果输出后是and 开头的,MyBatis会把第一个and忽略,当然如果是or开头的,MyBatis也会把它忽略;此外,在where元素中你不需要考虑空格的问题,MyBatis会智能的帮你加上。像上述例子中,如果title=null, 而content != null,那么输出的整个语句会是select * from t_blog where content = #{content},而不是select * from t_blog where and content = #{content},因为MyBatis会智能的把首个and 或 or 给忽略


trim

trim元素的主要功能是可以 在自己包含的内容前加上某些前缀或后缀,与之对应的属性是prefix(加前缀)和suffix(加后缀) ;也可以 把包含内容的首部或尾部某些内容覆盖,即忽略,对应的属性是prefixOverrides(覆盖首部内容)和suffixOverrides(覆盖尾部内容) ;正因为trim有这样的功能,所以我们也可以非常简单的利用trim来代替where元素的功能,示例代码如下:

<select id="dynamicTrimTest" parameterType="Blog" resultType="Blog">
    select * from t_blog
    <trim prefix="where" prefixOverrides="and |or">
        <if test="title != null">
            title = #{title}
        </if>
        <if test="content != null">
            and content = #{content}
        </if>
        <if test="owner != null">
            or owner = #{owner}
        </if>
    </trim>
</select>

意思是在包含内容前加上”where”,并将首部的and或or忽略。

trim示例

// 根据id、角色role、状态status批量查询User
@Select("<script>" +
        "SELECT * FROM user" +
        "<trim prefix = 'WHERE' prefixOverrides = 'AND |OR'>" +
            "<if test = 'status != null'> AND status = #{status} </if>" +
            "<if test = 'role != null'> AND role = #{role} </if>" +
            "<if test = 'user_ids == null or user_ids.size() == 0'> AND 1 = 2 </if>" +
            "<if test = 'user_ids != null and user_ids.size() > 0'>" +
            "AND id IN " +
            "  <foreach item='id' collection='user_ids' open='(' separator=',' close=')'>" +
            "      #{id}" +
            "  </foreach>" +
            "</if>" +
        "</trim>" +
        "ORDER BY update_time DESC" +
        "</script>")
List<User> queryUserByIds(@Param("user_ids") List<Long> userIds, @Param("role") Byte role, @Param("status") Byte status);

set

set元素主要是用在更新操作的时候,它的主要功能和where元素其实是差不多的,主要是在包含的语句前输出一个set,然后如果包含的语句是以逗号结束的话将会把该逗号忽略,如果set包含的内容为空的话则会出错。有了set元素我们就可以动态的更新那些修改了的字段。下面是一段示例代码:

<update id="dynamicSetTest" parameterType="Blog">
    update t_blog
    <set>
        <if test="title != null">
            title = #{title},
        </if>
        <if test="content != null">
            content = #{content},
        </if>
        <if test="owner != null">
            owner = #{owner}
        </if>
    </set>
    where id = #{id}
</update>

上述示例代码中,如果set中一个条件都不满足,即set中包含的内容为空的时候就会报错。


foreach

foreach的主要用在构建in条件中,它可以在SQL语句中进行迭代一个集合。
foreach元素的属性主要有item,index,collection,open,separator,close。

  • collection 是迭代的集合
  • item 表示集合中每一个元素进行迭代时的别名,支持属性的点路径访问,如item.age,item.info.details。 具体说明:在list和数组中是其中的对象,在map中是value。 该参数为必选。
  • index 指定一个名字,用于表示在迭代过程中,每次迭代到的位置。在list和数组中,index是元素的序号,在map中,index是元素的key,该参数可选。
  • separator 元素之间的分隔符,例如在in()的时候,separator=”,”会自动在元素中间用“,“隔开,避免手动输入逗号导致sql错误,如in(1,2,)这样。该参数可选。
  • open foreach代码的开始符号,一般是(和close=”)”合用。常用在in(),values()时。该参数可选。,
  • close foreach代码的关闭符号,一般是)和open=”(“合用。常用在in(),values()时。该参数可选。

在使用foreach的时候最关键的也是最容易出错的就是collection属性,该属性是必须指定的,但是在不同情况下,该属性的值是不一样的,主要有一下3种情况:

  • 如果传入的是单参数且参数类型是一个List的时候,collection属性值为list
  • 如果传入的是单参数且参数类型是一个array数组的时候,collection的属性值为array
  • 如果传入的参数是多个的时候,我们就需要把它们封装成一个Map了,当然单参数也可以封装成map,实际上如果你在传入参数的时候,在MyBatis里面也是会把它封装成一个Map的,map的key就是参数名,所以这个时候collection属性值就是传入的List或array对象在自己封装的map里面的key

单List类型参数

<select id="dynamicForeachTest" resultType="Blog">
    select * from t_blog where id in
    <foreach collection="list" index="index" item="item" open="(" separator="," close=")">
        #{item}
    </foreach>
</select>

上述collection的值为list,对应的Mapper是这样的
public List<Blog> dynamicForeachTest(List<Integer> ids);
测试代码:

public void dynamicForeachTest() {
    SqlSession session = Util.getSqlSessionFactory().openSession();
    BlogMapper blogMapper = session.getMapper(BlogMapper.class);
    List<Integer> ids = new ArrayList<Integer>();
    ids.add(1);
    ids.add(3);
    ids.add(6);
    List<Blog> blogs = blogMapper.dynamicForeachTest(ids);
    for (Blog blog : blogs)
        System.out.println(blog);
    session.close();
}

单array类型参数

<select id="dynamicForeach2Test" resultType="Blog">
    select * from t_blog where id in
    <foreach collection="array" index="index" item="item" open="(" separator="," close=")">
        #{item}
    </foreach>
</select>

上述collection为array,对应的Mapper代码:
public List<Blog> dynamicForeach2Test(int[] ids);
对应的测试代码:

public void dynamicForeach2Test() {
    SqlSession session = Util.getSqlSessionFactory().openSession();
    BlogMapper blogMapper = session.getMapper(BlogMapper.class);
    int[] ids = new int[] {1,3,6,9};
    List<Blog> blogs = blogMapper.dynamicForeach2Test(ids);
    for (Blog blog : blogs)
        System.out.println(blog);
    session.close();
}

Map类型参数

当使用 Map 对象(或者 Map.Entry 对象的集合)时,index 是 key ,item 是 value 。

user 表有两个字段 country_code 和 mobile,如果想批量查询的话,可以使用 OR

// 根据 Map<country_code, mobile> 批量查询 User
@Select({"<script>",
        "   SELECT * ",
        "   FROM user u ",
        "   WHERE  <foreach collection='map' index='key' item='item' open='(' separator='OR' close=')'>",
        "           ( u.country_code = #{key} AND u.mobile = #{item} )",
        "       </foreach>",
        "</script>"
})
List<User> queryUserByMobiles(@Param("map") Map<String, String> countryCodeMobileMap);

java 调用代码
其实这么写不对,后面的 key 把前面的都覆盖了,如果确定key不重复,可以这么用。

Map<String, String> params = Maps.newHashMap();
// countryCodeMobileStr: 86-13916425833, 49-11100002581
ids.forEach(countryCodeMobileStr -> {
    List<String> mobileList = Splitter.on("-").trimResults().omitEmptyStrings().splitToList(countryCodeMobileStr);
    if (mobileList.size() != 2) {
        return;
    }
    params.put(mobileList.get(0), mobileList.get(1));
});
List<User> users = userMapper.queryUserByMobiles(params);
Map<String, User> userBeanMap = Maps.uniqueIndex(users, user -> Joiner.on("-").join(user.getCountryCode(), user.getMobile()));

pass list of Pair to myBatis
https://stackoverflow.com/questions/53290994/pass-list-of-pair-to-mybatis

List<Object>类型参数

// 根据 List<UserIdBean(countryCode,mobile)> 批量查询UserIdBean
@Select({"<script>",
        "   SELECT u.id, u.uuid, uai.account_id, u.mobile, u.country_code ",
        "   FROM user u LEFT JOIN user_account_info uai on u.id = uai.user_id",
        "   WHERE (uai.status = 'enable' OR uai.status IS NULL)",
        "   AND  <foreach collection='user_id_bean_list' item='item' open='(' separator='OR' close=')'>",
        "           ( u.country_code = #{item.countryCode} AND u.mobile = #{item.mobile} )",
        "       </foreach>",
        "</script>"
})
List<UserIdBean> queryUserIdBeanByMobiles(@Param("user_id_bean_list") List<UserIdBean> userIdBeanList);

java 调用代码

List params = Lists.newArrayList();
// countryCodeMobileStr: 86-13916425833, 49-11100002581
ids.forEach(countryCodeMobileStr -> {
    List<String> mobileList = Splitter.on("-").trimResults().omitEmptyStrings().splitToList(countryCodeMobileStr);
    if (mobileList.size() != 2) {
        return;
    }
    params.add(UserIdBean.builder().countryCode(mobileList.get(0)).mobile(mobileList.get(1)).build());
});
List<UserIdBean> userIdBeans = userBiz.queryUserIdBeanByMobiles(params);

自己遇到的例子

orgcabin格式为”C/Y/W”,分割后生成orgcabin的list,放入map,供mybatis中使用,
变更前舱位:增加多舱位的解析

if (StringUtils.isNotBlank(cons.getOrgCabin())) { //变更前舱位
    String orgCabinArray[] = cons.getOrgCabin().split(Symbol_Split_SLASH);//'/'分割多舱位
    List<String> orgCabinList = Arrays.asList(orgCabinArray);
    map.put("orgcabinList", orgCabinList);
}

变更前舱位list的解析:

<sql id="where">
    <where>
        <if test="@com.masikkk.common.OgnlUtil@isNotEmpty(orgcabinList)">
            and orgcabin in
            <foreach collection="orgcabinList" item="orgcabinItem" index="index" open="(" close=")" separator=",">
                #{orgcabinItem}
            </foreach>
        </if>
    </where>
</sql>

参考


上一篇 GitHub

下一篇 SoapUI使用笔记

阅读
评论
8,176
阅读预计37分钟
创建日期 2015-11-16
修改日期 2020-01-07
类别

页面信息

location:
protocol:
host:
hostname:
origin:
pathname:
href:
document:
referrer:
navigator:
platform:
userAgent:

评论