Mybatis的初级使用
文章目录
前言
记录学习mybatis的内容,用于以后查看。
一、配置文件
- 首先在pom.xml文件中加入依赖。代码如下:
<dependencies>
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.9</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.46</version>
</dependency>
</dependencies>
- 然后在resource目录下创建mybatis的配置文件。代码如下:
<?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>
<typeAliases>
<package name="org.example.dao"/>
</typeAliases>
<environments default="development"> <!--通过default = id 来选择生效的环境 -->
<environment id="development">
<transactionManager type="JDBC"/>
<!-- 配置数据源 -->
<dataSource type="POOLED">
<property name="driver" value="com.mysql.jdbc.Driver"/>
<property name="url" value="jdbc:mysql:///mybatis?useSSL=false"/>
<property name="username" value="root"/>
<property name="password" value="123456"/>
</dataSource>
</environment>
</environments>
<!-- 配置映射文件 -->
<mappers>
<mapper resource="org/example/Mapper/UserMapper.xml"/>
<mapper resource="org/example/Mapper/BrandMapper.xml"/>
</mappers>
</configuration>
- 配置映射文件。此次是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">
<mapper namespace="org.example.Mapper.UserMapper">
<!-- 查询usersinf表的所有内容 -->
<select id="selectAllUser" resultType="org.example.dao.Users">
select * from usersinf
</select>
<!-- 带参查询 , 参数是根据形参位置输入-->
<insert id="insertOneUser" parameterType="Users">
insert into usersinf(username, passwd) values (#{param1},#{param2})
</insert>
</mapper>
二、使用步骤
1.创建POJO类
代码如下(示例):
public class Users {
private Integer user_id;
private String username;
private String passwd;
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 getPasswd() {
return passwd;
}
public void setPasswd(String passwd) {
this.passwd = passwd;
}
@Override
public String toString() {
return "Users{" +
"user_id=" + user_id +
", username='" + username + '\'' +
", passwd='" + passwd + '\'' +
'}';
}
}
2.创建测试方法,查询SQL数据
- 直接调用UserMapper.xml文件中的sql语句。代码如下(示例):
public static void main(String[] args) {
// 读取mybatis配置文件,并获取sqlSession
String resource = "mybatis-config.xml";
InputStream inputStream = null;
try {
inputStream = Resources.getResourceAsStream(resource);
} catch (IOException e) {
throw new RuntimeException(e);
}
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
SqlSession sqlSession = sqlSessionFactory.openSession();
// 第一种使用方式,使用UserMapper.xml中的namespace+id的方式调用
List<Users> list = sqlSession.selectList("org.example.Mapper.UserMapper.selectAllUser");
System.out.println(list);
sqlSession.close();
}
- 使用Mapper映射的形式。使用Mapper映射有三个前提条件:
- 需创建一个与Mapper文件同名的接口,将namespace赋值为Mapper接口的路径。
<mapper namespace="org.example.Mapper.UserMapper"></mapper>
- 接口内要声明一个方法,方法名是Mapper文件中sql语句对应的id。
代码如下:
public interface UserMapper {
List<Users> selectAllUser();
// 函数名为UserMapper.xml中的id,参数类型要与MySQL中的字段一致
Boolean insertOneUser(String username, String passwd);
}
- 该接口和Mapper文件在编译后须在同一文件夹下。
解决方法:在resource目录下建立一个与同名接口相同目录,这样在编译后就会在同一目录下。
举例:UserMapper接口在src.main.java.org.example.Mapper目录下。那么,UserMapper.xml文件就应该放在src.main.resources.org.example.Mapper目录下。
测试方法的代码如下:
public static void main(String[] args) {
// 读取mybatis配置文件
String resource = "mybatis-config.xml";
InputStream inputStream = null;
try {
inputStream = Resources.getResourceAsStream(resource);
} catch (IOException e) {
throw new RuntimeException(e);
}
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
// 获取sqlSession对象
SqlSession sqlSession = sqlSessionFactory.openSession();
//第二种使用方式,Mapper代理开发
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
// 向users表插入一条数据
Boolean bool = mapper.insertOneUser("小U", "123456");
System.out.println(bool);
// 查询整个users表
List<Users> list = mapper.selectAllUser();
System.out.println(list);
sqlSession.close();
}
- 解决查询结果不为空,但在控制台上显示是null。
原因:SQL的字段名与你所创建的POJO类中的成员变量名不一致。
解决方法:
- 改成同名即可。但耦合程度高,也不符合Java的驼峰命名方式。
- 取别名。SQL查询语句使用 as 对字段取与成员变量相同的别名,这样名字就一致了。但麻烦,每写一条查询语句就要重写一次。
- 使用SQL片段。将相同的部分拿出来。代码如下:
<mapper namespace="org.example.Mapper.BrandMapper">
<!-- 引入SQL片段 -->
<sql id="test">
id, brand_name as brandName, company_name as companyName, ordered, description, status
</sql>
<select id="getAllInfo" resultType="Brand">
select <include refid="test"/> from tb_btand;
</select>
</mapper>
缺点:仍然不是很灵活,如果相同的部分不一样(仅查询brand_name 和 company_name),就需要再写一条sql片段。
4. 使用resultMap形成数据库中表和POJO类的映射。代码如下:
<mapper namespace="org.example.Mapper.BrandMapper">
<!-- id是唯一标识,type是对应的POJO类-->
<resultMap id="brand" type="Brand">
<!-- 映射名字不一样的属性-->
<result column="brand_name" property="brandName"/>
<result column="company_name" property="companyName"/>
</resultMap>
<select id="getAllInfo" resultMap="brand">
select
*
from tb_btand;
</select>
</mapper>
3.创建测试方法,插入SQL数据
从这开始,我使用的都是Mapper映射的方式。
- 在UserMapper.xml中编写SQL代码。
<!-- 向userinfo表中插入一条数据,返回添加数据的主键,并将值赋给传入对象的user_id-->
<insert id="insertOneUser" useGeneratedKeys="true" keyProperty="user_id">
insert into usersinf(username, passwd) values (#{username},#{passwd})
</insert>
- 在UserMapper接口中声明方法。
public interface UserMapper {
List<Users> selectAllUser();
// 函数名为UserMapper.xml中的id,传参类型是一个Users对象,Integer返回值仅代表插入是否成功
Integer insertOneUser(Users users);
List<Users> selectByCondition(Users users);
List<Users> selectByOne(Users users);
}
- 编写测试方法,仅展示部分代码。
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
// 向users表插入一条数据
Users users = new Users();
users.setUsername(name);
users.setPasswd(passwd);
// 调用UsersMapper接口方法
mapper.insertOneUser(users);
// 返回插入数据的主键
System.out.println(users.getUser_id());
// 查询整个users表
List<Users> list = mapper.selectAllUser();
System.out.println(list);
注意事项:
- 在创建sqlSession对象时,使用的sqlSessionFactory.openSession()方法默认开启事务,即每次插入数据后,需要我们手动sqlSession.commit(),不然数据库会回滚我们修改的记录。
- 想要在插入数据后接收到插入数据的主键,首先传递的参数得是对象(基本数据类型是值传递)。其次,得在< insert >标签中写useGeneratedKeys=“true” 和 keyProperty=“你指定的对象的成员变量”。
4.创建测试方法,更新SQL数据
- 在UserMapper.xml中编写SQL语句。标签的介绍在第六部分。
<!-- 根据传入的user_id来动态更新userinf表的username 和 passwd字段-->
<update id="updateUsersById">
update usersinf
<set>
<if test="username != null and username != ''">
username = #{username},
</if>
<if test="passwd != null and passwd != ''">
passwd = #{passwd}
</if>
</set>
where user_id = #{user_id}
</update>
- 在UserMapper接口中定义方法。Users类的定义在第一部分。
public interface UserMapper {
// 查询所有数据
List<Users> selectAllUser();
//根据传入的users.user_id来修改数据,返回结果代表影响了几条数据
Integer updateUsersById(Users users);
}
- 编写测试方法。仅部分代码,sqlSession对象的获取在前面的部分讲了。
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
// 向users表插入一条数据
Users users = new Users();
users.setUser_id(2);
users.setUsername(name);
users.setPasswd(passwd);
// 更新主键id=2的数据,将userinf表的username改成name的值,userinf表的passwd改成passwd的值
mapper.updateUsersById(users);
// 查询整个users表
List<Users> list = mapper.selectAllUser();
System.out.println(list);
5.创建测试方法,删除SQL数据
- 在UserMapper.xml文件中编写SQL语句。标签介绍在第六部分。
<!-- 删除userinf表中user_id处于传入参数的数据-->
<delete id="deleteByUser_id">
delete from usersinf
where user_id in
<!-- 案例: 假如user_ids有3项,则最终结果为(user_id1, user_id2, user_id3) -->
<foreach collection="user_ids" item="user_id" open="(" separator="," close=")">
#{user_id}
</foreach>
</delete>
- 在UserMapper接口中定义方法。
public interface UserMapper {
// 查询所有
List<Users> selectAllUser();
// 根据输入的id数组来批量删除数据
void deleteByUser_id(@Param("user_ids") Integer[] userids);
}
- 编写测试方法。
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
// 定义id数组
Integer[] user_ids = {1,2,4};
// 删除数据
mapper.deleteByUser_id(user_ids);
// 查询整个userinf表
List<Users> list = mapper.selectAllUser();
System.out.println(list);
6.动态SQL
- 动态输入多条件。
- < if test = “条件”></ if>:判断条件是否满足,若满足则执行if中间的内容。
- < where >:动态判断 从where关键字开始后面的内容是否满足规则。若不满足,则自动帮你修改。例:在用< if >时,很容易出现 where 后面直接接 and 的情况。< where >检测到这种情况时,会自动帮你去掉and关键字。
举例代码:
查询usersinf表,若传入的username不为null,则SQL语句加上“ and username like #{username} ”。若传入的passwd不为null,则SQL语句加上“ and passwd like #{passwd} ”。如果都为空,则< where > 标签帮你自动去掉where关键字。
<!-- 根据不同的字段进行查询, 可以是部分字段-->
<select id="selectByCondition" resultMap="users">
select * from usersinf
<where>
<if test="username != null">
and username like #{username}
</if>
<if test="passwd != null">
and passwd like #{passwd}
</if>
</where>
</select>
- 从多条件中选择一个条件
- < choose ></ choose >:功能类似于Java中的switch
- < when test = “条件”></ when>:功能类似于Java中的case
- < otherwise ></ otherwise>:功能类似于Java中的default
举例代码:
<select id="selectByOne" resultMap="users">
select * from usersinf
<where>
<choose>
<when test="username != null and username != ''">
and username like #{username}
</when>
<when test="passwd != null and passwd != ''">
and passwd like #{passwd}
</when>
</choose>
</where>
</select>
- 更新数据
- < set ></ set>:用处于< where >类似,都是自动修改不满足规则的内容。
- < foreach collection=“集合对象 or 数组” item = “单项” open = “最开始的字符串” end = “结尾的字符串” separator = “单项之间的分隔符”></ foreach>:读取collection中的每一项,最左边用open拼接,最右边用end拼接,中间用separator分割。
7. 参数传递
- 单个参数的传递
- POJO类:直接使用,需要保持成员变量名与SQL中的占位符名字保持一致。
- Map类:直接使用,需要保持键名与SQL中的占位符名字保持一致。
- Collection:会被封装成Map集合。键名为collection或arg0。可以通过@param注解代替arg0名称。
- List:会被封装成Map集合。键名为collection、list或arg0。可以通过@param注解代替arg0名称。
- Array:会被封装成Map集合。键名为array或arg0。可以通过@param注解代替arg0名称。
- 其他类型:直接使用,取啥名都行。
- 多个参数的传递:均会被封装成Map集合。键名为arg0、arg1、… 和 param1、param2、…,可以通过@param注解来代替这些名称。
- 参数的返回:普通类型和POJO类我就不讲了,直接在xml文件中的resultType或resultMap中声明返回的类型就行了。这里主要讲不是很常用的。
-
Map<String, Object>:在xml文件中声明返回值类型为Map类型后,返回的数据中key是表的字段名,value是表的数据。(注意:这里指的是一行数据,毕竟key不能重复)
-
List<Map<String, Object>>:返回多条数据,每一条数据形成一个Map。
-
@MapKey(value = “字段名”):返回多条数据,将原本返回成Map类型的数据外又封装了一层Map。以声明的字段名作为key,整个Map作为value。
8. 缓存管理
1.一级缓存
- 默认开启
- 级别:sqlSession
- 用处:当用同一个sqlSession去查询数据时,只要中间没有发生过增删改操作,那么下一次使用相同的语句查询时会从缓存中直接调用,而不会去访问数据库。
- 失效条件:
1 使用了另一个sqlSession
2 第二次查询前,进行了增删改操作
3 查询条件不同
4 主动清空了缓存(sqlSession.clearCache())
2.二级缓存
-
需要手动开启。
1 在xml文件中< set></ set>配置全局属性enablecache=true
2 在对应的Mapper.xml中加入< cache/>
3 相应的实体类需要实现序列化serializable -
级别:sqlSessionFactory
-
需要在sqlSession关闭或提交后生效
-
失效条件:进行了增删改操作
3.缓存顺序
- 先进行查询二级缓存
- 再进行查询一级缓存
- 再进行查询数据库
- sqlSession关闭后,一级缓存会写进二级缓存
总结
以上就是我记录学习Mybatis的内容。