Mybatis通用Mapper实战

最新推荐文章于 2024-07-26 00:55:46 发布
最新推荐文章于 2024-07-26 00:55:46 发布
阅读量492 收藏 2
点赞数
分类专栏： mybatis 文章标签： spring java 后端 mybatis
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/churen2007/article/details/116108364
版权

使用Mybatis的开发者，大多数都会遇到一个问题，就是要写大量的SQL在xml文件中，除了特殊的业务逻辑SQL之外，还有大量结构类似的增删改查SQL。而且，当数据库表结构改动时，对应的所有SQL以及实体类都需要更改。这工作量和效率的影响或许就是区别增删改查程序员和真正程序员的屏障。这时，通用Mapper便应运而生。

通用Mapper就是为了解决单表增删改查，基于Mybatis的插件。开发人员不需要编写SQL，不需要在DAO中增加方法，只要写好实体类，就能支持相应的增删改查方法。

通用Mapper实例：

代码工程结构：

数据库使用mysql，建表语句：

CREATE TABLE `user` (
  `id` int(32) NOT NULL AUTO_INCREMENT,
  `userName` varchar(32) NOT NULL,
  `passWord` varchar(50) NOT NULL,
  `realName` varchar(32) DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=3 DEFAULT CHARSET=utf8;

maven依赖：

<?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.demo.mybatis</groupId>
   <artifactId>mybatisdemo</artifactId>
   <version>0.0.1-SNAPSHOT</version>
   <packaging>jar</packaging>
 
   <name>mybatisdemo</name>
   <description>Demo project for Spring Boot</description>
 
   <parent>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-parent</artifactId>
      <version>2.4.5</version>
      <relativePath/>
   </parent>
 
   <properties>
      <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
      <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
      <java.version>1.8</java.version>
   </properties>
 
   <dependencies>
      <dependency>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-jdbc</artifactId>
      </dependency>
      <dependency>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-web</artifactId>
      </dependency>
      <dependency>
         <groupId>org.mybatis.spring.boot</groupId>
         <artifactId>mybatis-spring-boot-starter</artifactId>
         <version>2.1.0</version>
      </dependency>
      <dependency>
         <groupId>tk.mybatis</groupId>
         <artifactId>mapper-spring-boot-starter</artifactId>
         <version>2.1.5</version>
      </dependency>
      <dependency>
         <groupId>com.github.pagehelper</groupId>
         <artifactId>pagehelper-spring-boot-starter</artifactId>
         <version>1.3.0</version>
      </dependency>
      <dependency>
         <groupId>mysql</groupId>
         <artifactId>mysql-connector-java</artifactId>
         <version>8.0.20</version>
      </dependency>
      <dependency>
         <groupId>org.projectlombok</groupId>
         <artifactId>lombok</artifactId>
         <version>1.18.20</version>
         <scope>provided</scope>
      </dependency>
      <dependency>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-test</artifactId>
         <scope>test</scope>
      </dependency>
   </dependencies>
 
   <build>
      <plugins>
         <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
         </plugin>
      </plugins>
   </build>
</project>

application.yml配置：

server:
  port: 8090
 
spring:
  datasource:
    username: root
    password: Yj_123456
    url: jdbc:mysql://192.168.0.106:3306/alpha?useUnicode=true&characterEncoding=utf-8&useSSL=true&serverTimezone=UTC
    driver-class-name: com.mysql.jdbc.Driver
 
mybatis:
  mapper-locations: classpath:mapper/*.xml
  type-aliases-package: com.demo.mybatis.entity

mapper:
  mappers: com.demo.mybatis.basemapper.MyMapper
  identity: MYSQL
 
#showSql
logging:
  level:
    com:
      example:
        mapper : debug
mapper配置xml文档内容(UserMapping.xml)：
<?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="com.demo.mybatis.mapper.UserMapper">

    <select id="sel" resultType="User">
        select id,userName,passWord,realName from user where id = #{id}
    </select>

</mapper>

实体类：

package com.demo.mybatis.entity;

import lombok.Data;

import javax.persistence.*;

@Table(name = "user")
@Data
public class User {

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

    @Column(name = "userName")
    private String userName;

    @Column(name = "passWord")
    private String passWord;

    @Column(name = "realName")
    private String realName;
}

常亮接口：

package com.demo.mybatis.constant;

public interface CommonConstant {

    String STATUS_OK = "success";

    String STATUS_FAIL = "fail";

}

通用Mapper接口：

package com.demo.mybatis.basemapper;

import tk.mybatis.mapper.additional.idlist.IdListMapper;
import tk.mybatis.mapper.common.Mapper;
import tk.mybatis.mapper.common.MySqlMapper;

public interface MyMapper<T> extends IdListMapper<T, Long>, Mapper<T>, MySqlMapper<T> {
}

业务Mapper接口：

package com.demo.mybatis.mapper;

import com.demo.mybatis.basemapper.MyMapper;
import com.demo.mybatis.entity.User;
import org.apache.ibatis.annotations.Mapper;

@Mapper
public interface UserMapper extends MyMapper<User> {
}

通用结果VO：

package com.demo.mybatis.vo;

import lombok.Data;

@Data
public class GenericResult<T> {

    private String code;

    private String message;

    private T data;
}

结果处理工具类：

package com.demo.mybatis.util;

import com.demo.mybatis.constant.CommonConstant;
import com.demo.mybatis.vo.GenericResult;
import org.springframework.stereotype.Service;

@Service
public class ResultUtil<T> {

    public GenericResult<T> success(T data) {
        GenericResult<T> result = new GenericResult();
        result.setData(data);
        result.setCode(CommonConstant.STATUS_OK);
        return result;
    }

}

业务Service类：

package com.demo.mybatis.service;

import com.demo.mybatis.constant.CommonConstant;
import com.demo.mybatis.entity.User;
import com.demo.mybatis.mapper.UserMapper;
import com.demo.mybatis.vo.GenericResult;
import com.github.pagehelper.PageHelper;
import com.github.pagehelper.PageInfo;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.List;

@Service
public class UserService {

    @Autowired
    private UserMapper userMapper;

    public User selectOne(int id) {
        User user = new User();
        user.setId(id);
        return userMapper.selectOne(user);
    }

    public void save(List<User> users) {
        userMapper.insertList(users);
    }

    public void save(User user) {
        userMapper.insert(user);
    }

    public void update(User user) {
        userMapper.updateByPrimaryKey(user);
    }

    public List<User> getAll() {
        return userMapper.selectAll();
    }

    public GenericResult<PageInfo<User>> page(int pageNum, int pageSize) {
        PageHelper.startPage(pageNum, pageSize);
        List<User> users = userMapper.selectAll();
        PageInfo<User> pageInfo = new PageInfo<User>(users);
        GenericResult<PageInfo<User>> result = new GenericResult<>();
        result.setCode(CommonConstant.STATUS_OK);
        result.setMessage("ok");
        result.setData(pageInfo);
        return result;
    }

}

业务Controller类：

package com.demo.mybatis.controller;

import com.demo.mybatis.entity.User;
import com.demo.mybatis.util.ResultUtil;
import com.demo.mybatis.vo.GenericResult;
import com.demo.mybatis.service.UserService;
import com.github.pagehelper.PageInfo;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

import java.util.List;

@RestController
@RequestMapping("/demo/mybatis")
public class UserController {

    @Autowired
    private UserService userService;

    @Autowired
    private ResultUtil<String> resultUtil;

    @RequestMapping("getUser/{id}")
    public User getUser(@PathVariable int id) {
        return userService.selectOne(id);
    }

    @RequestMapping("getAllUser")
    public List<User> getAllUser() {
        return userService.getAll();
    }

    @PostMapping("saveOne")
    public GenericResult<String> saveOne(@RequestBody User user) {
        userService.save(user);
        return resultUtil.success(user.getUserName());
    }

    @PostMapping("saveList")
    public GenericResult<String> saveList(@RequestBody List<User> users) {
        userService.save(users);
        return resultUtil.success(users.size() + "");
    }

    @PutMapping("update")
    public GenericResult<String> update(@RequestBody User user) {
        userService.update(user);
        return resultUtil.success("success");
    }

    @RequestMapping("page")
    public GenericResult<PageInfo<User>> page(@RequestParam(name = "pageNum") int pageNum, @RequestParam(name = "pageSize") int pageSize) {
        return userService.page(pageNum, pageSize);
    }

}

DAO的写法

在传统的Mybatis写法中，DAO接口需要与Mapper文件关联，即需要编写SQL来实现DAO接口中的方法。而在通用Mapper中，DAO只需要继承一个通用接口，即可拥有丰富的方法：

继承通用的Mapper，必须指定泛型

一旦继承了Mapper，继承的Mapper就拥有了Mapper所有的通用方法：

public interface MyMapper<T> extends IdListMapper<T, Long>, Mapper<T>, MySqlMapper<T> { }

Select
方法：List<T> select(T record);
说明：根据实体中的属性值进行查询，查询条件使用等号

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

方法：List<T> selectAll();
说明：查询全部结果，select(null)方法能达到同样的效果

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

方法：int selectCount(T record);
说明：根据实体中的属性查询总数，查询条件使用等号

Insert
方法：int insert(T record);
说明：保存一个实体，null的属性也会保存，不会使用数据库默认值

方法：int insertSelective(T record);
说明：保存一个实体，null的属性不会保存，会使用数据库默认值

Update
方法：int updateByPrimaryKey(T record);
说明：根据主键更新实体全部字段，null值会被更新

方法：int updateByPrimaryKeySelective(T record);
说明：根据主键更新属性不为null的值

Delete
方法：int delete(T record);
说明：根据实体属性作为条件进行删除，查询条件使用等号

方法：int deleteByPrimaryKey(Object key);
说明：根据主键字段进行删除，方法参数必须包含完整的主键属性

Example方法
方法：List<T> selectByExample(Object example);
说明：根据Example条件进行查询
重点：这个查询支持通过Example类指定查询列，通过selectProperties方法指定查询列

方法：int selectCountByExample(Object example);
说明：根据Example条件进行查询总数

方法：int updateByExample(@Param("record") T record, @Param("example") Object example);
说明：根据Example条件更新实体record包含的全部属性，null值会被更新

方法：int updateByExampleSelective(@Param("record") T record, @Param("example") Object example);
说明：根据Example条件更新实体record包含的不是null的属性值

方法：int deleteByExample(Object example);
说明：根据Example条件删除数据

总结

通用Mapper的原理是通过反射获取实体类的信息，构造出相应的SQL，因此我们只需要维护好实体类即可，对于应付复杂多变的需求提供了很大的便利。上文叙述的只是通用Mapper的简单用法，在实际项目中，还是要根据业务，在通用Mapper的基础上封装出粒度更大、更通用、更好用的方法。

星际探索行者
关注
  • 0
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
mybatis——mapper文件详解
2401_84010107的博客
04-02 465
按照上面的过程，4个月的时间刚刚好。当然Java的体系是很庞大的，还有很多更高级的技能需要掌握，但不要着急，这些完全可以放到以后工作中边用别学。学习编程就是一个由混沌到有序的过程，所以你在学习过程中，如果一时碰到理解不了的知识点，大可不必沮丧，更不要气馁，这都是正常的不能再正常的事情了，不过是“人同此心，心同此理”的暂时而已。道路是曲折的，前途是光明的！《一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码》点击传送门即可获取！
Mybatis-Plus 实战教程
weixin_43711204的博客
08-12 813
MyBatis-Plus (opens new window)（简称 MP）是一个MyBatis (opens new window)的增强工具， 在 MyBatis的基础上只做增强不做改变，为简化开发、提高效率而生。
Mybatis-plus + 通用mapper（tk.mybatis）
qq_45981086的博客
03-28 1007
Mybatis-plus + 通用mapper（tk.mybatis）
5年码农的我整理了MyBatis从入门到实战，想精通看这一篇就够了
a1901149的博客
05-03 1030
自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。深知大多数Java工程师，想要提升技能，往往是自己摸索成长，自己不成体系的自学效果低效漫长且无助。因此收集整理了一份《2024年Java开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。
SpringBoot整合SpringMVC、Druid连接池、mybatis、通用mapper实战
lyu1122的博客
07-15 356
什么是SpringBoot SpringBoot makes it easy to create stand-alone, production-grade Spring based Applications that you can “just run”.We take an opinionated view of the Spring platform and third-party libraries so you can get started with minimum fuss. Most Sp
Mybatis-Plus实战
ITKidKid的博客
06-02 1229
Mybatis-Plus快速入门，以及相关注解的使用，插件的使用，扩展功能实现、以及代码实战。
【Mybatis】如何继承Mybatis中的Mapper
2401_84046876的博客
04-18 1062
上面是我生成的代码;并且能够正常使用;
Mybatis源码 - Mapper实现类
weixin_43796428的博客
01-28 2025
Mybatis-Mapper实现类 摘要 说到Mybatis，我们都知道这是一个与数据库交互的持久层框架，它能提供可自定义的数据库查询接口，并且封装了查询细节，让我们专注于业务开发的优秀框架。 但说到动态代理，大部分刚出来同学可能就有点疑惑了，因为在工作中我不止一次被刚参加工作的同事问道:“Mapper接口的实现是放在那个包下？我怎么找不到呢?”。然后我会毫不犹豫的告诉他:“Mapper接口的实现类是由动态代理技术生成的，是放在内存中的，你是看不到的”,然后他们带着一脸问号回到了工位。 接下来让我们来看看
SpringBoot 框架整合 (二) ： MyBatis + Mapper + mybatis-generator
爱莲说的博客
09-01 8457
[TOC] 本文实例需要用Spring Tool Suite创建基本spring boot项目，具体步骤请移步到： SpringBoot 实战 (一) ：如何创建SpringBoot项目 –入门篇Mapper介绍前言使用MyBatis在我们通过xml集中配置SQL，并通过创建接口Mapper文件来完成持久化DAO层（mybatis内部使用的是动态代理，所以我们不需要自己编写实现类 ），不需要实现
SpringBoot+Mybatis+通用Mapper整合security
qq_19663899的博客
05-10 1255
通用Mapper映射视频
07-18
尚硅谷提供的通用Mapper插件，是一种基于MyBatis的增强工具，可以极大地简化Mapper接口的开发工作，使得开发者无需编写具体的SQL语句即可完成常见的数据库操作。 - **特点**： - 自动为Mapper接口生成实现方法，...
《Spring MVC MYBatis企业应用实战+源码》
07-03
5. 集成Spring Data JPA或MyBatis的Mapper，实现更高级的数据访问功能。 6. 整合Spring Security或Shiro进行安全控制，保护敏感资源。 7. 使用Spring MVC的视图技术，如Thymeleaf或FreeMarker，构建前端页面。 8. ...
SpringMyBatis企业应用实战-sourcecode
05-26
《SpringMyBatis企业应用实战-sourcecode》是一个与书籍配套的源码库，它涵盖了Spring和MyBatis在实际企业项目中的应用。Spring是一个全面的Java应用框架，它提供了依赖注入（DI）、面向切面编程（AOP）等功能，极大...
Spring+MYBatis企业应用实战pdf
11-17
《Spring+MYBatis企业应用实战》是一本深入解析如何在实际项目中集成并高效使用Spring和MyBatis框架的指南。Spring是一个全面的Java应用框架，提供了丰富的功能，包括依赖注入、AOP（面向切面编程）、MVC（模型-视图...
mybatis-plus实战.zip
08-26
MyBatis-Plus还提供了全局通用Mapper和通用Service，可以进一步减少代码量。只需要简单配置，就可以自动实现基本的CRUD操作。 七、逻辑删除与自定义填充 MyBatis-Plus支持逻辑删除，只需在实体类中定义一个字段并...
java springboot 集成 阿里通义千问
qq_25987725的博客
07-25 266
一、在阿里云https://www.aliyun.com官网直接搜索“通义千问”，点击“开通DashScope”进行服务激活。四、在config目录添加配置 TongYiAiConfiguration.java。三、在yml中配置中配置key。二、加入Maven依赖。
【过滤器 vs 拦截器】SpringBoot中过滤器与拦截器：明智选择的艺术（如何在项目中做出明智选择）
weixin_68020300的博客
07-25 1026
本文深入剖析了SpringBoot框架下过滤器与拦截器的核心差异及应用场景，指导开发者在面对请求-响应周期中的不同需求时，如何做出最佳技术选择。无论是实现安全性、日志记录，还是权限控制与数据预处理，本文都将帮助你理解何时何地使用过滤器或拦截器，以构建更加高效、可维护的Web应用程序。通过对比二者的特性与优劣，本文旨在赋能开发者，使其在实际项目中灵活运用这两种强大工具，达成项目目标。
【Spring Framework】使用完全注解方式开发
最新发布
u013675821的博客
07-26 1011
本文介绍了如何使用 Spring 完全注解化的方式来进行开发。通过使用注解，我们可以减少 XML 配置文件的使用，使项目的配置更加直观和简洁。配置类：使用@Bean等注解定义配置类。数据库配置：使用DataSource以及@Autowired自动装配数据源。服务层和控制器层：使用@Service和注解定义业务逻辑和控制器，并使用@Autowired注入依赖。AOP 和事务管理：通过@Aspect和注解实现日志记录和事务管理。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值