通用mapper

概念

使用Mybatis时，大的问题是，要写大量的重复SQL语句在xml文件中，除了特殊的业务逻辑SQL语句之外，还有大量结构类似的增删改查SQL。而且，当数据库表结构改动时，对应的所有SQL以及实体类都需要更改。这大量增 加了程序员的负担。避免重复书写CRUD映射的框架有两个

通用mybatis（tk mybatis）
mybatis plus，通能更加强大

依赖
通用Mapper的作者也为自己的插件编写了启动器，我们直接引入即
	 <!-- 添加了tkmybatis的启动器依赖可以注释掉原本mybatis的依赖-->
	 
	 <!--<dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>2.1.4</version>
        </dependency>-->

        <dependency>
            <groupId>tk.mybatis</groupId>
            <artifactId>mapper-spring-boot-starter</artifactId>
            <version>2.0.2</version>
        </dependency>

实体类

tk mybatis 实体类使用的注解是jpa注解

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.ToString;

import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.Table;

@Data
@NoArgsConstructor
@AllArgsConstructor
@ToString

@Table
public class Admin {

    private static final long serialVersionUID = 1L;

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private int id;

    private String account;

    private String password;
}

注意事项：

默认表名=类名，字段名=属性名
表名可以使用 @Table(name = “tableName”) 进行指定 ，如果表名和实体类名相同可以不加name属性
@Column(name = “fieldName”) 指定 ，如果字段名和属性名相同可以不加属性name
使用 @Transient 注解表示跟字段不进行映射
主键id必须要 @Id 使用指定，以及@GeneratedValue(strategy = GenerationType.IDENTITY)表示主键自增策略

不需要做任何配置就可以使用了
持久层
import com.kaikeba.entity.Admin;
import org.apache.ibatis.annotations.Select;
import org.springframework.stereotype.Repository;
import tk.mybatis.mapper.common.Mapper;

import java.util.List;

@Repository
public interface AdminMapper extends Mapper<Admin> {

    @Select("select * from admin")
    public List<Admin> findAll();

}

1、必须继承 tk mybatis提供的Mapper类，以及使用需要操作的bean类作为泛型参数

2、继承完也可以自行添加数据库操作
一旦继承了Mapper，继承的Mapper就拥有了Mapper所有的通用方法：
Select
方法： List select(T record);

说明：根据实体中的属性值进行查询，查询条件使用等号
方法： T selectByPrimaryKey(Object key);

说明：根据主键字段进行查询，方法参数必须包含完整的主键属性， 查询条件使用等号
方法： List 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 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条件删除数据
启动类

注意：必须使用tk mybatis的MapperScan

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import tk.mybatis.spring.annotation.MapperScan;

@SpringBootApplication
@MapperScan("com.kaikeba.mapper")
public class SpringbootMybatisApplication {

    public static void main(String[] args) {
        SpringApplication.run(SpringbootMybatisApplication.class, args);
    }

}

前提:
基于SpringBoot项目,正常集成Mybatis后,为了简化sql语句的编写,甚至达到无mapper.xml文件。
在本篇总结教程,不在进行SpringBoot集成Mybatis的概述。
如有需要,请查看我另一篇文章 SpringBoot集成MyBatis，这里不再赘述。
一. 实现步骤
1. 引入TkMybatis的Maven依赖
2. 实体类的相关配置,@Id,@Table
3. Mapper继承tkMabatis的Mapper接口
4. 启动类Application或自定义Mybatis配置类上使用@MapperScan注解扫描Mapper接口
5. 在application.properties配置文件中,配置mapper.xml文件指定的位置[可选]
6. 使用TkMybatis提供的sql执行方法
PS :
1. TkMybatis默认使用继承Mapper接口中传入的实体类对象去数据库寻找对应的表,因此如果表名与实体类名不满足对应规则时,会报错,这时使用@Table为实体类指定表。(这种对应规则为驼峰命名规则)
2. 使用TkMybatis可以无xml文件实现数据库操作,只需要继承tkMybatis的Mapper接口即可。
3. 如果有自定义特殊的需求,可以添加mapper.xml进行自定义sql书写,但路径必须与步骤4对应。
6. 如有需要,实现mapper.xml自定义sql语句
二. 实现细节
2.1 引入TkMybatis的Maven依赖
tk.mybatis
mapper
4.0.3
tk.mybatis
mapper-spring-boot-starter
2.0.3
2.2 实体类的配置
TkMybatis默认使用继承Mapper接口中传入的实体类对象去数据库寻找对应的表,因此如果表名与实体类名不满足对应规则时,会报错,这时使用@Table为实体类指定表。(这种对应规则为驼峰命名规则)
下面以一个实体类Custoemr为例：
package cn.invengo.middleware.base.model;
import java.util.Date;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.Table;
// @Table指定该实体类对应的表名,如表名为base_customer,类名为BaseCustomer可以不需要此注解
@Table(name = "t_base_customer")
public class Customer {
// @Id表示该字段对应数据库表的主键id
// @GeneratedValue中strategy表示使用数据库自带的主键生成策略.
// @GeneratedValue中generator配置为"JDBC",在数据插入完毕之后,会自动将主键id填充到实体类中.类似普通mapper.xml中配置的selectKey标签
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY,generator = "JDBC")
private Long id;
private String name;
private String code;
private String status;
private String linkman;
private String linkmanPhone;
private String remark;
private String attr01;
private String attr02;
private String attr03;
private Date createDate;
private Date lastUpdate;
private Long creater;
private Long lastUpdateMan;
getter(),setter()方法省略...
}
2.3 Mapper继承tkMabatis的Mapper接口
import cn.base.model.Customer;
import tk.mybatis.mapper.common.Mapper;
/**
* @ClassName:  CustomerMapper
* @Description:TODO(Customer数据库操作层)
* @author: wwj
* @date:   2018年8月31日 上午10:12:20
*/
public interface CustomerMapper extends Mapper {
}
01.png
2.4 启动类Application或自定义Mybatis配置类上使用@MapperScan注解扫描Mapper接口
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.builder.SpringApplicationBuilder;
import org.springframework.boot.context.web.SpringBootServletInitializer;
import tk.mybatis.spring.annotation.MapperScan;
@SuppressWarnings("deprecation")
@SpringBootApplication
@MapperScan("cn.base.mapper")
public class MiddlewareApplication extends SpringBootServletInitializer {
private static Logger logger = LoggerFactory.getLogger(MiddlewareApplication.class);
public static void main(String[] args) {
SpringApplication.run(MiddlewareApplication.class, args);
logger.info("Application Start Success!");
}
// 当SpringBoot项目打成war包发布时,需要继承SpringBootServletInitializer接口实现该方法
@Override
protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) {
return builder.sources(Application.class);
}
}
2.5 application.properties配置mapper.xml配置文件的扫描路径
mybatis.mapperLocations=classpath*:cn/base/mapper/*.xml
2.6 使用TkMybatis提供的sql执行方法
import java.util.List;
import java.util.Objects;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;
import cn.invengo.middleware.base.mapper.CustomerMapper;
import cn.invengo.middleware.base.model.Customer;
import cn.invengo.middleware.base.service.BaseCustomerService;
import tk.mybatis.mapper.entity.Example;
import tk.mybatis.mapper.entity.Example.Criteria;
@Service
@Transactional
public class BaseCustomerServiceImpl implements BaseCustomerService {
@Autowired
private CustomerMapper customerMapper;
@Override
public List selectByEntity(Customer customer) {
if(Objects.isNull(customer)) {
customer = new Customer();
}
Example example = new Example(Customer.class);
Criteria criteria = example.createCriteria();
criteria.andEqualTo(customer);
return customerMapper.selectByExample(example);
}
@Override
public int insertSelective(Customer customer) {
return customerMapper.insertSelective(customer);
}
@Override
public int updateSelectiveById(Customer record) {
return customerMapper.updateByPrimaryKeySelective(record);
}
}
02.png
2.7 如有需要,自定义mapper.xml配置文件,完成自定义sql编写
ps:
1. 大多数复杂的需求,都能通过TkMyBatis的组合完成操作。这里以联表查询为例,自定义mapper.xml的sql编写。
2. 该mapper.xml与以往普通方式的mapper.xml文件不同之处在于,这里不需要使用resultMap进行字段的映射。当然如果想在返回的Map中新增返回字段映射直接添加新的字段即可。
使用tkmybatis,在数据模型修改之后,修改代码也较为简便,只需要修改对应实体类中的字段即可。
eg:
ContainerMapper.xml:
id="selectCodeByDeviceId"
parameterType="java.lang.Long"
resultType="java.lang.String">
SELECT c.`code` FROM
`t_base_container`
c LEFT OUTER JOIN
t_base_device
d ON c.id =
d.container_id
WHERE d.id = #{deviceId,jdbcType=BIGINT};
ps:这里需要注意的是,不要自己在mapper.xml中在书写tkMybatis已经有的一些基础方法了,否则会报错提示方法重复。
本篇总结到此结束。

为何用TkMybatis

基于SpringBoot项目,正常集成Mybatis后,为了简化sql语句的编写,甚至达到无mapper.xml文件。
在本篇总结教程,不在进行SpringBoot集成Mybatis的概述。


 

项目搭建TkMybatis开发环境

1. 引入TkMybatis的Maven依赖
2. 实体类的相关配置,@Id,@Table
3. Mapper继承tkMabatis的Mapper接口
4. 启动类Application或自定义Mybatis配置类上使用@MapperScan注解扫描Mapper接口
5. 在application.properties配置文件中,配置mapper.xml文件指定的位置[可选]
6. 使用TkMybatis提供的sql执行方法

PS : 
    1. TkMybatis默认使用继承Mapper接口中传入的实体类对象去数据库寻找对应的表,因此如果表名与实体类名不满足对应规则时,会报错,这时使用@Table为实体类指定表。(这种对应规则为驼峰命名规则)
    2. 使用TkMybatis可以无xml文件实现数据库操作,只需要继承tkMybatis的Mapper接口即可。
    3. 如果有自定义特殊的需求,可以添加mapper.xml进行自定义sql书写,但路径必须与步骤4对应。
    
6. 如有需要,实现mapper.xml自定义sql语句


 

1、

        <!-- https://mvnrepository.com/artifact/tk.mybatis/mapper -->
        <dependency>
            <groupId>tk.mybatis</groupId>
            <artifactId>mapper</artifactId>
            <version>4.0.3</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/tk.mybatis/mapper-spring-boot-starter -->
        <dependency>
            <groupId>tk.mybatis</groupId>
            <artifactId>mapper-spring-boot-starter</artifactId>
            <version>2.0.3</version>
        </dependency>


 

2、实体类略过

 

3、Dao层接口略过

 

4、

@MapperScan(basePackages = { "com.xxx.mybatis.mapper" })

 

5、yml文件配置

mybatis:
  mapper-locations: classpath:mapper/*.xml
  type-aliases-package: com.xxx.mybatis.dao  # 注意：对应实体类的路径
  config-location: classpath:mybatis-config.xml
mapper:
  mappers: com.xxx.mybatis.MyBaseDao #通用mapper基类位置
  identity: MYSQL



 

 

好文章参考：

https://www.jianshu.com/p/50449dde7f2b

前提:
基于SpringBoot项目,正常集成Mybatis后,为了简化sql语句的编写,甚至达到无mapper.xml文件。
在本篇总结教程,不在进行SpringBoot集成Mybatis的概述。

如有需要,请查看我另一篇文章 SpringBoot集成MyBatis，这里不再赘述。
一.  实现步骤
1. 引入TkMybatis的Maven依赖
2. 实体类的相关配置,@Id,@Table
3. Mapper继承tkMabatis的Mapper接口
4. 启动类Application或自定义Mybatis配置类上使用@MapperScan注解扫描Mapper接口
5. 在application.properties配置文件中,配置mapper.xml文件指定的位置[可选]
6. 使用TkMybatis提供的sql执行方法
PS :

1. TkMybatis默认使用继承Mapper接口中传入的实体类对象去数据库寻找对应的表,因此如果表名与实体类名不满足对应规则时,会报错,这时使用@Table为实体类指定表。(这种对应规则为驼峰命名规则)

2. 使用TkMybatis可以无xml文件实现数据库操作,只需要继承tkMybatis的Mapper接口即可。

3. 如果有自定义特殊的需求,可以添加mapper.xml进行自定义sql书写,但路径必须与步骤4对应。
6. 如有需要,实现mapper.xml自定义sql语句


二.  实现细节
2.1 引入TkMybatis的Maven依赖
        <!-- https://mvnrepository.com/artifact/tk.mybatis/mapper -->
        <dependency>
            <groupId>tk.mybatis</groupId>
            <artifactId>mapper</artifactId>
            <version>4.0.3</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/tk.mybatis/mapper-spring-boot-starter -->
        <dependency>
            <groupId>tk.mybatis</groupId>
            <artifactId>mapper-spring-boot-starter</artifactId>
            <version>2.0.3</version>
        </dependency>

2.2 实体类的配置
TkMybatis默认使用继承Mapper接口中传入的实体类对象去数据库寻找对应的表,因此如果表名与实体类名不满足对应规则时,会报错,这时使用@Table为实体类指定表。(这种对应规则为驼峰命名规则)
下面以一个实体类Custoemr为例：
package cn.invengo.middleware.base.model;

import java.util.Date;

import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.Table;

// @Table指定该实体类对应的表名,如表名为base_customer,类名为BaseCustomer可以不需要此注解
@Table(name = <span class="hljs-string">"t_base_customer"</span>)
public class Customer {

    // @Id表示该字段对应数据库表的主键id
    // @GeneratedValue中strategy表示使用数据库自带的主键生成策略.
    // @GeneratedValue中generator配置为<span class="hljs-attr">"JDBC"</span>,在数据插入完毕之后,会自动将主键id填充到实体类中.类似普通mapper.xml中配置的selectKey标签
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY,generator = <span class="hljs-attr">"JDBC"</span>)
    private Long id;

    private String name;

    private String code;

    private String status;

    private String linkman;

    private String linkmanPhone;

    private String remark;

    private String attr01;

    private String attr02;

    private String attr03;

    private Date createDate;

    private Date lastUpdate;

    private Long creater;

    private Long lastUpdateMan;

    getter(),setter()方法省略...
}


2.3 Mapper继承tkMabatis的Mapper接口

import cn.base.model.Customer;
import tk.mybatis.mapper.common.Mapper;
/**   
 * @ClassName:  CustomerMapper   
 * @Description:TODO(Customer数据库操作层)   
 * @author: wwj
 * @date:  
 */  
public interface CustomerMapper extends Mapper&lt;Customer&gt; {
}







01.png

2.4 启动类Application或自定义Mybatis配置类上使用@MapperScan注解扫描Mapper接口

import org.slf4j.Logger;
import org.slf<span class="hljs-number">4</span>j.LoggerFactory;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.builder.SpringApplicationBuilder;
import org.springframework.boot.context.web.SpringBootServletInitializer;

import tk.mybatis.spring.annotation.MapperScan;

@SuppressWarnings(<span class="hljs-string">"deprecation"</span>)
@SpringBootApplication
@MapperScan(<span class="hljs-string">"cn.base.mapper"</span>)
public class MiddlewareApplication extends SpringBootServletInitializer {

    private static Logger logger = LoggerFactory.getLogger(MiddlewareApplication.class);

    public static void main(String[] args) {

        SpringApplication.run(MiddlewareApplication.class, args);
        logger.info(<span class="hljs-attr">"Application Start Success!"</span>);
    }
    
    // 当SpringBoot项目打成war包发布时,需要继承SpringBootServletInitializer接口实现该方法
    @Override
    protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) {
        return builder.sources(Application.class);
    }
}


2.5 application.properties配置mapper.xml配置文件的扫描路径
mybatis.mapperLocations=classpath*:cn/base/mapper/*.xml

2.6 使用TkMybatis提供的sql执行方法

import java.util.List;
import java.util.Objects;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;

import cn.invengo.middleware.base.mapper.CustomerMapper;
import cn.invengo.middleware.base.model.Customer;
import cn.invengo.middleware.base.service.BaseCustomerService;
import tk.mybatis.mapper.entity.Example;
import tk.mybatis.mapper.entity.Example.Criteria;

@Service
@Transactional
public class BaseCustomerServiceImpl implements BaseCustomerService {

    @Autowired
    private CustomerMapper customerMapper;

    @Override
    public List&lt;Customer&gt; selectByEntity(Customer customer) {
        if(Objects.isNull(customer)) {
            customer = new Customer();
        }
        Example example = new Example(Customer.class);
        Criteria criteria = example.createCriteria();
        criteria.andEqualTo(customer);
        return customerMapper.selectByExample(example);
    }

    @Override
    public int insertSelective(Customer customer) {
        return customerMapper.insertSelective(customer);
    }

    @Override
    public int updateSelectiveById(Customer record) {
        return customerMapper.updateByPrimaryKeySelective(record);
    }
}







02.png

2.7 如有需要,自定义mapper.xml配置文件,完成自定义sql编写
ps:
1. 大多数复杂的需求,都能通过TkMyBatis的组合完成操作。这里以联表查询为例,自定义mapper.xml的sql编写。
2. 该mapper.xml与以往普通方式的mapper.xml文件不同之处在于,这里不需要使用resultMap进行字段的映射。当然如果想在返回的Map中新增返回字段映射直接添加新的字段即可。
    使用tkmybatis,在数据模型修改之后,修改代码也较为简便,只需要修改对应实体类中的字段即可。
eg:

ContainerMapper.xml:
<?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="cn.invengo.middleware.base.mapper.ContainerMapper">
    <select
        id="selectCodeByDeviceId"
        parameterType="java.lang.Long"
        resultType="java.lang.String">
        SELECT c.`code` FROM
        `t_base_container`
        c LEFT OUTER JOIN
        t_base_device
        d ON c.id =
        d.container_id
        WHERE d.id = #{deviceId,jdbcType=BIGINT};
    </select>
</mapper>


ps:这里需要注意的是,不要自己在mapper.xml中在书写tkMybatis已经有的一些基础方法了,否则会报错提示方法重复。



本篇总结到此结束。