通用 Mappper

最新推荐文章于 2023-03-16 18:12:40 发布
最新推荐文章于 2023-03-16 18:12:40 发布
阅读量745 收藏 4
点赞数
分类专栏： # MyBatis 文章标签： 通用Mapper
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/bm1998/article/details/104044408
版权

文章目录

1. 通用 Mapper 介绍

通用 Mapper 是一个辅助 MyBatis 单表开发的组件，它使我们能极其方便的使用 MyBatis 单表的增删改查。

2. 快速入门

2.1 搭建环境

  1. 创建数据库 mapper，和 table_user 表

    DROP TABLE IF EXISTS `table_user`;
CREATE TABLE `table_user` (
  `user_id` int(11) NOT NULL AUTO_INCREMENT,
  `user_name` varchar(20) DEFAULT NULL,
  `user_gender` char(2) DEFAULT '未知',
  `user_address` varchar(30) DEFAULT NULL,
  `user_birthday` date DEFAULT NULL,
  PRIMARY KEY (`user_id`)
) ENGINE=InnoDB AUTO_INCREMENT=11 DEFAULT CHARSET=utf8;

-- ----------------------------
-- Records of table_user
-- ----------------------------
INSERT INTO `table_user` VALUES ('1', '张三', '男', '北京', '2020-01-15');
INSERT INTO `table_user` VALUES ('2', '李四', '男', '上海', '2020-01-14');
INSERT INTO `table_user` VALUES ('3', '王五', '女', '广州', '2020-01-12');

  2. 创建工程

    1. 打开 IDEA --> Create New Project --> Empty Project --> 填写项目名 --> Finish
    2. New Module --> Maven --> Next --> 填写项目信息 --> Finish

  3. 引入依赖

    <?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.zt</groupId>
    <artifactId>mapper_demo1</artifactId>
    <version>1.0-SNAPSHOT</version>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.1.RELEASE</version>
    </parent>

    <dependencies>
        <!--jdbc的启动器，默认使用 HikariCP 连接池-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jdbc</artifactId>
        </dependency>
        <!--mysql驱动-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <!--mybatis-->
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>1.3.2</version>
        </dependency>
        <!--SpringBoot-test-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

</project>

  4. 配置 application.properties

    # 连接四大参数
spring.datasource.url=jdbc:mysql://localhost:3306/mapper?serverTimezone=GMT%2B8&useUnicode=true&characterEncoding=utf-8
spring.datasource.username=root
spring.datasource.password=123456

  5. 创建引导类

    @SpringBootApplication
public class MapperApplication {
    public static void main(String[] args) {
        SpringApplication.run(MapperApplication.class,args);
    }
}

  6. 创建测试类，测试能否获取数据库连接

    @RunWith(SpringRunner.class)
@SpringBootTest(classes = MapperApplication.class)
public class ConnectionTest {
    @Autowired
    private DataSource dataSource;

    @Test
    public void testGetConnection() throws SQLException {
        Connection connection = dataSource.getConnection();
        System.out.println(connection);
    }
}

    运行结果：

    HikariProxyConnection@737756161 wrapping com.mysql.cj.jdbc.ConnectionImpl@2532b351

2.2 集成通用 Mapper

  1. 引入依赖

    <!--通用 Mapper-->
<dependency>
    <groupId>tk.mybatis</groupId>
    <artifactId>mapper-spring-boot-starter</artifactId>
    <version>2.1.5</version>
</dependency>

  2. 创建实体类 User

    /**
 * 建立数据库与实体类之间的关系
 */
@Table(name = "table_user")
public class User implements Serializable {
    private Integer userId;
    private String userName;
    private String userGender;
    private String userAddress;
    private Date userBirthday;

    public User() {
    }

    public User(Integer userId, String userName, String userGender, String userAddress, Date userBirthday) {
        this.userId = userId;
        this.userName = userName;
        this.userGender = userGender;
        this.userAddress = userAddress;
        this.userBirthday = userBirthday;
    }

    public Integer getUserId() {
        return userId;
    }

    public void setUserId(Integer userId) {
        this.userId = userId;
    }

    public String getUserName() {
        return userName;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }

    public String getUserGender() {
        return userGender;
    }

    public void setUserGender(String userGender) {
        this.userGender = userGender;
    }

    public String getUserAddress() {
        return userAddress;
    }

    public void setUserAddress(String userAddress) {
        this.userAddress = userAddress;
    }

    public Date getUserBirthday() {
        return userBirthday;
    }

    public void setUserBirthday(Date userBirthday) {
        this.userBirthday = userBirthday;
    }

    @Override
    public String toString() {
        return "User{" +
                "userId=" + userId +
                ", userName='" + userName + '\'' +
                ", userGender='" + userGender + '\'' +
                ", userAddress='" + userAddress + '\'' +
                ", userBirthday=" + userBirthday +
                '}';
    }
}

  3. 创建持久层 UserMapper

    /**
 * 具体操作数据库的 Mapper 接口，需要继承通用 mapper 提供的核心接口：Mapper<User>
 * 泛型类型就是实体类的类型
 */
@org.apache.ibatis.annotations.Mapper
public interface UserMapper extends Mapper<User> {

}

  4. 创建 UserMapper 测试类

    @RunWith(SpringRunner.class)
@SpringBootTest(classes = MapperApplication.class)
public class MapperTest {
    @Autowired
    private UserMapper userMapper;

    @Test
    public void testSelectOne() {
        User user = new User(null, "张三", null, null, null);
        System.out.println(userMapper.selectOne(user));
    }
}

    运行结果：

    User{userId=1, userName='张三', userGender='男', userAddress='北京', userBirthday=Wed Jan 15 00:00:00 CST 2020}

3. 常用注解

3.1 @Table

  • 作用：建立实体类和数据库表之间的对应关系。

  • 默认规则：实体类类名首字母小写作为表名。User 类 --> user 表。

  • 实例：

    @Table(name = "table_user")
public class User implements Serializable {

3.2 @Column

  • 作用：建立实体类字段和数据库表字段之间的对应关系。

  • 默认规则：

    实体类字段：驼峰式命名

    数据库表字段：使用 “_” 区分各个单词

  • 实例：

    @Column(name = "user_id")
private Integer id;

3.3 @Id

  • 作用：建立实体类主键字段和数据库表主键字段之间的对应关系。

  • 实例：

    @Id
private Integer userId;

3.4 @GeneratedValue

  • 作用：让通用 Mapper 在执行 insert 操作之后将数据库自动生成的主键值回写到实体类对象中。

  • 实例：

    @Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Integer userId;

    @Test
public void testInsert() {
    User user = new User(null, "小红", "女", "杭州", new java.util.Date());
    userMapper.insert(user);

    System.out.println(user);
}

    运行结果：

    User{userId=10, userName='小红', userGender='女', userAddress='杭州', userBirthday=Sat Jan 18 14:52:38 CST 2020}

3.5 @Transient

  • 作用：用于标记不与数据库表字段对应的实体类字段。

  • 实例：

    @Transient 
private String otherThings; //非数据库表中字段

4. 基础方法

4.1 selectOne 方法

  • 说明：根据实体中的属性进行查询，只能有一个返回值，有多个结果是抛出异常，查询条件使用等号

  • 实例：

    @Test
public void testSelectOne() {
    User user = new User(null, "张三", null, null, null);
    System.out.println(userMapper.selectOne(user));
}

    运行结果：

    User{id=1, userName='张三', userGender='男', userAddress='北京', userBirthday=Wed Jan 15 00:00:00 CST 2020}

4.2 select 方法

  • 说明：根据实体中的属性值进行查询，查询条件使用等号

  • 实例：

    @Test
public void testSelect() {
    User user = new User(null, null, "男", null, null);
    List<User> users = userMapper.select(user);
    for (User user1 : users) {
        System.out.println(user1);
    }
}

    运行结果：

    User{userId=1, userName='张三', userGender='男', userAddress='北京', userBirthday=Wed Jan 15 00:00:00 CST 2020}
User{userId=2, userName='李四', userGender='男', userAddress='上海', userBirthday=Tue Jan 14 00:00:00 CST 2020}
User{userId=7, userName='小明', userGender='男', userAddress='深圳', userBirthday=Sat Jan 18 00:00:00 CST 2020}

4.3 selectAll 方法

  • 说明：查询全部结果，select(null)方法能达到同样的效果

  • 实例：

    @Test
public void testSelectAll() {
    List<User> users = userMapper.selectAll();
    for (User user : users) {
        System.out.println(user);
    }
}

    运行结果：

    User{userId=1, userName='张三', userGender='男', userAddress='北京', userBirthday=Wed Jan 15 00:00:00 CST 2020}
User{userId=2, userName='李四', userGender='男', userAddress='上海', userBirthday=Tue Jan 14 00:00:00 CST 2020}
User{userId=3, userName='王五', userGender='女', userAddress='广州', userBirthday=Sun Jan 12 00:00:00 CST 2020}
User{userId=7, userName='小明', userGender='男', userAddress='深圳', userBirthday=Sat Jan 18 00:00:00 CST 2020}

4.4 selectByPrimaryKey 方法

  • 说明：根据主键字段进行查询，方法参数必须包含完整的主键属性，查询条件使用等号

  • 注意：该方法需要使用 @Id 指定实体类中的主键，否则通用 Mapper 会默认将所有实体类字段作为联合主键

  • 实例：

    @Test
public void testSelectByPrimaryKey() {
    System.out.println(userMapper.selectByPrimaryKey(3));
}

    运行结果：

    User{userId=3, userName='王五', userGender='女', userAddress='广州', userBirthday=Sun Jan 12 00:00:00 CST 2020}

4.5 selectCount 方法

  • 说明：根据实体中的属性查询总数，查询条件使用等号

  • 实例：

    @Test
public void testSelectCount() {
    User user = new User(null, null, "男", null, null);
    System.out.println(userMapper.selectCount(user));
}

    运行结果：

    3

4.6 insert 方法

  • 说明：保存一个实体，null 的属性也会保存，不会使用数据库默认值

  • 实例：

    @Test
public void testInsert() {
    User user = new User(null, "小红", "女", "杭州", new java.util.Date());
    userMapper.insert(user);
    System.out.println(userMapper.selectOne(new User(null,"小红",null,null,null)));
}

    运行结果：

    User{userId=14, userName='小红', userGender='女', userAddress='杭州', userBirthday=Sat Jan 18 00:00:00 CST 2020}

4.7 insertSelective 方法

  • 说明：保存一个实体，null 的属性不会保存，会使用数据库默认值

  • 实例：

    @Test
public void testInsertSelective() {
    User user = new User(null, "小美", null, "南京", new java.util.Date());
    userMapper.insertSelective(user);
    System.out.println(userMapper.selectOne(new User(null,"小美",null,null,null)));
}

    运行结果：

    User{userId=15, userName='小美', userGender='未知', userAddress='南京', userBirthday=Sat Jan 18 00:00:00 CST 2020}

4.8 updateByPrimaryKey 方法

  • 说明：根据主键更新实体全部字段，null 值会被更新

  • 实例：

    @Test
public void testUpdateByPrimaryKey() {
    User user = new User(3, "建国", null, null, null);
    userMapper.updateByPrimaryKey(user);
    System.out.println(userMapper.selectOne(new User(3, null, null, null, null)));
}

    运行结果：

    User{userId=3, userName='建国', userGender='null', userAddress='null', userBirthday=null}

4.9 updateByPrimaryKeySelective 方法

  • 说明：根据主键更新属性不为 null 的值

  • 实例：

    @Test
public void testUpdateByPrimaryKeySelective() {
    User user = new User(2, "建军", null, null, null);
    userMapper.updateByPrimaryKeySelective(user);
    System.out.println(userMapper.selectOne(new User(2, null, null, null, null)));
}

    运行结果：

    User{userId=2, userName='建军', userGender='男', userAddress='上海', userBirthday=Tue Jan 14 00:00:00 CST 2020}

4.10 delete 方法

  • 说明：根据实体属性作为条件进行删除，查询条件使用等号

  • 注意：如果所有实体属性都为空，会删除表中所有记录

  • 实例：

    @Test
public void testDelete() {
    User user = new User(null, "小美", null, null, null);
    userMapper.delete(user);
}

4.11 deleteByPrimaryKey 方法

  • 说明：根据主键字段进行删除，方法参数必须包含完整的主键属性

  • 实例：

    @Test
public void testDeleteByPrimaryKey() {
    userMapper.deleteByPrimaryKey(14);
}

5. Example 方法

Mybatis 的逆向工程中会生成实例及实例对应的 example，example 用于添加条件，相当 where 后面的部分

5.1 selectByExample 方法

  • 说明：根据 Example 条件进行查询

  • 实例：

    /**
 * 相当于：select * from table_user where (user_address = "北京") or (user_name like "%王%");
 */
@Test
public void testSelectByExample() {
    // 1. 创建 Example 对象
    Example example = new Example(User.class);
    // 2. 通过 Example 对象创建 Criteria 对象
    Example.Criteria criteria1 = example.createCriteria();
    Example.Criteria criteria2 = example.createCriteria();

    // 3. 在两个 Criteria 对象中分别设置查询条件
    criteria1.andEqualTo("userAddress","北京");
    criteria2.andLike("userName","%王%");

    // 4. 使用 or 关键词组装两个 Criteria 对象
    example.or(criteria2);

    // 5. 执行查询
    List<User> users = userMapper.selectByExample(example);
    for (User user : users) {
        System.out.println(user);
    }
}

    运行结果：

    User{userId=1, userName='张三', userGender='男', userAddress='北京', userBirthday=Wed Jan 15 00:00:00 CST 2020}
User{userId=3, userName='王五', userGender='女', userAddress='广州', userBirthday=Sun Jan 12 00:00:00 CST 2020}

5.2 selectCountByExample 方法

  • 说明：根据 Example 条件进行查询总数

  • 实例：

    /**
 * 相当于：select COUNT(*) from table_user where user_gender = "男";
 */
@Test
public void testSelectCountByExample() {
    Example example = new Example(User.class);
    Example.Criteria criteria = example.createCriteria();

    criteria.andEqualTo("userGender", "男");

    System.out.println(userMapper.selectCountByExample(example));
}

    运行结果：

    3

5.3 updateByExample 方法

  • 说明：根据 Example 条件更新实体包含的全部属性，null 值会被更新

  • 实例：

    /**
 * 相当于：update table_user set user_name = "小红",user_gender = null,user_address = null,user_birthday = null where user_id = 7;
 */
@Test
public void testUpdateByExample() {
    User user = new User(null, "小红", null, null, null);
    Example example = new Example(User.class);
    Example.Criteria criteria = example.createCriteria();
    criteria.andEqualTo("userId", 7);

    userMapper.updateByExample(user, example);
    System.out.println(userMapper.selectOne(user));
}

    运行结果：

    User{userId=7, userName='小红', userGender='null', userAddress='null', userBirthday=null}

5.4 updateByExampleSelective 方法

  • 说明：根据 Example 条件更新实体包含的不是 null 的属性值

  • 实例：

    /**
 * 相当于：update table_user set user_name = "小花" where user_id = 3;
 */
@Test
public void testUpdateByExampleSelective() {
    User user = new User(null, "小花", null, null, null);
    Example example = new Example(User.class);
    Example.Criteria criteria = example.createCriteria();
    criteria.andEqualTo("userId", 3);

    userMapper.updateByExampleSelective(user,example);
    System.out.println(userMapper.selectOne(user));
}

    运行结果：

    User{userId=3, userName='小花', userGender='女', userAddress='广州', userBirthday=Sun Jan 12 00:00:00 CST 2020}

5.5 deleteByExample 方法

  • 说明：根据 Example 条件删除数据

  • 实例：

    /**
 * 相当于：delete from table_user where user_name = "小红";
   */
    @Test
  public void testDeleteByExample() {
        Example example = new Example(User.class);
        Example.Criteria criteria = example.createCriteria();
        criteria.andEqualTo("userName","小红");
    
        userMapper.deleteByExample(example);
    }
bm1998
关注
  • 0
    点赞
  • 踩
  • 4
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
上汽通用 VX manager
08-03
上汽通用 VX manager
APP通用测试用例
03-06
这是一份专用于移动端项目的通用测试用例汇总！！！！！！
Mybatis之通用Mappper
China_TomCat的博客
08-31 348
Mybatis之通用Mappper 通用 Mapper 介绍 通用 Mapper 是一个辅助 MyBatis 单表开发的组件，它使我们能极其方便的使用 MyBatis 单表的增删改查。 快速入门 2.1 搭建环境 创建数据库 mapper，和 table_user 表 DROP TABLE IF EXISTS table_user; CREATE TABLE table_user ( user_id int(11) NOT NULL AUTO_INCREMENT, user_name varch
SSM中使用通用mapper提取通用service -BaseService
qq_41534573的博客
10-08 632
使用通用mapper提取出service层的service方法，可以大大减少作量，少些赘余的代码。 利用通用Mappe封装rBaseService 主要有如下方法： 1、 queryById 2、 queryAll 3、 queryOne 4、 queryListByWhere 5、 queryPageListByWhere 6、 save 7、 update 8、 deleteById 9、 d...
Mybatis学习——认识Mappper.xml配置文件
J.Jian博客
11-03 2414
Mybatis中Mapper映射文件
Mysql查询表中的字段属性&通用mapper
peopleware1的博客
03-19 855
查询表中的字段属性 show full columns from tablename; 强大的IDEA：加入工具类通用mapper 将单表的增删改查省去，通过通用mapper来简化。 1.通过在pom.xml中配置通用mapper <dependency> <groupId>tk.mybatis</groupId> ...
Mappper 的增加与修改
weixin_51448614的博客
03-09 93
神舟通用jar
03-26
神舟通用连接数据库驱动包，利用该客户端，可以连接并操作神州通用企业版7.0,对神州通用进行操作。
oscar神州通用jdbc驱动
最新发布
07-16
oscar神州通用jdbc驱动，oscar神州通用jdbc驱动
通用设计法则
01-14
完整版，但文本字体颜色浅。
SpringBoot整合tkMybatis基础教程- 通用mappper的使用
qq_41787812的博客
03-02 202
SpringBoot整合tkMybatis基础教程
使用mapper代理开发
weixin_64218896的博客
03-16 100
Mapper代理的开发
mybats-puls---条件构造器Wrapper,插件扩展,SQL注入器,公共字段填充
guoguo0717的博客
05-20 491
条件构造器Wrapper（看官网即可） 代码生成器 AutoGenerator 是 MyBatis­Plus 的代码生成器，通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块 的代码，极大的提升了开发效率。 其实在学习mybatis的时候我们就使用过逆向工程，根据我们的数据表 来生成的对应的实体类，DAO接口和Mapper映射文件，而MyBatis­plus提供了 更加完善的功能，下面来针对两种方式做一个基本的对
通用mapper（mapper-mybatis）
m0_62520968的博客
07-19 1万+
通用Mapper是一个可以实现任意MyBatis通用方法的框架，项目提供了常规的增删改查操作以及Example相关的单表操作，与mybatisplus相似，对mybatis制作增强不做修改。为什么要用通用mapper？我们这里列举一下原生Mybatis的痛点1、mapper.xml文件里有大量的sql，当数据库表字段变动，配置文件就要修改2、需要自己实现sql分页，select*fromtablewhere...limit1,3。...
mapper注入spring的实现过程
yang_yang_6666的博客
01-16 2199
定位 注解方式 根据MapperScan里的内容找到basePackages 加载 MapperScannerRegistrar里registerBeanDefinitions方法通过ClassPathMapperScanner的doScan方法进行扫描basePackages。ClassPathMapperScanner继承spring中ClassPathBeanDefinitionScann...
SpringBoot-Mybatis_Plus学习记录之公共字段自动填充
weixin_34198797的博客
04-23 1019
一.应用场景 平时在建对象表的时候都会有最后修改时间，最后修改人这两个字段，对于这些大部分表都有的字段，每次在新增和修改的时候都要考虑到这几个字段有没有传进去，很麻烦。mybatisPlus有一个很好的解决方案。也就是公共字段自动填充的功能。一般满足下面条件的字段就可以使用此功能： 这个字段是大部分表都会有的。 这个字段的值是固定的，或则字段值是可以在后台动态获取的。 常用的就是last_...
Mybatis plus 3.x 公用字段 全局字段填充配置 Spring Boot
亦如黎明中的花朵
08-18 787
文章用到的技术框架版本如下： Mybatis Plus 3.3.2 Spring Boot 2.3.2.RELEASE MySQL 8.0 设计背景 在设计表结构的时候，往往会有一些公用的字段，如创建人编号(create_user_id)，最后修改人编号(last_update_user_id)、创建时间(create_time)、最后修改时间（last_update_time）等。 表结构 create table sys_user ( user_id varch.
mybatis笔记之使用Mapper接口注解
weixin_30344795的博客
11-09 2496
1. mybatis支持的映射方式 mybatis支持的映射方式有基于xml的mapper.xml文件、基于java的使用Mapper接口class，简单学习一下mybatis使用接口来配置映射的方法。 接口方法注解主要是四个：@Insert、@Delete、@Update、@Select 2. 如何使用接口注解来映射 下面的实验都是基于t_user表的，其结构如下：DROP T...
MyBatis 通用 Mapper 实现原理
热门推荐
偶尔记一下 - mybatis.io
11-09 6万+
MyBatis 通用 Mapper 实现原理 文章出自 GitChat http://gitbook.cn/books/59ed3c942f5a1d7161bad162/index.html 本文会先介绍通用 Mapper 的简单原理，然后使用最简单的代码来实现这个过程。基本原理通用 Mapper 提供了一些通用的方法，这些通用方法是以接口的形式提供的，例如。public interfac
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

bm1998

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值