TKMybatis的使用方法是什么

本篇內容介紹了“TKMybatis的使用方法是什么”的有關知識，在實際案例的操作過程中，不少人都會遇到這樣的困境，接下來就讓小編帶領大家學習一下如何處理這些情況吧！希望大家仔細閱讀，能夠學有所成！

一、什么是 TKMybatis

TKMybatis 是基于 Mybatis 框架開發的一個工具，內部實現了對單表的基本數據操作，只需要簡單繼承 TKMybatis 提供的接口，就能夠實現無需編寫任何 sql 即能完成單表操作。

二、TKMybatis 使用

2.1 Springboot 項目中加入依賴

<!--通用mapper起步依賴-->
<dependency>
    <groupId>tk.mybatis</groupId>
    <artifactId>mapper-spring-boot-starter</artifactId>
    <version>2.0.4</version>
</dependency>

在 POJO 類中加入依賴

<!--每個工程都有Pojo，都需要用到該包對應的注解-->
<dependency>
    <groupId>javax.persistence</groupId>
    <artifactId>persistence-api</artifactId>
    <version>1.0</version>
    <scope>compile</scope>
</dependency>

在啟動類中配置 @MapperScan 掃描

@SpringBootApplication
@MapperScan(basePackages = {"com.tom.order.mapper"})
public class OrderApplication {
    public static void main(String[] args) {
        SpringApplication.run(OrderApplication.class, args);
    }
}

2.2 使用講解

2.2.1 實體類中使用

在實體類中，常用的注解和意義為：

@Table：描述數據庫表信息，主要屬性有name(表名)、schema、catalog、uniqueConstraints等。

@Id：指定表主鍵字段，無屬性值。

@Column：描述數據庫字段信息，主要屬性有name(字段名)、columnDefinition、insertable、length、nullable(是否可為空)、precision、scale、table、unique、updatable等。

@ColumnType：描述數據庫字段類型，可對一些特殊類型作配置，進行特殊處理，主要屬性有jdbcType、column、typeHandler等。

其他注解如：@Transient、@ColumnResult、@JoinColumn、@OrderBy、@Embeddable等暫不描述

2.2.2 dao中使用

單表操作，只需要繼承 tk.mybatis 下的 Mapper 接口即可使用

import tk.mybatis.mapper.common.Mapper;
 
@Repository
public interface BrandMapper extends Mapper<Brand> {
}

查看具體使用：內部都已經封裝了基本的單表操作

 2.2.3 Service 層中使用

2.3 實際案例

2.3.1 dao 層使用

 import tk.mybatis.mapper.common.Mapper;
 
/**
 * DAO 使用通用Mapper
 * DSO接口需要繼承 tk.mybatis.mapper.common.Mapper
 */
@Repository
public interface BrandMapper extends Mapper<Brand> {
 
 
}

2.3.2 service 層使用

import com.github.pagehelper.PageHelper;
import com.github.pagehelper.PageInfo;
import org.apache.commons.lang.StringUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import tk.mybatis.mapper.entity.Example;
 
import java.util.List;
 
@Service
public class BrandServiceImpl implements BrandService {
 
    @Autowired
    private BrandMapper brandMapper;
 
    public Example createExample(Brand brand) {
        // 自定義條件搜索對象 Example
        Example example = new Example(Brand.class);
        Example.Criteria criteria = example.createCriteria(); //條件構造器
 
        if (brand != null) {
            if (!StringUtils.isEmpty(brand.getName())) {
                criteria.andLike("name", '%' + brand.getName() + '%');
            }
 
            if (!StringUtils.isEmpty(brand.getLetter())) {
                criteria.andEqualTo("letter", brand.getLetter());
            }
        }
        return example;
    }
 
    @Override
    public List<Brand> findAll() {
        return brandMapper.selectAll();
    }
 
    @Override
    public List<Brand> findList(Brand brand) {
        Example example = createExample(brand);
        return brandMapper.selectByExample(example);
    }
 
    @Override
    public Brand findById(Integer id) {
        return brandMapper.selectByPrimaryKey(id);
    }
 
    /**
     * 分頁查詢
     * @param page  當前頁
     * @param size  每頁顯示的條數
     * @return
     */
    @Override
    public PageInfo<Brand> pageSearch(Integer page, Integer size) {
        // 分頁實現
        // 后面的查詢必須是緊跟集合查詢
        PageHelper.startPage(page, size);
        // 查詢集合
        List<Brand> brands = brandMapper.selectAll();
        return new PageInfo<Brand>(brands);
    }
 
    @Override
    public PageInfo<Brand> pageSearchAndCondition(Brand brand, Integer page, Integer size) {
        // 開始分頁
        PageHelper.startPage(page, size);
        // 搜索數據
        Example example = createExample(brand);
        List<Brand> list = brandMapper.selectByExample(example);
        return new PageInfo<Brand>(list);
    }
 
    /**
     * 增加品牌
     * @param brand
     */
    @Override
    public void add(Brand brand) {
        // 使用通用 Mapper.insertSelective
        // 方法中但凡帶有selective就會忽略空值
        int i = brandMapper.insertSelective(brand);
    }
 
    /**
     * 根據id修改品牌
     * @param brand
     */
    @Override
    public void update(Brand brand) {
        // 使用通用mapper.update();
        brandMapper.updateByPrimaryKeySelective(brand);
    }
 
    /**
     * 根據id刪除
     * @param id
     */
    @Override
    public void del(Integer id) {
        brandMapper.deleteByPrimaryKey(id);
    }
}

三、擴展介紹

使用

public interface BaseMapper<T> extends tk.mybatis.mapper.common.BaseMapper<T>, IdsMapper<T>, MySqlMapper<T>, OracleMapper<T> {
}

pom.xml引入
<dependency>
    <groupId>tk.mybatis</groupId>
    <artifactId>mapper-spring-boot-starter</artifactId>
    <version>2.1.5</version>
</dependency>

注：為了演示所以同時引用了MySqlMapper和OracleMapper 正常情況是只能引用一種因為他們有一個相同的方法insertList(List list)

泛型(實體類)的類型必須符合要求

實體類按照如下規則和數據庫表進行轉換,注解全部是JPA中的注解:

• 表名默認使用類名,駝峰轉下劃線(只對大寫字母進行處理),如UserInfo默認對應的表名為user_info。

• 表名可以使用@Table(name = “tableName”)進行指定,對不符合第一條默認規則的可以通過這種方式指定表名。

• 字段默認和@Column一樣,都會作為表字段,表字段默認為Java對象的Field名字駝峰轉下劃線形式。

• 可以使用@Column(name = “fieldName”)指定不符合第3條規則的字段名。

• 使用@Transient注解可以忽略字段,添加該注解的字段不會作為表字段使用。

• 建議一定是有一個@Id注解作為主鍵的字段,可以有多個@Id注解的字段作為聯合主鍵。

所有的mapper繼承此類將具有以下通用方法

查詢方法

BaseSelectMapper下的通用方法

SelectByIdsMapper下的通用方法

添加方法
BaseInsertMapper下的通用方法

MySqlMapper下的通用方法

OracleMapper下的通用方法

修改方法

BaseUpdateMapper下的通用方法

刪除方法
BaseDeleteMapper下的通用方法

IdsMapper下的通用方法

“TKMybatis的使用方法是什么”的內容就介紹到這里了，感謝大家的閱讀。如果想了解更多行業相關的知識可以關注億速云網站，小編將為大家輸出更多高質量的實用文章！