TKmybatis的使用，MyBatis的Mapper接口、Example方法

秒速五厘米 2022-12-24 13:59 242阅读 0赞

### 文章目录 ###

*   *  TKmybatis的使用
     *   *  TKmybatis的常用注解
         *  Mapper中的方法（dao继承可用）
         *  Example方法设置查询条件

## TKmybatis的使用 ##

1.  `pom.xml`导入依赖

<dependency>
 <groupId>tk.mybatis</groupId>
 <artifactId>mapper</artifactId>
 <version>4.1.5</version>
 </dependency>
 
 <dependency>
 <groupId>tk.mybatis</groupId>
 <artifactId>mapper-spring-boot-starter</artifactId>
 <version>2.0.3</version>
 </dependency>

【注意】如果在使用tkmybatis之前，你已经集成过mybatis，有mybatis的起步依赖`mapper-spring-boot-starter`，那么需要注释mybatis起步依赖，或者不添加tkmybatis的`mapper-spring-boot-starter`，否则会出报错\*\*[java.lang.NoSuchMethodException: tk.mybatis.mapper.provider.ExampleProvider.＜init＞][java.lang.NoSuchMethodException_ tk.mybatis.mapper.provider.ExampleProvider._init]\*\*

1.  实体类的相关配置，@Id、@Table、@Column等

### TKmybatis的常用注解 ###

<table> 
 <thead> 
 <tr> 
 <th align="left">注解</th> 
 <th align="left">作用</th> 
 </tr> 
 </thead> 
 <tbody> 
 <tr> 
 <td align="left">@Table</td> 
 <td align="left">指定该实体类对应的数据库表名 <code>@Table(name = "tb_sy_company_info")</code></td> 
 </tr> 
 <tr> 
 <td align="left">@Id</td> 
 <td align="left">表示该字段对应数据库表的主键id</td> 
 </tr> 
 <tr> 
 <td align="left">@GeneratedValue</td> 
 <td align="left">strategy表示使用数据库自带的主键生成策略，generator配置为"JDBC",在数据插入完毕之后,会自动将主键id填充到实体类中。 <code>@GeneratedValue(strategy = GenerationType.IDENTITY)：主键自增</code></td> 
 </tr> 
 <tr> 
 <td align="left">@Column</td> 
 <td align="left">属性名和列名不一致进行匹配（数据库表以下划线，类属性是驼峰式）</td> 
 </tr> 
 <tr> 
 <td align="left">@Transient注解</td> 
 <td align="left">忽略作用，不与数据库表任何字段对应</td> 
 </tr> 
 </tbody> 
</table>

@Table(name = "tb_sy_company_info") //数据库的表
    @Data   //lombok 不用写get、set、tostring、构造方法等代码
    //供货商（公司）表
    public class Company { 
        //@Id注解：主键
        //@GeneratedValue(strategy = GenerationType.IDENTITY)：主键自增
        //@Column注解：属性名和列名不一致匹配
        //@Transient注解：忽略，不与数据库表任何字段对应
        @Id
        @Column(name = "company_id")
        private String companyId;               //主键（UUID），供应商名称
        @Column(name="company_name")
        private String companyName;             //供货商名称
        @Column(name = "company_contact")
        private String companyContact;          //供货商联系人
        @Column(name = "company_phone")
        private String companyPhone;            //供货商联系电话
        @Column(name = "company_address")
        private String companyAddress;          //供货商地址
        @Column(name = "company_email")
        private String companyEmail;            //供货商邮箱
        @Column(name = "business_license")
        private String businessLicense;         //营业执照照片地址（src)
        @Column(name = "representative_id")
        private String representativeId;        //法人代表身份证证件号
        @Column(name = "representative_name")
        private String representativeName;      //法人代表姓名
        private Integer weight;	                //权重（根据权重排名显示）
        @Column(name = "company_status")
        private Integer companyStatus;         //激活状态 0：停用，1：启用
        @Column(name = "company_size")
        private Integer companySize;           //供货商公司规模
        @Column(name = "create_time")
        private Date createTime;	            //创建时间(申请通过时间)
        @Column(name = "update_time")
        private Date updateTime;	            //最后更新时间
        private String remark;	                //备注（供货商的介绍信息）
    
        @Transient
        private boolean check;          //忽略，不与数据库表对应（判断是否选中）
    }

1. dao层继承Mapper接口，`dao extends Mapper<T>`

import tk.mybatis.mapper.entity.Example;
 public interface CompanyMapper extends Mapper<Company> { 
 //update、delete、select、insert方法可以全部省略，由tkmybatis实现
 }

### Mapper中的方法（dao继承可用） ###

Example example = new Example(JavaBean.class);

<table> 
 <thead> 
 <tr> 
 <th align="left">方法</th> 
 <th align="left">功能说明</th> 
 </tr> 
 </thead> 
 <tbody> 
 <tr> 
 <td align="left">String/Integer insert(Javabean bean) thorws SQLException</td> 
 <td align="left">整条插入数据（返回值为ID）</td> 
 </tr> 
 <tr> 
 <td align="left">int insertSelective(Javabean bean);</td> 
 <td align="left">有选择性的插入数据</td> 
 </tr> 
 <tr> 
 <td align="left">int deleteByPrimaryKey(Integer id) thorws SQLException</td> 
 <td align="left">按表的主键删除数据</td> 
 </tr> 
 <tr> 
 <td align="left">int deleteByExample(UserExample example) thorws SQLException</td> 
 <td align="left">按指定条件删除</td> 
 </tr> 
 <tr> 
 <td align="left">long countByExample(UserExample example) thorws SQLException</td> 
 <td align="left">按条件查询满足条件的个数</td> 
 </tr> 
 <tr> 
 <td align="left">Object selectByPrimaryKey(Integer id) thorws SQLException</td> 
 <td align="left">按主键查询，返回一个javabean对象</td> 
 </tr> 
 <tr> 
 <td align="left">List selectByExample(UserExample example) thorws SQLException</td> 
 <td align="left">按指定条件查询</td> 
 </tr> 
 <tr> 
 <td align="left">List selectByExampleWithBLOGs(UserExample example) thorws SQLException</td> 
 <td align="left">按指定条件查询（包括BLOB字段）。只有当数据表中的字段类型有为二进制的才会产生。</td> 
 </tr> 
 <tr> 
 <td align="left">int updateByPrimaryKey(Javabean bean) thorws SQLException</td> 
 <td align="left">按主键更新</td> 
 </tr> 
 <tr> 
 <td align="left">int updateByPrimaryKeySelective(Javabean bean) thorws SQLException</td> 
 <td align="left">按主键更新<code>值不为null的字段</code></td> 
 </tr> 
 <tr> 
 <td align="left">int updateByExample(Javabean bean, UserExample example) thorws SQLException</td> 
 <td align="left">按条件更新example</td> 
 </tr> 
 <tr> 
 <td align="left">int updateByExampleSelective(Javabean bean, UserExample example) thorws SQLException</td> 
 <td align="left">按条件更新值不为null的字段</td> 
 </tr> 
 </tbody> 
</table>

1.  在启动类Application上使用`@MapperScan()`扫描Mapper接口

@SpringBootApplication
    @MapperScan(basePackages = "com.xgf.online_mall.system.mapper")     //扫描mapper包
    public class OnlineMallApplication { 
    
        public static void main(String[] args) { 
            SpringApplication.run(OnlineMallApplication.class, args);
        }
    
    }

1.  `application.properties`配置文件配置数据库属性

# 数据库配置
    spring:
      datasource: # hikari
        type: com.zaxxer.hikari.HikariDataSource  # 数据库类型，默认就是hikari（如果不改的话可以不写）
        driver-class-name: com.mysql.cj.jdbc.Driver # mysql 8 需要添加时区
        username: root
        password: 861221293
        url: jdbc:mysql://localhost:3306/onlinemall?useUnicode=true&characterEncoding=utf8&serverTimezone=GMT%2B8  # serverTimezone=GMT%2B8表示东8区，不然报错time zone
    
    # mybatis配置
    mybatis:
      type-aliases-package: com.xgf.online_mall.system.domain # 别名
      mapper-locations: classpath*:com/xgf/online_mall/mapper/*.xml # use xml 使用xml配置的时候需要
      configuration:
        log-impl: org.apache.ibatis.logging.stdout.StdOutImpl # 开启mybatis日志

1.  Service调用

@Service
 public class CompanyServiceImpl implements ICompanyService { 
 
 @Autowired
 CompanyMapper companyMapper;
 
 @Override
 public List<Company> findAll() { 
 Example example = new Example(Company.class); //查询条件
 Example.Criteria criteria = example.createCriteria();
 //criteria.andEqualTo(company); //根据值来拼接出where 条件
 //where by username=?
 //where by name=?
 List<Company> companyList = companyMapper.selectByExample(example);
 return companyList;
 }
 
 @Override
 public void saveCompany(Company company) { 
 try { 
 companyMapper.insert(company); //添加
 }catch (Exception e){ 
 e.printStackTrace();
 }
 
 }
 }

### Example方法设置查询条件 ###

`example` 用于添加条件，相当与sql语句中的where后面的条件部分。

Example.Criteria criteria = example.createCriteria();

【注意】

1.  没写`example.createCriteria();`，然后执行`selectByExample(example)`会查询全部数据。
2.  `example`没加条件，执行查询语句`selectByExample(example);`也是查询全部。

<table> 
 <thead> 
 <tr> 
 <th align="left">example方法，criteria方法</th> 
 <th align="left">说明</th> 
 </tr> 
 </thead> 
 <tbody> 
 <tr> 
 <td align="left">example.setOrderByClause(“字段名 ASC”);</td> 
 <td align="left">添加升序（ASC）排列条件，DESC为降序。<code>example.setOrderByClause("</code>AFTER_CHECK_TIME<code>DESC");</code></td> 
 </tr> 
 <tr> 
 <td align="left">example.setDistinct(boolean b)</td> 
 <td align="left">去除重复，boolean类型，true：去重（无重复）</td> 
 </tr> 
 <tr> 
 <td align="left">criteria.andXxxIsNull</td> 
 <td align="left">添加字段xxx为null的条件</td> 
 </tr> 
 <tr> 
 <td align="left">criteria.andXxxIsNotNull</td> 
 <td align="left">添加字段xxx不为null的条件</td> 
 </tr> 
 <tr> 
 <td align="left">criteria.andXxxEqualTo(value)</td> 
 <td align="left">添加字段xxx等于value条件</td> 
 </tr> 
 <tr> 
 <td align="left">criteria.andXxxNotEqualTo(value)</td> 
 <td align="left">添加字段xxx不等于value条件</td> 
 </tr> 
 <tr> 
 <td align="left">criteria.andXxxGreaterThan(value)</td> 
 <td align="left">添加字段xxx大于value条件</td> 
 </tr> 
 <tr> 
 <td align="left">criteria.andXxxGreaterThanOrEqualTo(value)</td> 
 <td align="left">添加字段xxx大于等于value条件</td> 
 </tr> 
 <tr> 
 <td align="left">criteria.andXxxLessThan(value)</td> 
 <td align="left">添加字段xxx小于value条件</td> 
 </tr> 
 <tr> 
 <td align="left">criteria.andXxxLessThanOrEqualTo(value)</td> 
 <td align="left">添加字段xxx小于等于value条件</td> 
 </tr> 
 <tr> 
 <td align="left">criteria.andXxxIn(List&lt;？&gt;)</td> 
 <td align="left">添加字段xxx值在List&lt;？&gt;列表条件</td> 
 </tr> 
 <tr> 
 <td align="left">criteria.andXxxNotIn(List&lt;？&gt;)</td> 
 <td align="left">添加字段xxx值不在List&lt;？&gt;条件</td> 
 </tr> 
 <tr> 
 <td align="left">criteria.andXxxLike(“%”+value+”%”)</td> 
 <td align="left">添加字段xxx值为value的模糊查询条件</td> 
 </tr> 
 <tr> 
 <td align="left">criteria.andXxxNotLike(“%”+value+”%”)</td> 
 <td align="left">添加字段xxx值不为value的模糊查询条件</td> 
 </tr> 
 <tr> 
 <td align="left">criteria.andXxxBetween(value1,value2)</td> 
 <td align="left">添加字段xxx值在value1和value2之间条件</td> 
 </tr> 
 <tr> 
 <td align="left">criteria.andXxxNotBetween(value1,value2)</td> 
 <td align="left">添加字段xxx值不在value1和value2之间条件</td> 
 </tr> 
 </tbody> 
</table>

7. 创建测试类测试增加查询

@SpringBootTest
 public class TestCompanyServiceImpl { 
 
 @Autowired
 CompanyServiceImpl companyService;
 
 //测试添加
 @Test
 public void test01(){ 
 Company company = new Company();
 company.setCompanyId(UUID.randomUUID().toString());
 company.setCompanyName("供货商名称");
 company.setCompanyEmail("email邮箱");
 company.setCompanyContact("供货商联系人");
 company.setCompanyAddress("供货商地址");
 company.setBusinessLicense("c://"+company.getCompanyName()+"/"+"license.jpg");
 company.setRepresentativeId("123456789987654321");
 company.setWeight(2);
 
 companyService.saveCompany(company); //保存数据
 }
 
 
 //测试查询所有数据
 @Test
 public void test02(){ 
 List<Company> companyServiceAll = companyService.findAll();
 System.out.println(companyServiceAll);
 }
 }

1.  测试结果  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwNTQyNTM0_size_16_color_FFFFFF_t_70]  
    ![在这里插入图片描述][20201129004018751.png]  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwNTQyNTM0_size_16_color_FFFFFF_t_70 1]

[java.lang.NoSuchMethodException_ tk.mybatis.mapper.provider.ExampleProvider._init]: https://striveday.blog.csdn.net/article/details/110485356
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwNTQyNTM0_size_16_color_FFFFFF_t_70]: /images/20221120/7a92466d000441dcb8b71ae70b8c166d.png
[20201129004018751.png]: https://img-blog.csdnimg.cn/20201129004018751.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwNTQyNTM0_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20201129004111631.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwNTQyNTM0,size_16,color_FFFFFF,t_70