Spring-boot + Mybatis-plus 3.0-gamma 配置记录

pom.xml


    4.0.0
    com.baomidou
    mybatisplus-spring-boot
    1.0

    
        org.springframework.boot
        spring-boot-starter-parent
        2.0.3.RELEASE
    

    
        UTF-8
        UTF-8
        1.8
        1.8
        3.0-gamma
    

    
        
            org.springframework.boot
            spring-boot-starter-web
        
        
            org.springframework.boot
            spring-boot-starter-jetty
        

        
        
            com.baomidou
            mybatis-plus-boot-starter
            ${mybatis-plus-boot-starter.version}
        
        

        
            org.projectlombok
            lombok
        
        
            org.apache.commons
            commons-dbcp2
        
        
            mysql
            mysql-connector-java
        
        
            org.apache.commons
            commons-lang3
        
        
            com.google.code.gson
            gson
        
    

    
        
            
                org.springframework.boot
                spring-boot-maven-plugin

这个工程里依赖 mysql, dbcp2, gson, lombok

工程的结构

Spring-boot + Mybatis-plus 3.0-gamma 配置记录_第1张图片

工程的结构

config.mybatis mybatis的配置
config.mybatis.scanner 扩展mybatis的mapper scanner
controller 接口控制器
db 访问数据库相关的对象
db.entity 实体
db.mapper mybatis mapper
exception 例外处理器，用来处理controller里的例外
repository 仓库
resources.mapper mybatis mapper的xml文件
resources.META-INF 向spring注册组件

application.yml 配置文件

#app
server:
    port: 8080

#spring
spring:
  devtools:
    restart:
      enabled: false

  # H2 DATABASE CONFIG
  datasource:
    type: org.apache.commons.dbcp2.BasicDataSource
    dbcp2:
      driver-class-name: com.mysql.jdbc.Driver
      username: xxxx
      password: xxxxx
      jmx-name: xxxxxx
      url: jdbc:mysql://xxxxxx:3306/xxxxxxx?zeroDateTimeBehavior=convertToNull&allowMultiQueries=true&characterEncoding=UTF-8

mybatis:
  mapperScanner:
    basePackage: com.baomidou.springboot.db.mapper*


#mybatis
mybatis-plus:
  mapper-locations: classpath:/mapper/*Mapper.xml
  #实体扫描，多个package用逗号或者分号分隔
  typeAliasesPackage: com.baomidou.springboot.db.entity
  typeEnumsPackage: com.baomidou.springboot.db.entity.enums
  global-config:
    #刷新mapper 调试神器
    db-config:
      #主键类型  0:"数据库ID自增", 1:"用户输入ID",2:"全局唯一ID (数字类型唯一ID)", 3:"全局唯一ID UUID";
      id-type: id_worker
      #字段策略 0:"忽略判断",1:"非 NULL 判断"),2:"非空判断"
      field-strategy: not_empty
      #驼峰下划线转换
      column-underline: true
      #数据库大写下划线转换
      #capital-mode: true
      #逻辑删除配置
      logic-delete-value: Y
      logic-not-delete-value: N
      db-type: mysql
    refresh: true
    sql-injector: com.baomidou.mybatisplus.extension.injector.LogicSqlInjector
      #自定义填充策略接口实现
      #meta-object-handler: com.baomidou.springboot.xxx
      #自定义SQL注入器
      #sql-injector: com.baomidou.springboot.xxx
  configuration:
    map-underscore-to-camel-case: true
    cache-enabled: false

mybatis-plus部分的配置中：

mapper-locations 存放mapper xml文件的位置
typeAliasesPackage 数据对象的目录
typeEnumsPackage 数据对象中使用的enum定义
id-type id的生成策略
field-strategy 字段处理策略
column-underline 对代码中的驼峰字段映射到数据库字段的策略
logic-delete-value 逻辑删除的标记值
logic-not-delete-value 逻辑未删除的标记值
sql-injector SQL注入器。这里为了处理逻辑删除操作，使用了LogicSqlInjector注入器
db-type 数据库类型。支持主流的数据库
map-underscore-to-camel-case 数据库字段与数据对象字段的映射策略

类的说明

MybatisPlusConfig

@Configuration
public class MybatisPlusConfig {
    ... 一些配置， 例如，配置 datasource， sqlSessionFactory, transaction manager 等等
}

MybatisPlusAutoConfiguration

@Configuration
public class MybatisPlusAutoConfiguration {

    /**
     * 将自定义的converter注册到ConversionService中
     *
     * @return
     */
    @Bean
    public ConversionService conversionService() {
        ConversionServiceFactoryBean bean = new ConversionServiceFactoryBean();
        Set converters = new HashSet<>();
        converters.add(new String2SqlInjectorConverter());
        bean.setConverters(converters);
        bean.afterPropertiesSet();
        return bean.getObject();
    }

    /**
     *  将String 转成 ISqlInjector 实例
     */
    public class String2SqlInjectorConverter implements Converter {
        @Override
        public ISqlInjector convert(String s) {
            if(StringUtils.isEmpty(s))
                return null;

            try {
                Class clazz = ClassUtils.getClass(s);
                ISqlInjector sqlInjector = (ISqlInjector)clazz.newInstance();
                return sqlInjector;
            } catch (ClassNotFoundException|IllegalAccessException|InstantiationException e) {
                ReflectionUtils.rethrowRuntimeException(e);
            }

            return null;
        }
    }
}

向spring注册自定义的 converter，否则，application.yml中mybatis-plus.sql-injector配置会出错，提示没有相应的转换器
这个文件需要在resources/META-INF/spring.factories中注册：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
  com.baomidou.springboot.config.mybatis.MybatisPlusAutoConfiguration

这个文件里的程序会先于spring组建bean之前执行

SuperEntity

@Data
public abstract class SuperEntity extends Model {

    /**
     * 主键ID , 这里故意演示注解可以无
     */
    @TableId
    private String  uuid;


    @Override
    protected Serializable pkVal() {
        return this.uuid;
    }
}

数据库对象的父类，在这个类中可以定义一些公共的字段。 mybatis-plus只把id作为主键字段，非id的字段，需要用@TableId来标注。pkVal() 是用来支持组合主键的，现在版本的mybatis-plus不支持组合主键

WxTokenObj

@Data
@TableName("tb_wx_token")
public class WxTokenObj extends SuperEntity{
    private String token;

    @JsonFormat(pattern="yyyy-MM-dd HH:mm:ss",timezone = "GMT+8")
    private Date createTime;
    @JsonFormat(pattern="yyyy-MM-dd HH:mm:ss",timezone = "GMT+8")
    private Date modifyTime;

    private String accountUuid;
    private String name;
    private String avatarPath;

    @TableLogic
    private String isDelete;
    private String unionId;
}

所有的数据对象都需要继承SuperEntity，如果表名与数据对象名称不对应，需要用@TableName标注数据表名。mybatis-plus可以配置自动解析驼峰命名的字段为下划线分割的数据库字段名。如果数据库字段名与数据字段名不一致，需要用@TableField来标注
@TableLogic标注的字段，是用来做逻辑删除的字段，在调用删除方法的时候，会将这个字段改成删除状态，而不是真正删除数据

SuperMapper

/**
 * 演示 mapper 父类，注意这个类不要让 mp 扫描到！！
 */
public interface SuperMapper extends BaseMapper {

    // 这里可以放一些公共的方法
}

所有mapper的父接口，在这个接口中可以放一些公共方法。这个接口需要放到mapper目录外，不能让mybatis scanner 扫描到。

WxTokenMapper

public interface WxTokenMapper extends SuperMapper {

    @Select("select * from tb_wx_token where uuid=#{uuid}")
    WxTokenObj selectOneBySQL(String uuid);

    WxTokenObj selectOneByWrapper(@Param("ew") Wrapper wrapper);

    List selectAllTokens();
}

一个具体的mapper接口。接口可以使用@Select等标注原生的sql，也可以使用mapper.xml 放置灵活的数据库操作。
自定义的mapper需要继承SuperMapper，也就是需要从BaseMapper中继承其定义的方法。BaseMapper中定义了很多类似JPA的自定义函数，方便开发使用：

public interface BaseMapper {

    /**
     * 
     * 插入一条记录
     * 
     *
     * @param entity 实体对象
     */
    Integer insert(T entity);

    /**
     * 
     * 根据 ID 删除
     * 
     *
     * @param id 主键ID
     */
    Integer deleteById(Serializable id);

    /**
     * 
     * 根据 columnMap 条件，删除记录
     * 
     *
     * @param columnMap 表字段 map 对象
     */
    Integer deleteByMap(@Param("cm") Map columnMap);

    /**
     * 
     * 根据 entity 条件，删除记录
     * 
     *
     * @param queryWrapper 实体对象封装操作类（可以为 null）
     */
    Integer delete(@Param("ew") Wrapper queryWrapper);

    /**
     * 
     * 删除（根据ID 批量删除）
     * 
     *
     * @param idList 主键ID列表(不能为 null 以及 empty)
     */
    Integer deleteBatchIds(@Param("coll") Collection idList);

    /**
     * 
     * 根据 ID 修改
     * 
     *
     * @param entity 实体对象
     */
    Integer updateById(@Param(Constants.META_OBJ_PREFIX) T entity);

    /**
     * 
     * 根据 whereEntity 条件，更新记录
     * 
     *
     * @param entity        实体对象 (set 条件值,不能为 null)
     * @param updateWrapper 实体对象封装操作类（可以为 null,里面的 entity 用于生成 where 语句）
     */
    Integer update(@Param(Constants.META_OBJ_PREFIX) T entity, @Param("ew") Wrapper updateWrapper);

    /**
     * 
     * 根据 ID 查询
     * 
     *
     * @param id 主键ID
     */
    T selectById(Serializable id);

    /**
     * 
     * 查询（根据ID 批量查询）
     * 
     *
     * @param idList 主键ID列表(不能为 null 以及 empty)
     */
    List selectBatchIds(@Param("coll") Collection idList);

    /**
     * 
     * 查询（根据 columnMap 条件）
     * 
     *
     * @param columnMap 表字段 map 对象
     */
    List selectByMap(@Param("cm") Map columnMap);

    /**
     * 
     * 根据 entity 条件，查询一条记录
     * 
     *
     * @param queryWrapper 实体对象
     */
    T selectOne(@Param("ew") Wrapper queryWrapper);

    /**
     * 
     * 根据 Wrapper 条件，查询总记录数
     * 
     *
     * @param queryWrapper 实体对象
     */
    Integer selectCount(@Param("ew") Wrapper queryWrapper);

    /**
     * 
     * 根据 entity 条件，查询全部记录
     * 
     *
     * @param queryWrapper 实体对象封装操作类（可以为 null）
     */
    List selectList(@Param("ew") Wrapper queryWrapper);

    /**
     * 
     * 根据 Wrapper 条件，查询全部记录
     * 
     *
     * @param queryWrapper 实体对象封装操作类（可以为 null）
     */
    List> selectMaps(@Param("ew") Wrapper queryWrapper);

    /**
     * 
     * 根据 Wrapper 条件，查询全部记录
     * 注意： 只返回第一个字段的值
     * 
     *
     * @param queryWrapper 实体对象封装操作类（可以为 null）
     */
    List