Mybatis注解开发
1 mybatis注解开发的环境搭建
mybatis 的常用注解说明,如下所示
@Insert:实现新增
@Update:实现更新
@Delete:实现删除
@Select:实现查询
@Result:实现结果集封装
@Results:可以与@Result一起使用,封装多个结果集
@ResultMap:实现引用@Results 定义的封装
@One:实现一对一结果集封装
@Many:实现一对多结果集封装
@SelectProvider: 实现动态SQL映射
@CacheNamespace:实现注解二级缓存的使用
1.打开IDEA工具如图所示的界面,点击Create New Project。
2.选择Maven工程和JDK的版本,点击Next。如图所示:
3.填写项目名称和保存的地址,并点击Finish。如图所示:
4.导入相应依赖jar包的代码如下:
<?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.txw</groupId>
<artifactId>day04_03annotation_mybatis</artifactId>
<version>1.0-SNAPSHOT</version>
<!--打包的方式-->
<packaging>jar</packaging>
<dependencies>
<!--导入mybatis的依赖jar包的坐标-->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.4.5</version>
</dependency>
<!--导入mysql的依赖jar包的坐标-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.6</version>
</dependency>
<!--导入log4j的依赖jar包的坐标-->
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.17</version>
</dependency>
<!--导入junit的依赖jar包的坐标-->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.13</version>
<scope>test</scope>
</dependency>
<!--导入lombok的依赖jar包的坐标-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.12</version>
</dependency>
</dependencies>
</project>
5.编写用户实体类的代码如下:
package com.txw.domain;
import lombok.Data;
import lombok.ToString;
import java.io.Serializable;
import java.util.Date;
/**
* 用户的实体类
* @author:Adair
* @QQ:1578533828
*/
@Data // 自动生成set和get方法
@ToString // 重写toString方法
@SuppressWarnings("all") // 注解警告信息
public class User implements Serializable {
private Integer id; // 用户的id
private String username; // 用户的名称
private String address; // 用户的地址
private String sex; // 用户的性别
private Date birthday; // 用户的地址
}
6.编写用户实体类持久层接口的代码如下:
package com.txw.dao;
import com.txw.domain.User;
import org.apache.ibatis.annotations.Select;
import java.util.List;
/**
* 用户实体类持久层接口
* 在mybatis中针对,CRUD一共有四个注解
* @Select @Insert @Update @Delete
* @author:Adair
* @QQ:1578533828
*/
@SuppressWarnings("all") // 注解警告信息
public interface UserDao {
/**
* 查询所有用户
* @return
*/
@Select("select * from user")
List<User> findAll();
}
7.在resources目录下创建jdbcConfig.properties的代码如下:
jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://192.168.59.130:3306/mybatis?characterEncoding=utf-8
jdbc.username=root
jdbc.password=123456
8.在resources目录下创建SqlMapConfig.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>
<!-- 引入外部配置文件-->
<properties resource="jdbcConfig.properties"></properties>
<!--配置别名-->
<typeAliases>
<package name="com.txw.domain"></package>
</typeAliases>
<!-- 配置环境-->
<environments default="mysql">
<environment id="mysql">
<transactionManager type="JDBC"></transactionManager>
<dataSource type="POOLED">
<property name="driver" value="${jdbc.driver}"></property>
<property name="url" value="${jdbc.url}"></property>
<property name="username" value="${jdbc.username}"></property>
<property name="password" value="${jdbc.password}"></property>
</dataSource>
</environment>
</environments>
<!-- 指定带有注解的dao接口所在位置 -->
<mappers>
<package name="com.txw.dao"/>
</mappers>
</configuration>
2 mybatis注解开发测试和使用注意事项
1.编写测试的代码如下:
package com.txw.test;
import com.txw.dao.UserDao;
import com.txw.domain.User;
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import java.io.InputStream;
import java.util.List;
/**
* 注解测试
* @author:Adair
* @QQ:1578533828
*/
@SuppressWarnings("all") // 注解警告信息
public class MybatisAnnoTest {
/**
* 测试基于注解的mybatis使用
* @param args
*/
public static void main(String[] args) throws Exception{
// 1.获取字节输入流
InputStream in = Resources.getResourceAsStream("SqlMapConfig.xml");
// 2.根据字节输入流构建SqlSessionFactory
SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(in);
// 3.根据SqlSessionFactory生产一个SqlSession
SqlSession session = factory.openSession();
// 4.使用SqlSession获取Dao的代理对象
UserDao userDao = session.getMapper(UserDao.class);
// 5.执行Dao的方法
List<User> users = userDao.findAll();
for(User user : users){
System.out.println(user);
}
// 6.释放资源
session.close();
in.close();
}
}
运行结果如图所示:
注意事项:
如果注解与xml配置的存在,使用了如图所示的配置:
运行就会报出如下所示的错误!
Exception in thread "main" org.apache.ibatis.exceptions.PersistenceException:
### Error building SqlSession.
### The error may exist in com/txw/dao/UserDao.xml
### Cause: org.apache.ibatis.builder.BuilderException: Error parsing SQL Mapper Configuration. Cause: java.lang.IllegalArgumentException: Mapped Statements collection already contains value for com.txw.dao.UserDao.findAll
at org.apache.ibatis.exceptions.ExceptionFactory.wrapException(ExceptionFactory.java:30)
at org.apache.ibatis.session.SqlSessionFactoryBuilder.build(SqlSessionFactoryBuilder.java:80)
at org.apache.ibatis.session.SqlSessionFactoryBuilder.build(SqlSessionFactoryBuilder.java:64)
at com.txw.test.MybatisAnnoTest.main(MybatisAnnoTest.java:26)
Caused by: org.apache.ibatis.builder.BuilderException: Error parsing SQL Mapper Configuration. Cause: java.lang.IllegalArgumentException: Mapped Statements collection already contains value for com.txw.dao.UserDao.findAll
at org.apache.ibatis.builder.xml.XMLConfigBuilder.parseConfiguration(XMLConfigBuilder.java:121)
at org.apache.ibatis.builder.xml.XMLConfigBuilder.parse(XMLConfigBuilder.java:99)
at org.apache.ibatis.session.SqlSessionFactoryBuilder.build(SqlSessionFactoryBuilder.java:78)
... 2 more
Caused by: java.lang.IllegalArgumentException: Mapped Statements collection already contains value for com.txw.dao.UserDao.findAll
at org.apache.ibatis.session.Configuration$StrictMap.put(Configuration.java:872)
at org.apache.ibatis.session.Configuration$StrictMap.put(Configuration.java:844)
at org.apache.ibatis.session.Configuration.addMappedStatement(Configuration.java:668)
at org.apache.ibatis.builder.MapperBuilderAssistant.addMappedStatement(MapperBuilderAssistant.java:302)
at org.apache.ibatis.builder.annotation.MapperAnnotationBuilder.parseStatement(MapperAnnotationBuilder.java:351)
at org.apache.ibatis.builder.annotation.MapperAnnotationBuilder.parse(MapperAnnotationBuilder.java:134)
at org.apache.ibatis.binding.MapperRegistry.addMapper(MapperRegistry.java:72)
at org.apache.ibatis.session.Configuration.addMapper(Configuration.java:741)
at org.apache.ibatis.builder.xml.XMLConfigBuilder.mapperElement(XMLConfigBuilder.java:381)
at org.apache.ibatis.builder.xml.XMLConfigBuilder.parseConfiguration(XMLConfigBuilder.java:119)
... 4 more
如图所示,说明都是的存在。
解决方法,把UserDao.xml删除即可。
3 mybatis注解开发保存和更新功能
1.在用户实体类持久层接口添加如下代码:
package com.txw.dao;
import com.txw.domain.User;
import org.apache.ibatis.annotations.Insert;
import org.apache.ibatis.annotations.Select;
import org.apache.ibatis.annotations.Update;
import java.util.List;
/**
* 用户实体类持久层接口
* 在mybatis中针对,CRUD一共有四个注解
* @Select @Insert @Update @Delete
* @author:Adair
* @QQ:1578533828
*/
@SuppressWarnings("all") // 注解警告信息
public interface UserDao {
/**
* 查询所有用户
* @return
*/
@Select("select * from user")
List<User> findAll();
/**
* 保存用户
* @param user
*/
@Insert("insert into user(username,address,sex,birthday)values(#{username},#{address},#{sex},#{birthday})")
void saveUser(User user);
/**
* 更新用户
* @param user
*/
@Update("update user set username=#{username},sex=#{sex},birthday=#{birthday},address=#{address} where id=#{id}")
void updateUser(User user);
}
2.编写测试的代码如下:
package com.txw.test;
import com.txw.dao.UserDao;
import com.txw.domain.User;
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import java.io.InputStream;
import java.util.Date;
/**
* 注解CRUD的测试
* @author:Adair
* @QQ:1578533828
*/
@SuppressWarnings("all") // 注解警告信息
public class AnnotationCRUDTest {
private InputStream in;
private SqlSession sqlSession;
private UserDao userDao;
@Before // 用于在测试方法执行之前执行
public void init()throws Exception{
// 1.读取配置文件,生成字节输入流
in = Resources.getResourceAsStream("SqlMapConfig.xml");
// 2.获取SqlSessionFactory
SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(in);
// 3.获取SqlSession对象
sqlSession = factory.openSession(true);
// 4.获取dao的代理对象
userDao = sqlSession.getMapper(UserDao.class);
}
@After // 用于在测试方法执行之后执行
public void destroy()throws Exception{
// 提交事务
sqlSession.commit();
// 6.释放资源
sqlSession.close();
in.close();
}
/**
* 测试保存操作
*/
@Test
public void testSave(){
User user = new User();
user.setUsername("mybatis annotation");
user.setAddress("贵州省贵阳市");
user.setSex("女");
user.setBirthday(new Date());
userDao.saveUser(user);
System.out.println(user);
}
/**
* 测试修改用户
*/
@Test
public void testUpdate(){
User user = new User();
user.setId(2);
user.setUsername("Adair");
user.setAddress("贵州省六盘水市");
user.setSex("男");
user.setBirthday(new Date());
userDao.updateUser(user);
System.out.println(user);
}
}
运行结果如图所示:
4 mybatis注解开发CRUD的其他操作
1.在用户实体类持久层接口添加如下代码:
package com.txw.dao;
import com.txw.domain.User;
import org.apache.ibatis.annotations.Delete;
import org.apache.ibatis.annotations.Insert;
import org.apache.ibatis.annotations.Select;
import org.apache.ibatis.annotations.Update;
import java.util.List;
/**
* 用户实体类持久层接口
* 在mybatis中针对,CRUD一共有四个注解
* @Select @Insert @Update @Delete
* @author:Adair
* @QQ:1578533828
*/
@SuppressWarnings("all") // 注解警告信息
public interface UserDao {
/**
* 查询所有用户
* @return
*/
@Select("select * from user")
List<User> findAll();
/**
* 保存用户
* @param user
*/
@Insert("insert into user(username,address,sex,birthday)values(#{username},#{address},#{sex},#{birthday})")
void saveUser(User user);
/**
* 更新用户
* @param user
*/
@Update("update user set username=#{username},sex=#{sex},birthday=#{birthday},address=#{address} where id=#{id}")
void updateUser(User user);
/**
* 删除用户
* @param userId
*/
@Delete("delete from user where id=#{id} ")
void deleteUser(Integer userId);
/**
* 根据id查询用户
* @param userId
* @return
*/
@Select("select * from user where id=#{id} ")
User findById(Integer userId);
/**
* 根据用户名称模糊查询
* @param username
* @return
*/
// @Select("select * from user where username like #{username} ")
@Select("select * from user where username like '%${value}%' ")
List<User> findUserByName(String username);
/**
* 查询总用户数量
* @return
*/
@Select("select count(*) from user ")
int findTotalUser();
}
2.编写测试的代码如下:
package com.txw.test;
import com.txw.dao.UserDao;
import com.txw.domain.User;
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import java.io.InputStream;
import java.util.Date;
import java.util.List;
/**
* 注解CRUD的测试
* @author:Adair
* @QQ:1578533828
*/
@SuppressWarnings("all") // 注解警告信息
public class AnnotationCRUDTest {
private InputStream in;
private SqlSession sqlSession;
private UserDao userDao;
@Before // 用于在测试方法执行之前执行
public void init()throws Exception{
// 1.读取配置文件,生成字节输入流
in = Resources.getResourceAsStream("SqlMapConfig.xml");
// 2.获取SqlSessionFactory
SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(in);
// 3.获取SqlSession对象
sqlSession = factory.openSession(true);
// 4.获取dao的代理对象
userDao = sqlSession.getMapper(UserDao.class);
}
@After // 用于在测试方法执行之后执行
public void destroy()throws Exception{
// 提交事务
sqlSession.commit();
// 6.释放资源
sqlSession.close();
in.close();
}
/**
* 测试保存操作
*/
@Test
public void testSave(){
User user = new User();
user.setUsername("mybatis annotation");
user.setAddress("贵州省贵阳市");
user.setSex("女");
user.setBirthday(new Date());
userDao.saveUser(user);
System.out.println(user);
}
/**
* 测试修改用户
*/
@Test
public void testUpdate(){
User user = new User();
user.setId(2);
user.setUsername("Adair");
user.setAddress("贵州省六盘水市");
user.setSex("男");
user.setBirthday(new Date());
userDao.updateUser(user);
System.out.println(user);
}
/**
* 测试删除操作
*/
@Test
public void testDelete(){
userDao.deleteUser(7);
}
/**
* 测试根据id查询用户
*/
@Test
public void testFindOne(){
User user = userDao.findById(2);
System.out.println(user);
}
/**
* 测试根据用户名称模糊查询
*/
@Test
public void testFindByName(){
// List<User> users = userDao.findUserByName("%mybatis%");
List<User> users = userDao.findUserByName("mybatis");
for(User user : users){
System.out.println(user);
}
}
/**
* 测试查询总用户数量
*/
@Test
public void testFindTotal(){
int total = userDao.findTotalUser();
System.out.println(total);
}
}
运行结果如图所示: