mybatis框架常见注解（持续补充）

灰太狼 2024-03-30 16:33 103阅读 0赞

#### mybatis ####

*   *  1.@MapperScan
     *  2.@Mapper
     *  3.@Insert
     *  4.@Delete
     *  5.@Update
     *  6.@Select
     *  7.@Results
     *  8.@Param

### 1.@MapperScan ###

> 该注解扫描某个包目录下的Mapper，将Mapper接口类交给Spring进行管理。

import org.mybatis.spring.annotation.MapperScan;
    
    @SpringBootApplication
    @MapperScan("com.xxx.xxx.mapper")
    public class Application {
        
        //TODO 业务逻辑
    }

### 2.@Mapper ###

> 该注解目的就是为了不再写mapper映射文件(例如：UserMapper.xml)。可以大大的简化编写xml的繁琐。该注解是由Mybatis框架中定义的一个扫描数据层接口的注解，注解起到一个描述作用，用于告诉Spring框架此接口的实现类由Mybatis负责创建，并将其实现类对象存储到Spring容器中。

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

### 3.@Insert ###

> @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);

### 4.@Delete ###

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

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

### 5.@Update ###

> 修改的时候和删除一样只要把SQL语句写在@Update的value中就好了，返回一个int类型表示被修改的记录行数。  
> 对应xml文件中的update标签。

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

### 6.@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);

### 7.@Results ###

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

/**
     * 使用ResultMap 
     */
    @Results(id = "userMap", value = {
        
        //可以使用这种方式来处理字段名和数据库表字段名不一致的情况
        @Result(column = "id", property = "id", id=true, jdbcType=JdbcType.LONG),
        @Result(column = "username", property = "username", jdbcType=JdbcType.VARCHAR),
        @Result(column = "passwd", property = "passwd", jdbcType=JdbcType.VARCHAR),
        @Result(column = "birth_day", property = "birthDay", jdbcType=JdbcType.VARCHAR)
    })
    @Select("SELECT * FROM t_user WHERE id=#{id}")
    User loadByIdResultMap(Long id);

> @Results 各个属性的含义。  
> id：表示当前结果集声明的唯一标识；  
> value：表示结果集映射关系；  
> @Result：代表一个字段的映射关系。其中，column 指定数据库字段的名称，property 指定实体类属性的名称，jdbcType 数据库字段类型，id 为 true 表示主键，默认 false。

> @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标签定义的。

### 8.@Param ###

> 参数标签，我们在Mapper的方法签名上标注的参数，我们可以指定参数名称，然后在注解中或者xml中的SQL里就可以使用我们自定义的参数名称。  
> @Param 中的 value 属性可省略，用于指定参数的别名。

int saveUser(@Param(value="user") User user,@Param("name") String name,@Param("age") Int age);

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