KingbaseES客户端编程开发框架-MyBatis_Plus.pdf

KingbaseES 客户端编程开发框架-MyBatis-Plus 金仓数据库管理系统 KingbaseES 文档版本：V9（V009R001C001B0024） 发布日期：2023 年 10 月 12 日 北京人大金仓信息技术股份有限公司 目 目 录 录 第 1 章 前言 1 1.1 适用读者 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 1.2 相关文档 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 1.3 术语 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 1.4 手册约定 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 第 2 章 概述 3 第 3 章 MyBatis-Plus 配置说明 4 第 4 章 MyBatis-Plus 注意点 10 版权声明 11 服务周期承诺 12 I 第 1 章 前言 1 第 章 前言 本文档描述了 KingbaseES 数据库对 MyBatis-Plus 框架的支持情况，以及如何配置它。 前言部分包含以下主题： • 适用读者 • 相关文档 • 术语 • 手册约定 1.1 适用读者 《KingbaseES MyBatis-Plus 指南》面向所有使用 KingbaseES 数据库的用户，主要是数据库管理员和应用程序 开发人员。 在开始阅读本文档之前，您需要了解以下内容： KingbaseES 客户端编程开发框架-MyBatis 1.2 相关文档 有关 MyBatis-Plus 的更多信息，请参阅以下资源： Mybatis-Plus 指南 1.3 术语 $KINGBASE_HOME ：KingbaseES 数据库的安装路径。 1 第 1 章 前言 1.4 手册约定 本文档中可能出现“注意、提示、警告、另请参阅”等标志，它们所代表的含义如下： 注意: 用于突出重要/关键信息、最佳实践等。 提示: 用于突出小窍门、捷径等。 警告: 用于传递设备或环境安全警示信息，若不避免，可能会导致设备损坏、数据丢失、设备性能降低或其 它不可预知的结果。 另请参阅: 用于突出参考、参阅等。 以下程序代码书写约定适用于本文档： 符号 说明 [] 表示包含一个或多个可选项。不需要输入中括号本身。 {} 表示包含两个以上（含两个）的候选，必须在其中选取一个。不需要输入花括号本身。 | 分割中括号或者花括号中的两个或两个以上选项。不需要输入“|”本身。 ... 表示其之前的元素可以被重复。 斜体 表示占位符或者需要提供特定值的变量。 大写 表示系统提供的元素，以便与用户定义的元素相互区分。除出现在方括号中的元素外，应当按 照顺序逐字输入。当然，部分元素在系统中是大小写不敏感的，因此用户可以根据系统说明以 小写形式输入。 小写 表示由用户提供的元素。 2 第 2 章 概述 2 第 章 概述 MyBatis-Plus 是一个 Mybatis 的增强工具，在 Mybatis 的基础上只做增强不做修改。 在本章中详细说明了 KingbaseES 对 MyBatis-Plus 的支持情况，以及使用时应该注意的问题。 3 第 3 章 MYBATIS-PLUS 配置说明 3 第 章 MyBatis-Plus 配置说明 Mybatis-Plus 的 jar 包可以从官方网站下载，Mybatis-Plus 所使用的 JDBC 包 kingbase8-9.0.0.jar 位于 $KINGBASE_HOME/Interface/jdbc 目录下。使用时将 Mybatis-Plus 包和 JDBC 包导入到项目的 Libraries 中并定义相关 配置项即可。 您还可以前往 人大金仓官网 下载 Mybatis-Plus 测试用例 。 图 3.1: Mybatis-Plus 框架结构 定义 Mybatis-Plus 配置文件，根据用户选择，更改一下配置文件。以 SpringMVC 工程整合 Mybatis-Plus3.x 为 例： a. 配置 spring 配置文件： 配置 MapperScan： 4 第 3 章 MYBATIS-PLUS 配置说明 调整 SqlSessionFactory 为 Mybatis-Plus 的 SqlSessionFactory： b. 配置实体类： @TableName(value = "tb_employee") public class Employee { @TableId(value = "id", type = IdType.AUTO) private Integer id; @TableField(value = "last_name", exist = true) private String lastName; private String email; private boolean gender; private Integer age; private Date date; public Integer getId() { return id; } 5 第 3 章 MYBATIS-PLUS 配置说明 public void setId(Integer id) { this.id = id; } public String getLastName() { return lastName; } public void setLastName(String lastName) { this.lastName = lastName; } public String getEmail() { return email; } public void setEmail(String email) { this.email = email; } public boolean isGender() { return gender; } public void setGender(boolean gender) { this.gender = gender; } public Integer getAge() { return age; } public void setAge(Integer age) { this.age = age; } public Date getDate() { return date; } public void setDate(Date date) { this.date = date; } @Override 6 第 3 章 MYBATIS-PLUS 配置说明 public String toString() { return "Employee [id=" + id + ", lastName=" + lastName + ", email=" + email + ", gender=" + gender +", age=" + age + ", date=" + date + "]"; } } c. 定义 Mapper 接口： @Mapper public interface EmplopyeeDao extends BaseMapper { } d. 在 Java 中进行表的增删改查操作： @RunWith(SpringJUnit4ClassRunner.class) @ContextConfiguration({ "classpath:spring/spring-dao.xml" }) public class test { @Autowired private DataSource dataSource; @Test public void testDataSource() throws SQLException { System.out.println(dataSource.getConnection()); } @Autowired private EmplopyeeDao emplopyeeDao; @Test public void testInsert() { Employee employee = new Employee(); employee.setLastName("tom"); employee.setEmail("dfbb@163.com"); employee.setGender(false); employee.setAge(22); employee.setDate(new Date(System.currentTimeMillis())); emplopyeeDao.insert(employee); System.out.println(employee.getId()); } @Test public void testUpdate() { Employee employee = new Employee(); 7 第 3 章 MYBATIS-PLUS 配置说明 employee.setId(1); employee.setLastName(" 更新测试"); emplopyeeDao.updateById(employee); emplopyeeDao.update(employee, null); } @Test public void testSelectById() { Employee employee = emplopyeeDao.selectById(2); System.out.println(employee.toString()); } @Test public void testSelect() { Map columnMap = new HashMap(); columnMap.put("last_name", " 更新测试"); columnMap.put("gender", false); List employees = emplopyeeDao.selectByMap(columnMap); System.out.println(employees.size()); } @Test public void testSelectByPage() { IPage employees = emplopyeeDao.selectPage(new Page(1, 5), new QueryWrapper().between("age", 18, 50).eq("gender", false).eq("last_name", " 更新测试")); System.out.println(employees); } @Test public void testDeleteById() { System.out.println(emplopyeeDao.deleteById(1)); } @Test public void testDelete() { Map columnMap = new HashMap(); columnMap.put("gender", false); columnMap.put("age", 18); emplopyeeDao.deleteByMap(columnMap); } 8 第 3 章 MYBATIS-PLUS 配置说明 @Test public void testSelectByPage1() { Integer[] ints = { 1, 18, 19, 20, 21, 22, 23, 24, 25 }; IPage employees = emplopyeeDao.selectPage(new Page(1, 5), new QueryWrapper().between("age", 18, 50).eq("gender", false).eq("last_name", " 更新测试").in(true, "age", Arrays.asList(ints))); System.out.println(employees.toString()); System.out.println(employees.getTotal()); System.out.println(employees.getPages()); System.out.println(employees.getRecords()); } } 注意: 注：Mybatis-Plus2.2.0 和 Mybatis-Plus3.1.2 均已通过版本适配的验证测试。 9 第4章 MYBATIS-PLUS 注意点 4 第 章 MyBatis-Plus 注意点 a. Mybatis-Plus2.x 和 Mybatis-Plus3.x 的包结构不同，注意引用时的包路径的区别； b. KingbaseES 适配 Mybatis-Plus 时，由于 Mybatis-Plus 无法识别 KingbaseES 数据库类型，故在相关配置中需 将其配置成 postgresql，如： 在使用分页插件时，配置方言类型为 postgresql 示例： 10 版权声明 版权声明 北京人大金仓信息技术股份有限公司（简称：人大金仓）版权所有，并保留对本手册及本声明的一切权利。 未得到人大金仓的书面许可，任何人不得以任何方式或形式对本手册内的任何部分进行复制、摘录、备份、修 改、传播、翻译成其他语言、将其全部或部分用于商业用途。 免责声明 本手册内容依据现有信息制作，由于产品版本升级或其他原因，其内容有可能变更。人大金仓保留在没有任何通 知或者提示的情况下对手册内容进行修改的权利。 本手册仅作为使用指导，人大金仓在编写本手册时已尽力保证其内容准确可靠，但并不确保手册内容完全没有错 误或遗漏，本手册中的所有信息也不构成任何明示或暗示的担保。 技术支持 • 人大金仓官方网站：http://www.kingbase.com.cn/ • 人大金仓文档中心：http://help.kingbase.com.cn/ • 全国服务热线：400-601-1188 • 人大金仓技术支持与反馈信箱：support@kingbase.com.cn 11 服务周期承诺 服务周期承诺 由于市场需求在不断变化，技术创新和发展的进程不断加剧，产品的版本更迭不可避免。人大金仓对于产品版本 生命周期的有效管理，有助于您提前规划项目，更好地从产品服务终止上过渡。 表 1: KingbaseES 产品生命周期里程碑 关键里程碑点 定义 产品发布日期 产品正式发布版本，即 GA（general availability）版本的发布日期。 停止销售日期 正式停止销售的日期，版本停止接受订单日。该日之后，产品将不再销售。 停止功能升级日期 在该日期之后，不再提供新特性和新硬件支持。但依旧提供错误修复、安全修复、功 能维护等服务。 停止功能维护日期 在该日期之后，不再维护功能，修复问题。但依旧提供安全修复等服务 停止安全维护日期 在该日期之后，不再发布补丁版本修复中高风险漏洞，仅提供有限的支持。 产品服务终止日期 停止提供产品服务和支持的日期。包括软件维护版本，缺陷修复，以及针对该产品的 所有服务支持（包括服务热线和远程/现场支持）。 服务周期策略 金仓数据库管理系统 KingbaseES 产品确保以下的服务周期： 1）产品自发布之日起至产品停止功能升级（包含新特性、新硬件支持）之日不少于 5 年。 2）产品停止功能升级之日起至产品停止功能维护（主要包括问题修复）之日不少于 4 年。 3）产品功能维护停止之日起至产品停止安全维护（包括中高风险漏洞修复）之日不少于 2 年。 服务终止策略 金仓数据库管理系统 KingbaseES 产品确保在销售后，至少提供 6 年的服务支持。 注意: 人大金仓将会综合各方因素来确定产品服务终止日期。并将在实际产品服务终止日期之前至少 90 天，通过公 12 服务周期承诺 开方式宣布产品服务终止日期。 13