基本 CRUD

BaseMapper

1、大多方法中都有 Wrapper 类型的形参,此为条件构造器,可针对于 SQL 语句设置不同的条件,若没有条件,则可以为该形参赋值 null,即查询(删除 / 修改)所有数据

public interface BaseMapper<T> extends Mapper<T> {

    /**
     * 插入一条记录
     *
     * @param entity 实体对象
     */
    int insert(T entity);

    /**
     * 根据 ID 删除
     *
     * @param id 主键ID
     */
    int deleteById(Serializable id);

    /**
     * 根据实体(ID)删除
     *
     * @param entity 实体对象
     * @since 3.4.4
     */
    int deleteById(T entity);

    /**
     * 根据 columnMap 条件,删除记录
     *
     * @param columnMap 表字段 map 对象
     */
    int deleteByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);

    /**
     * 根据 entity 条件,删除记录
     *
     * @param queryWrapper 实体对象封装操作类(可以为 null,里面的 entity 用于生成 where 语句)
     */
    int delete(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

    /**
     * 删除(根据ID或实体 批量删除)
     *
     * @param idList 主键ID列表或实体列表(不能为 null 以及 empty)
     */
    int deleteBatchIds(@Param(Constants.COLL) Collection<?> idList);

    /**
     * 根据 ID 修改
     *
     * @param entity 实体对象
     */
    int updateById(@Param(Constants.ENTITY) T entity);

    /**
     * 根据 whereEntity 条件,更新记录
     *
     * @param entity        实体对象 (set 条件值,可以为 null)
     * @param updateWrapper 实体对象封装操作类(可以为 null,里面的 entity 用于生成 where 语句)
     */
    int update(@Param(Constants.ENTITY) T entity, @Param(Constants.WRAPPER) Wrapper<T> updateWrapper);

    /**
     * 根据 ID 查询
     *
     * @param id 主键ID
     */
    T selectById(Serializable id);

    /**
     * 查询(根据ID 批量查询)
     *
     * @param idList 主键ID列表(不能为 null 以及 empty)
     */
    List<T> selectBatchIds(@Param(Constants.COLL) Collection<? extends Serializable> idList);

    /**
     * 查询(根据 columnMap 条件)
     *
     * @param columnMap 表字段 map 对象
     */
    List<T> selectByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);

    /**
     * 根据 entity 条件,查询一条记录
     * <p>查询一条记录,例如 qw.last("limit 1") 限制取一条记录, 注意:多条数据会报异常</p>
     *
     * @param queryWrapper 实体对象封装操作类(可以为 null)
     */
    default T selectOne(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper) {
        List<T> ts = this.selectList(queryWrapper);
        if (CollectionUtils.isNotEmpty(ts)) {
            if (ts.size() != 1) {
                throw ExceptionUtils.mpe("One record is expected, but the query result is multiple records");
            }
            return ts.get(0);
        }
        return null;
    }

    /**
     * 根据 Wrapper 条件,判断是否存在记录
     *
     * @param queryWrapper 实体对象封装操作类
     * @return 是否存在记录
     */
    default boolean exists(Wrapper<T> queryWrapper) {
        Long count = this.selectCount(queryWrapper);
        return null != count && count > 0;
    }

    /**
     * 根据 Wrapper 条件,查询总记录数
     *
     * @param queryWrapper 实体对象封装操作类(可以为 null)
     */
    Long selectCount(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

    /**
     * 根据 entity 条件,查询全部记录
     *
     * @param queryWrapper 实体对象封装操作类(可以为 null)
     */
    List<T> selectList(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

    /**
     * 根据 Wrapper 条件,查询全部记录
     *
     * @param queryWrapper 实体对象封装操作类(可以为 null)
     */
    List<Map<String, Object>> selectMaps(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

    /**
     * 根据 Wrapper 条件,查询全部记录
     * <p>注意: 只返回第一个字段的值</p>
     *
     * @param queryWrapper 实体对象封装操作类(可以为 null)
     */
    List<Object> selectObjs(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

    /**
     * 根据 entity 条件,查询全部记录(并翻页)
     *
     * @param page         分页查询条件(可以为 RowBounds.DEFAULT)
     * @param queryWrapper 实体对象封装操作类(可以为 null)
     */
    <P extends IPage<T>> P selectPage(P page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

    /**
     * 根据 Wrapper 条件,查询全部记录(并翻页)
     *
     * @param page         分页查询条件
     * @param queryWrapper 实体对象封装操作类
     */
    <P extends IPage<Map<String, Object>>> P selectMapsPage(P page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
}

 

示例

1、插入

@Test
public void testInsert(){
    //实现新增用户信息
    //INSERT INTO user ( id, name, age, email ) VALUES ( ?, ?, ?, ? )
    User user = new User();
    //user.setId(100L);
    user.setName("张三");
    user.setAge(23);
    user.setEmail("zhangsan@atguigu.com");
    int result = userMapper.insert(user);	
    System.out.println("受影响行数:"+result);
    //1475754982694199298
    System.out.println("id:"+user.getId());
}

2、删除

(1)deleteById

@Test
public void testDelete(){
    //通过id删除用户信息
    //DELETE FROM user WHERE id=?
    int result = userMapper.deleteById(1492767055210991617L);
    System.out.println("受影响行数:"+result);
}

(2)deleteBatchIds

@Test
public void testDelete(){
    //通过多个id实现批量删除
    //DELETE FROM user WHERE id IN ( ? , ? , ? )
    List<Long> list = Arrays.asList(1L, 2L, 3L);
    int result = userMapper.deleteBatchIds(list);
    System.out.println("受影响的行数:"+result);
}

(3)deleteByMap

@Test
public void testDelete(){
    //根据map集合中所设置的条件删除用户信息
    //DELETE FROM user WHERE name = ? AND age = ?
    Map<String, Object> map = new HashMap<>();
    map.put("name", "张三");
    map.put("age", 23);
    int result = userMapper.deleteByMap(map);
    System.out.println("result:"+result);
}

3、修改

(1)updateById

@Test 
public void testUpdateById(){ 
    User user = new User(4L, "admin", 22, null); 
    //UPDATE user SET name=?, age=? WHERE id=? 
    int result = userMapper.updateById(user); 
    System.out.println("受影响行数:"+result); 
}

4、查询

(1)selectById

@Test 
public void testSelectById(){ 
    //根据id查询用户信息 
    //SELECT id,name,age,email FROM user WHERE id=? 
    User user = userMapper.selectById(4L); 
    System.out.println(user); 
}

(2)selectBatchIds

@Test 
public void testSelectBatchIds(){ 
    //根据多个id查询多个用户信息 
    //SELECT id,name,age,email FROM user WHERE id IN ( ? , ? ) 
    List<Long> idList = Arrays.asList(4L, 5L); 
    List<User> list = userMapper.selectBatchIds(idList);
    list.forEach(System.out::println); 
}

(3)selectByMap

@Test 
public void testSelectByMap(){ 
    //通过map条件查询用户信息 
    //SELECT id,name,age,email FROM user WHERE name = ? AND age = ? 
    Map<String, Object> map = new HashMap<>(); 
    map.put("age", 22); 
    map.put("name", "admin"); 
    List<User> list = userMapper.selectByMap(map); 
    list.forEach(System.out::println); 
}

(4)selectList

@Test 
public void testSelectList(){ 
	//查询所有用户信息 
	//SELECT id,name,age,email FROM user 
	List<User> list = userMapper.selectList(null); 
	list.forEach(System.out::println); 
}

 

自定义查询

1、application.yml

(1)设置 Mapper 接口:mybatis-plus.mapper-locations

(2)默认扫描位置:*:/mapper/**/*.xml

2、示例

(1)映射文件

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="org.test.mybatisplus.mapper.UserMapper">

    <!-- Map<String, Object> selectMapById(Long id); -->
    <select id="selectMapById" resultType="map">
        select id, name, age, email from user where id = #{id}
    </select>

</mapper>

(2)测试方法,Mapper 接口定义方法略

@Test
public void testSelect(){
    Map<String, Object> map = userMapper.selectMapById(1L);
    System.out.println(map);
}

 

通用 Service 接口

1、IService 接口封装通用 Service CRUD,采用 get(查询单行)、remove(删除)、list(查询集合)、page(分页)前缀命名方式区分 Mapper 层避免混淆

2、对象 Wrapper 为 条件构造器

3、MyBatis-Plus 中有一个接口 IService 和其实现类 ServiceImpl,封装了常见的业务层逻辑

(1)IService 泛型:T 为实体类;ServiceImpl 泛型:M 为 Mapper 接口,T 为实体类

(2)不建议直接使用 ServiceImpl,无法满足其他自定义需求

(3)建议如果存在自定义通用 Service 方法的可能,请创建自己的 IBaseService 继承 Mybatis-Plus 提供的基类

4、示例

(1)Service 接口

//UserService继承IService模板提供的基础功能 
public interface UserService extends IService<User> { 

}

(2)Service 实现类

/**
* ServiceImpl实现了IService,提供了IService中基础功能的实现 
* 若ServiceImpl无法满足业务需求,则可以使用自定义UserService方法,并在实现类中实现 
*/ 
@Service 
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements UserService { 

}

(3)测试类

@SpringBootTest
public class MyBatisPlusServiceTest {
    @Autowired 
    private UserService userService; 

    //测试查询记录数
    @Test
    public void testGetCount(){ 
        //select count(*) from user
        long count = userService.count();
        System.out.println("总记录数:" + count); 
    }
    
    //测试批量插入
    @Test 
    public void testSaveBatch(){ 
        //SQL长度有限制,海量数据插入单条SQL无法实行, 
        //因此MP将批量插入放在了通用Service中实现,而不是通用Mapper 
        ArrayList<User> users = new ArrayList<>(); 
        for (int i = 0; i < 5; i++) { 
            User user = new User();
            user.setName(i); 
            user.setAge(20 + i); 
            users.add(user); 
        }
        //INSERT INTO user ( username, age ) VALUES ( ?, ? )
        userService.saveBatch(users); 
    }
}
posted @   半条咸鱼  阅读(56)  评论(0编辑  收藏  举报
(评论功能已被禁用)
相关博文:
阅读排行:
· 微软正式发布.NET 10 Preview 1:开启下一代开发框架新篇章
· 没有源码,如何修改代码逻辑?
· PowerShell开发游戏 · 打蜜蜂
· 在鹅厂做java开发是什么体验
· WPF到Web的无缝过渡:英雄联盟客户端的OpenSilver迁移实战
点击右上角即可分享
微信分享提示