关于java:年终总结mybatis常见注解

关注“Java后端技术全栈”

回复“面试”获取全套面试材料

当下，注解十分风行，以前很长篇的代码，当初基本上一个注解就能搞定。

那，在Mybatis中又有哪些注解呢？

Mybatis中的注解基本上都在org.apache.ibatis.annotations目录下：

`@MapperScan`

该注解存在着争议，但不可否认的是这个注解的确是Mybatis的注解，是为了集成Spring而写的注解。该注解次要是扫描某个包目录下的Mapper，将Mapper接口类交给Spring进行治理。

org.mybatis.spring.annotation.MapperScan

应用形式

@SpringBootApplication@MapperScan("com.tian.mybatis.mapper")public class Application {}

其实，从名字上就能看出，是用来扫描的Mapper的。

扫描包门路能够是一个或者多个，也能够在门路中能够应用 * 作为通配符对包名进行匹配。

@SpringBootApplication@MapperScan("com.tian.*.mapper")public class Application {}@SpringBootApplication@MapperScan({"com.tian.mybatis.mapper","com.tian.mybatis.mapper1"})public class Application {}

灵便度相当高，这样在实际上我的项目中，咱们就能够指定扫描想要被扫描的包门路。

@Mapper

该注解目标就是为了不再写mapper映射文件（UserMapper.xml）。能够大大的简化编写xml的繁琐。该注解是由Mybatis框架中定义的一个形容数据层接口的注解，注解往往起到的都是一个描述性作用，用于通知Spring框架此接口的实现类由Mybatis负责创立，并将其实现类对象存储到spring容器中。

应用形式

@Mapperpublic interface UserMapper {     User selectById(Integer id); }

@Insert

插入记录的时候主键如何生成？对此基本上有三种计划，别离是：手动指定(应用层)、自增主键(数据层单表)、抉择主键(数据层多表)。

对应xml文件中的<insert>标签。

在应用层手动指定主键

手动指定的形式不把主键区别对待，插入之前在应用层生成对象的时候就会给主键一个值，插入的时候与一般字段没啥区别。

/*** 插入记录，手动调配主键 */@Insert("INSERT INTO t_user (id, username, passwd) VALUES (#{id}, #{username}, #{passwd})")int addUserAssignKey(User user);

在下面的这个例子中，mybatis并不知道到底哪个字段是主键，id尽管是主键字段，但并没有被区别对待。

「留神」

{username}这种写法，是把User作为了以后上下文，这样拜访User的属性的时候间接写属性名字就能够了。

表自增主键

自增主键对应着XML配置中的主键回填，一个简略的例子：

/*** 插入记录，数据库生成主键 */@Options(useGeneratedKeys = true, keyProperty = "id")@Insert("INSERT INTO t_user (username, passwd) VALUES (#{username}, #{passwd})")int addUserGeneratedKey(User user);

应用Option来对应着XML设置的select标签的属性，userGeneratordKeys示意要应用自增主键，keyProperty用来指定主键字段的字段名。自增主键会应用数据库底层的自增个性。

抉择主键

抉择主键从数据层生成一个值，并用这个值作为主键的值。

/** * 插入记录，抉择主键  */@Insert("INSERT INTO t_user (username, passwd) VALUES (#{username}, #{passwd})")@SelectKey(statement = "SELECT UNIX_TIMESTAMP(NOW())", keyColumn = "id", keyProperty = "id", resultType = Long.class, before = true)int addUserSelectKey(User user);

@Delete

删除的时候只有把语句条件神马的写在@Delete注解的value里就好了，返回一个int类型是被胜利删除的记录数。对应xml文件中的<delete>标签。

/** * 删除记录  */@Delete("DELETE FROM t_user WHERE id=#{id}")int delete(Long id);

@Update

批改的时候和删除一样只有把SQL语句写在@Update的value中就好了，返回一个int类型示意被批改的记录行数。

对应xml文件中的<update>标签。

/** * 批改记录  */@Update("UPDATE t_user SET username=#{username}, passwd=#{passwd} WHERE id=#{id}")int update(User user);

@Select

查问的时候稍稍有些简单，因为查问会波及到如何将查出来的字段设置到对象上，对应xml文件中的<select>标签。

通常有那么三种方法：

在SQL语句中手动指定别名来匹配

在写SQL语句的时候，手动为每一个字段指定一个别名来跟对象的属性做匹配，实用于表字段名与对象属性名差别很大没有法则并且表字段不多的状况。

/** * 依据ID查问，手动设置别名  */@Select("SELECT id, username, passwd, birth_day AS birthDay FROM t_user WHERE id=#{id}")User loadByIdHandAlias(Long id);

应用mybatis的主动下划线驼峰转换

mybatis有一个选项叫mapUnderscoreToCamelCase，当表中的字段名与对象的属性名雷同只是下划线和驼峰写法的差别时实用。

配置了mapUnderscoreToCamelCase之后mybatis在将ResultSet查出的数据设置到对象的时候会尝试先将下划线转换为驼峰而后后面拼接set去设置属性。

开启转换：

而后查问

/** *  依据ID查问，开了主动驼峰转换  */@Select("SELECT * FROM t_user WHERE id=#{id}")User loadByIdAutoAlias(Long id);

查看打印的后果，birth_day属性填充到了对象中：

应用ResultMap

对于表的字段名和对象的属性名没有太大相同点并且表中的字段挺多的状况下，应该应用ResultMap做适配。

/** * 应用ResultMap  */@Results(id = "userMap", value = {        //能够应用这种形式来解决字段名和数据库表字段名不统一的状况        @Result(id=true, column = "id", property = "id"),        @Result(column = "username", property = "username"),        @Result(column = "passwd", property = "passwd"),        @Result(column = "birth_day", property = "birthDay")})@Select("SELECT * FROM t_user WHERE id=#{id}")User loadByIdResultMap(Long id);

@Results对应着XML中的ResultMap，同时能够为其指定一个id，其它中央能够应用这个id来援用它，比方要援用下面的这个Results：

/** * 援用其余的Result  */@ResultMap("userMap")@Select("SELECT * FROM t_user WHERE id=#{id}")User loadByIdResultMapReference(Long id);

应用@ResultMap来援用一个曾经存在的ResultMap，这个ResultMap能够是在Java中应用@Results注解定义的，也能够是在XML中应用resultMap标签定义的。

增删改查注解总结

其余注解

@Results:后果映射的列表, 蕴含了一个特地后果列如何被映射到属性或字段的详情。属性:value, id。value 属性是 Result 注解的数组。对应xml中的<resultMap> 标签。

@Result:在列和属性或字段之间的独自后果映射。属性:id,column, property, javaType ,jdbcType ,type Handler, one,many。id 属性是一个布尔值,表示了应该被用于比拟(和在 XML 映射中的类似)的属性。one 属性是单独的联系, 和 <association> 相似 , 而 many 属性是对集合而言的 , 和 <collection>类似。它们这样命名是为了防止名称抵触。相似于<resultMap>的子标签 <result>`<id>`。

@One：简单类型的独自属性值映射。属性: select,已映射语句(也就是映射器方法)的齐全限定名,它能够加载适合类型的实例。留神:联结映射在注解 API 中是不反对的。这是因为 Java 注解的限度,不容许循环援用。相似于<association>标签。

@Many：与@One相似，一对多的关系，相似于<collection>

@Param :参数标签，咱们在Mapper的办法签名上标注的参数，咱们能够指定参数名称，而后在注解中或者xml中的SQL里就能够应用咱们自定义的参数名称。

@SelectKey ：获取最新插入id。

@CacheNamespace ：为给定的命名空间 (比方类) 配置缓存。对应xml中的<cache>。

@CacheNamespaceRef ：参照另外一个命名空间的缓存来应用。属性:value,应该是一个名空间的字符串值(也就是类的齐全限定名) 。对应xml中的<cacheRef>标签。

@ConstructorArgs ：收集一组后果传递给一个劫夺对象的构造方法。属性:value,是形式参数的数组。

@Arg ：单独的构造方法参数 , 是 ConstructorArgs 汇合的一部分。属性: id,column,javaType,typeHandler。id 属性是布尔值, 来标识用于比拟的属性,和XML 元素类似。对应xml中的<arg>标签。

@Case ：独自实例的值和它对应的映射。属性: value,type,results。Results 属性是结果数组,因而这个注解和理论的 ResultMap 很类似,由上面的 Results 注解指定。对应xml中标签<case>。

Mybatis罕用注解对应的指标和标签

总结

mybatis最后配置信息是基于 XML ,映射语句(SQL)也是定义在 XML 中的。而到了 MyBatis 3提供了新的基于注解的配置。mybatis提供的注解有很多，笔者进行了分类：

「增删改查：」@Insert、@Update、@Delete、@Select、@MapKey、@Options、@SelelctKey、@Param、@InsertProvider、@UpdateProvider、@DeleteProvider、@SelectProvider
「后果集映射：」@Results、@Result、@ResultMap、@ResultType、@ConstructorArgs、@Arg、@One、@Many、@TypeDiscriminator、@Case
「缓存：」@CacheNamespace、@Property、@CacheNamespaceRef、@Flush

绝大部分注解，在xml映射文件中都有元素与之对应，然而不是所有。此外在mybatis-spring中提供了@Mapper注解和@MapperScan注解，用于和spring进行整合。

参考：

http://www.yanhongzhi.com/pos...

https://www.cnblogs.com/cc110...

http://www.tianshouzhi.com/ap...

举荐浏览

《JavaScript高级程序设计》.pdf