Package io.mybatis.mapper.example

Interface ExampleMapper<T,​E>

  • Type Parameters:
    T - 实体类
    E - 符合Example数据结构的对象，例如 Example，也可以是 MBG 生成 XXXExample 对象。
    All Known Subinterfaces:
    BaseMapper<T,​I>, LogicalMapper<T,​I>, Mapper<T,​I>
    public interface ExampleMapper<T,​E>
    Example 相关方法
    Author:
    liuzh

    • Method Detail

      • example

        default Example<T> example()
        获取 Example 对象
        Returns:
        Example 对象

      • deleteByExample

        @Lang(io.mybatis.provider.Caching.class)
@DeleteProvider(type=ExampleProvider.class,
                method="deleteByExample")
int deleteByExample​(E example)
        根据 Example 删除
        Parameters:
        example - 条件
        Returns:
        大于等于1成功，0失败

      • updateByExample

        @Lang(io.mybatis.provider.Caching.class)
@UpdateProvider(type=ExampleProvider.class,
                method="updateByExample")
int updateByExample​(@Param("entity")
                    T entity,
                    @Param("example")
                    E example)
        根据 Example 条件批量更新实体信息
        Parameters:
        entity - 实体类
        example - 条件
        Returns:
        大于等于1成功，0失败

      • updateByExampleSetValues

        @Lang(io.mybatis.provider.Caching.class)
@UpdateProvider(type=ExampleProvider.class,
                method="updateByExampleSetValues")
int updateByExampleSetValues​(@Param("example")
                             E example)
        根据 Example 条件和 setValue 值更新字段
        Parameters:
        example - 条件
        Returns:
        大于等于1成功，0失败

      • updateByExampleSelective

        @Lang(io.mybatis.provider.Caching.class)
@UpdateProvider(type=ExampleProvider.class,
                method="updateByExampleSelective")
int updateByExampleSelective​(@Param("entity")
                             T entity,
                             @Param("example")
                             E example)
        根据 Example 条件批量更新实体不为空的字段
        Parameters:
        entity - 实体类
        example - 条件
        Returns:
        大于等于1成功，0失败

      • selectByExample

        @Lang(io.mybatis.provider.Caching.class)
@SelectProvider(type=ExampleProvider.class,
                method="selectByExample")
List<T> selectByExample​(E example)
        根据 Example 条件批量查询
        Parameters:
        example - 条件
        Returns:
        实体列表

      • selectOneByExample

        @Lang(io.mybatis.provider.Caching.class)
@SelectProvider(type=ExampleProvider.class,
                method="selectByExample")
Optional<T> selectOneByExample​(E example)
        根据 Example 条件查询单个实体
        Parameters:
        example - 条件
        Returns:
        单个实体，查询结果由多条时报错

      • countByExample

        @Lang(io.mybatis.provider.Caching.class)
@SelectProvider(type=ExampleProvider.class,
                method="countByExample")
long countByExample​(E example)
        根据 Example 条件查询总数
        Parameters:
        example - 条件
        Returns:
        总数

      • selectByExample

        List<T> selectByExample​(E example,
                        org.apache.ibatis.session.RowBounds rowBounds)
        根据 Example 条件批量查询
        Parameters:
        example - 条件
        rowBounds - 分页信息
        Returns:
        实体列表