Example
增加复杂的 and
和 or
功能。Example
增加排除查询字段的方法 excludeProperties
(selectProperties
优先级更高) #261.SqlHelper
中复杂的 if
改为 choose
方式。@Column
配置关键字的分隔符时,无法得到该列值的bug。Example
增加 for update 支持,仅能用于 selectByExample 和 selectCountByExample 方法 #210Example.Criteria
增加 andAllEqualTo
方法,将此对象的所有字段参数作为相等查询条件,如果字段为 null,则为 is null #206checkExampleEntityClass
,默认 false
用于校验通用 Example 构造参数 entityClass 是否和当前调用的 MapperuseSimpleType
,默认 false
,启用后判断实体类属性是否为表字段时校验字段是否为简单类型,如果不是就忽略该属性,这个配置优先级高于所有注解simpleTypes
,默认的简单类型在 SimpleTypeUtil
中,使用该参数可以增加额外的简单类型,通过逗号隔开的全限定类名添加RuntimeException
异常改为 tk.mybatis.mapper.MapperException
异常@Options(useCache = false, useGeneratedKeys = false)
,fix #216SelectKeyGenerator
,防止有默认值时被替换掉 fix #213xml
<generatedKey column="id"
sqlStatement="select SEQ_{1}.nextval from dual"
identity="false"
type="pre"/>
这个配置生成的代码会像下面这样:
java
public class Author {
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY,
generator = "select SEQ_AUTHOR.nextval from dual")
private Integer id;
// 省略其他
}
selectByIds
和deleteByIds
,用法见通用Mapper接口大全Example
中的propertyMap
#159Example
中的andIn
和andNotIn
中的参数Collection
改为Iterable
beginningDelimiter
和endingDelimiter
schema.tablename
Example
的andIn
和andNotIn
方法参数改为Collection
#109lazy
方法导致无法兼容3.2.4~3.2.5版本的问题,仍然兼容3.2.4+Example
增加orderBy
方法,使用属性进行排序,例如:example.orderBy("id").desc().orderBy("countryname").orderBy("countrycode").asc();
resultMap
中不使用javaType
,这种情况如果出错,可以通过@ColumnType
注解设置jdbcType
#103transient
类型的字段#106Example
增加对动态表名支持,通过setTableName
设置表名update
方法中,参数为实体类和Example
,这个方法只能通过Example
来设置动态表名,不支持通过实体设置动态表名select count
查询,当表只有一个主键的时候,使用select count(pk)
,其他时候使用select count(*)
Example
构造方法增加notNull
参数,默认false
,允许值为null
,值为null
的时候不加入到条件中。seqFormat
格式化参数增加第四个可配置值TableName
tk.mybatis.spring.mapper.MapperScannerConfigurer
中的属性mapperHelper
增加setter和getter方法,方便通过代码进行配置enableMethodAnnotation
参数,可以控制是否支持方法上的JPA注解,默认false
。
设置enableMethodAnnotation = true
的时候注意,如getRealName
或setYourName
都会产生realName
属性或yourName
属性,如果该方法对应的属性不是表中的字段,就需要给方法增加@Transient
注解。
同样如果你的实体是继承Map
类型的,你不需要在实体中写private String userName
这样的属性,你只需要写setUserName
或getUserName
这样的方法就可以。Field
获取,然后是setter
方法,最后是getter
方法,注解重复的情况下,只获取按顺序得到的第一个public class Country extends Entity<Integer, String>
这样的泛型类型,在生成#{propertyName}
的时候都带上了javaType
属性。
产生的结果就是#{propertyName, javaType=java.lang.Integer}
这样子的,这会导致当你调用方法时,必须保证类型一致。
也就是假设主键是Integer id
,调用selectByPrimaryKey(Object id)
的时候,参数id
必须使用100
这样的数字,不能使用"100"
字符串(以前版本可以)。
如果不带javaType
,那么如果id
是个泛型,MyBatis查找的时候就会因为找不到正确的类型而抛出异常。tk.mybatis.mapper.provider
包下所有的通用接口的实现方法改为了String
形式。
自己扩展单表操作的方法是非常容易的事情,建议有一定通用Mapper使用基础的自行扩展,扩展可以参考如何扩展通用接口SqlHelper
工具类,其中包含了大量可用的现成的SQL方法@Column
注解增加对insertable
和updatable
属性的支持IDynamicTableName
接口,用法见详细说明Example
增加自定义查询条件,提供了4个方法,具体方法和用法见详细说明@ColumnType
注解,可以单独设置列的jdbcType
和typeHandler
Example
的in
和not in
中的List<Object>
参数改为List<?>
,允许任意类型resultType
,改为resultMap
,因此可以支持typeHandler
的读取Style
自动转方式新增camelhumpAndUppercase
驼峰转下划线大写形式,camelhumpAndLowercase
驼峰转下划线小写形式getSelectReturnType
方法改为getEntityClass
,getBEFORE
改为isBEFORE
@GeneratedValue(strategy = GenerationType.IDENTITY)
的一种重要用法说明@OrderBy
注解的bughelloWorld
会转换为hello_world
(原先是hello_World
)markerInterface
属性配置通用接口(注意该属性的原有作用不变),想要让该接口自动注册,该接口就需要继承tk.mybatis.mapper.common.Marker
接口,Mapper<T>
默认继承该接口,所以如果自己的接口是继承Mapper<T>
的,不需要再继承。MapperInterceptor
拦截器,以后不能在通过拦截器配置tk.mybatis.spring.mapper.MapperScannerConfigurer
tk.mybatis.spring.mapper.MapperFactoryBean
MapperScannerConfigurer
中使用properties
属性注入配置org.mybatis.xxx
改为了tk.mybatis.xxx
,名字相近,更方便修改配置<bean class="tk.mybatis.spring.mapper.MapperScannerConfigurer">
<property name="basePackage" value="com.isea533.mybatis.mapper"/>
<property name="properties">
<value>
mappers=tk.mybatis.mapper.common.Mapper
</value>
</property>
</bean>
style
属性配置,用来配置对象名/字段和表名/字段之间的转换方式,可选值:
normal
:使用实体类名/属性名作为表名/字段名camelhump
:这是默认值,驼峰转换为下划线形式uppercase
:转换为大写lowercase
:转换为小写@NameStyle
,该注解优先于全局配置style
example.selectProperties
映射错误的bug#48MapperOnceInterceptor
拦截器,下个版本会完善MapperHelper
的配置方式Example
增加了example.selectProperties("id", "countryname", ...)
方法,可以指定查询列,注意这里参数写的是属性名,Example
会自动映射到列名Example
增加andEqualTo(实体对象)
方法,可以将一个实体放进去,会自动根据属性和值拼出column=value的条件 Bob - 0haizhu0@gmail.com 提供<cache/>
和@CacheNamespace
的时候不统一,只有一个能生效,这导致xml中配置二级缓存对通用Mapper注解形式的方法无效,该问题已解决@Select
等注解定义的这种仍然无效,这种情况只能在xml中定义@Column(name="
desc")
的时候,就不需要自动添加别名ConditionMapper
中selectByCondition
和updateByCondition
方法错误com.github.abel533
改为tk.mybatis.mapper
tk.mybatis
,artifactId为mapper
EntityMapper
和SqlMapper
移出,现在是独立项目EntityMapperMapper<T>
全部接口方法拆分为独立接口,方便选择集成MySqlMapper<T>
包含批量插入和单个插入,批量插入可以回写全部idRowBoundsMapper<T>
包含两个分页查询,可以配合PageHelper实现物理分页and
缺少空格的问题String
,可以是任意简单类型,需要自己保证类型匹配。例如UUID配置的策略可以返回Integer
,那么字段类型必须是Integer
。keyProperties="id1,id2..."
EntityHelper
的getOrderByClause
方法返回值从StringBuilder
改为String
,解决@OrderBy
注解时的异常selectOne
方法,该查询返回值最多只能有一个,存在多个时抛出异常@Orderby
注解。其中Example
查询中的orderby
会覆盖注解的@Orderby
设置。@Table
注解和数据库保持一致。SqlMapper
,可以使用MyBatis直接执行sql,详细文档通用Mapper接口增加Example查询方法,包括以下方法:
int selectCountByExample(Object example);
int deleteByExample(Object example);
List<T> selectByExample(Object example);
int updateByExampleSelective(@Param("record") T record, @Param("example") Object example);
int updateByExample(@Param("record") T record, @Param("example") Object example);
通用Example
增加了一个exists
的参数,当true
的时候如果使用的字段不存在会抛出异常,false
时不抛出异常,但是不使用该字段的条件。
CommonMapper
和包装类EntityMapper
,建议使用EntityMapper
EntityMapper
的内容请看独立文档,这个类足以独立成一个开源项目OrderBy
的支持,仅对select
一个方法有效简单说明,为什么版本这么快就到了2.0?
因为EntityMapper
,这是另一种形式的通用Mapper。
这里说说EntityMapper
和通用Mapper的区别。
通用Mapper需要有继承的接口,需要指定泛型类型,可以缓存,和手写的效果一样。
EntityMapper
无需继承,可以直接使用,而且这一个对象就可以操作全部的实体对象(和通用Mapper注解要求一样,不支持主键策略)和表,是一个更接近Hibernate用法的类,这个类非常强大,支持Mybatis生成的Example查询,还支持一个通用Example查询。
EntityMapper
功能更全面,但是不支持主键策略,由于该类足以独立成一个开源项目,简单几句不能说明用法,因此详细内容请看独立的文档。
@GeneratedValue(generator = "JDBC")
,详细请看下面关于主键策略的详细内容notEmpty
参数,该参数会影响所有使用getAllIfColumnNode
方法的地方,具体到Mapper<T>
,影响3个方法:select,selectCount,delete。如果设置为true
,那么<if ...
的条件中会包含String
类型property!=''
的条件。移除了MapperInterceptor
类,不在提供拦截器方式的使用。如果有需要可以自己从0.3.1版本获取。
支持Spring4泛型注入,详细请看文档在Spring4中使用通用Mapper
这个版本的主要目的是消除拦截器,因此针对常用的情况增加了两种更方便的使用方式。
该版本做了大量的重构,在原有基础上增加了两个类,分别为MapperTemplate
和MapperProvider
,其他几个类都有相当大的改动。
但是,这次重构并不影响原有的业务代码。
这次重构的目的是为了方便开发者自行扩展,增加自己需要的通用Mapper。这次重构后,扩展变的更容易。稍后会写一篇如何进行扩展的文档。
这次更新还修复Oracle序列的BUG。