😀前言
在实际的软件开发过程中,我们常常会遇到实体类属性名和数据库表字段名不一致的问题,这时就需要我们采取一些策略来解决这个问题以保证程序的正常运行。一种常用的策略就是使用MyBatis框架来进行操作,其中涉及到一些高级特性,比如使用
HashMap
来传递参数,以及使用resultMap
来完成复杂的结果映射。在这个教程中,我们将会详细地探讨如何通过使用HashMap来灵活地处理查询参数,包括如何创建和测试与HashMap相关的方法。同时,我们也会学习到如何利用
resultMap
来解决字段映射的问题。
🧑个人简介:大家好,我是尘觉,希望我的文章可以帮助到大家,您的满意是我的动力😉😉
灵活的数据库查询:在MyBatis中使用HashMap
官方文档
文档地址: https://mybatis.org/mybatis-3/zh/sqlmap-xml.html
XxxMapper.xml-基本介绍
MyBatis 的真正强大
在于它的语句映射(在XxxMapper.xml 配置), 由于它的异常强大, 如果拿它跟具有相同功能的 JDBC 代码进行对比,你会立即发现省掉了将近 95% 的代码。 MyBatis 致力于减少使用成本,让用户能更专注于 SQL 代码。
2、SQL 映射文件
常用的几个顶级元素(按照应被定义的顺序列出):
cache – 该命名空间的缓存配置。
cache-ref – 引用其它命名空间的缓存配置。
resultMap – 描述如何从数据库结果集中加载对象,是最复杂也是最强大的元素。
parameterType - 将会传入这条语句的参数的类全限定名或别名
sql – 可被其它语句引用的可重用语句块。
insert – 映射插入语句。
update – 映射更新语句。
delete – 映射删除语句。
select – 映射查询语句。
XxxMapper.xml-详细说明
1. insert、delete、update、select 这个我们在前面讲解过,分别对应增删改查的方法和SQL语句的映射.
2. 如何获取到刚刚添加的 Monster 对象的 id 主键 [前面使用过了]
因为这是一个宁外开了一个项目所以做一下前期准备
将需要的文件/资源拷贝过来(这里我们拷贝Monster.java、resources和jdbc.properties 和 mybatis-config.xml)
创建 MonsterMapper.java MonsterMapper.xml 和 MonsterMapperTest.java , 做一个比较干净的讲解环境
Monster.java
package com.wyxedu.entity; import java.util.Date; /** * Monster 和 monster表有对应关系 * 体现OOP */ //解读 //1. 一个普通的Pojo类 //2. 使用原生态的sql语句查询结果还是要封装成对象 //3. 要求大家这里的实体类属性名和表名字段保持一致。 public class Monster { //属性-和表字段有对应关系 private Integer id; private Integer age; private String name; private String email; private Date birthday; private double salary; private Integer gender; public Monster() { } public Monster(Integer id, Integer age, String name, String email, Date birthday, double salary, Integer gender) { this.id = id; this.age = age; this.name = name; this.email = email; this.birthday = birthday; this.salary = salary; this.gender = gender; } }
MonsterMapper接口
MonsterMapper .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"> <!--解读 1. 这是一个mapper xml 文件 2. 该文件可以去实现对应的接口的方法 3. namespace 指定该xml文件和哪个接口对应!!! --> <mapper namespace="com.wyxedu.mapper.MonsterMapper"> </mapper>
MonsterMapperTest.java
注意这里的get set 和tostring大家自己生成一下或者使用注解@set @get 和快捷键生成tostring
public class MonsterMapperTest { //属性 private SqlSession sqlSession; private MonsterMapper monsterMapper; //初始化 @Before public void init() { sqlSession = MyBatisUtils.getSqlSession(); monsterMapper = sqlSession.getMapper(MonsterMapper.class); System.out.println("monsterMapper=" + monsterMapper.getClass()); } }
jdbc.properties
jdbc.driver=com.mysql.jdbc.Driver jdbc.url=jdbc:mysql://127.0.0.1:3306/mybatis?useSSL=true&useUnicode=true&characterEncoding=UTF-8//注意这里填自己的 jdbc.user=root jdbc.pwd=123456//注意这里填自己的
mybatis-config.xml
<?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "http://mybatis.org/dtd/mybatis-3-config.dtd"> <configuration> <!--引入外部的jdbc.properties--> <properties resource="jdbc.properties"/> <!--配置MyBatis自带的日志输出-查看原生的sql--> <settings> <setting name="logImpl" value="STDOUT_LOGGING"/> </settings> <!--配置别名--> <typeAliases> <!--<typeAlias type="com.wyxedu.entity.Monster" alias="Monster"/>--> <!-- 如果一个包下有很多的类,我们可以直接引入包,这样 该包下面的所有类名,可以直接使用 --> <package name="com.wyxedu.entity"/> </typeAliases> <environments default="development"> <environment id="development"> <!--配置事务管理器--> <transactionManager type="JDBC"/> <!--配置数据源 解读 1. 我们使用外部的properties文件来设置相关的值 2. 这个属性文件,需要统一的放在 resources目录/类加载路径 3. 关于属性文件,在讲解java基础-集合 --> <dataSource type="POOLED"> <!--配置驱动--> <!--<property name="driver" value="com.mysql.jdbc.Driver"/>--> <property name="driver" value="${jdbc.driver}"/> <!--配置连接mysql-url 解读: 1. jdbc:mysql 协议 2. 127.0.0.1:3306 : 指定连接mysql的ip+port 3. mybatis: 连接的DB 4. useSSL=true 表示使用安全连接 5. & 表示 & 防止解析错误 6. useUnicode=true : 使用unicode 作用是防止编码错误 7. characterEncoding=UTF-8 指定使用utf-8, 防止中文乱码 8. 温馨提示:不要背,直接使用即可 --> <property name="url" value="${jdbc.url}"/> <property name="username" value="${jdbc.user}"/> <property name="password" value="${jdbc.pwd}"/> </dataSource> </environment> </environments> <!--说明 1. 这里我们配置需要关联的Mapper.xml 2. 这里我们可以通过菜单 Path from source root --> <mappers> <!--<mapper resource="com/wyxedu/mapper/MonsterMapper.xml"/>--> <!--解读 1. 如果是通过注解的方式,可不再使用 MonsterMapper.xml 2. 但是需要在mybatis-config.xml注册/引入含注解的类 3. 如果没有引入,不能使用 --> <!--<mapper class="com.wyxedu.mapper.MonsterAnnotation"/>--> <!-- 解读 1. 当一个包下有很多的Mapper.xml文件和基于注解实现的接口时, 为了方便,我们可以以包方式进行注册 2. 将下面的所有xml文件和注解接口 都进行注册 --> <package name="com.wyxedu.mapper"/> </mappers> </configuration>
parameterType(输入参数类型)
1. 传入简单类型,比如按照id 查Monster(前讲过)
2. 传入POJO 类型,查询时需要有多个筛选条件
3. 当有多个条件时,传入的参数就是Pojo 类型的Java 对象,比如这里的Monster 对象
4. 当传入的参数类是String 时,也可以使用 ${} 来接收参数
parameterType-应用案例
案例1:请查询 id = 1 或者 name = '白骨精' 的妖怪
案例2:请查询 name 中 包含 "牛魔王" 的妖怪1
修改 MonsterMapper.java, 增加方法接口
public interface MonsterMapper { //通过id 或者名字查询 public List<Monster> findMonsterByNameORId(Monster monster); //查询名字中含义'精'妖怪 public List<Monster> findMonsterByName(String name); }
修改 MonsterMapper.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"> <!--解读 1. 这是一个mapper xml 文件 2. 该文件可以去实现对应的接口的方法 3. namespace 指定该xml文件和哪个接口对应!!! --> <mapper namespace="com.wyxedu.mapper.MonsterMapper"> <!-- 1. 配置/实现public List<Monster> findMonsterByNameORId(Monster monster); 2. 通过id 或者名字查询 3. `id` = #{id} `id`表示表的字段名 #{id} 中的id表示你传入的Monster对象的属性名 --> <select id="findMonsterByNameORId" parameterType="Monster" resultType="Monster"> SELECT * FROM `monster` WHERE `id` = #{id} OR `name` = #{name} </select> <!-- 1. 配置/实现 public List<Monster> findMonsterByName(String name); 2. 请查询 name 中 包含 "牛魔王" 的妖怪 - 是模糊查询 3. 模糊查询的使用 取值 需要 ${value} 取值 --> <select id="findMonsterByName" parameterType="String" resultType="Monster"> SELECT * FROM `monster` WHERE `name` LIKE '%${name}%' </select> </mapper>
修改 MonsterMapperTest.java ,完成测试
package com.wyxedu.mapper; import com.wyxedu.entity.Monster; import com.wyxedu.util.MyBatisUtils; import org.apache.ibatis.session.SqlSession; import org.junit.Before; import org.junit.Test; import java.util.HashMap; import java.util.List; import java.util.Map; public class MonsterMapperTest { //属性 private SqlSession sqlSession; private MonsterMapper monsterMapper; //初始化 @Before public void init() { sqlSession = MyBatisUtils.getSqlSession(); monsterMapper = sqlSession.getMapper(MonsterMapper.class); System.out.println("monsterMapper=" + monsterMapper.getClass()); } @Test public void findMonsterByNameORId() { Monster monster = new Monster(); monster.setId(1); monster.setName("狐狸精-100"); List<Monster> monsters = monsterMapper.findMonsterByNameORId(monster); for (Monster m : monsters) { System.out.println("m-" + m); } if (sqlSession != null) { sqlSession.close(); } System.out.println("操作成功~"); } @Test public void findMonsterByName() { List<Monster> monsters = monsterMapper.findMonsterByName("精"); for (Monster monster : monsters) { System.out.println("monster--" + monster); } if (sqlSession != null) { sqlSession.close(); } System.out.println("操作成功~"); } }
传入HashMap
1. HashMap 传入参数更加灵活,比如可以灵活的增加查询的属性,而不受限于 Monster 这个 Pojo 属性本身
2. 演示如何遍历一个 List> 的数据类型
要求:声明一个方法,按传入参数是 HashMap 的方式,查询 id > 10 并且 salary 大于 40的所有妖怪
修改 MonsterMapper.java, 增加方法接口
//查询 id > 10 并且 salary 大于 40, 要求传入的参数是HashMap public List<Monster> findMonsterByIdAndSalary_PrameterHashMap(Map<String, Object> map);
修改 MonsterMapper.xml
<!-- 1. 配置/实现public List<Monster> findMonsterByIdAndSalary_PrameterHashMap(Map<String, Object> map); 2. id > 10 并且 salary 大于 40, 要求传入的参数是HashMap 3. 如果是以map形式传入参数,当你这样写条件 `id` > #{id} 表示你的map 中有一个k-v 中 key是id --> <select id="findMonsterByIdAndSalary_PrameterHashMap" parameterType="map" resultType="Monster"> SELECT * FROM `monster` WHERE `id` > #{id} AND `salary` > #{salary} </select>
修改 MonsterMapperTest.java 进行测试
@Test public void findMonsterByIdAndSalary_PrameterHashMap() { //Diamond types are not supported at language level '5' //如何解决.=> 在pom.xml文件中指定编译器版本 /* <!--指定Maven编译器 和 jdk版本--> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <maven.compiler.source>1.8</maven.compiler.source> <maven.compiler.target>1.8</maven.compiler.target> <java.version>1.8</java.version> </properties> */ Map<String, Object> map = new HashMap<>(); map.put("id", 10); map.put("salary", 40); List<Monster> monsters = monsterMapper.findMonsterByIdAndSalary_PrameterHashMap(map); for (Monster monster : monsters) { System.out.println("monster--" + monster); } if (sqlSession != null) { sqlSession.close(); } System.out.println("操作成功~"); }
传入和返回 HashMap- 应用实例
要求:将上面的方法的改成返回参数也以 HashMap 的类型
修改 MonsterMapper.java
//查询 id > 10 并且 salary 大于 40, 要求传入的参数是HashMap public List<Map<String, Object>> findMonsterByIdAndSalary_PrameterHashMap_ReturnHashMap(Map<String, Object> map);
修改 MonsterMapper.xml
<!-- 1. 配置/实现 public List<Map<String, Object>> findMonsterByIdAndSalary_PrameterHashMap_ReturnHashMap(Map<String, Object> map); 2. id > 10 并且 salary 大于 40, 要求传入的参数和返回的是HashMap --> <select id="findMonsterByIdAndSalary_PrameterHashMap_ReturnHashMap" parameterType="map" resultType="map"> SELECT * FROM `monster` WHERE `id` > #{id} AND `salary` > #{salary} </select>
修改 MonsterMapperTest.java
@Test public void findMonsterByIdAndSalary_PrameterHashMap_ReturnHashMap() { Map<String, Object> map = new HashMap<>(); map.put("id", 10); map.put("salary", 40); List<Map<String, Object>> monsterList = monsterMapper.findMonsterByIdAndSalary_PrameterHashMap_ReturnHashMap(map); //取出返回的结果-以map取出 //回顾java基础,map遍历 for (Map<String, Object> monsterMap : monsterList) { //System.out.println("monsterMap-" + monsterMap); //遍历monsterMap(方式1) ,取出属性和对应值 //Set<String> keys = monsterMap.keySet(); //for (String key : keys) { // System.out.println(key + "=>" + monsterMap.get(key)); //} //遍历monsterMap(方式2) ,取出属性和对应值 for (Map.Entry<String, Object> entry : monsterMap.entrySet()) { System.out.println(entry.getKey() + "==>" + entry.getValue()); } System.out.println("------------------------"); } if (sqlSession != null) { sqlSession.close(); } System.out.println("操作成功~"); }
resultMap(结果集映射)
基本介绍
当实体类的属性和表的字段名字不一致时,我们可以通过 resultMap 进行映射,从而屏蔽实体类属性名和表的字段名的不同
创建表 user
CREATE TABLE `user`( `user_id` INT NOT NULL AUTO_INCREMENT, `user_email` VARCHAR(255) DEFAULT '', `user_name` VARCHAR(255) DEFAULT '', PRIMARY KEY (`user_id`) )CHARSET=utf8
创建User.java
package com.wyxedu.entity; public class User { private Integer user_id; private String username; private String useremail; public Integer getUser_id() { return user_id; } public void setUser_id(Integer user_id) { this.user_id = user_id; } public String getUsername() { return username; } public void setUsername(String username) { this.username = username; } public String getUseremail() { return useremail; } public void setUseremail(String useremail) { this.useremail = useremail; } @Override public String toString() { return "User{" + "user_id=" + user_id + ", username='" + username + '\'' + ", useremail='" + useremail + '\'' + '}'; } }
创建UserMapper.java接口
public interface UserMapper { //添加方法 public void addUser(User user); //查询所有的User public List<User> findAllUser(); }
mybatis-co nfig.xml, 改变别名的写法
<typeAliases> <!-- 为某个 mapper指定一个别名, 下面可以在 XxxxxMapper.xml 做相应简化处理 --> <!-- <typeAlias type="com.hspedu.entity.Monster" alias="Monster"/> --> <!--<typeAlias type="com.wyxedu.entity.Monster" alias="Monster"/>--> <!-- 如果一个包下有很多的类,我们可以直接引入包,这样 该包下面的所有类名,可以直接使用 --> <package name="com.wyxedu.entity"/> </typeAliases>
创建UserMapper.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"> <!--解读 1. 这是一个mapper xml 文件 2. 该文件可以去实现对应的接口的方法 3. namespace 指定该xml文件和哪个接口对应!!! --> <mapper namespace="com.wyxedu.mapper.UserMapper"> <!-- 1、配置方法public void addUser(User user); 2、完成添加用户的任务, 注意这里user属性和表的字段名不一致 --> <insert id="addUser" parameterType="User"> INSERT INTO `user` (`user_email`,`user_name`) VALUE (#{useremail}, #{username}) </insert> <!-- 1. 配置方法public List<User> findAllUser(); 2. 返回所有的user信息 3. 按照传统的方式完成,会出现什么问题?=> 如果对象属性名和表字段相同时,就会设置值, 如果不同, 就会是默认值 4. 我们可以使用resultMap来解决 5. resultMap : 表示我们要定义一个resultMap 6. id="findAllUserMap" => id 就是程序员指定的resultMap id ,后面通过id可以使用他 7. type="User" , 就是你需要返回的对象类型 8. result column="user_email" property="useremail": column="user_email" 表的字段名, property="useremail" 对象属性名 9. resultMap="findAllUserMap" 表示使用我们定义的 resultMap , 通过id关联 --> <resultMap id="findAllUserMap" type="User"> <result column="user_email" property="useremail"/> <result column="user_name" property="username"/> </resultMap> <select id="findAllUser" resultMap="findAllUserMap"> SELECT * FROM `user` </select> <!--使用表字段别名,来解决表的字段名和对象属性名,不一致问题, 可以用,但是我们仍然推荐使用resultmap--> <!--<select id="findAllUser" resultType="User">--> <!-- SELECT user_id ,user_name AS username,user_email AS useremail FROM `user`--> <!--</select>--> </mapper>
完成测试 创建UserMapperTest 类
package com.wyxedu.mapper; import com.wyxedu.entity.User; import com.wyxedu.util.MyBatisUtils; import org.apache.ibatis.session.SqlSession; import org.junit.Before; import org.junit.Test; import java.util.List; public class UserMapperTest { //属性 private SqlSession sqlSession; private UserMapper userMapper; //初始化 @Before public void init() { sqlSession = MyBatisUtils.getSqlSession(); userMapper = sqlSession.getMapper(UserMapper.class); } @Test public void addUser() { User user = new User(); user.setUsername("jack"); user.setUseremail("jack@qq.com"); userMapper.addUser(user); //如果是增删改, 需要commit() if(sqlSession != null) { sqlSession.commit(); sqlSession.close(); } System.out.println("操作OK~"); } @Test public void findAllUser() { List<User> users = userMapper.findAllUser(); for (User user : users) { System.out.println("user--" + user); } if(sqlSession != null) { sqlSession.close(); } System.out.println("操作OK~"); } }
注意事项和细节
1、解决表字段和对象属性名不一致, 也支持使用字段别名
实现 findAllUser【使用别名 屏蔽属性名和字段名不一致 1.可以用,但是复用性不 ok】
如果是 MyBatis-Plus 处理就比较简单, 可以使用 注解@TableField 来解决实体字段名和表字段名不一致的问题,还可以使用@TableName 来解决 实体类名和表名不一致的问题
😄总结
通过本次教程,我们深入理解了如何使用HashMap来处理灵活的查询参数,实现了通过传入HashMap来灵活增加查询的属性而不受限于POJO属性本身的目标。我们还探讨了如何遍历一个具有特定数据类型的List>。
我们成功实现了几个不同的方法来查询满足特定条件的数据,以及使用HashMap来获取返回结果。在这个过程中,我们还学会了如何使用resultMap来完成结果集的映射,尤其是在实体类属性和表字段名不一致时,它展示了其强大的功能。
通过实现和测试这些方法,我们可以看到使用HashMap和resultMap不仅可以使代码更灵活,也可以提高代码的可维护性和可读性。
希望通过这个教程,你已经掌握了使用MyBatis进行数据库操作的高级技巧,可以在你的项目中灵活应用这些技巧来解决实际问题。在实际应用中,你还可以探索更多MyBatis的高级特性来进一步优化你的代码。
文章到这里就结束了,如果有什么疑问的地方请指出,诸佬们一起来评论区一起讨论😁 希望能和诸佬们一起努力,今后我们一起观看感谢您的阅读🍻 如果帮助到您不妨3连支持一下,创造不易您们的支持是我的动力🤞