Mybatis通用Mapper应用

通用Mapper

日期：2019-06-25

目录：

• 概述
• 集成(spring-boot)
  • 1. 引入依赖包
  • 2. 配置yml
  • 3. MapperScan
• 应用案例
  • 1. 实体类
  • 2. 字段类型处理器
  • 3. Mapper使用
  • 4. 扩展自己Mapper
    • 4.1 实现SelectResultProvider类
    • 4.2 自动关联Mapper实现
  • 5. Weekend动态查询使用
• 通用Mapper实现原理
  • 1. Mybatis架构图
  • 2. Mapper 原理

---

概述

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

集成(spring-boot)

1. 引入依赖包

• 引用通用Mapper

   
      tk.mybatis
      mapper-spring-boot-starter
      2.1.2
   
      
  

2. 配置yml

 mybatis:
   type-aliases-package: com.suixingpay.udip.manager.core #领域对象扫描路径
   mapper-locations: classpath:mapper/*.xml
   type-handlers-package: com.suixingpay.udip.manager.core.handler #字段为枚举类型的Handler
 mapper:
   mappers:
     - com.suixingpay.udip.common.mapper.BaseMapper #mapper的父接口
   not-empty: true  #insert和update中，是否判断字符串类型!=''，少数方法会用到
   identity: MYSQL
   enum-as-simple-type: true  # 允许bean 接受 enum 类型
    

3. MapperScan

• mapper扫描路径

  @MapperScan(basePackages = "com.suixingpay.udip.manager.core")
  

• 说明

1. mapperScan为tk.mybatis.spring.annotation.MapperScan而不是org.mybatis.spring.annotation.MapperScan。
2. 不能扫描到mapper的基础和自定义接口，比如com.suixingpay.udip.common.mapper.BaseMapper等。

应用案例

1. 实体类

• Person实体类

  
  @Data
  public class Person implements Serializable {
  
      @Id
      @GeneratedValue(strategy = GenerationType.IDENTITY)
      private Long id;
  
      private String name;
  
      private Integer age;
  
      @ColumnType(typeHandler = BaseHandler.class)
      private StatusEnum status;
  
      @ColumnType(typeHandler = BaseHandler.class)
      private AuthEnum role;
  
      private Long countryId;
  
      @Transient
      private Country country;
  
      @Transient
      private List personAddresses;
  
  }
  
  

• 说明

1. 实体字段值映射到数据库字段，采用驼峰字段映射；
2. 主键字段使用@id注解；
3. 非数据库字段使用@Transient标注；
4. 枚举类型使用@ColumnType 注解标注；并指明Hanler处理器；

2. 字段类型处理器

• 通用枚举类型BaseHandler

@MappedJdbcTypes(JdbcType.INTEGER)
@MappedTypes(value = {StatusEnum.class, AuthEnum.class})
public class BaseHandler extends BaseTypeHandler {

    private Class types;

    public BaseHandler(Class types) {
        this.types = types;
    }

    @Override
    public void setNonNullParameter(PreparedStatement ps, int i, EnumType parameter, JdbcType jdbcType) throws SQLException {
        ps.setInt(i, parameter.getValue());
    }

    @Override
    public EnumType getNullableResult(ResultSet rs, String columnName) throws SQLException {
        int id = rs.getInt(columnName);
        if (rs.wasNull()) {
            return null;
        } else {
            return getEnumType(id);
        }
    }

    @Override
    public EnumType getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
        int id = rs.getInt(columnIndex);
        if (rs.wasNull()) {
            return null;
        } else {
            return getEnumType(id);
        }
    }

   private EnumType getEnumType(int id) {
        try {
            Method valueOfType = Arrays.stream(types.getDeclaredMethods())
                    .filter(m -> m.getName().equals("valueOfType"))
                    .findFirst()
                    .orElse(null);
            return (EnumType) ReflectionUtils.invokeMethod(valueOfType, types.getEnumConstants()[0], id);
        } catch (Exception ex) {
            throw new IllegalArgumentException("Cannot convert to " + types.getName() + " by ordinal value.", ex);
        }
    }

    @Override
    public EnumType getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
        int id = cs.getInt(columnIndex);
        if (cs.wasNull()) {
            return null;
        } else {
            return getEnumType(id);
        }
    }
}

• 说明

1. class使用注解@MappedJdbcTypes
   和@MappedTypes,并继承BaseTypeHandler;
2. 枚举类要实现接口EnumType，该接口valueOfType用反射来获取实例；
3. 该类主要就是对PreparedStatement和ResultSet设值和获取值，从数据库到java有个类型映射问题；
4. 该类型是在SqlSessionFactoryBean类中，创建
   SqlSessionFactory时注册字段映射类型；

    protected SqlSessionFactory buildSqlSessionFactory() throws IOException {
     ......
        if (hasLength(this.typeHandlersPackage)) {
          String[] typeHandlersPackageArray = tokenizeToStringArray(this.typeHandlersPackage,
              ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS);
          for (String packageToScan : typeHandlersPackageArray) {
            configuration.getTypeHandlerRegistry().register(packageToScan);
            if (LOGGER.isDebugEnabled()) {
              LOGGER.debug("Scanned package: '" + packageToScan + "' for type handlers");
            }
          }
        }
    
        if (!isEmpty(this.typeHandlers)) {
          for (TypeHandler

5. 该handler会在DefaultResultSetHandlerle类中处理ResultMap时创建返回值的java对象时使用：

public class DefaultResultSetHandler implements ResultSetHandler{
.......
  private Object createResultObject(ResultSetWrapper rsw, ResultMap resultMap, List> constructorArgTypes, List