Mybatis学习笔记:
使用xml配置有时会出现冗长的问题,此时注解可能是更好的选择,注解可以简化xml配置,提高开发效率。但是因为大部分注解在确定之后很少会发生改变,所以注解比较适用于一些中小型的项目。
Mybatis中常用的注解:
注解 | 功能 | 映射类型 |
---|---|---|
@Insert | 实现插入功能 | SQL语句映射 |
@Select | 实现查询功能 | SQL语句映射 |
@SelectKey | 插入后,获取id的值 | SQL语句映射 |
@Update | 实现更新功能 | SQL语句映射 |
@Delete | 实现删除功能 | SQL语句映射 |
@Result | 对结果集映射 | 结果集映射 |
@Results | 对结果集中的字段映射 | 结果集映射 |
@ResultMap | 引用映射结果集 | 结果集映射 |
@one | 一对一关系映射 | 关系映射 |
@many | 一对多关系映射 | 关系映射 |
案例:使用注解实现CRUD
项目目录:
创建maven项目,并配置pom.xml文件:
<?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>org.example</groupId>
<artifactId>mybatis_day04_annotation</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>jar</packaging>
<dependencies>
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.4.5</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.11</version>
</dependency>
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.12</version>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.10</version>
</dependency>
</dependencies>
</project>
配置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-->
<properties>
<property name="driver" value="com.mysql.cj.jdbc.Driver"></property>
<property name="url" value="jdbc:mysql://localhost:3306/mybatis?serverTimezone=GMT%2B8&useUnicode=true&characterEncoding=utf-8"></property>
<property name="username" value="root"></property>
<property name="password" value="123456"></property>
</properties>
<typeAliases>
<package name="com.ly.domain"/>
</typeAliases>
<!--配置环境-->
<environments default="mysql">
<!-- 配置mysql的环境-->
<environment id="mysql">
<!-- 配置事务 -->
<transactionManager type="JDBC"/>
<!--配置连接池-->
<dataSource type="POOLED">
<property name="driver" value="${driver}"></property>
<property name="url" value="${url}"></property>
<property name="username" value="${username}"></property>
<property name="password" value="${password}"></property>
</dataSource>
</environment>
</environments>
<mappers>
<mapper class="com.ly.dao.IUserDao"/>
</mappers>
</configuration>
创建用户实体类User:
public class User implements Serializable {
private Integer id;
private String username;
private String address;
private String sex;
private Date birthday;
public Integer getId() {
return id;
}
public void setId(Integer id) {
this.id = id;
}
public String getUsername() {
return username;
}
public void setUsername(String username) {
this.username = username;
}
public String getAddress() {
return address;
}
public void setAddress(String address) {
this.address = address;
}
public String getSex() {
return sex;
}
public void setSex(String sex) {
this.sex = sex;
}
public Date getBirthday() {
return birthday;
}
public void setBirthday(Date birthday) {
this.birthday = birthday;
}
@Override
public String toString() {
return "User{" +
"id=" + id +
", username='" + username + '\'' +
", address='" + address + '\'' +
", sex='" + sex + '\'' +
", birthday=" + birthday +
'}';
}
}
实现实体类User的dao接口,并进行相应的注解配置:
/**
* @Author: Ly
* @Date: 2020-07-19 17:27
* 在mybatis中正对CRUD一共有四个注解
* @Select @Insert @Update @Delete
*/
public interface IUserDao {
/**
* 查询所有用户
* @return
*/
@Select(value = "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},address=#{address},sex=#{sex},birthday=#{birthday} 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}")
List<User> findUserByName(String username);
/**
* 查询总用户数量
* @return
*/
@Select("select count(*) from user")
int findTotalUser();
}
测试代码:实现增删改查
/**
* @Author: Ly
* @Date: 2020-07-20 16:01
*/
public class AnnotationCRUDTest {
private SqlSessionFactory factory;
private SqlSession session;
private IUserDao userDao;
private InputStream in;
@Before
public void init() throws IOException {
in= Resources.getResourceAsStream("SqlMapConfig.xml");
factory =new SqlSessionFactoryBuilder().build(in);
session =factory.openSession();
userDao =session.getMapper(IUserDao.class);
}
@After
public void destroy() throws IOException {
session.commit();
session.close();
in.close();
}
@Test
public void testSave(){
User user =new User();
user.setUsername("lll");
user.setAddress("新乡市");
userDao.saveUser(user);
}
@Test
public void testUpdate(){
User user =new User();
user.setId(9);
user.setUsername("ll");
user.setAddress("北京市");
user.setSex("男");
user.setBirthday(new Date());
userDao.updateUser(user);
}
@Test
public void testDelete(){
userDao.deleteUser(12);
}
@Test
public void testFindOne(){
User user =userDao.findById(13);
System.out.println(user);
}
@Test
public void testFindByName(){
List<User> users=userDao.findUserByName("%张%");
for(User user:users){
System.out.println(user);
}
}
@Test
public void testFindTotal(){
int total =userDao.findTotalUser();
System.out.println(total);
}
}
解决实体表与数据库的对应关系
当我们配置的实体类与我们数据库的属性名称不对应时,我们是无法完成数据封装的,解决这个问题可以从数据库语句方面(起别名)或者通过配置xml文件来解决,当然Mybatis中也提供了一种通过注解的解决方案@Results。
/**
* @Author: Ly
* @Date: 2020-07-19 17:27
* 在mybatis中正对CRUD一共有四个注解
* @Select @Insert @Update @Delete
*/
public interface IUserDao {
/**
* 查询所有用户
* @return
*/
@Select(value = "select * from user")
//id为当前结果集声明唯一标识,value值为结果集映射关系
@Results(id="userMap", value = {
//column指定数据库字段的名称,property指定实体类属性的名称,jdbcType数据库字段类型
@Result(id=true,column = "id",property = "id1"),
@Result(column = "username",property = "username1"),
@Result(column = "address",property = "address1"),
@Result(column = "sex",property = "sex1"),
@Result(column = "birthday",property = "birthday1")
})
List<User> findAll();
/**
* 根据id查询用户
* @param userId
* @return
*/
@Select("select * from user where id=#{id}")
//引用id为userMap的Results结果集映射
@ResultMap(value={"userMap"})
User findById(Integer userId);
/**
* 根据用户名称模糊查询
* @param username
* @return
*/
@Select("select * from user where username like #{username}")
@ResultMap(value={"userMap"})
List<User> findUserByName(String username);
}
使用注解实现多表查询
要实现多表查询,首先我们在项目中添加Account类的相关信息,并在实体类中添加表与表之间的对应关系(一个账户只能属于一个用户,一个用户可以有多个账户)。
目录结构:
创建Account实体类:
在创建实体类时,在类中添加User类属性,形成账户对用户的一对一关系。
public class Account implements Serializable {
private Integer id;
private Integer uid;
private Double money;
//多对一(mybatis中称之为一对一)的映射,一个账户只能属于一个用户
private User user;
public User getUser() {
return user;
}
public void setUser(User user) {
this.user = user;
}
public Integer getId() {
return id;
}
public void setId(Integer id) {
this.id = id;
}
public Integer getUid() {
return uid;
}
public void setUid(Integer uid) {
this.uid = uid;
}
public Double getMoney() {
return money;
}
public void setMoney(Double money) {
this.money = money;
}
@Override
public String toString() {
return "Account{" +
"id=" + id +
", uid=" + uid +
", money=" + money +
'}';
}
}
创建实体类Account的dao接口,并使用注解进行性相关配置:
当我们要实现一对一关系时,应该用到注解 @One,在注解@Result中进行配置,格式为: @Result(property = "--",column = "--",one = @One( select = "--" ,fetchType = --))
在注解@One中:select对应我们需要功能的方法的路径(全限定类名+.方法名),fetchType对应加载模式(LAZY,EAGER,DEFAULT)
public interface IAccountDao {
/**
* 查询所有账户,并且获取每一个账户所属的用户信息
* @return
*/
@Select("select * from account")
@Results(id="accountMap",value={
@Result(id=true,column = "id",property = "id"),
@Result(column = "uid",property = "uid"),
@Result(column = "money",property = "money"),
@Result(property = "user",column = "uid",one=@One( select="com.ly.dao.IUserDao.findById",fetchType= FetchType.EAGER))
})
List<Account> findAll();
/**
* 根据用户id查询账户信息
* @param userId
* @return
*/
@Select("select * from account where uid=#{userId}")
List<Account> findAccountByUid(Integer userId);
}
测试代码:
/**
* @Author: Ly
* @Date: 2020-07-20 22:45
*/
public class AccountTest {
private SqlSessionFactory factory;
private SqlSession session;
private IAccountDao accountDao;
private InputStream in;
@Before
public void init() throws IOException {
in= Resources.getResourceAsStream("SqlMapConfig.xml");
factory =new SqlSessionFactoryBuilder().build(in);
session =factory.openSession();
accountDao =session.getMapper(IAccountDao.class);
}
@After
public void destroy() throws IOException {
session.commit();
session.close();
in.close();
}
@Test
public void testFindAll(){
List<Account> accounts =accountDao.findAll();
for(Account account :accounts){
System.out.println("-------每个账户的信息-------");
System.out.println(account);
System.out.println(account.getUser());
}
}
}
测试结果:
实现一对多查询:
想要实现一对多查询,首先我们应该在User实体类中添加一对多关系映射所对应的属性
//一对多关系映射:一个用户对应多个账户
private List<Account> accounts;
public List<Account> getAccounts() {
return accounts;
}
public void setAccounts(List<Account> accounts) {
this.accounts = accounts;
}
修改User的dao接口中的代码,想要实现一对多查询我们应该用到@Many注解,在注解@Results中添加相应代码:
@Result(property = "accounts",column = "id",
many = @Many(select="com.ly.dao.IAccountDao.findAccountByUid",fetchType = FetchType.LAZY))
测试代码:
public class AnnotationCRUDTest {
private SqlSessionFactory factory;
private SqlSession session;
private IUserDao userDao;
private InputStream in;
@Before
public void init() throws IOException {
in= Resources.getResourceAsStream("SqlMapConfig.xml");
factory =new SqlSessionFactoryBuilder().build(in);
session =factory.openSession();
userDao =session.getMapper(IUserDao.class);
}
@After
public void destroy() throws IOException {
session.commit();
session.close();
in.close();
}
@Test
public void testFindAll(){
List<User> users =userDao.findAll();
for(User user :users){
System.out.println("----------打印每个用户的信息-----------");
System.out.println(user);
System.out.println(user.getAccounts());
}
}
@Test
public void testFindOne(){
User user =userDao.findById(13);
System.out.println(user);
}
@Test
public void testFindByName(){
List<User> users=userDao.findUserByName("%张%");
for(User user:users){
System.out.println(user);
}
}
}
运行结果: