Mybatis 通用 Dao 的封装源码与示例

本贴最后更新于 2979 天前,其中的信息可能已经事过境迁

曾将发布过俩篇关于Mybatis封装的文章,当时曾曾承诺过当测试没有问题后阿海会整理一下然后将原代码发布出来。

那么今天正好朋友找我要一份那套mybatis封装的源码,我便整理了一份,想想这么长时间了并没有发现什么明显的bug,于是决定将它发出来。


喜欢的朋友可以在这里下载:

crud-src.rar


关于这个mybatis的封装,我且叫他CRUD框架吧,这样说着还顺口一点。这是一个Maven工程,代码在src/main/java中。配置文件在src/main/resource中,这就不多说了,整个CRUD的源码在com.aiyi.core包中。

QQ截图20160628154905.jpg

喜欢的朋友可以进去瞅瞅,也没有什么高深的技术,就是写了一个公用的Dao并代理了一下dao的实现层。还有就是com.aiyi.base包中,就是你写代码的地方了,里面有一些dao包啦、service包啦、controller包啦之类的。这事我随便写的一些使用的例子,这些根据自己项目结构随便改。

QQ截图20160628155416.jpg

接下来就是一些使用方式什么的,将工程导入到eclipse中后,进入com.aiyi.base.dao包,可以看到两个实体类,这两个实体类对应的是数据库中的两张表。

TestUserPo.java:

package com.aiyi.base.pojo;

import com.aiyi.core.annotation.po.FieldName;
import com.aiyi.core.annotation.po.TableName;
import com.aiyi.core.annotation.po.TempField;
import com.aiyi.core.beans.Po;

//@TableName 用来表示当前实体类对应数据库中的表名
@TableName(name="q_test_table1")
public class TestUserPo extends Po {

 private int id;
 
 //@FieldName 注解是用来标识该字段对应的数据库字段名。假如数据库字段和实体类中的字段一致的话,就不需要这个注解
 @FieldName(name="img_id")
 private int imgId;
 
 private String name;
 
 //@TempField 注解标识 imgUrl 这个字段是一个临时字段,也就是说,在数据库中这个字段是不存在的。
 @TempField
 private String imgUrl;

 public int getId() {
  return id;
 }

 public void setId(int id) {
  this.id = id;
 }

 public int getImgId() {
  return imgId;
 }

 public void setImgId(int imgId) {
  this.imgId = imgId;
 }

 public String getName() {
  return name;
 }

 public void setName(String name) {
  this.name = name;
 }

 public String getImgUrl() {
  return imgUrl;
 }

 public void setImgUrl(String imgUrl) {
  this.imgUrl = imgUrl;
 }
 
 
}

TestImgResourcePo.java:

package com.aiyi.base.pojo;

import com.aiyi.core.annotation.po.TableName;
import com.aiyi.core.beans.Po;

@TableName(name="q_test_table2")
public class TestImgResourcePo extends Po {

 private int id;
 
 private String url;

 public int getId() {
  return id;
 }

 public void setId(int id) {
  this.id = id;
 }

 public String getUrl() {
  return url;
 }

 public void setUrl(String url) {
  this.url = url;
 }
 
 
}

com.aiyi.base.dao 包中,有资格类,分别是 UserDao、ImgResourceDao 以及他们的接口。这里如果你只是单纯的想用 CRUD 做开发的话,

一般情况下是不用写那两个接口类的,也就是说,你只需要写 UserDao、ImgResourceDao 这两个类就好了,但是这里既然是例子,那就说全一点,一般情况下虽然不需要写 dao 的接口类,但是我喜欢二班情况。

若问我为什么要闲着没事儿给他写接口玩儿,是因为我封装的这套 CRUD 支持编程扩展的。也就是说,你可以在开发的时候根据需要扩展他的功能。你可以理解为一种叫做“插件”的东西。待会儿我要在两张表内各插入 3000 条数据,原始的 CRUD 框架虽然可以插入数据,但是他只能一条一条的插入,虽然你可以写个可爱的 for 循环,但是效率摆在那,如果想批量的插入一些数据的话,你或许需要给他增加这么一个功能,也就是说,给他写一个支持批量增加记录的插件。

所以请看好,接下来的相信在实际开发中经常会遇到,我给他添加批量新增的支持,就先建立一个接口类并给他生命一个 add 方法用来批量添加数据:

package com.aiyi.base.dao;

import java.util.List;

import com.aiyi.base.pojo.TestUserPo;

/**
 * UserDao 的接口类,也属于爱易 CRUD 的插件扩展类。这个类一般情况下不用创建。当需要重载或者新增 REUD 框架的一些方法时,可以声明接口类
 * 本接口类重载了 add()方法,使 add 方法可以一次性插入多条数据,极大的提高了数据批量增加的效率
 * @author 郭胜凯
 * @time 2016 年 6 月 28 日下午 12:51:29
 * @email 719348277@qq.com
 *
 */
public interface UserDaoInterface {

 int add(List list);
}

接口类建立了以后,我需要写一个 mapper 映射文件,将它执行的 sql 映射一下,那么我建立一个 com.aiyi.base.mapper.userDaoMapper.xml:

并将它的 namespace 指向咱们先前写的这个接口:com.aiyi.base.dao.UserDaoInterface

<mapper namespace="com.aiyi.base.dao.UserDaoInterface">

    
 <insert id="user_addList" useGeneratedKeys="true" parameterType="java.util.List">
  insert into q_test_table1 (img_id, name)
  values
  <foreach collection="list" item="item" index="index"
   separator=",">
   (#{item.imgId}, #{item.name})
  

 
 

接下来建立 UserDao.java,并继承 DaoImpl,DaoImpl 有两个泛型,第一个是当前 Dao 对应的实体类,第二个是当前实体类中的主键类型。这个时候,你的这个 UserDao 就已经拥有通用的增删改查方法了但是我希望他拥有批量新增的方法,所以我在让他实现之前的 UserDaoInterface 这个类。

package com.aiyi.base.dao;

import java.util.List;

import javax.annotation.Resource;

import org.mybatis.spring.SqlSessionTemplate;
import org.springframework.stereotype.Repository;

import com.aiyi.base.pojo.TestUserPo;
import com.aiyi.core.dao.impl.DaoImpl;

/**
 * UserDao 的实现类,该类继承了公共 Dao 的原始方法。当你要给爱易 REUD 框架增加新功能时,不用去改源码,爱易 CRUD 提供了可编程式插件接口的方案。
 * 你可以编写一个接口类并实现他,以此来扩展爱易 CRUD
 * @author 郭胜凯
 * @time 2016 年 6 月 28 日下午 12:56:42
 * @email 719348277@qq.com
 *
 */
@Repository
public class UserDao extends DaoImpl<TestUserPo, Integer> implements UserDaoInterface /UserDaoInterface 这个接口是一个插件实现的演示。他完善了爱易 CRUD 的批量添加方案/ {

 @Resource
 private SqlSessionTemplate sqlSessionTemplateASS;
 
 /**
  * 重载 Add 方法,批量添加
  * @param list
  * @return
  */
 public int add(List list){
  
  long startId = nextId();
  
  for (int i = 0; i < list.size(); i++) {
   list.get(i).setId(Integer.valueOf(startId + i + ""));
  }
  
  //注意了,这里的“user_addList”对应的是 userDaoMapper.xml 中的 insertSQL 块的 Id
  return sqlSessionTemplateASS.insert("user_addList", list);
 }
}

好了,这么一个批量新增的扩展类已经编写完成了!你只需要调用 userDao.add()方法的时候,传入一个 list 进去,他就会以最短的时间吧 list 中的元素插入到数据库中!

接下来吧 imgDao 页添加一个批量新增的功能,以上面一样,所以我就不再贴代码了!看我写个 Service 来测试一下!

package com.aiyi.base.service.impl;

import java.util.ArrayList;
import java.util.List;

import javax.annotation.Resource;

import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Isolation;
import org.springframework.transaction.annotation.Transactional;

import com.aiyi.base.dao.ImgDao;
import com.aiyi.base.dao.UserDao;
import com.aiyi.base.pojo.TestImgResourcePo;
import com.aiyi.base.pojo.TestUserPo;
import com.aiyi.base.service.TestService;
import com.aiyi.core.beans.Method;
import com.aiyi.core.sql.where.C;
import com.aiyi.core.util.Formatter;
import com.aiyi.core.util.FormatterSql;

@Service
public class TestServiceImpl implements TestService {
 
 @Resource
 private ImgDao imgDao;
 
 @Resource
 private UserDao userDao;

 //批量新增 User 和 Img 各 3000 条,速度嗖嗖的
 @Override
 @Transactional(isolation = Isolation.SERIALIZABLE)
 public int addList() {
  // TODO Auto-generated method stub
  
  List users = new ArrayList<>();
  List imgs = new ArrayList<>();
  
  for (int i = 0; i < 3000; i++) {
   TestImgResourcePo imgResourcePo = new TestImgResourcePo();
   imgResourcePo.setUrl("http://imgresource.com/url/" + i + ".jpg");
   imgs.add(imgResourcePo);
  }
  int add = imgDao.add(imgs);
  
  for (int i = 0; i < 3000; i++) {
   TestUserPo testUserPo = new TestUserPo();
   testUserPo.setImgId(imgs.get(i).getId());
   testUserPo.setName("用户" + i);
   users.add(testUserPo);
  }
  add += userDao.add(users);
  
  
  return add;
 }

 //联表查询,之前说了 user 实体类的 imgUrl 是一个临时字段,他的真正的值在 img 表的 url 字段里,user 中的 imgId 对应的就是 img 表中的 Id
 @Override
 public List listUser() {
  // TODO Auto-generated method stub
  
  Formatter fmt = new FormatterSql();
  fmt.addFmt("imgUrl", "url", TestImgResourcePo.class, Method.where("[fmt.R].id", C.EQ, "[fmt.L].img_id"));
  
  return userDao.listFormat(Method.createDefault(), fmt);
 }
}

写个 Controller 跑一下:

package com.aiyi.base.controller;

import java.util.HashMap;
import java.util.List;
import java.util.Map;

import javax.annotation.Resource;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

import com.aiyi.base.pojo.TestUserPo;
import com.aiyi.base.service.TestService;

@Controller
public class TestController {

 @Resource
 private TestService testService;
 
 /**
  * 添加测试
  * @return
  /
 @RequestMapping("testAdd")
 @ResponseBody
 public Object testAddList(){
  
  long t = System.currentTimeMillis();
  int n = testService.addList();
  long tT = System.currentTimeMillis();
  
  double s = (tT - t) / 1000;
  
  return "共添加" + n + "条数据,用时" + s + "秒";
 }
 
 /
*
  * 查询测试
  * @return
  /
 @RequestMapping("testSelect")
 @ResponseBody
 public Object testSelectFmt(){
  
  long t = System.currentTimeMillis();
  List listUser = testService.listUser();
  long tT = System.currentTimeMillis();
  
  double s = (tT - t) / 1000;
  
  Map<String, Object> map = new HashMap<>();
  
  map.put("msg", "共查询" + listUser.size() + "条记录,用时" + s + "秒");
  map.put("oData", listUser);
  
  return map;
  
 }
}

以上就是这个样子,更多的东西可以从我以前的文章中看到,或者自己下载源码摸索一下,这里就介绍这么多了至此,再见!

呃。。等等,还有个事儿给忘了,数据库在/crud2/src/main/resources/jdbc.properties 下面配置成自己的。

下面是 Mysql 的两张测试表:

/
Navicat MySQL Data Transfer

Source Server         : aiyi_web
Source Server Version : 50518
Source Host           : rm-bp1995mscsm3q9bus.mysql.rds.aliyuncs.com:3306
Source Database       : rz4m1ulg3q

Target Server Type    : MYSQL
Target Server Version : 50518
File Encoding         : 65001

Date: 2016-06-28 16:38:37
*/

SET FOREIGN_KEY_CHECKS=0;

-- ----------------------------
-- Table structure for q_test_table1
-- ----------------------------
DROP TABLE IF EXISTS q_test_table1;
CREATE TABLE q_test_table1 (
  id int(11) NOT NULL AUTO_INCREMENT,
  name varchar(255) DEFAULT NULL,
  img_id int(11) DEFAULT NULL,
  PRIMARY KEY (id)
) ENGINE=InnoDB AUTO_INCREMENT=12001 DEFAULT CHARSET=utf8;

-- ----------------------------
-- Table structure for q_test_table2
-- ----------------------------
DROP TABLE IF EXISTS q_test_table2;
CREATE TABLE q_test_table2 (
  id int(11) NOT NULL AUTO_INCREMENT,
  url varchar(255) DEFAULT NULL,
  PRIMARY KEY (id)
) ENGINE=InnoDB AUTO_INCREMENT=21001 DEFAULT CHARSET=utf8;

OK!到此,真的再见了!

  • MyBatis

    MyBatis 本是 Apache 软件基金会 的一个开源项目 iBatis,2010 年这个项目由 Apache 软件基金会迁移到了 google code,并且改名为 MyBatis ,2013 年 11 月再次迁移到了 GitHub。

    170 引用 • 414 回帖 • 400 关注

相关帖子

欢迎来到这里!

我们正在构建一个小众社区,大家在这里相互信任,以平等 • 自由 • 奔放的价值观进行分享交流。最终,希望大家能够找到与自己志同道合的伙伴,共同成长。

注册 关于
请输入回帖内容 ...
请输入回帖内容 ...

推荐标签 标签

  • 资讯

    资讯是用户因为及时地获得它并利用它而能够在相对短的时间内给自己带来价值的信息,资讯有时效性和地域性。

    54 引用 • 85 回帖 • 1 关注
  • Node.js

    Node.js 是一个基于 Chrome JavaScript 运行时建立的平台, 用于方便地搭建响应速度快、易于扩展的网络应用。Node.js 使用事件驱动, 非阻塞 I/O 模型而得以轻量和高效。

    138 引用 • 268 回帖 • 102 关注
  • ZooKeeper

    ZooKeeper 是一个分布式的,开放源码的分布式应用程序协调服务,是 Google 的 Chubby 一个开源的实现,是 Hadoop 和 HBase 的重要组件。它是一个为分布式应用提供一致性服务的软件,提供的功能包括:配置维护、域名服务、分布式同步、组服务等。

    59 引用 • 29 回帖 • 1 关注
  • 设计模式

    设计模式(Design pattern)代表了最佳的实践,通常被有经验的面向对象的软件开发人员所采用。设计模式是软件开发人员在软件开发过程中面临的一般问题的解决方案。这些解决方案是众多软件开发人员经过相当长的一段时间的试验和错误总结出来的。

    198 引用 • 120 回帖
  • 程序员

    程序员是从事程序开发、程序维护的专业人员。

    546 引用 • 3531 回帖
  • 禅道

    禅道是一款国产的开源项目管理软件,她的核心管理思想基于敏捷方法 scrum,内置了产品管理和项目管理,同时又根据国内研发现状补充了测试管理、计划管理、发布管理、文档管理、事务管理等功能,在一个软件中就可以将软件研发中的需求、任务、bug、用例、计划、发布等要素有序的跟踪管理起来,完整地覆盖了项目管理的核心流程。

    6 引用 • 15 回帖 • 166 关注
  • 招聘

    哪里都缺人,哪里都不缺人。

    189 引用 • 1056 回帖
  • IDEA

    IDEA 全称 IntelliJ IDEA,是一款 Java 语言开发的集成环境,在业界被公认为最好的 Java 开发工具之一。IDEA 是 JetBrains 公司的产品,这家公司总部位于捷克共和国的首都布拉格,开发人员以严谨著称的东欧程序员为主。

    180 引用 • 400 回帖
  • Wide

    Wide 是一款基于 Web 的 Go 语言 IDE。通过浏览器就可以进行 Go 开发,并有代码自动完成、查看表达式、编译反馈、Lint、实时结果输出等功能。

    欢迎访问我们运维的实例: https://wide.b3log.org

    30 引用 • 218 回帖 • 613 关注
  • 反馈

    Communication channel for makers and users.

    123 引用 • 908 回帖 • 221 关注
  • 博客

    记录并分享人生的经历。

    272 引用 • 2386 回帖
  • webpack

    webpack 是一个用于前端开发的模块加载器和打包工具,它能把各种资源,例如 JS、CSS(less/sass)、图片等都作为模块来使用和处理。

    41 引用 • 130 回帖 • 274 关注
  • Netty

    Netty 是一个基于 NIO 的客户端-服务器编程框架,使用 Netty 可以让你快速、简单地开发出一个可维护、高性能的网络应用,例如实现了某种协议的客户、服务端应用。

    49 引用 • 33 回帖 • 21 关注
  • 思源笔记

    思源笔记是一款隐私优先的个人知识管理系统,支持完全离线使用,同时也支持端到端加密同步。

    融合块、大纲和双向链接,重构你的思维。

    20648 引用 • 80709 回帖 • 2 关注
  • 服务

    提供一个服务绝不仅仅是简单的把硬件和软件累加在一起,它包括了服务的可靠性、服务的标准化、以及对服务的监控、维护、技术支持等。

    41 引用 • 24 回帖 • 1 关注
  • C++

    C++ 是在 C 语言的基础上开发的一种通用编程语言,应用广泛。C++ 支持多种编程范式,面向对象编程、泛型编程和过程化编程。

    106 引用 • 152 回帖 • 3 关注
  • 钉钉

    钉钉,专为中国企业打造的免费沟通协同多端平台, 阿里巴巴出品。

    15 引用 • 67 回帖 • 351 关注
  • 创业

    你比 99% 的人都优秀么?

    83 引用 • 1398 回帖
  • jsoup

    jsoup 是一款 Java 的 HTML 解析器,可直接解析某个 URL 地址、HTML 文本内容。它提供了一套非常省力的 API,可通过 DOM,CSS 以及类似于 jQuery 的操作方法来取出和操作数据。

    6 引用 • 1 回帖 • 468 关注
  • SOHO

    为成为自由职业者在家办公而努力吧!

    7 引用 • 55 回帖 • 48 关注
  • Electron

    Electron 基于 Chromium 和 Node.js,让你可以使用 HTML、CSS 和 JavaScript 构建应用。它是一个由 GitHub 及众多贡献者组成的活跃社区共同维护的开源项目,兼容 Mac、Windows 和 Linux,它构建的应用可在这三个操作系统上面运行。

    15 引用 • 136 回帖 • 10 关注
  • SMTP

    SMTP(Simple Mail Transfer Protocol)即简单邮件传输协议,它是一组用于由源地址到目的地址传送邮件的规则,由它来控制信件的中转方式。SMTP 协议属于 TCP/IP 协议簇,它帮助每台计算机在发送或中转信件时找到下一个目的地。

    4 引用 • 18 回帖 • 614 关注
  • VirtualBox

    VirtualBox 是一款开源虚拟机软件,最早由德国 Innotek 公司开发,由 Sun Microsystems 公司出品的软件,使用 Qt 编写,在 Sun 被 Oracle 收购后正式更名成 Oracle VM VirtualBox。

    10 引用 • 2 回帖 • 11 关注
  • flomo

    flomo 是新一代 「卡片笔记」 ,专注在碎片化时代,促进你的记录,帮你积累更多知识资产。

    5 引用 • 103 回帖
  • JSON

    JSON (JavaScript Object Notation)是一种轻量级的数据交换格式。易于人类阅读和编写。同时也易于机器解析和生成。

    52 引用 • 190 回帖 • 2 关注
  • Thymeleaf

    Thymeleaf 是一款用于渲染 XML/XHTML/HTML5 内容的模板引擎。类似 Velocity、 FreeMarker 等,它也可以轻易的与 Spring 等 Web 框架进行集成作为 Web 应用的模板引擎。与其它模板引擎相比,Thymeleaf 最大的特点是能够直接在浏览器中打开并正确显示模板页面,而不需要启动整个 Web 应用。

    11 引用 • 19 回帖 • 334 关注
  • Spring

    Spring 是一个开源框架,是于 2003 年兴起的一个轻量级的 Java 开发框架,由 Rod Johnson 在其著作《Expert One-On-One J2EE Development and Design》中阐述的部分理念和原型衍生而来。它是为了解决企业应用开发的复杂性而创建的。框架的主要优势之一就是其分层架构,分层架构允许使用者选择使用哪一个组件,同时为 JavaEE 应用程序开发提供集成的框架。

    942 引用 • 1459 回帖 • 96 关注