Mybatis通用Mapper介绍与使用

匿名 (未验证) 提交于 2019-12-03 00:37:01

前言

使用过jpa后再使用mybatis就会反感重复写xml文件里面的简单增删改查sql,一些复杂的特殊的业务逻辑sql当然是不可避免的,但是大量结构类似的增删改查SQL就是大大影响程序员的开发效率。而且,当数据库表结构改动时,对应的所有SQL以及实体类都需要更改。这时,通用Mapper便应运而生……

什么是通用Mapper

通用Mapper就是为了解决单表增删改查,基于Mybatis的插件。开发人员不需要编写SQL,不需要在DAO中增加方法,只要写好实体类,就能支持相应的增删改查方法。

Maven依赖

<dependency>     <groupId>tk.mybatis</groupId>     <artifactId>mapper</artifactId>     <version>3.3.7</version>     <exclusions>         <exclusion>             <artifactId>persistence-api</artifactId>             <groupId>javax.persistence</groupId>         </exclusion>     </exclusions> </dependency>

因为这个项目已经集成了jpa,javax.persistence的依赖已存在,故需要移除。如果项目没有这个jar,需要添加进来。

javax.persistence在实体类中会引用到其中的注解。


数据库建表语句

DROP TABLE IF EXISTS `fly_user`; CREATE TABLE `fly_user` (   `user_id` int(11) NOT NULL AUTO_INCREMENT COMMENT '用户ID',   `user_name` varchar(255) NOT NULL COMMENT '用户名',   `user_pwd` varchar(255) NOT NULL COMMENT '密码',   `full_name` varchar(255) DEFAULT NULL COMMENT '真实姓名',   `gender` varchar(255) DEFAULT NULL COMMENT '性别',   `age` varchar(255) DEFAULT NULL COMMENT '年龄',   `email` varchar(255) DEFAULT NULL,   `address` varchar(255) DEFAULT NULL,   `mobile` varchar(255) DEFAULT NULL,   `location` varchar(255) DEFAULT NULL,   `discuss_id` varchar(255) DEFAULT NULL,   `img` mediumblob,   PRIMARY KEY (`user_id`),   UNIQUE KEY `user_name` (`user_name`) ) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8;

spring配置

    <!-- mybatis通用 Mapper配置  类似mybatis的配置,只是org和tk的区别 -->     <bean class="tk.mybatis.spring.mapper.MapperScannerConfigurer">         <property name="basePackage" value="org.fei.repository.mapper"></property>         <property name="properties">             <value>                 mappers=tk.mybatis.mapper.common.Mapper,tk.mybatis.mapper.common.special.InsertListMapper             </value>         </property>         <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory"></property>     </bean> 

实体类

package org.fei.domain;  import javax.persistence.*; import java.io.Serializable;  @Table(name = "fly_user") public class UserPO implements Serializable {      @Id     @GeneratedValue(generator = "JDBC")     @Column(name = "user_id")     private Integer userId;      @Column(name = "user_name")     private String userName;      @Column(name = "user_pwd")     private String userPwd;      @Column(name = "full_name")     private String fullName;      @Column(name = "gender")     private String gender;      @Column(name = "age")     private String age;      @Column(name = "email")     private String email;      @Column(name = "address")     private String address;      @Column(name = "mobile")     private String mobile;      @Column(name = "location")     private String location;          @Column(name = "img")     private byte[] img;     //get set  constructor }


记住一个原则:实体类的字段数量 >= 数据库表中需要操作的字段数量。默认情况下,实体类中的所有字段都会作为表中的字段来操作,如果有额外的字段,必须加上@Transient注解。

说明:

  1. 表名默认使用类名,驼峰转下划线(只对大写字母进行处理),如UserInfo默认对应的表名为user_info
  2. 表名可以使用@Table(name = "tableName")进行指定,对不符合第一条默认规则的可以通过这种方式指定表名.
  3. 字段默认和@Column一样,都会作为表字段,表字段默认为Java对象的Field名字驼峰转下划线形式.
  4. 可以使用@Column(name = "fieldName")指定不符合第3条规则的字段名
  5. 使用@Transient注解可以忽略字段,添加该注解的字段不会作为表字段使用.
  6. 建议一定是有一个@Id注解作为主键的字段,可以有多个@Id注解的字段作为联合主键.
  7. 如果是MySQL的自增字段,加上@GeneratedValue(generator = "JDBC")即可。如果是其他数据库,可以参考官网文档

DAO接口

/**  * mybatis通用的Mapper的实现,能够满足绝大多数的需求,类似于jpa  * 必须指定泛型,来继承通用的Mapper,不需要配置对应xml文件。例如: extends Mapper<UserPO>  * @create 2018-06-26 17:13  */  public interface UserMapperDao extends Mapper<UserPO> {  }

一旦继承了Mapper,继承的Mapper就拥有了Mapper所有的通用方法:

Select方法:List<T> select(T record);说明:根据实体中的属性值进行查询,查询条件使用等号

方法:T selectByPrimaryKey(Object key);说明:根据主键字段进行查询,方法参数必须包含完整的主键属性,查询条件使用等号

方法:List<T> selectAll();说明:查询全部结果,select(null)方法能达到同样的效果

方法:T selectOne(T record);说明:根据实体中的属性进行查询,只能有一个返回值,有多个结果是抛出异常,查询条件使用等号

方法:int selectCount(T record);说明:根据实体中的属性查询总数,查询条件使用等号

Insert方法:int insert(T record);说明:保存一个实体,null的属性也会保存,不会使用数据库默认值

方法:int insertSelective(T record);说明:保存一个实体,null的属性不会保存,会使用数据库默认值

Update方法:int updateByPrimaryKey(T record);说明:根据主键更新实体全部字段,null值会被更新

方法:int updateByPrimaryKeySelective(T record);说明:根据主键更新属性不为null的值

Delete方法:int delete(T record);说明:根据实体属性作为条件进行删除,查询条件使用等号

方法:int deleteByPrimaryKey(Object key);说明:根据主键字段进行删除,方法参数必须包含完整的主键属性

Example方法方法:List<T> selectByExample(Object example);说明:根据Example条件进行查询重点:这个查询支持通过Example类指定查询列,通过selectProperties方法指定查询列

方法:int selectCountByExample(Object example);说明:根据Example条件进行查询总数

方法:int updateByExample(@Param("record") T record, @Param("example") Object example);说明:根据Example条件更新实体record包含的全部属性,null值会被更新

方法:int updateByExampleSelective(@Param("record") T record, @Param("example") Object example);说明:根据Example条件更新实体record包含的不是null的属性值

方法:int deleteByExample(Object example);说明:根据Example条件删除数据

编写测试类进行测试

遇到的问题:

Could not resolve matching constructor (hint: specify index/type/name arguments for simple parameters to avoid type ambiguities)
出错的原因是与构造器不匹配,给出的线索是为bean的构造器参数指定正确的索引、类或者名字,防止引起混淆
jar包版本不合适,将tk.mybatis.mapper 由3.3.1改成3.3.7就正常运

tk.mybatis.mapper 3.1.x之前是在GitHub上面的项目,支持mybatis 3.2.4+

总结

通用Mapper的原理是通过反射获取实体类的信息,构造出相应的SQL,因此我们只需要维护好实体类即可,对于应付复杂多变的需求提供了很大的便利。上文叙述的只是通用Mapper的简单用法,在实际项目中,还是要根据业务,在通用Mapper的基础上封装出粒度更大、更通用、更好用的方法。

附 Spring Boot 配置(还没验证

Maven

1 2 3 4 5 6 7 8 9 10 11 12 
<!--mybatis--> <dependency>     <groupId>org.mybatis.spring.boot</groupId>     <artifactId>mybatis-spring-boot-starter</artifactId>     <version>1.3.1</version> </dependency> <!--mapper--> <dependency>     <groupId>tk.mybatis</groupId>     <artifactId>mapper-spring-boot-starter</artifactId>     <version>1.1.4</version> </dependency> 

application.properties 配置

1 2 3 4 5 
#mapper #mappers 多个接口时逗号隔开 mapper.mappers=tk.mybatis.mapper.common.Mapper mapper.not-empty=false mapper.identity=MYSQL

易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!