TkMybatis使用学习以及Example条件设置

ゞ浴缸里的玫瑰 2024-04-06 14:19 87阅读 0赞

#### TkMybatis使用学习以及Example条件设置 ####

*  一、导入依赖
 *  二、表结构以及代码
 *   *  1、GenerationType知识
     *  2、表结构
 *  三、增删改查
 *   *  1、基本结构
     *  2、增
     *   *  2.1、insert into table (所有字段) values (?,?...,?)
         *  2.2、insert into table (部分字段) values (?,..?)
     *  3、删
     *   *  3.1、delete自定义删除
         *  3.2、deleteByPrimaryKey根据主键删除其他条件忽略
     *  4、改
     *   *  4.1、UpdateByPrimaryKeyMapper根据主键修改所有字段
         *  4.2、updateByPrimaryKeySelective根据主键修改不为null字段
     *  5、查
     *   *  5.1、select不为null的为判断条件
         *  5.2、selectOne查找一条记录多条则报错
         *  5.3、selectCount查找数量
         *  5.4、selectAll查找全部
         *  5.5、selectByPrimaryKey通过主键查找
         *  5.6、existsWithPrimaryKey通过主键判断记录是否存在
 *  四、基础方法
 *   *  1、批量插入insertList
     *  2、selectByIds批量查询
     *  3、deleteByIds批量删除
 *  五、Example条件设置器
 *   *  1、Example 条件设置举例代码
 *  六、其他
 *   *  1、@MapperScan使用注意点
     *  2、官方文档

--------------------

## 一、导入依赖 ##

<dependency>
                <groupId>tk.mybatis</groupId>
                <artifactId>mapper</artifactId>
                
                <version>4.1.5</version>
            </dependency>

![在这里插入图片描述][91b074ff169a467e84bbd5988f15dfea.png]

## 二、表结构以及代码 ##

### 1、GenerationType知识 ###

一：GenerationType.IDENTITY：主键由数据库自动生成（主要是自动增长型）。

@ApiModelProperty(value = "ID", hidden = true)
        @Id
        @GeneratedValue(strategy = GenerationType.IDENTITY)
        public Long id;

二：GenerationType.AUTO：主键由程序控制。

@ApiModelProperty(value = "ID", hidden = true)
        @Id
        @GeneratedValue(strategy = GenerationType.AUTO)
        public Long id;

### 2、表结构 ###

CREATE TABLE `op_user_info` (
      `id` int(11) NOT NULL AUTO_INCREMENT,
      `name` varchar(255) DEFAULT NULL,
      `sex` varchar(255) DEFAULT NULL,
      PRIMARY KEY (`id`)
    ) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8;
    
    INSERT INTO `test_yjdsns`.`op_user_info`(`id`, `name`, `sex`) VALUES (1, '卢本伟', '女');

## 三、增删改查 ##

### 1、基本结构 ###

![在这里插入图片描述][7498e607166149e8a8b56a324c203f67.png]

### 2、增 ###

#### 2.1、insert into table (所有字段) values (?,?..,?) ####

OpUserInfo opUserInfo = new OpUserInfo();
            opUserInfo.setName("卢本伟");
    //        opUserInfo.setSex("女");
            int insert = opUserInfoMapper.insert(opUserInfo);

![在这里插入图片描述][baeea9f95bb34461bd60f6f3281a0790.png]

#### 2.2、insert into table (部分字段) values (?,…?) ####

OpUserInfo opUserInfo = new OpUserInfo();
            opUserInfo.setName("卢本伟");
    //        opUserInfo.setSex("女");
            int insert = opUserInfoMapper.insertSelective(opUserInfo);

![在这里插入图片描述][c03887690b764bcaac16eea030b248cd.png]

### 3、删 ###

#### 3.1、delete自定义删除 ####

OpUserInfo opUserInfo = new OpUserInfo();
            opUserInfo.setName("卢本伟");
            int delete = opUserInfoMapper.delete(opUserInfo);

![在这里插入图片描述][7be2a63f2a05455086b7b77c93631b65.png]

#### 3.2、deleteByPrimaryKey根据主键删除其他条件忽略 ####

OpUserInfo opUserInfo = new OpUserInfo();
            opUserInfo.setId(2);
            opUserInfo.setName("卢本伟");
            int delete = opUserInfoMapper.deleteByPrimaryKey(opUserInfo);

![在这里插入图片描述][2ec883d91cb943d68e0c17fe13590b60.png]

### 4、改 ###

#### 4.1、UpdateByPrimaryKeyMapper根据主键修改所有字段 ####

OpUserInfo opUserInfo = new OpUserInfo();
            opUserInfo.setId(1);
            opUserInfo.setName("卢本伟");
            int update = opUserInfoMapper.updateByPrimaryKey(opUserInfo);

![在这里插入图片描述][5579b960c63f4503a0ea0b233926a40f.png]

#### 4.2、updateByPrimaryKeySelective根据主键修改不为null字段 ####

OpUserInfo opUserInfo = new OpUserInfo();
            opUserInfo.setId(1);
            opUserInfo.setName("卢本伟");
            int update = opUserInfoMapper.updateByPrimaryKeySelective(opUserInfo);

![在这里插入图片描述][516f88c38fc34855b586ff0daa53a2b2.png]

### 5、查 ###

#### 5.1、select不为null的为判断条件 ####

OpUserInfo opUserInfo = new OpUserInfo();
            opUserInfo.setName("卢本伟");
            List<OpUserInfo> opUserInfoList = opUserInfoMapper.select(opUserInfo);

![在这里插入图片描述][689f3be7d92040e48784caa6e576184a.png]

#### 5.2、selectOne查找一条记录多条则报错 ####

OpUserInfo opUserInfo = new OpUserInfo();
            opUserInfo.setName("卢本伟");
            OpUserInfo resultOpUserInfo = opUserInfoMapper.selectOne(opUserInfo);

![在这里插入图片描述][340e1b5ef2d4472e9a15d9168c7ddfb3.png]

#### 5.3、selectCount查找数量 ####

OpUserInfo opUserInfo = new OpUserInfo();
            opUserInfo.setName("卢本伟");
            int row = opUserInfoMapper.selectCount(opUserInfo);

![在这里插入图片描述][19bbda335eea4e4f9b08b260f6de76c2.png]

#### 5.4、selectAll查找全部 ####

List<OpUserInfo> opUserInfoList = opUserInfoMapper.selectAll();

![在这里插入图片描述][c21407bae2104ca38756442a23a81bda.png]

#### 5.5、selectByPrimaryKey通过主键查找 ####

OpUserInfo opUserInfo = new OpUserInfo();
            opUserInfo.setId(1);
            opUserInfo.setName("卢本伟");
            OpUserInfo resultOpUserInfo = opUserInfoMapper.selectByPrimaryKey(opUserInfo);

![在这里插入图片描述][c0605b2004554e21afd047c757e5ca40.png]

#### 5.6、existsWithPrimaryKey通过主键判断记录是否存在 ####

OpUserInfo opUserInfo = new OpUserInfo();
            opUserInfo.setId(1);
            opUserInfo.setName("卢本伟");
            Boolean existsWithPrimaryKey = opUserInfoMapper.existsWithPrimaryKey(opUserInfo);

![在这里插入图片描述][9ed42a5b781e4766b97487f8fe1640f7.png]

## 四、基础方法 ##

### 1、批量插入insertList ###

![在这里插入图片描述][ccc8a3c8ffc44079afd6bf227f14825e.png]

这两个功能有一个要求，那就是操作的数据库表必须有一个自增主键，因为它要求主键必须要有一个默认值，否则就抛出异常。

这两个接口是集成到 MySqlMapper 接口中了，所以 dao 层的 mapper 接口还要继承 MySqlMapper 接口才能使用批量插入功能。

public interface OpUserInfoMapper extends Mapper<OpUserInfo>, MySqlMapper<OpUserInfo> {
        
    }

ArrayList<OpUserInfo> objectArrayList = Lists.newArrayList();
            objectArrayList.add(new OpUserInfo(null, "李伟雄", "女"));
            objectArrayList.add(new OpUserInfo(null, "易拉罐", null));
            int i = opUserInfoMapper.insertList(objectArrayList);

![在这里插入图片描述][278a2f9bce0041ee8aecb24bc8fbb05a.png]

### 2、selectByIds批量查询 ###

SelectByIdsMapper 接口有一个方法 selectByIds，按照多个主键 id 值进行查询，但是方法的参数是 String，那么主键id之间用逗号隔开就行。

public interface OpUserInfoMapper extends Mapper<OpUserInfo>, MySqlMapper<OpUserInfo>, SelectByIdsMapper<OpUserInfo> {
        
    }

String sb = "6,7,8";
            List<OpUserInfo> opUserInfoList = opUserInfoMapper.selectByIds(sb);

![在这里插入图片描述][c591ccc78dff471d9ba7f9cf5f18effa.png]

### 3、deleteByIds批量删除 ###

DeleteByIdsMapper 接口有一个方法 deleteByIds，按照多个主键 id 值进行删除。

public interface OpUserInfoMapper extends Mapper<OpUserInfo>, MySqlMapper<OpUserInfo>, SelectByIdsMapper<OpUserInfo>, DeleteByIdsMapper<OpUserInfo> {
        
    }

String sb = "6,7,8";
            int i = opUserInfoMapper.deleteByIds(sb);

![在这里插入图片描述][9211ece4b7f74c59bf3c6d9708208ed1.png]

## 五、Example条件设置器 ##

### 1、Example 条件设置举例代码 ###

@Data
    @Table(name = "op_user_info")
    public class OpUserInfo implements Serializable {
        
    
        private static final long serialVersionUID = 6606590853013684198L;
    
        @Id
        @Column(name = "Id")
        @GeneratedValue(strategy = GenerationType.IDENTITY)
        private Integer id;
    
        private String name;
    
        private String sex;
    }

Condition condition = new Condition(OpUserInfo.class);
            Example.Criteria criteria = condition.createCriteria();
            criteria.andEqualTo("name","卢本伟");
            List<OpUserInfo> opUserInfos = opUserInfoMapper.selectByExample(condition);
            log.info(opUserInfos.toString());

![在这里插入图片描述][fcaee96361f54691ace775d2d8d4e1fd.png]

<table> 
 <thead> 
  <tr> 
   <th>方法</th> 
   <th>功能描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>andAllEqualTo(Object param)</td> 
   <td>所有字段都作为 where 后面的判断条件，判断值就是参数实体对象</td> 
  </tr> 
  <tr> 
   <td>andBetween(String property, Object value1, Object value2)</td> 
   <td>where property between value1 and value2 ，范围条件，包含两端</td> 
  </tr> 
  <tr> 
   <td>andEqualTo(Object param)</td> 
   <td>实体对象中不为 null 的字段作为 where 后面的判断条件</td> 
  </tr> 
  <tr> 
   <td>andEqualTo(String property, Object value)</td> 
   <td>某一个&lt;字段，值&gt;作为 where 后面的判等条件</td> 
  </tr> 
  <tr> 
   <td>andGreaterThan(String property, Object value)</td> 
   <td>大于条件，某个字段大于某个值</td> 
  </tr> 
  <tr> 
   <td>andGreaterThanOrEqualTo(String property, Object value)</td> 
   <td>大于等于条件，某个字段大于等于某个值</td> 
  </tr> 
  <tr> 
   <td>andIn(String property, Iterable values)</td> 
   <td>where property in ()，范围条件</td> 
  </tr> 
  <tr> 
   <td>andIsNotNull(String property)</td> 
   <td>where property is not null，判空条件</td> 
  </tr> 
  <tr> 
   <td>andIsNull(String property)</td> 
   <td>where property is null，判空条件</td> 
  </tr> 
  <tr> 
   <td>andLessThan(String property, Object value)</td> 
   <td>小于条件</td> 
  </tr> 
  <tr> 
   <td>andLessThanOrEqualTo(String property, Object value)</td> 
   <td>小于等于条件</td> 
  </tr> 
  <tr> 
   <td>andLike(String property, String value)</td> 
   <td>where property like value，注意 value 应该是一个匹配表达式</td> 
  </tr> 
  <tr> 
   <td>andNotBetween(String property, Object value1, Object value2)</td> 
   <td>范围条件，不包含两端</td> 
  </tr> 
  <tr> 
   <td>andNotEqualTo(String property, Object value)</td> 
   <td>要求字段不等于某个值</td> 
  </tr> 
  <tr> 
   <td>andNotIn(String property, Iterable values)</td> 
   <td>要求字段不在某个范围内</td> 
  </tr> 
  <tr> 
   <td>andNotLike(String property, String value)</td> 
   <td>模糊查询，要求不 like。</td> 
  </tr> 
  <tr> 
   <td>void setAndOr(String andOr)</td> 
   <td>意思相当于在括号前面加上 and 还是 or，比如执行了方法 setAndOr(“and”)，那么 criteria 相当于 and (id = 5)，而 example 就把这些 criteria 拼凑起了，比如 example 包含了 2 个 criteria，分别是 (id = 5) 和 and (name = “张三”)，那么此 example 的效果就是 (id = 5) and (name = “张三”)。</td> 
  </tr> 
 </tbody> 
</table>

## 六、其他 ##

### 1、@MapperScan使用注意点 ###

@MapperScan路径  
tk.mybatis.spring.annotation.MapperScan

### 2、官方文档 ###

[官方文档链接地址][Link 1]

[91b074ff169a467e84bbd5988f15dfea.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/2dc65df021d8424db6b9041ae457aaf1.png
[7498e607166149e8a8b56a324c203f67.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/6445e39012d741aca0039a91480ec28e.png
[baeea9f95bb34461bd60f6f3281a0790.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/bd06f6e1bdf4488b81ed33561257ff12.png
[c03887690b764bcaac16eea030b248cd.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/b6ef5dd8ef174ab8a37744ab7be530b5.png
[7be2a63f2a05455086b7b77c93631b65.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/385e421bea474547a9267ea2af996a1e.png
[2ec883d91cb943d68e0c17fe13590b60.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/605c336116c74c29957f6f3e87af4007.png
[5579b960c63f4503a0ea0b233926a40f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/b9fc437f5142466c8b07e8b4bed6dbbf.png
[516f88c38fc34855b586ff0daa53a2b2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/b4c07f34162244ac8aa6a1f755e8dfb6.png
[689f3be7d92040e48784caa6e576184a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/2a3c7ac2cc574a58bf91f609905bf30c.png
[340e1b5ef2d4472e9a15d9168c7ddfb3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/6eadc32790b645a587493bd255dfdd74.png
[19bbda335eea4e4f9b08b260f6de76c2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/5e245b0c719f4f1289ff0620ee649a76.png
[c21407bae2104ca38756442a23a81bda.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/940f03d51c0d4820939e35fb6751127f.png
[c0605b2004554e21afd047c757e5ca40.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/da7c2b971428414d80354054121ea877.png
[9ed42a5b781e4766b97487f8fe1640f7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/429146b55fd04c9bb9a36c0c45f5f9e4.png
[ccc8a3c8ffc44079afd6bf227f14825e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/ca40a0d8e009475f81b1e67be6819048.png
[278a2f9bce0041ee8aecb24bc8fbb05a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/4321ce6250e24bb49f0190fd9df8467e.png
[c591ccc78dff471d9ba7f9cf5f18effa.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/37bc4beaa95648bbbcfc9aca2949746b.png
[9211ece4b7f74c59bf3c6d9708208ed1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/f519fb0506554680a09ec1c245c8e637.png
[fcaee96361f54691ace775d2d8d4e1fd.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/536dfe1308774ba3a6f8406ce074d1e2.png
[Link 1]: https://mapperhelper.github.io/all/